Example Requests
To onboard your entity, you can call the Onboard Corporate Customer API. For an example call that you can customize with your information, see:
Private companies
The following is an API request example call where businessType = PRIVATE_COMPANY.
{
"region": "AU",
"businessDetails": {
"businessName": "Stocast Pvt. Ltd.",
"businessType": "PRIVATE_COMPANY",
"businessRegistrationNumber": "113400250",
"website": "www.stocast.com",
"legalDetails": {
"registeredCountry": "AU",
"registeredDate": "2021-08-10"
},
"addresses": {
"registeredAddress": {
"addressLine1": "302, 78, Woodlands Avenue",
"addressLine2": "AVE",
"city": "Parramatta",
"state": "NSW",
"country": "AU",
"postcode": "2150"
}
},
"documentDetails": [
{
"documentType": "BUSINESS_REGISTRATION_DOC",
"document": [
{
"fileName": "BRD.png",
"fileType": "png",
"document": "iVBORw0KGgoAAAANSUhEUgAAAOEAAADhCAMAAAAJbSJIAAAAJFBMVEX/////QAAAAADnOQCnIAD19vZSXV7dNgCkpqf1PQDNzs7P0NCe8r63AAAAoUlEQVR4nO3Wiw3DIAwFQGI+Ccn++1ZNM0IpEr2b4D1ZGKcEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAMC31FpnRxjqbBHRztkxxjmi5J5LHLODjHLGvr3tcc2OMkgr20dps6OMUSM/DXOsuW5q9KdhX7bh6jNc/x3+wS5d/z9M6bpvmmUneFv9LgUAAAAAAAAAAAAAAAAAAAAAAAAAAAAA+K0XNkoBrhhCyKYAAAAASUVORK5CYII="
}
]
}
],
"stakeholders": [
{
"stakeholderDetails": {
"kycMode": "MANUAL_KYC",
"firstName": "Arijit",
"lastName": "Singh aab",
"dateOfBirth": "1947-02-15",
"nationality": "AU",
"address": {
"addressLine1": "192, 101, High Street",
"addressLine2": "ST",
"city": "Sydney",
"state": "QLD",
"country": "AU",
"postcode": "2002"
},
"professionalDetails": [
{
"position": "DIRECTOR"
},
{
"position": "UBO"
}
],
"documentDetails": [
{
"documentType": "NATIONAL_ID",
"documentNumber": "123456009",
"document": [
{
"fileName": "nationalidfront",
"fileType": "png",
"document": "iVBORw0KGgoAAAANSUhEUgAAAOEAAADhCAMAAAAJbSJIAAAAJFBMVEX/////QAAAAADnOQCnIAD19vZSXV7dNgCkpqf1PQDNzs7P0NCe8r63AAAAoUlEQVR4nO3Wiw3DIAwFQGI+Ccn++1ZNM0IpEr2b4D1ZGKcEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAMC31FpnRxjqbBHRztkxxjmi5J5LHLODjHLGvr3tcc2OMkgr20dps6OMUSM/DXOsuW5q9KdhX7bh6jNc/x3+wS5d/z9M6bpvmmUneFv9LgUAAAAAAAAAAAAAAAAAAAAAAAAAAAAA+K0XNkoBrhhCyKYAAAAASUVORK5CYII="
}
]
}
]
}
},
{
"businessPartner": {
"businessType": "REGULATED_TRUST",
"businessEntityType": "EXECUTOR",
"businessName": "Ace Group aab",
"businessRegistrationNumber": "987600001",
"legalDetails": {
"registeredCountry": "AU",
"registrationType": "ABN",
"registeredDate": "2019-08-10"
},
"regulatoryDetails": {
"regulatedTrustType": [
"TT009"
]
}
}
}
],
"applicantDetails": {
"kycMode": "E_KYC",
"firstName": "Sachin",
"lastName": "Ten aab",
"dateOfBirth": "1992-08-09",
"nationality": "AU",
"professionalDetails": [
{
"position": "SETTLOR"
}
],
"contactDetails": {
"countryCode": "AU",
"contactNo": "733722664",
"email": "jomooo014_9@rairfl.com"
},
"address": {
"addressLine1": "192, 101, High Street",
"addressLine2": "ST",
"city": "Sydney",
"state": "QLD",
"postcode": "3207",
"country": "AU"
},
"documentDetails": [
{
"documentType": "PASSPORT",
"documentNumber": "A1111111",
"documentIssuanceCountry": "AU"
}
]
},
"additionalInfo": {
"isSameBusinessAddress": "Yes"
}
},
"riskAssessmentInfo": {
"countryOfOperation": [
"HK",
"IN",
"US"
],
"totalEmployees": "EM009",
"annualTurnover": "AU011",
"industrySector": "IS144",
"intendedUseOfAccount": "IU003",
"transactionCountries":[
"IN",
"US",
"CA"
]
}
}
Unregulated trusts
The following is an API request example call where businessType = UNREGULATED_TRUST.
{
"region": "AU",
"businessDetails": {
"businessName": "COPEN CHARITABLE TRUST23",
"businessType": "UNREGULATED_TRUST",
"businessRegistrationNumber": "11100000342",
"website": "www.copen.com",
"trusteeName": "KATIE PATTERSON",
"settlorName": "MICHAEL PATTERSON",
"legalDetails": {
"registeredCountry": "AU",
"registeredDate": "2021-08-10"
},
"addresses": {
"registeredAddress": {
"addressLine1": "302, 78, Woodlands Avenue",
"addressLine2": "AVE",
"city": "Parramatta",
"state": "NSW",
"country": "AU",
"postcode": "2150"
}
},
"regulatoryDetails": {
"unregulatedTrustType": [
"TT002",
"TT005"
]
},
"documentDetails": [
{
"documentType": "TRUST_DEED",
"document": [
{
"fileName": "TrustDeed.png",
"fileType": "png",
"document": "iVBORw0KGgoAAAANSUhEUgAAAOEAAADhCAMAAAAJbSJIAAAAJFBMVEX/////QAAAAADnOQCnIAD19vZSXV7dNgCkpqf1PQDNzs7P0NCe8r63AAAAoUlEQVR4nO3Wiw3DIAwFQGI+Ccn++1ZNM0IpEr2b4D1ZGKcEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAMC31FpnRxjqbBHRztkxxjmi5J5LHLODjHLGvr3tcc2OMkgr20dps6OMUSM/DXOsuW5q9KdhX7bh6jNc/x3+wS5d/z9M6bpvmmUneFv9LgUAAAAAAAAAAAAAAAAAAAAAAAAAAAAA+K0XNkoBrhhCyKYAAAAASUVORK5CYII="
}
]
}
],
"stakeholders": [
{
"stakeholderDetails": {
"kycMode": "MANUAL_KYC",
"firstName": "MAXWELL",
"lastName": "PLANCK",
"dateOfBirth": "1947-02-15",
"nationality": "AU",
"address": {
"addressLine1": "192, 101, High Street",
"addressLine2": "ST",
"city": "Sydney",
"state": "QLD",
"country": "AU",
"postcode": "2002"
},
"professionalDetails": [
{
"position": "DIRECTOR"
},
{
"position": "UBO"
}
],
"documentDetails": [
{
"documentType": "NATIONAL_ID",
"documentNumber": "321456009",
"document": [
{
"fileName": "nationalid",
"fileType": "png",
"document": "iVBORw0KGgoAAAANSUhEUgAAAOEAAADhCAMAAAAJbSJIAAAAJFBMVEX/////QAAAAADnOQCnIAD19vZSXV7dNgCkpqf1PQDNzs7P0NCe8r63AAAAoUlEQVR4nO3Wiw3DIAwFQGI+Ccn++1ZNM0IpEr2b4D1ZGKcEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAMC31FpnRxjqbBHRztkxxjmi5J5LHLODjHLGvr3tcc2OMkgr20dps6OMUSM/DXOsuW5q9KdhX7bh6jNc/x3+wS5d/z9M6bpvmmUneFv9LgUAAAAAAAAAAAAAAAAAAAAAAAAAAAAA+K0XNkoBrhhCyKYAAAAASUVORK5CYII="
}
]
}
]
}
},
{
"businessPartner": {
"businessType": "REGULATED_TRUST",
"businessEntityType": "DIRECTOR",
"businessName": "Plushie Corp",
"businessRegistrationNumber": "987600001",
"legalDetails": {
"registeredCountry": "AU",
"registrationType": "ABN",
"registeredDate": "2019-08-10"
},
"regulatoryDetails": {
"regulatedTrustType": [
"TT009"
]
}
}
}
],
"applicantDetails": {
"kycMode": "E_KYC",
"firstName": "KATHERINE",
"lastName": "JOHANSON",
"dateOfBirth": "1992-08-09",
"nationality": "AU",
"professionalDetails": [
{
"position": "REPRESENTATIVE"
}
],
"contactDetails": {
"countryCode": "AU",
"contactNo": "733722664",
"email": "katherine@copen.com"
},
"address": {
"addressLine1": "192, 101, High Street",
"addressLine2": "ST",
"city": "Sydney",
"state": "QLD",
"postcode": "3207",
"country": "AU"
},
"documentDetails": [
{
"documentType": "PASSPORT",
"documentNumber": "329847234",
"documentIssuanceCountry": "AU"
}
]
},
"additionalInfo": {
"isSameBusinessAddress": "Yes"
}
},
"riskAssessmentInfo": {
"countryOfOperation": [
"HK",
"IN",
"US"
],
"totalEmployees": "EM009",
"annualTurnover": "AU011",
"industrySector": "IS144",
"intendedUseOfAccount": "IU003",
"transactionCountries":[
"IN",
"US",
"CA"
]
},
"tags": [
{
"key": "tag1",
"value": "tag1value"
},
{
"key": "tag2",
"value": "tag2value"
}
]
}
Public companies
The following is an API request example call where businessType = PUBLIC_COMPANY.
{
"region": "AU",
"businessDetails": {
"businessName": "Hell's Kitchen Chain4 of Restaurants",
"businessType": "PUBLIC_COMPANY",
"businessRegistrationNumber": "120000350",
"website": "www.hellskitchen.com",
"legalDetails": {
"registeredCountry": "AU",
"registeredDate": "2021-08-10",
"listedExchange": "EX098"
},
"addresses": {
"registeredAddress": {
"addressLine1": "302, 78, Woodlands Avenue",
"addressLine2": "AVE",
"city": "Parramatta",
"state": "NSW",
"country": "AU",
"postcode": "2150"
}
},
"documentDetails": [
{
"documentType": "BUSINESS_REGISTRATION_DOC",
"document": [
{
"fileName": "BRD.png",
"fileType": "png",
"document": "iVBORw0KGgoAAAANSUhEUgAAAOEAAADhCAMAAAAJbSJIAAAAJFBMVEX/////QAAAAADnOQCnIAD19vZSXV7dNgCkpqf1PQDNzs7P0NCe8r63AAAAoUlEQVR4nO3Wiw3DIAwFQGI+Ccn++1ZNM0IpEr2b4D1ZGKcEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAMC31FpnRxjqbBHRztkxxjmi5J5LHLODjHLGvr3tcc2OMkgr20dps6OMUSM/DXOsuW5q9KdhX7bh6jNc/x3+wS5d/z9M6bpvmmUneFv9LgUAAAAAAAAAAAAAAAAAAAAAAAAAAAAA+K0XNkoBrhhCyKYAAAAASUVORK5CYII="
}
]
}
],
"stakeholders": [
{
"stakeholderDetails": {
"kycMode": "MANUAL_KYC",
"firstName": "MAX",
"lastName": "COOK",
"dateOfBirth": "1947-02-15",
"nationality": "AU",
"address": {
"addressLine1": "192, 101, High Street",
"addressLine2": "ST",
"city": "Sydney",
"state": "QLD",
"country": "AU",
"postcode": "2002"
},
"professionalDetails": [
{
"position": "DIRECTOR"
}
],
"documentDetails": [
{
"documentType": "NATIONAL_ID",
"documentNumber": "123456009",
"document": [
{
"fileName": "medicare_card",
"fileType": "png",
"document": "iVBORw0KGgoAAAANSUhEUgAAAOEAAADhCAMAAAAJbSJIAAAAJFBMVEX/////QAAAAADnOQCnIAD19vZSXV7dNgCkpqf1PQDNzs7P0NCe8r63AAAAoUlEQVR4nO3Wiw3DIAwFQGI+Ccn++1ZNM0IpEr2b4D1ZGKcEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAMC31FpnRxjqbBHRztkxxjmi5J5LHLODjHLGvr3tcc2OMkgr20dps6OMUSM/DXOsuW5q9KdhX7bh6jNc/x3+wS5d/z9M6bpvmmUneFv9LgUAAAAAAAAAAAAAAAAAAAAAAAAAAAAA+K0XNkoBrhhCyKYAAAAASUVORK5CYII="
}
]
}
]
}
},
{
"businessPartner": {
"businessType": "REGULATED_TRUST",
"businessEntityType": "DIRECTOR",
"businessName": "Ace Group",
"businessRegistrationNumber": "987600001",
"legalDetails": {
"registeredCountry": "AU",
"registrationType": "ABN",
"registeredDate": "2019-08-10"
},
"regulatoryDetails": {
"regulatedTrustType": [
"TT009"
]
}
}
}
],
"applicantDetails": {
"kycMode": "E_KYC",
"firstName": "JONATHAN",
"lastName": "PLANCK",
"dateOfBirth": "1992-08-09",
"nationality": "AU",
"professionalDetails": [
{
"position": "REPRESENTATIVE"
}
],
"contactDetails": {
"countryCode": "AU",
"contactNo": "733722664",
"email": "jonathan@hellskitchen.com"
},
"address": {
"addressLine1": "192, 101, High Street",
"addressLine2": "ST",
"city": "Sydney",
"state": "QLD",
"postcode": "3207",
"country": "AU"
},
"documentDetails": [
{
"documentType": "PASSPORT",
"documentNumber": "329847234",
"documentIssuanceCountry": "AU"
}
]
},
"additionalInfo": {
"isSameBusinessAddress": "Yes"
}
},
"riskAssessmentInfo": {
"countryOfOperation": [
"HK",
"IN",
"US"
],
"totalEmployees": "EM009",
"annualTurnover": "AU011",
"industrySector": "IS144",
"intendedUseOfAccount": "IU003",
"transactionCountries":[
"IN",
"US",
"CA"
]
}
}
Simulate scenarios in the eKYB flow
If you are using eKYB flow for the AU region, you can generate the following scenarios by using the below steps with the example businessRegistrationNumber (BRN) in the following table.
| Simulated scenario | Condition | Example BRN |
|---|---|---|
| Auto-approval | BRN Contains 101 and applicantDetails.contactDetails.contactNo starts with 91 | 101324536, 234101456, 12101B325 contactNo: 91092345, 913332134 |
| Action required | Contains 103 | 102324536, 234102456, 12102B325 |
| Completing applicant E_DOC_VERIFY | Pattern on applicantDetails.contactDetails.contactNo |
Step 1: Call the Public Corporate Details Using Business ID API using the Business Registration Number and Region according to the scenario you want to test. You receive multiple businesses in the response. Pick the one with with matching businessRegistrationNumber.
In this response, the businessName is always returned as EBL Disability Services Inc. for any of the businessRegistrationNumber mentioned in the table. This behavior is only in the sandbox; the accurate name appears in production.
Step 2: Use the example requests in the table and call the Onboard Corporate Customer API.
Request example: auto approval
For the description of this scenario, see Auto Approval Scenario
{
"region": "AU",
"businessDetails": {
"businessName": "Stocast Pvt. Ltd.",
"businessType": "PRIVATE_COMPANY",
"businessRegistrationNumber": "101340025",
"website": "www.stocast.com",
"legalDetails": {
"registeredCountry": "AU",
"registeredDate": "2021-08-10"
},
"addresses": {
"registeredAddress": {
"addressLine1": "302, 78, Woodlands Avenue",
"addressLine2": "AVE",
"city": "Parramatta",
"state": "NSW",
"country": "AU",
"postcode": "2150"
}
},
"documentDetails": [
{
"documentType": "BUSINESS_REGISTRATION_DOC",
"document": [
{
"fileName": "BRD.png",
"fileType": "png",
"document": "iVBORw0KGgoAAAANSUhEUgAAAOEAAADhCAMAAAAJbSJIAAAAJFBMVEX/////QAAAAADnOQCnIAD19vZSXV7dNgCkpqf1PQDNzs7P0NCe8r63AAAAoUlEQVR4nO3Wiw3DIAwFQGI+Ccn++1ZNM0IpEr2b4D1ZGKcEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAMC31FpnRxjqbBHRztkxxjmi5J5LHLODjHLGvr3tcc2OMkgr20dps6OMUSM/DXOsuW5q9KdhX7bh6jNc/x3+wS5d/z9M6bpvmmUneFv9LgUAAAAAAAAAAAAAAAAAAAAAAAAAAAAA+K0XNkoBrhhCyKYAAAAASUVORK5CYII="
}
]
}
],
"stakeholders": [
{
"stakeholderDetails": {
"kycMode": "E_KYC",
"firstName": "Arijit",
"lastName": "Singh aab",
"dateOfBirth": "1947-02-15",
"nationality": "AU",
"address": {
"addressLine1": "192, 101, High Street",
"addressLine2": "ST",
"city": "Sydney",
"state": "QLD",
"country": "AU",
"postcode": "2002"
},
"professionalDetails": [
{
"position": "DIRECTOR"
},
{
"position": "UBO"
}
]
}
},
{
"businessPartner": {
"businessType": "REGULATED_TRUST",
"businessEntityType": "EXECUTOR",
"businessName": "Ace Group aab",
"businessRegistrationNumber": "987600001",
"legalDetails": {
"registeredCountry": "AU",
"registrationType": "ABN",
"registeredDate": "2019-08-10"
},
"regulatoryDetails": {
"regulatedTrustType": [
"TT009"
]
}
}
}
],
"applicantDetails": {
"kycMode": "E_KYC",
"firstName": "Sachin",
"lastName": "Ten aab",
"dateOfBirth": "1992-08-09",
"nationality": "AU",
"professionalDetails": [
{
"position": "SETTLOR"
}
],
"contactDetails": {
"countryCode": "AU",
"contactNo": "913722664",
"email": "jomooo014_9@rairfl.com"
},
"address": {
"addressLine1": "192, 101, High Street",
"addressLine2": "ST",
"city": "Sydney",
"state": "QLD",
"postcode": "3207",
"country": "AU"
}
},
"additionalInfo": {
"isSameBusinessAddress": "Yes"
}
},
"riskAssessmentInfo": {
"countryOfOperation": [
"HK",
"IN",
"US"
],
"totalEmployees": "EM009",
"annualTurnover": "AU011",
"industrySector": "IS144",
"intendedUseOfAccount": "IU003",
"transactionCountries":[
"IN",
"US",
"CA"
]
}
}
Request example: action required
For the description of this scenario, see Action required scenario
{
"region": "AU",
"businessDetails": {
"businessName": "Stocast Pvt. Ltd.",
"businessType": "PRIVATE_COMPANY",
"businessRegistrationNumber": "110321340",
"website": "www.stocast.com",
"legalDetails": {
"registeredCountry": "AU",
"registeredDate": "2021-08-10"
},
"addresses": {
"registeredAddress": {
"addressLine1": "302, 78, Woodlands Avenue",
"addressLine2": "AVE",
"city": "Parramatta",
"state": "NSW",
"country": "AU",
"postcode": "2150"
}
},
"documentDetails": [
{
"documentType": "BUSINESS_REGISTRATION_DOC",
"document": [
{
"fileName": "BRD.png",
"fileType": "png",
"document": "iVBORw0KGgoAAAANSUhEUgAAAOEAAADhCAMAAAAJbSJIAAAAJFBMVEX/////QAAAAADnOQCnIAD19vZSXV7dNgCkpqf1PQDNzs7P0NCe8r63AAAAoUlEQVR4nO3Wiw3DIAwFQGI+Ccn++1ZNM0IpEr2b4D1ZGKcEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAMC31FpnRxjqbBHRztkxxjmi5J5LHLODjHLGvr3tcc2OMkgr20dps6OMUSM/DXOsuW5q9KdhX7bh6jNc/x3+wS5d/z9M6bpvmmUneFv9LgUAAAAAAAAAAAAAAAAAAAAAAAAAAAAA+K0XNkoBrhhCyKYAAAAASUVORK5CYII="
}
]
}
],
"stakeholders": [
{
"stakeholderDetails": {
"kycMode": "E_KYC",
"firstName": "Arijit",
"lastName": "Singh aab",
"dateOfBirth": "1947-02-15",
"nationality": "AU",
"address": {
"addressLine1": "192, 101, High Street",
"addressLine2": "ST",
"city": "Sydney",
"state": "QLD",
"country": "AU",
"postcode": "2002"
},
"professionalDetails": [
{
"position": "DIRECTOR"
},
{
"position": "UBO"
}
]
}
},
{
"businessPartner": {
"businessType": "REGULATED_TRUST",
"businessEntityType": "EXECUTOR",
"businessName": "Ace Group aab",
"businessRegistrationNumber": "987600001",
"legalDetails": {
"registeredCountry": "AU",
"registrationType": "ABN",
"registeredDate": "2019-08-10"
},
"regulatoryDetails": {
"regulatedTrustType": [
"TT009"
]
}
}
}
],
"applicantDetails": {
"kycMode": "E_KYC",
"firstName": "Sachin",
"lastName": "Ten aab",
"dateOfBirth": "1992-08-09",
"nationality": "AU",
"professionalDetails": [
{
"position": "SETTLOR"
}
],
"contactDetails": {
"countryCode": "AU",
"contactNo": "913722664",
"email": "jomooo014_9@rairfl.com"
},
"address": {
"addressLine1": "192, 101, High Street",
"addressLine2": "ST",
"city": "Sydney",
"state": "QLD",
"postcode": "3207",
"country": "AU"
}
},
"additionalInfo": {
"isSameBusinessAddress": "Yes"
}
},
"riskAssessmentInfo": {
"countryOfOperation": [
"HK",
"IN",
"US"
],
"totalEmployees": "EM009",
"annualTurnover": "AU011",
"industrySector": "IS144",
"intendedUseOfAccount": "IU003",
"transactionCountries":[
"IN",
"US",
"CA"
]
}
Completing applicant E_DOC_VERIFY
For non-Australian residents, the applicant eDocVerify is done via the third-party vendor Onfido. Applicant KYC via Onfido takes place for the Singapore region when the KYC mode is E_DOC_VERIFY.
To simulate different success and error responses of the eDocVerify flow, use the following conditions on the applicant's phone number. In all cases, the applicant needs to open the redirect URL in their browser. You either land on the vendor’s page or receive a success/failure redirection back to your KYC redirect URL without any actions needed on the UI. The redirectURL has isSuccess, errorCode, and errorMessage parameters as described in Applicant KYC.
Based on businessDetails.applicantDetails.contactDetail.contactNumber, there are two outcomes:
First two digits of contactNumber | Resulting situation |
|---|---|
| Doesn't contain any of the simulated patterns | Onfido's sandbox page is opened and the applicant needs to complete the simulated authentication on the UI. This can be used for end-to-end testing. |
| Does contain any of the simulated patterns | The customer's browser redirects to your KYC redirect URL without the need of any actions on the UI. Redirection will contain the following Redirection parameters |
Redirection parameters
| Return code | Query parameters in the redirection |
|---|---|
| 91 | isSuccess=true; errorCode=;erroressage= |
| 41 | isSuccess = false ; errorCode = R403; errorMessage = documentAlreadySubmitted |
| 51 | isSuccess = false ; errorCode = I500; errorMessage = unexpectedError |
| 61 | isSuccess = false ; errorCode = R408; errorMessage = redirectUrlExpired |
Note: You can simulate verificationAlreadyCompleted message by clicking on the redirectURL after completing verification.