Applications

Supply provider-required attributes for an application

Fills attributes a payment provider’s KYC requires that Zuba’s review does not assess: the applicant’s own attributes when the applicant is the beneficial owner, the business industry code, and the market the business primarily serves. Accepted in any application status, and only into a field the application has no value for; correcting an existing value goes through PATCH while the application is still editable.

POST

applications

{id}

enrich

Supply provider-required attributes for an application

curl --request POST \
  --url https://api.example.com/v2/applications/{id}/enrich \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "applicantOccupationCode": "111011",
  "industryCode": "541611",
  "targetMarketOtherDescription": "<string>"
}
'

import requests

url = "https://api.example.com/v2/applications/{id}/enrich"

payload = {
    "applicantOccupationCode": "111011",
    "industryCode": "541611",
    "targetMarketOtherDescription": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    applicantOccupationCode: '111011',
    industryCode: '541611',
    targetMarketOtherDescription: '<string>'
  })
};

fetch('https://api.example.com/v2/applications/{id}/enrich', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v2/applications/{id}/enrich",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'applicantOccupationCode' => '111011',
    'industryCode' => '541611',
    'targetMarketOtherDescription' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v2/applications/{id}/enrich"

	payload := strings.NewReader("{\n  \"applicantOccupationCode\": \"111011\",\n  \"industryCode\": \"541611\",\n  \"targetMarketOtherDescription\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/v2/applications/{id}/enrich")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"applicantOccupationCode\": \"111011\",\n  \"industryCode\": \"541611\",\n  \"targetMarketOtherDescription\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v2/applications/{id}/enrich")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"applicantOccupationCode\": \"111011\",\n  \"industryCode\": \"541611\",\n  \"targetMarketOtherDescription\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "applicationType": "business",
  "createdAt": "2023-11-07T05:31:56Z",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "draft",
  "editableSections": [
    "<string>"
  ],
  "moreInfoReason": "<string>",
  "registeredName": "<string>",
  "riskLevel": "low",
  "screeningStatus": "pending"
}

{
  "error": "BAD_REQUEST",
  "message": "Bad Request",
  "path": "/v1/resource",
  "statusCode": 400,
  "timestamp": "2024-01-15T10:30:00.000Z"
}

{
  "error": "BAD_REQUEST",
  "message": "Bad Request",
  "path": "/v1/resource",
  "statusCode": 400,
  "timestamp": "2024-01-15T10:30:00.000Z"
}

Authorizations

Authorization

string

header

required

Enter Auth0 JWT token

Path Parameters

string<uuid>

required

Body

application/json

applicantGender

enum<string>

Gender of the applicant, when the applicant is the beneficial owner.

Available options:

male,

female,

other

applicantOccupationCode

string

US Standard Occupational Classification code for the applicant, 6 digits with any dashes removed.

Example:

"111011"

industryCode

string

North American Industry Classification System code for the business, exactly 6 digits.

Example:

"541611"

targetMarket

enum<string>

The market the business primarily serves.

Available options:

commercial,

retail,

government,

other

targetMarketOtherDescription

string

Describes the market served, and belongs to the other market alone. Both this and targetMarket are written once into a still-empty column, so the value the application already records wins over the one sent here and the pair is judged on the result: a description is required when that result is other, and refused when it is a named market. A description may be sent on its own to qualify an other already on file.

Response

accountId

string<uuid>

required

The account this application belongs to (self or sub-account).

applicationType

enum<string>

required

Available options:

business,

individual

createdAt

string<date-time>

required

string<uuid>

required

status

enum<string>

required

Available options:

draft,

under_review,

approved,

more_info_requested,

rejected

editableSections

string[]

When status is more_info_requested, the sections you may edit and resubmit. applicant / businessInfo / businessActivity / individualActivity are edited via PATCH; persons via the /persons sub-resource (and covers that person’s own documents); documents is company-level documents via the /documents sub-resource. Empty otherwise.

moreInfoReason

string

When status is more_info_requested, the reviewer’s notes describing what needs to change. Null otherwise.

registeredName

string

The name the company is registered under, so a directory can label an application without reading the full record.

riskLevel

enum<string>

Available options:

low,

medium,

high,

prohibited

screeningStatus

enum<string>

Available options:

pending,

in_progress,

clear,

flagged,

failed,

timed_out

Supply provider-required attributes for an application

curl --request POST \
  --url https://api.example.com/v2/applications/{id}/enrich \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "applicantOccupationCode": "111011",
  "industryCode": "541611",
  "targetMarketOtherDescription": "<string>"
}
'

import requests

url = "https://api.example.com/v2/applications/{id}/enrich"

payload = {
    "applicantOccupationCode": "111011",
    "industryCode": "541611",
    "targetMarketOtherDescription": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    applicantOccupationCode: '111011',
    industryCode: '541611',
    targetMarketOtherDescription: '<string>'
  })
};

fetch('https://api.example.com/v2/applications/{id}/enrich', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v2/applications/{id}/enrich",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'applicantOccupationCode' => '111011',
    'industryCode' => '541611',
    'targetMarketOtherDescription' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v2/applications/{id}/enrich"

	payload := strings.NewReader("{\n  \"applicantOccupationCode\": \"111011\",\n  \"industryCode\": \"541611\",\n  \"targetMarketOtherDescription\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/v2/applications/{id}/enrich")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"applicantOccupationCode\": \"111011\",\n  \"industryCode\": \"541611\",\n  \"targetMarketOtherDescription\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v2/applications/{id}/enrich")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"applicantOccupationCode\": \"111011\",\n  \"industryCode\": \"541611\",\n  \"targetMarketOtherDescription\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "applicationType": "business",
  "createdAt": "2023-11-07T05:31:56Z",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "draft",
  "editableSections": [
    "<string>"
  ],
  "moreInfoReason": "<string>",
  "registeredName": "<string>",
  "riskLevel": "low",
  "screeningStatus": "pending"
}

{
  "error": "BAD_REQUEST",
  "message": "Bad Request",
  "path": "/v1/resource",
  "statusCode": 400,
  "timestamp": "2024-01-15T10:30:00.000Z"
}

{
  "error": "BAD_REQUEST",
  "message": "Bad Request",
  "path": "/v1/resource",
  "statusCode": 400,
  "timestamp": "2024-01-15T10:30:00.000Z"
}