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:
Sole traders
{
"region": "HK",
"businessDetails": {
"businessName": "Acme HK",
"businessRegistrationNumber": "92238740598",
"businessType": "SOLE_TRADER",
"tradeName": "Acme",
"website": "www.acmehk.com",
"legalDetails": {
"registeredCountry": "HK",
"registeredDate": "2021-08-10"
},
"addresses": {
"registeredAddress": {
"addressLine1": "Rm 1301 13/F",
"addressLine2": "Cre Building 303",
"city": "Wan Chai District",
"state": "Hong Kong",
"country": "HK",
"postcode": "2055"
}
},
"bankAccountDetails": {
"accountName": "Hong Kong Company",
"bankName": "DBS",
"accountNumber": "123456",
"currency": "HKD",
"routingType": "SWIFT",
"routingValue": "DHBKHKHH"
},
"documentDetails": [
{
"documentType": "LOA",
"documentNumber": "N118668(E)",
"document": [
{
"fileName": "LOA",
"fileType": "png",
"document": "iVBORw0KGgoAAAANSUhEUgAAAOEAAADhCAMAAAAJbSJIAAAAJFBMVEX/////QAAAAADnOQCnIAD19vZSXV7dNgCkpqf1PQDNzs7P0NCe8r63AAAAoUlEQVR4nO3Wiw3DIAwFQGI+Ccn++1ZNM0IpEr2b4D1ZGKcEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAMC31FpnRxjqbBHRztkxxjmi5J5LHLODjHLGvr3tcc2OMkgr20dps6OMUSM/DXOsuW5q9KdhX7bh6jNc/x3+wS5d/z9M6bpvmmUneFv9LgUAAAAAAAAAAAAAAAAAAAAAAAAAAAAA+K0XNkoBrhhCyKYAAAAASUVORK5CYII="
}
]
},
{
"documentType": "BUSINESS_REGISTRATION_DOC",
"documentNumber": "2348729383",
"document": [
{
"fileName": "BRD001.pdf",
"fileType": "png",
"document": "iVBORw0KGgoAAAANSUhEUgAAAOEAAADhCAMAAAAJbSJIAAAAJFBMVEX/////QAAAAADnOQCnIAD19vZSXV7dNgCkpqf1PQDNzs7P0NCe8r63AAAAoUlEQVR4nO3Wiw3DIAwFQGI+Ccn++1ZNM0IpEr2b4D1ZGKcEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAMC31FpnRxjqbBHRztkxxjmi5J5LHLODjHLGvr3tcc2OMkgr20dps6OMUSM/DXOsuW5q9KdhX7bh6jNc/x3+wS5d/z9M6bpvmmUneFv9LgUAAAAAAAAAAAAAAAAAAAAAAAAAAAAA+K0XNkoBrhhCyKYAAAAASUVORK5CYII="
}
]
}
],
"stakeholders": [
{
"stakeholderDetails": {
"kycMode": "MANUAL_KYC",
"firstName": "John",
"middleName": "J",
"lastName": "Smith",
"dateOfBirth": "1947-02-15",
"nationality": "HK",
"address": {
"addressLine1": "221 Sai Yeung",
"addressLine2": "Choi St N",
"city": "Sham Shui Po District",
"state": "Hong Kong",
"country": "HK",
"postcode": "2002"
},
"professionalDetails": [
{
"position": "DIRECTOR"
}
],
"documentDetails": [
{
"documentType": "NATIONAL_ID",
"documentNumber": "C668668E",
"documentIssuanceCountry": "HK",
"document": [
{
"fileName": "HKId",
"fileType": "png",
"document": "iVBORw0KGgoAAAANSUhEUgAAAOEAAADhCAMAAAAJbSJIAAAAJFBMVEX///// <base 64 encoding>"
}
]
}
]
}
}
],
"applicantDetails": {
"kycMode": "E_DOC_VERIFY",
"firstName": "Jake",
"middleName": "J",
"lastName": "Roberts",
"dateOfBirth": "1967-02-15",
"nationality": "HK",
"professionalDetails": [
{
"position": "SIGNATORY"
}
],
"address": {
"addressLine1": "Causeway Rd",
"addressLine2": "Causeway Bay",
"city": "Wan Chai District",
"state": "Hong Kong",
"country": "HK",
"postcode": "2002"
},
"documentDetails": [
{
"documentType": "NATIONAL_ID",
"documentNumber": "HK686634A",
"documentIssuanceCountry": "HK",
"document": [
{
"fileName": "HKId",
"fileType": "png",
"document": "iVBORw0KGgoAAAANSUhEUgAAAOEAAADhCAMAAAAJbSJIAAAAJFBMVEX///// <base 64 encoding>"
}
]
}
],
"contactDetails": {
"countryCode": "HK",
"contactNo": "303351617013",
"email": "jack@acmehk.com"
}
},
"additionalInfo": {
"isSameBusinessAddress": "Yes"
}
},
"riskAssessmentInfo": {
"countryOfOperation": [
"HK",
"IN"
],
"totalEmployees": "EM009",
"annualTurnover": "HK011",
"industrySector": "IS144",
"intendedUseOfAccount": "IU003",
"transactionCountries":[
"HK",
"US",
"CA"
]
},
"tags": [
{
"key": "Tag 1",
"value": "Tag 1 HK"
},
{
"key": "Tag 2",
"value": "Tag 2 HK"
}
]
}
Private companies
{
"region": "HK",
"businessDetails": {
"businessName": "Acme Incorporation",
"businessRegistrationNumber": "123358360598",
"businessType": "PRIVATE_COMPANY",
"tradeName": "Acme Inc.",
"website": "www.acme.com",
"legalDetails": {
"registeredCountry": "HK",
"registeredDate": "2021-08-10"
},
"addresses": {
"registeredAddress": {
"addressLine1": "Rm 1301 13/F",
"addressLine2": "Cre Building 303",
"city": "Wan Chai District",
"state": "Hong Kong",
"country": "HK",
"postcode": "2055"
}
},
"bankAccountDetails": {
"accountName": "Hong Kong Company",
"bankName": "DBS",
"accountNumber": "123456",
"currency": "HKD",
"routingType": "SWIFT",
"routingValue": "DHBKHKHH"
},
"stakeholders": [
{
"stakeholderDetails": {
"kycMode": "MANUAL_KYC",
"firstName": "Mark",
"middleName": "J",
"lastName": "Cary",
"dateOfBirth": "1947-02-15",
"nationality": "HK",
"address": {
"addressLine1": "221 Sai Yeung",
"addressLine2": "Choi St N",
"city": "Sham Shui Po District",
"state": "Hong Kong",
"country": "HK",
"postcode": "2002"
},
"professionalDetails": [
{
"position": "DIRECTOR"
}
],
"documentDetails": [
{
"documentType": "NATIONAL_ID",
"documentNumber": "C668668E",
"documentIssuanceCountry": "HK",
"document": [
{
"fileName": "HKId",
"fileType": "png",
"document": "iVBORw0KGgoAAAANSUhEUgAAAOEAAADhCAMAAAAJbSJIAAAAJFBMVEX/////QAAAAADnOQCnIAD19vZSXV7dNgCkpqf1PQDNzs7P0NCe8r63AAAAoUlEQVR4nO3Wiw3DIAwFQGI+Ccn++1ZNM0IpEr2b4D1ZGKcEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAMC31FpnRxjqbBHRztkxxjmi5J5LHLODjHLGvr3tcc2OMkgr20dps6OMUSM/DXOsuW5q9KdhX7bh6jNc/x3+wS5d/z9M6bpvmmUneFv9LgUAAAAAAAAAAAAAAAAAAAAAAAAAAAAA+K0XNkoBrhhCyKYAAAAASUVORK5CYII="
}
]
}
]
}
},
{
"businessPartner": {
"businessEntityType": "UBO",
"businessName": "TeleHK LTD",
"sharePercentage": "60.00",
"businessRegistrationNumber": "987600001",
"legalDetails": {
"registeredCountry": "HK"
}
}
}
],
"applicantDetails": {
"kycMode": "E_DOC_VERIFY",
"firstName": "John",
"middleName": "F",
"lastName": "Roberts",
"dateOfBirth": "1967-02-15",
"nationality": "HK",
"professionalDetails": [
{
"position": "SIGNATORY"
}
],
"address": {
"addressLine1": "Causeway Rd",
"addressLine2": "Causeway Bay",
"city": "Wan Chai District",
"state": "Hong Kong",
"country": "HK",
"postcode": "2002"
},
"contactDetails": {
"countryCode": "HK",
"contactNo": "303351617013",
"email": "john@acme.com"
},
"documentDetails": [
{
"documentType": "NATIONAL_ID",
"documentNumber": "H23424214",
"documentIssuanceCountry": "HK"
}
]
},
"additionalInfo": {
"isSameBusinessAddress": "Yes"
}
},
"riskAssessmentInfo": {
"countryOfOperation": [
"HK",
"IN"
],
"transactionCountries": [
"HK",
"US",
"CA"
],
"totalEmployees": "EM009",
"annualTurnover": "HK011",
"industrySector": "IS144",
"intendedUseOfAccount": "IU003"
},
"tags": [
{
"key": "Tag 1",
"value": "Tag 1 HK"
},
{
"key": "Tag 2",
"value": "Tag 2 HK"
}
]
}
Limited partnerships
{
"region": "HK",
"businessDetails": {
"businessName": "Acme Partnership",
"businessRegistrationNumber": "19238740598",
"businessType": "LIMITED_PARTNERSHIP",
"tradeName": "Acme Partners",
"website": "www.acmepartners.com",
"legalDetails": {
"registeredCountry": "HK",
"registeredDate": "2021-08-10"
},
"addresses": {
"registeredAddress": {
"addressLine1": "Rm 1301 13/F",
"addressLine2": "Cre Building 303",
"city": "Wan Chai District",
"state": "Hong Kong",
"country": "HK",
"postcode": "2055"
}
},
"bankAccountDetails": {
"accountName": "Hong Kong Company",
"bankName": "DBS",
"accountNumber": "123456",
"currency": "HKD",
"routingType": "SWIFT",
"routingValue": "DHBKHKHH"
},
"documentDetails": [
{
"documentType": "NAR1",
"documentNumber": "N118668(E)",
"document": [
{
"fileName": "NAR1",
"fileType": "png",
"document": "iVBORw0KGgoAAAANSUhEUgAAAOEAAADhCAMAAAAJbSJIAAAAJFBMVEX/////QAAAAADnOQCnIAD19vZSXV7dNgCkpqf1PQDNzs7P0NCe8r63AAAAoUlEQVR4nO3Wiw3DIAwFQGI+Ccn++1ZNM0IpEr2b4D1ZGKcEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAMC31FpnRxjqbBHRztkxxjmi5J5LHLODjHLGvr3tcc2OMkgr20dps6OMUSM/DXOsuW5q9KdhX7bh6jNc/x3+wS5d/z9M6bpvmmUneFv9LgUAAAAAAAAAAAAAAAAAAAAAAAAAAAAA+K0XNkoBrhhCyKYAAAAASUVORK5CYII="
}
]
},
{
"documentType": "LOA",
"documentNumber": "N118668(E)",
"document": [
{
"fileName": "LOA",
"fileType": "png",
"document": "iVBORw0KGgoAAAANSUhEUgAAAOEAAADhCAMAAAAJbSJIAAAAJFBMVEX/////QAAAAADnOQCnIAD19vZSXV7dNgCkpqf1PQDNzs7P0NCe8r63AAAAoUlEQVR4nO3Wiw3DIAwFQGI+Ccn++1ZNM0IpEr2b4D1ZGKcEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAMC31FpnRxjqbBHRztkxxjmi5J5LHLODjHLGvr3tcc2OMkgr20dps6OMUSM/DXOsuW5q9KdhX7bh6jNc/x3+wS5d/z9M6bpvmmUneFv9LgUAAAAAAAAAAAAAAAAAAAAAAAAAAAAA+K0XNkoBrhhCyKYAAAAASUVORK5CYII="
}
]
},
{
"documentType": "PARTNERSHIP_DEED",
"documentNumber": "2348729383",
"document": [
{
"fileName": "PD001",
"fileType": "png",
"document": "iVBORw0KGgoAAAANSUhEUgAAAOEAAADhCAMAAAAJbSJIAAAAJFBMVEX/////QAAAAADnOQCnIAD19vZSXV7dNgCkpqf1PQDNzs7P0NCe8r63AAAAoUlEQVR4nO3Wiw3DIAwFQGI+Ccn++1ZNM0IpEr2b4D1ZGKcEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAMC31FpnRxjqbBHRztkxxjmi5J5LHLODjHLGvr3tcc2OMkgr20dps6OMUSM/DXOsuW5q9KdhX7bh6jNc/x3+wS5d/z9M6bpvmmUneFv9LgUAAAAAAAAAAAAAAAAAAAAAAAAAAAAA+K0XNkoBrhhCyKYAAAAASUVORK5CYII="
}
]
}
],
"stakeholders": [
{
"stakeholderDetails": {
"kycMode": "MANUAL_KYC",
"firstName": "Mary",
"middleName": "J",
"lastName": "Campbell",
"dateOfBirth": "1947-02-15",
"nationality": "HK",
"address": {
"addressLine1": "221 Sai Yeung",
"addressLine2": "Choi St N",
"city": "Sham Shui Po District",
"state": "Hong Kong",
"country": "HK",
"postcode": "2002"
},
"professionalDetails": [
{
"position": "DIRECTOR"
}
],
"documentDetails": [
{
"documentType": "NATIONAL_ID",
"documentNumber": "C668668E",
"documentIssuanceCountry": "HK",
"document": [
{
"fileName": "HKId",
"fileType": "png",
"document": "iVBORw0KGgoAAAANSUhEUgAAAOEAAADhCAMAAAAJbSJIAAAAJFBMVEX/////QAAAAADnOQCnIAD19vZSXV7dNgCkpqf1PQDNzs7P0NCe8r63AAAAoUlEQVR4nO3Wiw3DIAwFQGI+Ccn++1ZNM0IpEr2b4D1ZGKcEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAMC31FpnRxjqbBHRztkxxjmi5J5LHLODjHLGvr3tcc2OMkgr20dps6OMUSM/DXOsuW5q9KdhX7bh6jNc/x3+wS5d/z9M6bpvmmUneFv9LgUAAAAAAAAAAAAAAAAAAAAAAAAAAAAA+K0XNkoBrhhCyKYAAAAASUVORK5CYII="
}
]
}
]
}
},
{
"businessPartner": {
"businessEntityType": "UBO",
"businessName": "Kitchens of Hongkong",
"sharePercentage": "60",
"businessRegistrationNumber": "987600001",
"legalDetails": {
"registeredCountry": "HK"
}
}
}
],
"applicantDetails": {
"kycMode": "E_DOC_VERIFY",
"firstName": "Jack",
"middleName": "J",
"lastName": "Smith",
"dateOfBirth": "1967-02-15",
"nationality": "HK",
"professionalDetails": [
{
"position": "SIGNATORY"
}
],
"address": {
"addressLine1": "Causeway Rd",
"addressLine2": "Causeway Bay",
"city": "Wan Chai District",
"state": "Hong Kong",
"country": "HK",
"postcode": "2002"
},
"contactDetails": {
"countryCode": "HK",
"contactNo": "303351617013",
"email": "jack@acme.com"
},
"documentDetails": [
{
"documentType": "NATIONAL_ID",
"documentNumber": "H23424214",
"documentIssuanceCountry": "HK"
}
]
},
"additionalInfo": {
"isSameBusinessAddress": "Yes"
}
},
"riskAssessmentInfo": {
"countryOfOperation": [
"HK",
"IN"
],
"transactionCountries": [
"HK",
"US",
"CA"
],
"totalEmployees": "EM009",
"annualTurnover": "HK011",
"industrySector": "IS144",
"intendedUseOfAccount": "IU003"
},
"tags": [
{
"key": "Tag 1",
"value": "Tag 1 HK"
},
{
"key": "Tag 2",
"value": "Tag 2 HK"
}
]
}
Simulate scenarios in the manual KYB flow
You can generate different scenarios for manual KYB only in the sandbox environment.
You might want to test transactions without going through the onboarding flow. To enable this, Nium provides simulated requests which get auto-approved in the manual KYB flow.
You can generate auto-approval scenarios for manual KYB only in the sandbox environment. In production, every application is reviewed by Nium's compliance analysts before approval.
| Simulated scenario | Condition on BRN | Example BRN |
|---|---|---|
| Auto-approval | BRN contains M01 and stakeholderDetails.firstName starts with AA for all individual stakeholders | BRN: M01324536, 234M01456, 12M01B325 Stakeholder firstName: AAshutosh, AAnthony |
| Action required | does not contain M01 | |
| In progress with documents required | ||
| In progress with redirectURL | Pattern on applicantDetails.contactDetails.contactNo |
Call the Onboard Corporate Customer API with the following example request.
Request example: auto-approval
{
"region": "HK",
"businessDetails": {
"businessName": "Acme",
"businessRegistrationNumber": "m01ty6eer8",
"businessType": "PRIVATE_COMPANY",
"tradeName": "Acme Inc.",
"website": "www.acme.com",
"legalDetails": {
"registeredCountry": "HK",
"registeredDate": "2021-08-10"
},
"addresses": {
"registeredAddress": {
"addressLine1": "Rm 1301 13/F",
"addressLine2": "Cre Building 303",
"city": "Wan Chai District",
"state": "Hong Kong",
"country": "HK",
"postcode": "2055"
}
},
"bankAccountDetails": {
"accountName": "Hong Kong Company",
"bankName": "DBS",
"accountNumber": "123456",
"currency": "HKD",
"routingType": "SWIFT",
"routingValue": "DHBKHKHH"
},
"stakeholders": [
{
"stakeholderDetails": {
"kycMode": "MANUAL_KYC",
"firstName": "Mark",
"middleName": "J",
"lastName": "Cary",
"dateOfBirth": "1947-02-15",
"nationality": "HK",
"address": {
"addressLine1": "221 Sai Yeung",
"addressLine2": "Choi St N",
"city": "Sham Shui Po District",
"state": "Hong Kong",
"country": "HK",
"postcode": "2002"
},
"professionalDetails": [
{
"position": "DIRECTOR"
}
],
"documentDetails": [
{
"documentType": "NATIONAL_ID",
"documentNumber": "C668668E",
"documentIssuanceCountry": "HK",
"document": [
{
"fileName": "HKId",
"fileType": "png",
"document": "iVBORw0KGgoAAAANSUhEUgAAAOEAAADhCAMAAAAJbSJIAAAAJFBMVEX/////QAAAAADnOQCnIAD19vZSXV7dNgCkpqf1PQDNzs7P0NCe8r63AAAAoUlEQVR4nO3Wiw3DIAwFQGI+Ccn++1ZNM0IpEr2b4D1ZGKcEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAMC31FpnRxjqbBHRztkxxjmi5J5LHLODjHLGvr3tcc2OMkgr20dps6OMUSM/DXOsuW5q9KdhX7bh6jNc/x3+wS5d/z9M6bpvmmUneFv9LgUAAAAAAAAAAAAAAAAAAAAAAAAAAAAA+K0XNkoBrhhCyKYAAAAASUVORK5CYII="
}
]
}
]
}
},
{
"businessPartner": {
"businessEntityType": "UBO",
"businessName": "TeleHK LTD",
"sharePercentage": "60.00",
"businessRegistrationNumber": "987600001",
"legalDetails": {
"registeredCountry": "HK"
}
}
}
],
"applicantDetails": {
"kycMode": "E_DOC_VERIFY",
"firstName": "Mark",
"middleName": "L",
"lastName": "Johnson",
"dateOfBirth": "1995-10-14",
"nationality": "IN",
"professionalDetails": [
{
"position": "SIGNATORY"
}
],
"address": {
"addressLine1": "Buldhana Road",
"addressLine2": "Taluka Malkapur",
"city": "Malkapur",
"state": "Maharashtra",
"country": "IN",
"postcode": "443101"
},
"contactDetails": {
"countryCode": "HK",
"contactNo": "913351617013",
"email": "john@hachiko.com"
},
"documentDetails": [
{
"documentType": "NATIONAL_ID",
"documentNumber": "682634114855",
"documentIssuanceCountry": "IN"
}
]
},
"additionalInfo": {
"isSameBusinessAddress": "Yes"
}
},
"riskAssessmentInfo": {
"countryOfOperation": [
"HK",
"IN"
],
"transactionCountries": [
"HK",
"US",
"CA"
],
"totalEmployees": "EM009",
"annualTurnover": "HK011",
"industrySector": "IS144",
"intendedUseOfAccount": "IU003"
},
"tags": [
{
"key": "Tag 1",
"value": "Tag 1 HK"
},
{
"key": "Tag 2",
"value": "Tag 2 HK"
}
]
}
Request example: action required
{
"region": "HK",
"businessDetails": {
"businessName": "Acme",
"businessRegistrationNumber": "P1201ty6eer8",
"businessType": "PRIVATE_COMPANY",
"tradeName": "Acme Inc.",
"website": "www.acme.com",
"legalDetails": {
"registeredCountry": "HK",
"registeredDate": "2021-08-10"
},
"addresses": {
"registeredAddress": {
"addressLine1": "Rm 1301 13/F",
"addressLine2": "Cre Building 303",
"city": "Wan Chai District",
"state": "Hong Kong",
"country": "HK",
"postcode": "2055"
}
},
"bankAccountDetails": {
"accountName": "Hong Kong Company",
"bankName": "DBS",
"accountNumber": "123456",
"currency": "HKD",
"routingType": "SWIFT",
"routingValue": "DHBKHKHH"
},
"stakeholders": [
{
"stakeholderDetails": {
"kycMode": "MANUAL_KYC",
"firstName": "Mark",
"middleName": "J",
"lastName": "Cary",
"dateOfBirth": "1947-02-15",
"nationality": "HK",
"address": {
"addressLine1": "221 Sai Yeung",
"addressLine2": "Choi St N",
"city": "Sham Shui Po District",
"state": "Hong Kong",
"country": "HK",
"postcode": "2002"
},
"professionalDetails": [
{
"position": "DIRECTOR"
}
],
"documentDetails": [
{
"documentType": "NATIONAL_ID",
"documentNumber": "C668668E",
"documentIssuanceCountry": "HK",
"document": [
{
"fileName": "HKId",
"fileType": "png",
"document": "iVBORw0KGgoAAAANSUhEUgAAAOEAAADhCAMAAAAJbSJIAAAAJFBMVEX/////QAAAAADnOQCnIAD19vZSXV7dNgCkpqf1PQDNzs7P0NCe8r63AAAAoUlEQVR4nO3Wiw3DIAwFQGI+Ccn++1ZNM0IpEr2b4D1ZGKcEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAMC31FpnRxjqbBHRztkxxjmi5J5LHLODjHLGvr3tcc2OMkgr20dps6OMUSM/DXOsuW5q9KdhX7bh6jNc/x3+wS5d/z9M6bpvmmUneFv9LgUAAAAAAAAAAAAAAAAAAAAAAAAAAAAA+K0XNkoBrhhCyKYAAAAASUVORK5CYII="
}
]
}
]
}
},
{
"businessPartner": {
"businessEntityType": "UBO",
"businessName": "TeleHK LTD",
"sharePercentage": "60.00",
"businessRegistrationNumber": "987600001",
"legalDetails": {
"registeredCountry": "HK"
}
}
}
],
"applicantDetails": {
"kycMode": "E_DOC_VERIFY",
"firstName": "Mark",
"middleName": "L",
"lastName": "Johnson",
"dateOfBirth": "1995-10-14",
"nationality": "IN",
"professionalDetails": [
{
"position": "SIGNATORY"
}
],
"address": {
"addressLine1": "Buldhana Road",
"addressLine2": "Taluka Malkapur",
"city": "Malkapur",
"state": "Maharashtra",
"country": "IN",
"postcode": "443101"
},
"contactDetails": {
"countryCode": "HK",
"contactNo": "913351617013",
"email": "john@hachiko.com"
},
"documentDetails": [
{
"documentType": "NATIONAL_ID",
"documentNumber": "682634114855",
"documentIssuanceCountry": "IN"
}
]
},
"additionalInfo": {
"isSameBusinessAddress": "Yes"
}
},
"riskAssessmentInfo": {
"countryOfOperation": [
"HK",
"IN"
],
"transactionCountries": [
"HK",
"US",
"CA"
],
"totalEmployees": "EM009",
"annualTurnover": "HK011",
"industrySector": "IS144",
"intendedUseOfAccount": "IU003"
},
"tags": [
{
"key": "Tag 1",
"value": "Tag 1 HK"
},
{
"key": "Tag 2",
"value": "Tag 2 HK"
}
]
}
Completing applicant eDocVerify
The applicant eDocVerify is done via the third-party vendor Jumio. Applicant KYC via Jumio takes place for the EU 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 | Jumio'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=;errorMessage= |
| 41 | isSuccess = false ; errorCode = R403; errorMessage = documentAlreadySubmitted |
| 51 | isSuccess = false ; errorCode = I500; errorMessage = unexpectedError |
| 61 | isSuccess = false ; errorCode = R408; errorMessage = redirectUrlExpired |
Request example: in progress with redirect URL
{
"region": "HK",
"businessDetails": {
"businessName": "Acme",
"businessRegistrationNumber": "P1201ty6eer8",
"businessType": "PRIVATE_COMPANY",
"tradeName": "Acme Inc.",
"website": "www.acme.com",
"legalDetails": {
"registeredCountry": "HK",
"registeredDate": "2021-08-10"
},
"addresses": {
"registeredAddress": {
"addressLine1": "Rm 1301 13/F",
"addressLine2": "Cre Building 303",
"city": "Wan Chai District",
"state": "Hong Kong",
"country": "HK",
"postcode": "2055"
}
},
"bankAccountDetails": {
"accountName": "Hong Kong Company",
"bankName": "DBS",
"accountNumber": "123456",
"currency": "HKD",
"routingType": "SWIFT",
"routingValue": "DHBKHKHH"
},
"stakeholders": [
{
"stakeholderDetails": {
"kycMode": "MANUAL_KYC",
"firstName": "Mark",
"middleName": "J",
"lastName": "Cary",
"dateOfBirth": "1947-02-15",
"nationality": "HK",
"address": {
"addressLine1": "221 Sai Yeung",
"addressLine2": "Choi St N",
"city": "Sham Shui Po District",
"state": "Hong Kong",
"country": "HK",
"postcode": "2002"
},
"professionalDetails": [
{
"position": "DIRECTOR"
}
],
"documentDetails": [
{
"documentType": "NATIONAL_ID",
"documentNumber": "C668668E",
"documentIssuanceCountry": "HK",
"document": [
{
"fileName": "HKId",
"fileType": "png",
"document": "iVBORw0KGgoAAAANSUhEUgAAAOEAAADhCAMAAAAJbSJIAAAAJFBMVEX/////QAAAAADnOQCnIAD19vZSXV7dNgCkpqf1PQDNzs7P0NCe8r63AAAAoUlEQVR4nO3Wiw3DIAwFQGI+Ccn++1ZNM0IpEr2b4D1ZGKcEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAMC31FpnRxjqbBHRztkxxjmi5J5LHLODjHLGvr3tcc2OMkgr20dps6OMUSM/DXOsuW5q9KdhX7bh6jNc/x3+wS5d/z9M6bpvmmUneFv9LgUAAAAAAAAAAAAAAAAAAAAAAAAAAAAA+K0XNkoBrhhCyKYAAAAASUVORK5CYII="
}
]
}
]
}
},
{
"businessPartner": {
"businessEntityType": "UBO",
"businessName": "TeleHK LTD",
"sharePercentage": "60.00",
"businessRegistrationNumber": "987600001",
"legalDetails": {
"registeredCountry": "HK"
}
}
}
],
"applicantDetails": {
"kycMode": "E_DOC_VERIFY",
"firstName": "John",
"middleName": "L",
"lastName": "Frank",
"dateOfBirth": "1995-10-14",
"nationality": "IN",
"professionalDetails": [
{
"position": "SIGNATORY"
}
],
"address": {
"addressLine1": "Buldhana Road",
"addressLine2": "Taluka Malkapur",
"city": "Malkapur",
"state": "Maharashtra",
"country": "IN",
"postcode": "443101"
},
"contactDetails": {
"countryCode": "HK",
"contactNo": "913351617013",
"email": "john@hachiko.com"
}
},
"additionalInfo": {
"isSameBusinessAddress": "Yes"
}
},
"riskAssessmentInfo": {
"countryOfOperation": [
"HK",
"IN"
],
"transactionCountries": [
"HK",
"US",
"CA"
],
"totalEmployees": "EM009",
"annualTurnover": "HK011",
"industrySector": "IS144",
"intendedUseOfAccount": "IU003"
},
"tags": [
{
"key": "Tag 1",
"value": "Tag 1 HK"
},
{
"key": "Tag 2",
"value": "Tag 2 HK"
}
]
}
Request example: in progress with document required
{
"region": "HK",
"businessDetails": {
"businessName": "Acme",
"businessRegistrationNumber": "m01ty6eer8",
"businessType": "PRIVATE_COMPANY",
"tradeName": "Acme Inc.",
"website": "www.acme.com",
"legalDetails": {
"registeredCountry": "HK",
"registeredDate": "2021-08-10"
},
"addresses": {
"registeredAddress": {
"addressLine1": "Rm 1301 13/F",
"addressLine2": "Cre Building 303",
"city": "Wan Chai District",
"state": "Hong Kong",
"country": "HK",
"postcode": "2055"
}
},
"bankAccountDetails": {
"accountName": "Hong Kong Company",
"bankName": "DBS",
"accountNumber": "123456",
"currency": "HKD",
"routingType": "SWIFT",
"routingValue": "DHBKHKHH"
},
"stakeholders": [
{
"stakeholderDetails": {
"kycMode": "MANUAL_KYC",
"firstName": "Mark",
"middleName": "J",
"lastName": "Cary",
"dateOfBirth": "1947-02-15",
"nationality": "HK",
"address": {
"addressLine1": "221 Sai Yeung",
"addressLine2": "Choi St N",
"city": "Sham Shui Po District",
"state": "Hong Kong",
"country": "HK",
"postcode": "2002"
},
"professionalDetails": [
{
"position": "DIRECTOR"
}
],
"documentDetails": [
{
"documentType": "NATIONAL_ID",
"documentNumber": "C668668E",
"documentIssuanceCountry": "HK",
"document": [
{
"fileName": "HKId",
"fileType": "png",
"document": "iVBORw0KGgoAAAANSUhEUgAAAOEAAADhCAMAAAAJbSJIAAAAJFBMVEX/////QAAAAADnOQCnIAD19vZSXV7dNgCkpqf1PQDNzs7P0NCe8r63AAAAoUlEQVR4nO3Wiw3DIAwFQGI+Ccn++1ZNM0IpEr2b4D1ZGKcEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAMC31FpnRxjqbBHRztkxxjmi5J5LHLODjHLGvr3tcc2OMkgr20dps6OMUSM/DXOsuW5q9KdhX7bh6jNc/x3+wS5d/z9M6bpvmmUneFv9LgUAAAAAAAAAAAAAAAAAAAAAAAAAAAAA+K0XNkoBrhhCyKYAAAAASUVORK5CYII="
}
]
}
]
}
},
{
"businessPartner": {
"businessEntityType": "UBO",
"businessName": "TeleHK LTD",
"sharePercentage": "60.00",
"businessRegistrationNumber": "987600001",
"legalDetails": {
"registeredCountry": "HK"
}
}
}
],
"applicantDetails": {
"kycMode": "MANUAL_KYC",
"firstName": "Mark",
"middleName": "L",
"lastName": "Roberts",
"dateOfBirth": "1995-10-14",
"nationality": "IN",
"professionalDetails": [
{
"position": "SIGNATORY"
}
],
"address": {
"addressLine1": "Buldhana Road",
"addressLine2": "Taluka Malkapur",
"city": "Malkapur",
"state": "Maharashtra",
"country": "IN",
"postcode": "443101"
},
"contactDetails": {
"countryCode": "HK",
"contactNo": "913351617013",
"email": "john@hachiko.com"
},
"documentDetails": [
{
"documentType": "NATIONAL_ID",
"documentNumber": "682634114855",
"documentIssuanceCountry": "IN"
}
]
},
"additionalInfo": {
"isSameBusinessAddress": "Yes"
}
},
"riskAssessmentInfo": {
"countryOfOperation": [
"HK",
"IN"
],
"transactionCountries": [
"HK",
"US",
"CA"
],
"totalEmployees": "EM009",
"annualTurnover": "HK011",
"industrySector": "IS144",
"intendedUseOfAccount": "IU003"
},
"tags": [
{
"key": "Tag 1",
"value": "Tag 1 HK"
},
{
"key": "Tag 2",
"value": "Tag 2 HK"
}
]
}