Onboarding API
The partner will be issued a partner username and password to create companies. Once the company is created, please use the username and password to connect to the company’s profile and complete the onboarding within the new company's profile. The partner will be required to change their password before starting the onboarding process. Each profile is unique, and if you are switching between profiles, please complete a new /connect request with the relevant company’s credentials.
Unless specified, Allowed characters: Latin letters A-Za-z, 0-9 numbers, - _ : & ; , # / and space
List of Onboarding API's
Partner:
Customer (Company):
- Connect to the Payments Service
- Disconnect from the Payments Service
- Change Password
- Personal Information*
- Add Company details
- Add Company Payment Data
- Add Registered Company Address
- Add Principal Business Address
- Add Residential Address*
- Directors Add
- Documents Upload
- PEP connection
- Submit Company
- Status Company AML
*Note: This applies only to personal accounts (Individual and sole trader clients).
POST Company Create
Endpoint: /company_create
Request Body Payload Example
The request body includes the following parameters:
| Parameter | Description | Type | Size | Mandatory |
|---|---|---|---|---|
country_iso |
2-digit ISO code of countries. | ISO code | 2 | Yes |
state_iso |
ISO code of states. | Varchar | 6 | Mandatory for countries: Australia, USA, Canada, and New Zealand |
account |
Options include business, personal, or educational. The default value is business. | Varchar | 10 | Yes |
account_role |
Options are private_company, public_company, partnership, trust, sole_trader, individual, education_private_company, education_public_company. Default value is private_company | Varchar | 25 | Yes |
company_name |
Legal name of the company A-Z a-z 0-9 - _ &. :;, ' :space: ( ). Not applicable for account roles Individual and Sole traders. | Varchar | 150 | Yes |
annual_equivalent_amount_currency |
3-digit ISO code for currencies. Options are USD, CAD, GBP, and EUR | Varchar | 3 | Optional |
annual_equivalent_amount |
Annual amount expected to be transacted through TransferMate. | Integer | 15 | Optional |
first_name |
First name of personal making application on behalf of the company Latin alphanumeric A-Z a-z | Varchar | 80 | Yes |
last_name |
Last name of person making application on behalf of company Latin alphanumeric A-Z a-z | Varchar | 80 | Yes |
email |
email addess of person making application, Lowecase letters(a-z), digits (0-9), underscores(_ ), hyphens( - ), periods( . ), @ | Varchar | 150 | Yes |
mobile_phone_country_code |
The international dialing code of the country in which the payee resides. See Country Code for more information | Varchar | 80 | Yes |
mobile_phone_number |
The mobile phone contact number for the payee. | Varchar | 80 | Yes |
terms_of_use_agree |
values: 0 - No, 1 - Yes | Integer | 1 | Yes |
Example Request
An example of the JSON structure in the request is as follows:
"country_iso": "US",
"state_iso": "US-CA",
"account": "business",
"account_role": "private_company",
"first_name": "Mary",
"last_name": "Smith",
"company_name": "Company Name LTD",
"email": "exampleeemailaddress@email.com",
"mobile_phone_country_code": "us 1",
"mobile_phone_number": "202-555-0192",
"agree_to_marketing": 0,
"annual_equivalent_amount_currency": "USD",
"annual_equivalent_amount": 10000000.00
}
Example Success Response
If the view company create request is successful, the service returns a response. The response body includes the following parameters:
| FIELD | DESCRIPTION | TYPE |
|---|---|---|
username |
Username of the account created | Varchar |
password |
Password of the account created | Varchar |
The JSON structure in a successful response is as follows:
{
"is_successful": true,
"stat": "success",
"messages": {
"success": "Action performed successfully."
},
"username": "f6-zs3-h76543Cpxt",
"password": "7&Eq#!17834vr$e4234gf40Ocwe%2843"
}
Errors
If the /create_company request is not successful, the service responds with an error code, rejects the request, and does not create the company. Some examples of error responses are provided.
The JSON structure associated with the error responses has the following parameters:
| FIELD | DESCRIPTION | TYPE |
|---|---|---|
ID |
Field that failed | Varchar |
description |
Description of error | Varchar |
"is_successful": false,
"messages": [],
"global_errors": [],
"input_errors": [
{
"ID": "email",
"description": "Already exists!"
}
]
}
You connect to the Payments service to log in. You do this by sending an HTTP POST request with the required account login information to the /connect endpoint.
POST Personal Information
Endpoint: /v2/personal_information
Request Body Payload Example
The request body includes the following parameters:
| Parameter | Description | Type | Size | Mandatory |
|---|---|---|---|---|
id_type |
Type of individual`s documents: 1 - Identity Card 2 - Passport |
Integer | - | Mandatory for some countries like Singapore/Hong Kong/China/etc |
identification_number |
Identification number of the individual`s documents. Latin letters A-Za-z, 0-9 numbers, - _ : & ; , # / | Varchar | 80 | Mandatory for some countries like Singapore/Hong Kong/China/etc |
gender |
Gender: male female other |
Varchar | 80 | Mandatory for some countries like New Zealand |
past_nationality_iso |
ISO country code - All past nationalities held by individual must be added - can add more than one - please see example - Mandatory for Singapore | Varchar | - | Mandatory for Singapore |
nationality |
Country code. Note: This field is scheduled for deprecation. | Integer | - | Yes |
nationality_iso |
Nationality ISO country code | Varchar | - | Yes |
id_issue_country_iso |
ISO country code where the passport is issued | Varchar | - | Yes |
middle_name |
Middle name contains Latin alphanumeric A-Z a-z hyphen ( - ) period ( . ) space | Varchar | 80 | Optional |
aliases |
Alias contains Latin alphanumeric A-Z a-z hyphen ( - ) period ( . ) space | Varchar | 80 | Optional |
occupation |
Occupation. See Occupation IDs for more information | Varchar | 80 | Yes |
date_of_birth |
Date of birth of the individual Format: DD-MM-YYYY | Varchar | 10 | Yes |
| website | The website of individaul or sole trader | Varchar | 150 | Optional |
An example of the JSON structure in the request is as follows:
"id_type": "",
"identification_number": "1",
"short_response": 1,
"past_nationality_iso": ["DE","ES"],
"nationality_iso": "IE",
"id_issue_country_iso": "UK",
"middle_name": "Test",
"aliases": "test",
"occupation": "20000027",
"date_of_birth": "08/08/1991"
}
Example Success Response
If the add registered business address request is successful, the service returns a response.
The response body includes the following parameters:
| FIELD | DESCRIPTION | TYPE |
|---|---|---|
is_successful |
Returns status of the upload. Values: true (successfully) , false (unsuccessfully) | Varchar |
stat |
The status of the request, success. | Varchar |
messages |
List of messages | List |
company_id |
The ID of the account, for example, 651134576. | Integer |
The JSON structure in a successful response is as follows:
"is_successful": true,
"stat": "personal_information_added",
"messages": {
"success": "Action performed successfully."
},
"company_id": 659
}
Errors
Error Code 521 - Bad Request
"is_successful": false,
"messages": [],
"global_errors": [],
"input_errors": [
{
"ID": "identification_number",
"description": "Please enter correct information!"
},
{
"ID": "occupation",
"description": "Please enter correct information!"
}
]
}
POST Add Company Details
Endpoint: /add_company_details Note: This endpoint is NOT applicable for Individuals.
Request Body Payload Example
The request body includes the following parameters:
| Parameter | Description | Type | Size | Required |
|---|---|---|---|---|
company_name |
Legal name of the company A-Z a-z 0-9 - _ & . : ; , ' :space: ( ) Not applicable for account role Sole traders. | Varchar | 150 | Yes |
trading_names |
The number of trading names the company has. Values: 0- don’t have, 1-3 have up to 3 trading names. | Integer | 1 | Yes |
trading_name_1 |
Trading name of the company A-Z a-z 0-9 - _ & . : ; , ' :space: ( ) | Varchar | 150 | Yes |
trading_name_2 |
Trading name of the company A-Z a-z 0-9 - _ & . : ; , ' :space: ( ) | Varchar | 150 | If trading names = 2 or 3 |
trading_name_3 |
Trading name of the company A-Z a-z 0-9 - _ & . : ; , ' :space: ( ) | Varchar | 150 | If trading names = 3 |
company_number |
Display the registered number of the company | Varchar | 100 | Optional for account_role = sole_trader |
industry_type |
Industry type of the company. See industry type id and values | Integer | 2 | Optional for account_role = trust |
date_of_incorporation |
Date when the company was incorporated. Format: DDMM-YYYY | varchar | 10 | Mandatory for all exept for account_role = sole_trader which is optional |
business_website_social_media |
Social media or website of the company A-Z a-z 0-9 - _ & . : ; , ' :space: ( ) | Varchar | 150 | No |
trust_purpose |
Purpose of the trust account | varchar | 1000 | Only for account_role = trust |
| tax_id | The tax ID of the company. Not applicable for the account role Sole traders | varchar | 150 | No |
An example of the JSON structure in the request is as follows:
"company_name": "Company Name LTD",
"trading_names": 1,
"trading_name_1": "International Company LLC",
"trading_name_2": "International Projections",
"trading_name_3": "International Laminates",
"company_number": "A1231231-12",
"industry_type": 12,
"date_of_incorporation": "02/02/2005",
"business_website_social_media": "www.globallamination.com, @globallamination",
"trust_purpose": "100000"
}
Example Success Response
If the add_company_details request is successful, the service returns a response.
The response body includes the following parameters:
| FIELD | DESCRIPTION | TYPE |
|---|---|---|
company_id |
ID of the company | Integer |
The JSON structure in a successful response is as follows:
"is_successful": true,
"stat": "company_details_added",
"messages": {
"success": "Action performed successfully."
},
"company_id": 659
}
Errors
If the /create_company request is not successful, the service responds with an error code, rejects the request, and does not create the comapny. Some examples of error responses are provided.
The JSON structure associated with the error responses has the following parameters:
| FIELD | DESCRIPTION | TYPE |
|---|---|---|
ID |
Field that failed | Varchar |
description |
Description of error | Varchar |
"is_successful": false,
"messages": {
"company_number": "Please enter correct information!"
},
"stat": "One or more JSON attributes missing or malformed: 'company_number'"
}
"is_successful": false,
"messages": [],
"global_errors": [],
"input_errors": [
{
"ID": "date_of_incorporation",
"description": "Please enter correct information!"
}
]
}
POST Add Company Payment Data
Endpoint: /add_company_payment_data
Request Body Payload Example
The request body includes the following parameters:
| Parameter | Description | Type | Size | Required |
|---|---|---|---|---|
business_model_overview |
Overview of the business model of the company A-Z a-z 0-9 - _ &. : ; , ' :space: ( ) Not applicable for account role Individual | Varchar | 250 | Yes |
business_size |
Size of the company: "small", "medium", "large". Small: Annual Turnover of less than 2 million EUR Medium: Annual Turnover of less than 10 million EUR Large-Sized: All other businesses above the thresholds noted above Conditional based on if 'country' = UK or any other country where we allow Reverse Enquiry under UK entity |
Varchar | 6 |
Conditional based on if 'country' = UK or any other country where we allow Reverse Enquiry under UK entity. Optional for account type = Sole Traders |
high_risk_countries |
Does the company expect to make or receive payments to countries deemed higher risk. Values: 0 - No, 1 - Yes | Integer | 1 | Yes |
specify_high_risk_countries |
2-digit ISO code of countries. | Varchar | 2 | Only if high_risk_countries=1 |
conducting_payment_activity |
Currently, the company will be conducting payment service activities, including A-Z, a-z, 0-9, -_ & . : ; , ' :space: ( ) | Varchar | 500 | Yes |
employees_number |
How many employees does the company have? Can accept the following options: ID 1 → 1-9 ID 2 → 10-99 ID 3 → 100-499 ID 4 → 500+ Not applicable for account role Individual |
Integer | 1 |
Conditional based on if 'country' = UK or any other country where we allow Reverse Enquiry under UK entity. Optional for account type = Sole Traders |
reason_for_payments |
Reason for the payment transfers A-Z a-z 0-9 - _ & . : ; , ' :space: ( ) | Varchar | 500 | Optional |
product_services_required |
Product of services that are required. Values: incoming and/or outgoing e.g. "incoming,outgoing" | Varchar | 17 | Yes |
beneficiary_types |
What type of beneficiaries will accept the transfers? Values: "Individual", "Business", "Both", "Other". | Varchar | 10 | If product_services_required = outgoing, then Mandatory. |
beneficiary_types_other |
Specify another type of beneficiary. A-Z a-z 0-9 - _ & . : ; , ' :space: ( ) | Varchar | 200 | In case "beneficiary_types" = Other. |
beneficiary_industries_top_5 |
Top 5 Beneficiary industries. A-Z a-z 0-9 - _ & . : ; , ' :space: ( ) | Varchar | 1000 | If product_services_required = outgoing, then Mandatory. |
countries_to_send_funds_to |
2-digit ISO code of the countries the company is expecting to send funds to | Varchar | 1000 | If product_services_required = outgoing, then Mandatory. |
expected_frequency_payments_out |
The expected average amount of the payments out. Values: "Daily", "Weekly", "Fortnightly", "Monthly", "Biannually", "Annually" | Varchar | 50 | Optional |
expected_avg_payments_out_currency |
Currency of the expected average payments out. An ID from the list of currency IDs. | Varchar | 3 | Optional. |
expected_avg_payments_out_amount |
The expected average amount of the payments out in the domestic currency. | Integer | 20 | Optional |
sender_types |
What type of sender's company will accept the transfers from. Values: "Individual", "Business", "Both", "Other". | Varchar | 10 | Optional |
sender_types_other |
Specify another type of sender. A-Z a-z 0-9 - _ & . : ; , ' :space: ( ) | Varchar | 200 | Optional |
sender_industries_top_5 |
Top 5 Senders industries. A-Z a-z 0-9 - _ & . : ; , ' :space: ( ) | Varchar | 1000 | Optional |
countries_to_receive_funds_from |
2-digit ISO code of the countries the company is expecting to receive funds from | Varchar | 2 | Optional |
expected_frequency_payments_in |
The expected average amount of the payments is. Values: "Daily", "Weekly", "Fortnightly", "Monthly", "Biannually", "Annually" | Integer | - | Optional |
expected_avg_payments_in_currency |
Currency of the expected average payments out. An ID from the list of currency IDs. | Varchar | 3 | Optional. |
expected_avg_payments_in_amount |
The expected average amount of the payments received in domestic currency. | Integer | 20 | Optional |
An example of the JSON structure in the request is as follows:
"business_model_overview": "Business Model Overview",
"business_size": "medium",
"high_risk_countries": 1,
"conducting_payment_activity": "Payment activity",
"employees_number": 2,
"reason_for_payments": "Expected reason",
"specify_high_risk_countries": "bg",
"product_services_required": "incoming,outgoing",
"beneficiary_types": "Other", "beneficiary_types_other": "Some Text",
"beneficiary_industries_top_5": "IT,IT",
"countries_to_send_funds_to": "BG,IT",
"expected_frequency_payments_out": "Monthly",
"expected_avg_payments_out_currency": "EUR",
"expected_avg_payments_out_amount": 10000,
"sender_types": "Other",
"sender_types_other": "Some Other",
"sender_industries_top_5": "IT,IT",
"countries_to_receive_funds_from": "BG,IT",
"expected_frequency_payments_in": "Monthly",
"expected_avg_payments_in_currency": "BGN",
"expected_avg_payments_in_amount": 20000
}
Example Success Response
If the add_company_payment_data request is successful, the service returns a response.
The response body includes the following parameters:
| FIELD | DESCRIPTION | TYPE |
|---|---|---|
company_id |
ID of the company | Integer |
The JSON structure in a successful response is as follows:
"is_successful": true,
"stat": "company_payment_data_added",
"messages": {
"success": "Action performed successfully."
},
"company_id": 659
}
Errors
If the add_company_payment_data request is not successful, the service responds with an error code, rejects the request, and does not add any company payment data. Some examples of error responses are provided.
The JSON structure in a successful response is as follows:
| FIELD | DESCRIPTION | TYPE |
|---|---|---|
ID |
Field that failed | Varchar |
description |
Description of error | Varchar |
"is_successful": false,
"messages": [],
"global_errors": [],
"input_errors": [
{
"ID": "business_model_overview",
"description": "Please enter correct information!"
}
]
}
POST Add Registered Company Address
Endpoint: /add_registered_business_addressNote: This endpoint is not applicable for account roles Individual and Sole traders.
Request Body Payload Example
The request body includes the following parameters:
| Parameter | Description | Type | Size | Required |
|---|---|---|---|---|
registered_business_address_country |
An ISO standard country code from the list of valid country codes, for example, IE (Ireland). See Country Reference by System ID for more information. | Varchar | 2 | Yes |
registered_business_address_state |
The appropriate state in US, Canadian, Australia and New Zealand jurisdictions. For all other jurisdictions, leave blank. See Country Code for more information | Varchar | 6 | Yes |
registered_business_address_apartment_unit_no |
Apartment number of the business | Varchar | 225 | Yes |
registered_business_street |
Street address of the business | Varchar | 225 | Yes |
registered_business_address_suburb |
Suburb of thebusiness | Varchar | 225 | No |
registered_business_address_city |
City of the business | Varchar | 100 | Yes |
registered_business_address_post_code |
Post or ZIP code of the business | Varchar | 20 | Yes |
An example of the JSON structure in the request is as follows:
"registered_business_address_country": "US",
"registered_business_address_state": "US-CA",
"registered_business_address_apartment_unit_no": "225",
"registered_business_street": "Apple Lane",
"registered_business_address_suburb": "Financial District",
"registered_business_address_city": "San Francisco",
"registered_business_address_post_code": "94104"
}
Example Success Response
If the add registered business address request is successful, the service returns a response.
The response body includes the following parameters:
| FIELD | DESCRIPTION | TYPE |
|---|---|---|
stat |
The status of the request, success. | Varchar |
company_id |
The ID of the account, for example, 541238. | Integer |
The JSON structure in a successful response is as follows:
"is_successful": true,
"stat": "company_address_added",
"messages": {
"success": "Action performed successfully."
},
"company_id": 659
}
Errors
If the add_company_payment_data request is not successful, the service responds with an error code, rejects the request, and does not add any company payment data. Some examples of error responses are provided.
The JSON structure associated with the error responses has the following parameters:
| FIELD | DESCRIPTION | TYPE |
|---|---|---|
ID |
Field that failed | Varchar |
description |
Description of error | Varchar |
"is_successful": false,
"messages": [],
"global_errors": [],
"input_errors": [
{
"ID": "registered_business_address_post_code",
"description": "Please enter your Post/Zip Code"
}
]
}
POST Add Principal Business Address
Endpoint: /add_principal_business_address
Note: This endpoint is not applicable to Individuals
Request Body Payload Example
The request body includes the following parameters:
| Parameter | Description | Type | Size | Required |
|---|---|---|---|---|
same_as_business_address |
If Principal Business address is the same as the registered principal address, Use 1, if not, use 0 | Integer | 1 | Yes |
principal_business_address_country |
An ISO standard country code from the list of valid country codes, for example, IE (Ireland). See Country Reference by System ID for more information. | Varchar | 2 | Optional |
principal_business_address_state |
The appropriate state in US, Canadian, Australia and New Zealand jurisdictions. For all other jurisdictions, leave blank. See Country Code for more information. | Varchar | 6 | Optional |
principal_business_address_apartment_unit_no |
Number of the address of the business. | Varchar | 225 | Optional |
principal_business_street |
Street address of the business. | Varchar | 225 | Optional |
principal_business_address_suburb |
Suburb the business is located. | Varchar | 225 | Optional |
principal_business_address_city |
City the business is located. | Varchar | 100 | Optional |
principal_business_address_post_code |
Post or ZIP code of the Business. | Varchar | 20 | Optional |
An example of the JSON structure in the request is as follows:
"same_as_business_address": 0,
"principal_business_address_country": "US",
"principal_business_address_state": "US-NY",
"principal_business_address_apartment_unit_no": "1056",
"principal_business_street": "191 W 182th St",
"principal_business_address_suburb": "New York",
"principal_business_address_city": "New York",
"principal_business_address_post_code": "10026"
}
Example Success Response
If the add principal business address request is successful, the service returns a response.
The response body includes the following parameters:
| FIELD | DESCRIPTION | TYPE |
|---|---|---|
stat |
The status of the request, success. | Varchar |
company_id |
The ID of the account, for example, 541238. | Integer |
The JSON structure in a successful response is as follows:
"is_successful": true,
"stat": "principal_business_address_added",
"messages": {
"success": "Action performed successfully."
},
"company_id": 256279
}
Errors
If the add principal business address request is not successful, the service responds with an error code, rejects the request, and does not add any company payment data. Some examples of error responses are provided.
The JSON structure associated with the error responses has the following parameters:
| FIELD | DESCRIPTION | TYPE |
|---|---|---|
ID |
Field that failed | Varchar |
description |
Description of error | Varchar |
Error Code 521 - Bad Request
"is_successful": false,
"messages": [],
"global_errors": [],
"input_errors": [
{
"ID": "principal_business_street",
"description": "Please enter your street information!"
},
{
"ID": "principal_business_address_city",
"description": "Please enter a city name"
},
{
"ID": "principal_business_address_post_code",
"description": "Please enter your Post/Zip Code"
}
]
}
POST Add Residential Address
Endpoint: /v2/add_residential_address
Request Body Payload Example
The request body includes the following parameters:
| Parameter | Description | Type | Size | Required |
|---|---|---|---|---|
registered_business_address_country |
An ISO standard country code from the list of valid country codes, for example, IE (Ireland). See Country Reference by System ID for more information. | Varchar | 2 | Yes |
registered_business_address_state |
The appropriate state in US, Canadian, Australia and New Zealand jurisdictions. For all other jurisdictions, leave blank. See Country Code for more information | Varchar | 6 | Yes |
registered_business_address_apartment_unit_no |
Apartment number of the business | Varchar | 225 | Yes |
registered_business_street |
Street address of the business | Varchar | 225 | Yes |
registered_business_address_suburb |
Suburb of thebusiness | Varchar | 225 | No |
registered_business_address_city |
City of the business | Varchar | 100 | Yes |
registered_business_address_post_code |
Post or ZIP code of the business | Varchar | 20 | Yes |
An example of the JSON structure in the request is as follows:
"registered_business_address_country": "US",
"registered_business_address_state": "US-CA",
"registered_business_address_apartment_unit_no": "225",
"registered_business_street": "Apple Lane",
"registered_business_address_suburb": "Financial District",
"registered_business_address_city": "San Francisco",
"registered_business_address_post_code": "94104"
}
Example Success Response
If the add registered business address request is successful, the service returns a response.
The response body includes the following parameters:
| FIELD | DESCRIPTION | TYPE |
|---|---|---|
stat |
The status of the request, success. | Varchar |
company_id |
The ID of the account, for example, 541238. | Integer |
The JSON structure in a successful response is as follows:
"is_successful": true,
"stat": "residential_address_added",
"messages": {
"success": "Action performed successfully."
},
"company_id": 659
}
Errors
If the add_residential_address request is not successful, the service responds with an error code, rejects the request, and does not add any company payment data. Some examples of error responses are provided.
The JSON structure associated with the error responses has the following parameters:
| FIELD | DESCRIPTION | TYPE |
|---|---|---|
ID |
Field that failed | Varchar |
description |
Description of error | Varchar |
Error Code 521 - Bad Request
"is_successful": false,
"messages": [],
"global_errors": [],
"input_errors": [
{
"ID": "registered_business_address_post_code",
"description": "Please enter your Post/Zip Code"
}
]
}
POST Directors Add
Endpoint: /directors_addNote: This endpoint is not applicable to Individuals
Request Body Payload Example
The request body includes the following parameters:
| Parameter | Description | Type | Size | Required |
|---|---|---|---|---|
nominees |
Nominees of the relevant individual.Values: Yes-1, No-0 Not applicable for Sole traders. |
Integer | 1 | Yes - optional for account_role= sole_trader |
specify_nominees |
Specify relevant individual nominees—Latin alphanumeric A-Z a-z hyphen ( - ) period ( . ) space. Not applicable for Sole traders. |
Varchar | 500 | Yes - optional for account_role= sole_trader |
relevant_individual_role |
Role of the relevant individual. Values: 'directors' 'controlling', 'beneficial_owners', 'authorized_users', 'sole_traders', 'partners', 'protector_trustors', 'trustees', 'trust_bene. For a Sole trader, possible values are 'sole_traders' or 'authorized_users'. For a Partnership, possible values are 'controlling_persons', 'partners', or 'authorized_users' | Varchar | 17 | Yes |
relevant_individual_nationality_iso |
ISO country code of the relevant individual. | Varchar | 2 | Yes |
relevant_individual_past_nationality_iso |
ISO country code of the relevant individual past nationalities. This allows for more that one to be inputted if relevant. Mandatory for Singapore | Varchar | 30 | Mandatory for Singapore |
relevant_individual_first_name |
First name of the individual, ^[a-zA-Z ]{2,30}$ - lowecase a-z and uppercase letters A-Z | Varchar | 30 | Yes |
relevant_individual_middle_name |
Middle name of the individual, , Latin alphanumeric A-Z a-z hyphen ( - ) period ( . ) space | Varchar | 80 | No |
relevant_individual_last_name |
Last name of the individual. , Latin alphanumeric A-Z a-z hyphen ( - ) period ( . ) space | Varchar | 80 | Yes |
relevant_individual_aliases |
Alias of the relevant individual. Latin alphanumeric A-Z a-z hyphen ( - ) period ( . ) space | Varchar | 80 | No |
relevant_individual_gender |
Gender of the relevant individual. Values: male, female, other Not applicable for Sole traders. |
Varchar | 6 | Mandatory for NZ only |
relevant_individual_id_issue_country_iso |
ISO country code of the relevant individual`s document Not applicable for Sole traders. |
Varchar | 2 | Yes |
relevant_individual_id_type |
Type of an individual`s documents. Values: Driver's license, 'Identification card', 'Passport' Not applicable for Sole traders. |
Varchar | 17 | Yes |
relevant_individual_id_number |
Identification number of the individual`s documents. Latin letters A-Za-z, 0-9 numbers, - _ : & ; , # / | Varchar | 80 | Yes |
relevant_individual_percentage_of_shares |
The percentage of shares in the company for this individual. Not applicable for Sole traders. |
Integer | 3 | Yes |
relevant_individual_date_of_birth |
Date of birth of the individual Format: DD-MM-YYYY | Varchar | 10 | Yes |
relevant_individual_residential_country_iso |
The ISO country code of the individual | Varchar | 2 | Yes |
relevant_individual_state_iso |
The ISO state code of the individual residential address | Varchar | 10 | Mandatory for countries: Australia, the USA, Canada, and New Zealand |
relevant_individual_apartment_unit |
Relevent Indivdual apartment unit, Latin letters A-Za-z, 0-9 numbers, - _ : & ; , # / and space | Varchar | 255 | Yes |
relevant_individual_street |
Relevent Indivdual street address, Latin letters A-Za-z, 0-9 numbers, - _ : & ; , # / and space | Varchar | 255 | Yes |
relevant_individual_suburb |
Relevent Indivdual suburb address, Latin letters A-Za-z, 0-9 numbers, - _ : & ; , # / and space | Varchar | 255 | No |
relevant_individual_city |
Relevant Individual residential city, Latin letters A-Za-z | Varchar | 100 | Yes |
relevant_individual_post_zip_code |
Relevent Indivdual zip code, Latin letters A-Za-z, 0-9 numbers, - _ : & ; , # / and space | Varchar | 255 | Yes |
An example of the JSON structure in the request is as follows:
"relevant_individuals": [
{
"relevant_individual_role": "directors,controlling,beneficial_owners",
"relevant_individual_nationality_iso": "BG",
"relevant_individual_past_nationality_iso": ["US","IE"],
"relevant_individual_first_name": "Name",
"relevant_individual_middle_name": "Middle",
"relevant_individual_last_name": "Last",
"relevant_individual_aliases": "Alias",
"relevant_individual_gender": "male",
"relevant_individual_id_issue_country_iso": "LA",
"relevant_individual_id_type": "Identity Card",
"relevant_individual_id_number": "123456789",
"relevant_individual_percentage_of_shares": 30,
"relevant_individual_date_of_birth": "22/06/1988",
"relevant_individual_residential_country_iso": "US",
"relevant_individual_state_iso": "US-AZ",
"relevant_individual_apartment_unit": "1234",
"relevant_individual_street": "Street",
"relevant_individual_suburb": "Suburb", "relevant_individual_city": "City",
"relevant_individual_post_zip_code": 12345
},
{
"relevant_individual_role": ["director", "controlling", "bene_owners"],
"relevant_individual_nationality_iso": "BG",
"relevant_individual_past_nationality_iso": ["US","IE"],
"relevant_individual_first_name": "Name",
"relevant_individual_middle_name": "Middle",
"relevant_individual_last_name": "Last",
"relevant_individual_aliases": "Alias",
"relevant_individual_gender": "male",
"relevant_individual_id_issue_country_iso": "IE",
"relevant_individual_id_type": "Identity Card",
"relevant_individual_id_number": "123456789",
"relevant_individual_percentage_of_shares": 30,
"relevant_individual_date_of_birth": "22/06/1993",
"relevant_individual_residential_country_iso": "IE",
"relevant_individual_apartment_unit": "1234",
"relevant_individual_street": "Street",
"relevant_individual_suburb": "Suburb",
"relevant_individual_city": "City",
"relevant_individual_post_zip_code": 12345
}
]
}
Example Success Response
If the directors_add request is successful, the service returns a response.
The response body includes the following parameters:
| FIELD | DESCRIPTION | TYPE |
|---|---|---|
stat |
The status of the request, success. | Varchar |
company_id |
The ID of the account, for example, 541238. | Integer |
The JSON structure in a successful response is as follows:
"is_successful": true,
"stat": "owners_directors_add_succesful",
"messages": {
"success": "Action performed successfully."
},
"company_id": 123461659
}
Errors
If the directors_add request is not successful, the service responds with an error code, rejects the request, and does not add any company payment data. Some examples of error responses are provided.
The JSON structure associated with the error responses has the following parameters:
| FIELD | DESCRIPTION | TYPE |
|---|---|---|
ID |
Field that failed | Varchar |
description |
Description of error | Varchar |
Error Code 521 - Bad Request
"is_successful": false,
"messages": [],
"global_errors": [],
"input_errors": [
{
"ID": "relevant_individual_date_of_birth_2",
"description": "Date format error: d/m/Y 22/06/1912312312393! Trailing data"
},
{
"ID": "relevant_individual_first_name_2",
"description": "Please enter correct information!"
},
{
"ID": "relevant_individual_last_name_2",
"description": "Please enter correct information!"
}
]
}
POST Documents Upload
Endpoint: /docs_upload
Request Body Payload Example
Only one file can be loaded at a time. Please use the correct document code for each uploaded document.
Maximum file size is 10 MB, accepted formats: csv, xls, docx, pdf, jpg, jpeg, png.
Important: Files must not contain any embedded scripts (including JavaScript, macros, or other active content).
Any file that contains executable code or active elements will be automatically rejected.
The request body includes the following parameters:
| Parameter | Description | Type | Size | Required |
|---|---|---|---|---|
json_data |
Please see codes and messages: Document Type | text/integer | 2 | Yes |
file_upload |
Upload file based document | file | 1 | Yes |
An example of the JSON structure in the request is as follows:
| Key | Type | Value |
|---|---|---|
json_data |
text | {"upload_type": 91} |
file |
File | File to be uploaded |
Example Success Response
If the docs_upload request is successful, the service returns a response.
The response body includes the following parameters:
| FIELD | DESCRIPTION | TYPE |
|---|---|---|
is_successful |
Returns status of the upload. Values: true (successfully) , false (unsuccessfully) | Varchar |
company_id |
The ID of the account, for example, 651134576. | Integer |
The JSON structure in a successful response is as follows:
"is_successful": true,
"messages": {
"success": "Action performed successfully."
},
"company_id": 651134576
}
Errors
If the docs_upload request is not successful, the service responds with an error code, rejects the request, and does not add any company payment data. Some examples of error responses are provided.
The JSON structure associated with the error responses has the following parameters:
| FIELD | DESCRIPTION | TYPE |
|---|---|---|
ID |
Field that failed | Varchar |
description |
Description of error | Varchar |
Invalid upload type provided:
"is_successful": false,
"messages": [],
"global_errors": [],
"input_errors": [
{
"ID": "upload_type",
"description": "Please enter correct information!"
}
]
}
File errors:
"is_successful": false,
"messages": [],
"global_errors": [],
"input_errors": [
{
"ID": "file_upload",
"description": "Please enter correct information!"
}
]
}
POST PEP Connection
Endpoint: /pep_connection
Request Body Payload Example
The request body includes the following parameters:
| Parameter | Description | Type | Size | Required |
|---|---|---|---|---|
pep |
Displays if any of the previously Relevant Individuals is (or have been) a Domestic or Foreign Politically Exposed Person (PEP) Values: Yes-1, No-0 | Integer | 1 | Yes, on first submit |
pep_associate |
Displays if any of the previously named Relevant Individuals have (or have had) an immediate Family or Close Associate of a Domestic or Foreign Politically Exposed Person (PEP) Values: Yes-1, No-0 | Integer | 1 | Yes, on first submit |
pep_personal_country |
ISO country code of the Politically Exposed Person | Varchar | 2 | Yes, if pep = 1 |
pep_personal_name |
Name of the Relevant individual, who is Politically Exposed Person (PEP), Latin alphanumeric A-Z a-z hyphen ( - ) period ( . ) space | Varchar | 80 | Yes, if pep = 1 |
pep_personal_position |
Position of the Relevant individual, who is Politically Exposed Person (PEP), Latin alphanumeric A-Z a-z hyphen ( - ) period ( . ) space | Varchar | 80 | Yes, if pep = 1 |
pep_personal_period_of_time |
Period of time this position was held, Latin letters A-Z, a-z, numbers 0-9 , - , _ , % , . : ; , ' space, () | Varchar | 80 | Yes, if pep = 1 |
pep_associate_country |
ISO country code of the Associate Individual who Politically Exposed Person | Varchar | 2 | Yes, if pep_associate = 1 |
pep_associate_name |
Name of the Relevant individual, who is Politically Exposed Person (PEP), Latin alphanumeric A-Z a-z hyphen ( - ) period ( . ) space | Varchar | 80 | Yes, if pep_associate = 1 |
pep_associate_relationship |
Relationship of the Relevant individual with the Politically Exposed Person (PEP), Latin alphanumeric A-Z a-z hyphen ( - ) period ( . ) space | Varchar | 80 | Yes, if pep_associate = 1 |
pep_associate_position |
Position of the Associate individual, who is Politically Exposed Person (PEP), Latin alphanumeric A-Z a-z hyphen ( - ) period ( . ) space | Varchar | 80 | Yes, if pep_associate = 1 |
pep_associated_period_of_time |
Period of time this position was held, Latin letters A-Z, a-z, numbers 0-9 , - , _ , % , . : ; , ' space, () | Varchar | 80 | Yes, if pep_associate = 1 |
An example of the JSON structure in the request is as follows:
"pep": "1",
"pep_associate": "1",
"pep_personal_country": "BG",
"pep_personal_name": "Person Name",
"pep_personal_position": "Position",
"pep_personal_period_of_time": "Period",
"pep_associate_country": "US",
"pep_associate_name": "Associate Name",
"pep_associate_relationship": "Relationship",
"pep_associate_position": "Postion",
"pep_associate_period_of_time": "Period"
}
Example Success Response
If the pep_connection request is successful, the service returns a response.
The response body includes the following parameters:
| FIELD | DESCRIPTION | TYPE |
|---|---|---|
is_successful |
Returns status of the upload. Values: true (successfully) , false (unsuccessfully) | Varchar |
company_id |
The ID of the account, for example, 651134576. | Integer |
The JSON structure in a successful response is as follows:
"is_successful": true,
"messages": {
"success": "Action performed successfully."
},
"company_id": 651134576
}
Errors
If the pep_connection request is not successful, the service responds with an error code, rejects the request, and does not add any company payment data. Some examples of error responses are provided.
The JSON structure associated with the error responses has the following parameters:
| FIELD | DESCRIPTION | TYPE |
|---|---|---|
ID |
Field that failed | Varchar |
description |
Description of error | Varchar |
Invalid pep_connection provided:
Error Code 522 - Bad Request
"is_successful": false,
"messages": {
"pep_associate_connection_position_period": "Please enter correct information!"
},
"stat": "One or more JSON attributes missing or malformed: 'pep_associate_period_of_time'"
}
POST Submit Company
Endpoint: /submit_company
Request Body Payload Example
NOTE: Submit Company does not have any input parameters.
Please Note that submitting the company will lock all endpoints except for docs_upload.
An example of the JSON structure in the request is as follows:
}
Example Success Response
If the Submit Company request is successful, the service returns a response. The response contains the status of the company application.
The response body includes the following parameters:
| FIELD | DESCRIPTION | TYPE |
|---|---|---|
is_successful |
Returns status of the upload. Values: true (successfully) , false (unsuccessfully) | Varchar |
message |
Status of the request. Example Action performed successfully, Verification pending. If submission is unsuccessful then the reasons will be displayed in messages | Varchar |
The JSON structure in a successful response is as follows:
{
"is_successful": true,
"stat": "company_submission_success",
"messages": {
"success": "Action performed successfully."
}
}
Errors
If the submit_company request is not successful, the service responds with an error code, rejects the request, and does not add any company payment data. Some examples of error responses are provided.
The JSON structure associated with the error responses has the following parameters:
| FIELD | DESCRIPTION | TYPE |
|---|---|---|
is_successful |
False | Varchar |
invalid_steps |
Description of error | Varchar |
Error 521 - Bad Request
"is_successful": false,
"messages": [],
"global_errors": [],
"input_errors": [
{
"ID": "add_company_details",
"description": "Please complete the verification step!"
},
{
"ID": "add_registered_business_address",
"description": "Please complete the verification step!"
},
{
"ID": "add_principal_business_address",
"description": "Please complete the verification step!"
},
{
"ID": "add_company_payment_data",
"description": "Please complete the verification step!"
},
{
"ID": "directors_add",
"description": "Please complete the verification step!"
},
{
"ID": "pep_connection",
"description": "Please complete the verification step!"
}
]
}
POST Status Company AML
Endpoint: /status_company_aml
Request Body Payload Example
NOTE: Submit Company does not have any input parameters.
An example of the JSON structure in the request is as follows:
}
Example Success Response
If the Submit Company request is successful, the service returns a response. The response contains the status of the company application.
The response body includes the following parameters:
| FIELD | DESCRIPTION | TYPE |
|---|---|---|
is_successful |
Returns status of the upload. Values: true (successfully) , false (unsuccessfully) | Varchar |
message |
Status of the request. Example Action performed successfully, Verification pending. | Varchar |
The JSON structure in a successful response is as follows:
"is_successful": true,
"stat": "company_submission_pending",
"messages": {
"success": "Action performed successfully."
},
"onboarding_status": "Pending"
}
"is_successful": true,
"stat": "company_submission_successful",
"messages": {
"success": "Action performed successfully."
},
"onboarding_status": "Successful"
}