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
- Public companies
- Partnerships
- Brazil Customer
- Simulate scenarios in the eKYB flow
- Simulate scenarios in the manual KYB flow
Private companies
The following is an API request example call where businessType = PRIVATE_COMPANY.
{
"region": "SG",
"businessDetails": {
"referenceId": "6913aac9-cbd9-4783-8fd6-07ea9655dfec",
"businessName": "Singapor2e23 Electronics",
"businessRegistrationNumber": "9223287324",
"website":"www.singaporeelectronics.com",
"businessType": "PRIVATE_COMPANY",
"legalDetails": {
"registeredCountry": "SG",
"registeredDate": "2000-01-02"
},
"addresses": {
"registeredAddress": {
"addressLine1": "High Street 101, 56th Avenue",
"addressLine2": "Hyung County",
"city": "Singapore",
"country": "SG",
"postcode": "28046"
}
},
"documentDetails": [
{
"documentType": "BUSINESS_REGISTRATION_DOC",
"document": [
{
"document": "iVBORw0KGgoAAAANSUhEUgAAAAgAAAAIAQMAAAD+wSzIAAAABlBMVEX///+/v7+jQ3Y5AAAADklEQVQI12P4AIX8EAgALgAD/aNpbtEAAAAASUVORK5CYII",
"fileName": "BRD.pdf",
"fileType": "application/pdf"
}
]
}
],
"stakeholders": [
{
"referenceId": "d25c5c6f-d4b0-47a5-986e-7b50641b65fc",
"stakeholderDetails": {
"firstName": "Narendra",
"middleName": "C",
"lastName": "Bhargav",
"nationality": "IN",
"kycMode": "MANUAL_KYC",
"professionalDetails": [
{
"position": "DIRECTOR"
},
{
"position": "UBO",
"sharePercentage": "23"
}
],
"address": {
"addressLine1": "MG road,25",
"addressLine2": "Gandhinagar",
"city": "Mumbai",
"country": "IN",
"postcode": "300012"
},
"documentDetails": [
{
"documentType": "PASSPORT",
"documentExpiryDate": "2029-09-10",
"documentIssuanceCountry": "IN",
"documentNumber": "098734524",
"document": [
{
"document": "iVBORw0KGgoAAAANSUhEUgAAAAgAAAAIAQMAAAD+wSzIAAAABlBMVEX///+/v7+jQ3Y5AAAADklEQVQI12P4AIX8EAgALgAD/aNpbtEAAAAASUVORK5CYII",
"fileName": "Passport.pdf",
"fileType": "application/pdf"
}
]
}
]
}
},
{
"referenceId": "s36c5c6f-d4b0-47a5-986e-7b50641b66rf",
"stakeholderDetails": {
"firstName": "Narayana",
"middleName": "R",
"lastName": "Pandit",
"nationality": "IN",
"kycMode": "E_DOC_VERIFY",
"professionalDetails": [
{
"position": "DIRECTOR"
}
],
"address": {
"addressLine1": "7 Koil street",
"addressLine2": "64 No.01-01",
"city": "Chennai",
"country": "IN",
"postcode": "600032"
}
}
},
{
"referenceId": "f45c5c6f-d4b0-47a5-986e-7b50641b67tf",
"stakeholderDetails": {
"firstName": "Rama",
"middleName": "R",
"lastName": "Krishna",
"nationality": "IN",
"kycMode": "E_KYC",
"professionalDetails": [
{
"position": "DIRECTOR"
}
],
"address": {
"addressLine1": "7 Koil street",
"addressLine2": "64 No.01-01",
"city": "Chennai",
"country": "IN",
"postcode": "600032"
}
}
},
{
"referenceId": "006ebeeb-3ede-4f49-8381-1e382334131c",
"businessPartner": {
"legalDetails": {
"registeredCountry": "FR"
},
"businessEntityType": "SHAREHOLDER",
"businessName": "Farto AgriTECH LIMITED",
"businessRegistrationNumber": "822843822"
}
}
],
"applicantDetails": {
"referenceId": "0c61376b-70c3-4d45-9193-0a6ddece4e0e",
"firstName": "Hardik",
"middleName": "Kumar",
"lastName": "Roshan",
"dateOfBirth": "1982-07-17",
"nationality": "SG",
"kycMode": "E_KYC",
"contactDetails": {
"contactNo": "222268870",
"countryCode": "SG",
"email": "hardik@singel.com"
},
"professionalDetails": [
{
"position": "SIGNATORY"
}
],
"address": {
"addressLine1": "7 Ang Mo Kio Street",
"addressLine2": "64 No.01-01",
"city": "Singapore",
"country": "SG",
"postcode": "28046"
}
},
"additionalInfo": {
"isSameBusinessAddress": "Yes",
"searchId": "6nf3aac9-cbd9-423k-8fd6-07ea9345dfec"
}
},
"riskAssessmentInfo": {
"countryOfOperation": [
"HK",
"IN"
],
"transactionCountries": [
"GB",
"AU",
"FR"
],
"totalEmployees": "EM009",
"annualTurnover": "SG011",
"industrySector": "IS144",
"intendedUseOfAccount": "IU003"
},
"tags": [
{
"key": "tag1",
"value": "tag1value"
},
{
"key": "tag2",
"value": "tag2value"
}
]
}
Public companies
The following is an API request example call where businessType = PUBLIC_COMPANY.
{
"region": "SG",
"businessDetails": {
"referenceId": "6913aac9-cbd9-4783-8fd6-07ea9655dfec",
"businessName": "Singapore Special Appliances",
"businessRegistrationNumber": "903280424",
"website":"www.singaporeappliances.com",
"businessType": "PUBLIC_COMPANY",
"legalDetails": {
"registeredCountry": "SG",
"registeredDate": "2000-01-02",
"listedExchange": "EX080"
},
"addresses": {
"registeredAddress": {
"addressLine1": "High Street 101, 56th Avenue",
"addressLine2": "Hyung County",
"city": "Singapore",
"country": "SG",
"postcode": "28046"
}
},
"documentDetails": [
{
"documentType": "BUSINESS_REGISTRATION_DOC",
"document": [
{
"document": "iVBORw0KGgoAAAANSUhEUgAAAAgAAAAIAQMAAAD+wSzIAAAABlBMVEX///+/v7+jQ3Y5AAAADklEQVQI12P4AIX8EAgALgAD/aNpbtEAAAAASUVORK5CYII",
"fileName": "BRD.pdf",
"fileType": "application/pdf"
}
]
}
],
"stakeholders": [
{
"referenceId": "d25c5c6f-d4b0-47a5-986e-7b50641b65fc",
"stakeholderDetails": {
"firstName": "John",
"middleName": "C",
"lastName": "Grisham",
"nationality": "IN",
"kycMode": "MANUAL_KYC",
"professionalDetails": [
{
"position": "DIRECTOR"
},
{
"position": "UBO",
"sharePercentage": "60"
}
],
"address": {
"addressLine1": "7 Ang Mo Kio Street",
"addressLine2": "64 No.01-01",
"city": "Singapore",
"country": "SG",
"postcode": "28046"
},
"documentDetails": [
{
"documentType": "PASSPORT",
"documentExpiryDate": "2029-09-10",
"documentIssuanceCountry": "IN",
"documentNumber": "098734524",
"document": [
{
"document": "iVBORw0KGgoAAAANSUhEUgAAAAgAAAAIAQMAAAD+wSzIAAAABlBMVEX///+/v7+jQ3Y5AAAADklEQVQI12P4AIX8EAgALgAD/aNpbtEAAAAASUVORK5CYII",
"fileName": "Passport.pdf",
"fileType": "application/pdf"
}
]
}
]
}
},
{
"referenceId": "006ebeeb-3ede-4f49-8381-1e382334131c",
"businessPartner": {
"legalDetails": {
"registeredCountry": "FR"
},
"businessEntityType": "SHAREHOLDER",
"businessName": "Fiago AgriTECH LIMITED",
"businessRegistrationNumber": "822843822"
}
}
],
"applicantDetails": {
"referenceId": "0c61376b-70c3-4d45-9193-0a6ddece4e0e",
"firstName": "Mitchell",
"middleName": "",
"lastName": "Johnson",
"dateOfBirth": "1982-07-17",
"nationality": "SG",
"kycMode": "E_KYC",
"contactDetails": {
"contactNo": "222268870",
"countryCode": "SG",
"email": "hardik@singel.com"
},
"professionalDetails": [
{
"position": "SIGNATORY"
}
],
"address": {
"addressLine1": "7 Ang Mo Kio Street",
"addressLine2": "64 No.01-01",
"city": "Singapore",
"country": "SG",
"postcode": "28046"
}
},
"additionalInfo": {
"isSameBusinessAddress": "Yes",
"searchId": "6nf3aac9-cbd9-423k-8fd6-07ea9345dfec"
}
},
"riskAssessmentInfo": {
"countryOfOperation": [
"HK",
"IN"
],
"transactionCountries": [
"GB",
"AU",
"FR"
],
"totalEmployees": "EM009",
"annualTurnover": "SG011",
"industrySector": "IS144",
"intendedUseOfAccount": "IU003"
},
"tags": [
{
"key": "tag1",
"value": "tag1value"
},
{
"key": "tag2",
"value": "tag2value"
}
]
}
Partnerships
The following is an API request example call where businessType = PARTNERSHIP.
{
"region": "SG",
"businessDetails": {
"referenceId": "6913aac9-cbd9-4783-8fd6-07ea9655dfec",
"businessName": "S&K Partners",
"businessRegistrationNumber": "903272424",
"website":"www.snkpartners.com",
"businessType": "PARTNERSHIP",
"legalDetails": {
"registeredCountry": "SG",
"registeredDate": "2000-01-02"
},
"addresses": {
"registeredAddress": {
"addressLine1": "High Street 101, 56th Avenue",
"addressLine2": "Hyung County",
"city": "Singapore",
"country": "SG",
"postcode": "28046"
}
},
"documentDetails": [
{
"documentType": "PARTNERSHIP_DEED",
"document": [
{
"document": "iVBORw0KGgoAAAANSUhEUgAAAAgAAAAIAQMAAAD+wSzIAAAABlBMVEX///+/v7+jQ3Y5AAAADklEQVQI12P4AIX8EAgALgAD/aNpbtEAAAAASUVORK5CYII",
"fileName": "PARTNERSHIPDeed.pdf",
"fileType": "application/pdf"
}
]
}
],
"stakeholders": [
{
"referenceId": "d25c5c6f-d4b0-47a5-986e-7b50641b65fc",
"stakeholderDetails": {
"firstName": "Samuel",
"middleName": "C",
"lastName": "Dickenson",
"nationality": "US",
"kycMode": "MANUAL_KYC",
"professionalDetails": [
{
"position": "DIRECTOR"
},
{
"position": "UBO"
}
],
"address": {
"addressLine1": "7 Ang Mo Kio Street",
"addressLine2": "64 No.01-01",
"city": "Singapore",
"country": "SG",
"postcode": "28046"
},
"documentDetails": [
{
"documentType": "PASSPORT",
"documentExpiryDate": "2029-09-10",
"documentIssuanceCountry": "SG",
"documentNumber": "098734524",
"document": [
{
"document": "iVBORw0KGgoAAAANSUhEUgAAAAgAAAAIAQMAAAD+wSzIAAAABlBMVEX///+/v7+jQ3Y5AAAADklEQVQI12P4AIX8EAgALgAD/aNpbtEAAAAASUVORK5CYII",
"fileName": "Passport.pdf",
"fileType": "application/pdf"
}
]
}
]
}
},
{
"referenceId": "006ebeeb-3ede-4f49-8381-1e382334131c",
"businessPartner": {
"legalDetails": {
"registeredCountry": "FR"
},
"businessEntityType": "SHAREHOLDER",
"businessName": "Soso FINTECH LIMITED",
"businessRegistrationNumber": "FL22843822"
}
}
],
"applicantDetails": {
"referenceId": "0c61376b-70c3-4d45-9193-0a6ddece4e0e",
"firstName": "Katrina",
"middleName": "",
"lastName": "Kaif",
"dateOfBirth": "1982-07-17",
"nationality": "SG",
"kycMode": "E_KYC",
"contactDetails": {
"contactNo": "222268870",
"countryCode": "SG",
"email": "katkaif@snkpartners.com"
},
"professionalDetails": [
{
"position": "SIGNATORY"
}
],
"address": {
"addressLine1": "7 Ang Mo Kio Street",
"addressLine2": "64 No.01-01",
"city": "Singapore",
"country": "SG",
"postcode": "28046"
}
},
"additionalInfo": {
"isSameBusinessAddress": "Yes",
"searchId": "6nf3aac9-cbd9-423k-8fd6-07ea9345dfec"
}
},
"riskAssessmentInfo": {
"countryOfOperation": [
"HK",
"IN"
],
"transactionCountries": [
"GB",
"AU",
"FR"
],
"totalEmployees": "EM009",
"annualTurnover": "SG011",
"industrySector": "IS144",
"intendedUseOfAccount": "IU003"
},
"tags": [
{
"key": "tag1",
"value": "tag1value"
},
{
"key": "tag2",
"value": "tag2value"
}
]
}
The following is an API request to onboard a customer from Brazil. Please note the mandatory taxDetails object.
{
"region": "SG",
"businessDetails": {
"businessName": "Brazil Consumer E231l1ectronics",
"businessRegistrationNumber": "229223287324",
"businessType":"PRIVATE_COMPANY",
"legalDetails": {
"registeredCountry": "BR",
"registeredDate": "2000-01-02"
},
"taxDetails": [
{
"country": "BR",
"taxNumber": "40.828.622/0001-27"
}
],
"addresses": {
"registeredAddress": {
"addressLine1": "High Street 101, 56th Avenue",
"addressLine2": "Hyung County",
"city": "Singapore",
"country": "SG",
"postcode": "28046"
}
},
"stakeholders": [
{
"referenceId": "d25c5c6f-d4b0-47a5-986e-7b50641b65fc",
"stakeholderDetails": {
"firstName": "Narendra",
"middleName": "C",
"lastName": "Bhargav",
"nationality": "IN",
"kycMode": "MANUAL_KYC",
"professionalDetails": [
{
"position": "DIRECTOR"
},
{
"position": "UBO"
}
],
"address": {
"addressLine1": "7 Ang Mo Kio Street",
"addressLine2": "64 No.01-01",
"city": "Singapore",
"country": "SG",
"postcode": "28046"
},
"documentDetails": [
{
"documentType": "PASSPORT",
"documentExpiryDate": "2029-09-10",
"documentIssuanceCountry": "IN",
"documentNumber": "098734524",
"document": [
{
"document": "iVBORw0KGgoAAAANSUhEUgAAAAgAAAAIAQMAAAD+wSzIAAAABlBMVEX///+/v7+jQ3Y5AAAADklEQVQI12P4AIX8EAgALgAD/aNpbtEAAAAASUVORK5CYII",
"fileName": "Passport.pdf",
"fileType": "application/pdf"
}
]
}
]
}
},
{
"referenceId": "006ebeeb-3ede-4f49-8381-1e382334131c",
"businessPartner": {
"legalDetails": {
"registeredCountry": "FR"
},
"businessEntityType": "SHAREHOLDER",
"businessName": "Farto AgriTECH LIMITED",
"businessRegistrationNumber": "822843822"
}
}
],
"applicantDetails": {
"referenceId": "0c61376b-70c3-4d45-9193-0a6ddece4e0e",
"firstName": "Hardik",
"middleName": "Kumar",
"lastName": "Roshan",
"dateOfBirth": "1982-07-17",
"nationality": "BR",
"kycMode": "E_DOC_VERIFY",
"contactDetails": {
"contactNo": "222268870",
"countryCode": "BR",
"email": "hardik@singel.com"
},
"professionalDetails": [
{
"position": "SIGNATORY"
}
],
"address": {
"addressLine1": "Rua Santo Antônio 1235",
"addressLine2": "Resende",
"city": "Rio de Janeiro",
"country": "BR",
"postcode": "27536-010"
}
},
"additionalInfo": {
"isSameBusinessAddress": "Yes"
}
},
"riskAssessmentInfo": {
"countryOfOperation": [
"HK",
"IN"
],
"transactionCountries": [
"GB",
"AU",
"FR"
],
"totalEmployees": "EM009",
"annualTurnover": "SG011",
"industrySector": "IS144",
"intendedUseOfAccount": "IU003"
},
"tags": [
{
"key": "tag1",
"value": "tag1value"
},
{
"key": "tag2",
"value": "tag2value"
}
]
}
Simulate scenarios in the eKYB flow
If you are using eKYB flow for the Singapore region, you can generate the following scenarios by using the below steps with the example businessRegistrationNumber (BRN) in the following table.
| Simulated scenario | Condition on BRN | Example BRN |
|---|---|---|
| Auto-approval | Contains M01 | M01324536, 234M01456, 12M01B325 |
| Action required | Contains A02 | A02324536, 234A02456, 12A02B325 |
| In progress with documents required | Contains A03 | A03324536, 234A03456, 12A03B325 |
| Completing applicant eKYC | Pattern on applicantDetails.contactDetails.contactNo | |
| Completing applicant eDocVerify | 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 and copy the searchReferenceId.
In this response, the businessName is always returned as STAR FINANCE PRIVATE LIMITED appended by your businessRegistrationNumber and doesn't match with what is returned in Step 2. This behavior is only in the sandbox; the accurate name appears in production.
Step 2: Call the Exhaustive Corporate Details Using Business ID API using the searchReferenceId received in Step 1 for the particular scenario. This returns detailed information about the corporate customer including searchId.
Step 3: Use the example requests in the table and call the Onboard Corporate Customer API.
Step 4: Use the redirect URL and complete the Applicant KYC section on the MyInfo page (or use the simulated scenarios for KYC mentioned below) and wait for the webhook. Verification can be completed with dummy credentials if using Myinfo's sandbox. Regardless, you need to open the redirect URL in your browser.
Response conditions for the Exhaustive Corporate Details API
You can generate responses for different businessType by following the table below. This can be used for testing the pre-population flow after calling the Exhaustive Corporate Details Using Business ID API.
businessType | Condition on businessRegistrationNumber |
|---|---|
PUBLIC_COMPANY | Contains A01 or A02 or A03 |
PRIVATE_COMPANY | Contains A11 or A12 or A13 |
SOLE_TRADER | Contains A21 or A22 or A23 |
PARTNERSHIP | Contains A31 or A32 or A33 |
Request example: auto-approval
For the description of this scenario, see Auto-approval scenario
{
"region": "SG",
"businessDetails": {
"businessName": "ACME COMPANY PTE. LTD. PWUIMRBF",
"businessRegistrationNumber": "A11232393",
"businessType": "PUBLIC_COMPANY",
"legalDetails": {
"registeredCountry": "SG",
"registeredDate": "2021-07-13",
"listedExchange": "EX056"
},
"addresses": {
"registeredAddress": {
"addressLine1": "22 CIRCULAR ROAD , 02 - 01",
"addressLine2": "-",
"city": "SINGAPORE",
"state": "SINGAPORE",
"country": "SG",
"postcode": "049422"
}
},
"stakeholders": [
{
"stakeholderDetails": {
"firstName": "MANISHA",
"middleName": null,
"lastName": "XUCCH",
"nationality": "IN",
"dateOfBirth": null,
"kycMode": "E_KYC",
"address": {
"addressLine1": "A - 2/5, CHANDER PRIYA APARTMENT, SECTOR -9, NEAR GANESH MRI",
"addressLine2": "ROHINI, NORTH WEST DELHI",
"city": "ROHINI",
"state": "NEW DELHI",
"country": "IN",
"postcode": "110085"
},
"contactDetails": null,
"professionalDetails": [
{
"position": "UBO",
"sharePercentage": "27"
},
{
"position": "DIRECTOR",
"sharePercentage": null
}
],
"documentDetails": null
},
"businessPartner": null
},
{
"stakeholderDetails": {
"firstName": "TANISHA",
"middleName": null,
"lastName": "FLEZY",
"nationality": "IN",
"dateOfBirth": null,
"kycMode": "E_KYC",
"address": {
"addressLine1": "A - 2/5, CHANDER PRIYA APARTMENT, SECTOR -9, NEAR GANESH MRI",
"addressLine2": "ROHINI, NORTH WEST DELHI",
"city": "ROHINI",
"state": "NEW DELHI",
"country": "IN",
"postcode": "110085"
},
"contactDetails": null,
"professionalDetails": [
{
"position": "SHAREHOLDER",
"sharePercentage": "5"
}
],
"documentDetails": null
},
"businessPartner": null
},
{
"stakeholderDetails": {
"firstName": "TANYA",
"middleName": null,
"lastName": "SHKZREB",
"nationality": "SG",
"dateOfBirth": null,
"address": {
"addressLine1": "39 ROBINSON ROAD",
"addressLine2": "11-01,ROBINSON POINT",
"city": "SINGAPORE",
"state": "SINGAPORE",
"country": "SG",
"postcode": "068911"
},
"contactDetails": null,
"professionalDetails": [
{
"position": "DIRECTOR",
"sharePercentage": null
}
],
"documentDetails": null
},
"businessPartner": null
}
],
"applicantDetails": {
"firstName": "TEO",
"middleName": null,
"lastName": "SHfOCCF",
"nationality": "SG",
"dateOfBirth": "1989-10-10",
"kycMode": "E_KYC",
"address": {
"addressLine1": "15 ST. GEORGE'S ROAD",
"addressLine2": "05-166",
"city": "SINGAPORE",
"state": "SINGAPORE",
"country": "SG",
"postcode": "32015"
},
"contactDetails": {
"contactNo": "32423411",
"countryCode": "SG",
"email": "teo.sg@yopmail.com"
},
"professionalDetails": [
{
"position": "DIRECTOR",
"sharePercentage": null
}
],
"documentDetails": null
},
"additionalInfo": {
"searchId": "2ea658b7-6ce3-4f2b-b22d-dab0b1ea0abb",
"companyStatus": "LIVE COMPANY",
"isSameBusinessAddress": "yes"
}
},
"riskAssessmentInfo": {
"totalEmployees": "EM009",
"annualTurnover": "SG011",
"industrySector": "IS144",
"intendedUseOfAccount": "IU003",
"countryOfOperation": [
"SG",
"US",
"GB"
],
"transactionCountry": [
"DE",
"JP",
"IN"
]
}
}
Request example: action required
For the description of this scenario, see Action required scenario
{
"region": "SG",
"businessDetails": {
"businessName": "ACME COMPANY PTE. LTD. PWUIMRBF",
"businessRegistrationNumber": "A11232393",
"businessType": "PUBLIC_COMPANY",
"legalDetails": {
"registeredCountry": "SG",
"registeredDate": "2021-07-13",
"listedExchange": "EX056"
},
"addresses": {
"registeredAddress": {
"addressLine1": "22 CIRCULAR ROAD , 02 - 01",
"addressLine2": "-",
"city": "SINGAPORE",
"state": "SINGAPORE",
"country": "SG",
"postcode": "049422"
}
},
"stakeholders": [
{
"stakeholderDetails": {
"firstName": "MANISHA",
"middleName": null,
"lastName": "XUCCH",
"nationality": "IN",
"dateOfBirth": null,
"kycMode": "E_KYC",
"address": {
"addressLine1": "A - 2/5, CHANDER PRIYA APARTMENT, SECTOR -9, NEAR GANESH MRI",
"addressLine2": "ROHINI, NORTH WEST DELHI",
"city": "ROHINI",
"state": "NEW DELHI",
"country": "IN",
"postcode": "110085"
},
"contactDetails": null,
"professionalDetails": [
{
"position": "UBO",
"sharePercentage": "27"
},
{
"position": "DIRECTOR",
"sharePercentage": null
}
],
"documentDetails": null
},
"businessPartner": null
},
{
"stakeholderDetails": {
"firstName": "TANISHA",
"middleName": null,
"lastName": "FLEZY",
"nationality": "IN",
"dateOfBirth": null,
"kycMode": "E_KYC",
"address": {
"addressLine1": "A - 2/5, CHANDER PRIYA APARTMENT, SECTOR -9, NEAR GANESH MRI",
"addressLine2": "ROHINI, NORTH WEST DELHI",
"city": "ROHINI",
"state": "NEW DELHI",
"country": "IN",
"postcode": "110085"
},
"contactDetails": null,
"professionalDetails": [
{
"position": "SHAREHOLDER",
"sharePercentage": "5"
}
],
"documentDetails": null
},
"businessPartner": null
},
{
"stakeholderDetails": {
"firstName": "TANYA",
"middleName": null,
"lastName": "SHKZREB",
"nationality": "SG",
"dateOfBirth": null,
"address": {
"addressLine1": "39 ROBINSON ROAD",
"addressLine2": "11-01,ROBINSON POINT",
"city": "SINGAPORE",
"state": "SINGAPORE",
"country": "SG",
"postcode": "068911"
},
"contactDetails": null,
"professionalDetails": [
{
"position": "DIRECTOR",
"sharePercentage": null
}
],
"documentDetails": null
},
"businessPartner": null
}
],
"applicantDetails": {
"firstName": "TEO",
"middleName": null,
"lastName": "SHfOCCF",
"nationality": "SG",
"dateOfBirth": "1989-10-10",
"kycMode": "MANUAL_KYC",
"address": {
"addressLine1": "15 ST. GEORGE'S ROAD",
"addressLine2": "05-166",
"city": "SINGAPORE",
"state": "SINGAPORE",
"country": "SG",
"postcode": "32015"
},
"contactDetails": {
"contactNo": "32423411",
"countryCode": "SG",
"email": "teo.sg@yopmail.com"
},
"professionalDetails": [
{
"position": "DIRECTOR",
"sharePercentage": null
}
],
"documentDetails": null
},
"additionalInfo": {
"searchId": "2ea658b7-6ce3-4f2b-b22d-dab0b1ea0abb",
"isSameBusinessAddress": "yes"
}
},
"riskAssessmentInfo": {
"totalEmployees": "EM009",
"annualTurnover": "SG011",
"industrySector": "IS144",
"intendedUseOfAccount": "IU003",
"countryOfOperation": [
"SG",
"US",
"GB"
],
"transactionCountry": [
"DE",
"JP",
"IN"
]
}
}
Request example: in progress with documents required
For the description of this scenario, see In progress scenario
{
"region": "SG",
"businessDetails": {
"businessName": "ACME COMPANY PTE. LTD. 8083",
"businessRegistrationNumber": "A0183473323",
"businessType": "PRIVATE_COMPANY",
"legalDetails": {
"registeredCountry": "SG",
"registeredDate": "2017-07-08"
},
"addresses": {
"registeredAddress": {
"addressLine1": "67 HIGH STREET, 06-08",
"addressLine2": "SATNAM HOUSE",
"city": "SINGAPORE",
"state": "SINGAPORE",
"country": "SG",
"postcode": "179431"
}
},
"stakeholders": [
{
"entityType": "CORPORATE",
"stakeholderDetails": null,
"businessPartner": {
"businessName": "TANYA SH VKP",
"businessRegistrationNumber": "E6554322",
"businessEntityType": "Shareholder",
"addresses": {
"registeredAddress": {
"addressLine1": "2 PANDAN VALLEY",
"addressLine2": "02-212, ACACIA COURT",
"city": "SINGAPORE",
"state": "SINGAPORE",
"country": "SG",
"postcode": "079903"
}
},
"legalDetails": {
"registeredCountry": "SG"
}
}
},
{
"entityType": "INDIVIDUAL",
"stakeholderDetails": {
"firstName": "ROBERT",
"middleName": "SH",
"lastName": "UWW",
"nationality": "VG",
"dateOfBirth": null,
"address": {
"addressLine1": "85 JLN DEDAP 7 TAMAN JAYA",
"addressLine2": "JOHOR BAHRU, JOHOR",
"city": "MALAYSIA",
"state": "MALAYSIA",
"country": "MY",
"postcode": "81100"
},
"contactDetails": null,
"professionalDetails": [
{
"position": "UBO",
"sharePercentage": "52.4"
}
],
"documentDetails": null
},
"businessPartner": null
},
{
"entityType": "INDIVIDUAL",
"stakeholderDetails": {
"firstName": "PETER",
"middleName": null,
"lastName": "TQ",
"nationality": "MN",
"dateOfBirth": null,
"address": {
"addressLine1": "85 JLN DEDAP 7 TAMAN JAYA",
"addressLine2": "JOHOR BAHRU, JOHOR",
"city": "MALAYSIA",
"state": "MALAYSIA",
"country": "MY",
"postcode": "81100"
},
"contactDetails": null,
"professionalDetails": [
{
"position": "DIRECTOR",
"sharePercentage": null
}
],
"documentDetails": null
},
"businessPartner": null
},
{
"entityType": "INDIVIDUAL",
"stakeholderDetails": {
"firstName": "TEO",
"middleName": null,
"lastName": "GI",
"nationality": "SG",
"dateOfBirth": null,
"address": {
"addressLine1": "15 ST. GEORGE'S ROAD",
"addressLine2": "05-166",
"city": null,
"state": null,
"country": "SG",
"postcode": "32015"
},
"contactDetails": null,
"professionalDetails": [
{
"position": "DIRECTOR",
"sharePercentage": null
}
],
"documentDetails": null
},
"businessPartner": null
}
],
"applicantDetails": {
"firstName": "TEO",
"middleName": null,
"kycMode": "MANUAL_KYC",
"lastName": "jksdhf",
"nationality": "GB",
"dateOfBirth": "1989-10-10",
"address": {
"addressLine1": "15 ST. GEORGE'S ROAD",
"addressLine2": "05-166",
"city": "LONDON",
"state": "LONDON",
"country": "GB",
"postcode": "32015"
},
"contactDetails": {
"contactNo": "32423411",
"countryCode": "SG",
"email": "teo.sg@yopmail.com"
},
"professionalDetails": [
{
"position": "DIRECTOR",
"sharePercentage": null
}
],
"documentDetails": null
},
"additionalInfo": {
"searchId": "c0be4204-698b-4c76-b17b-48d977304286",
"isSameBusinessAddress": "yes"
}
},
"riskAssessmentInfo": {
"totalEmployees": "EM009",
"annualTurnover": "SG011",
"industrySector": "IS144",
"intendedUseOfAccount": "IU003",
"countryOfOperation": [
"SG",
"US",
"GB"
],
"transactionCountry": [
"DE",
"JP",
"IN"
]
}
}
Completing applicant eKYC
For Singapore residents, the applicant eKYC is done via MyInfo.
To simulate different success and error responses of the eKYC flow, use the following conditions on the applicant's phone number. In all cases, the applicant needs to open the redirectURL in their browser. You either land on the vendor’s page or receive a success/failure redirection back to your client 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 | Myinfo’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 |
|---|---|
| 21 | isSuccess = false; errorCode = R500; errorMessage = internalServerError |
| 71 | isSuccess = false ; errorCode = I400; errorMessage = vendorValidationError |
| 91 | isSuccess = true ; errorCode =; errorMessage = Opening the redirect URL twice will generate the verification already completed scenario: isSuccess = false ; errorCode =; errorMessage=verificationAlreadyCompleted |
Completing applicant eDocVerify
For non-Singapore 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 test the verificationAlreadyCompleted message by clicking on the redirectURL after completing verification.
Simulate scenarios in the manual KYB flow
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 | Contains M01 | M01324536, 234M01456, 12M01B325 |
Call the Onboard Corporate Customer API with the following example request.
Request example: auto-approval
{
"region": "SG",
"businessDetails": {
"referenceId": "6913aac9-cbd9-4783-8fd6-07ea9655dfec",
"businessName": "Singapore Electronics 27779",
"businessRegistrationNumber": "903287424M01233",
"website":"www.singaporeelectronics.com",
"businessType": "PRIVATE_COMPANY",
"legalDetails": {
"registeredCountry": "SG",
"registeredDate": "2000-01-02"
},
"addresses": {
"registeredAddress": {
"addressLine1": "High Street 101, 56th Avenue",
"addressLine2": "Hyung County",
"city": "Singapore",
"country": "SG",
"postcode": "28046"
}
},
"documentDetails": [
{
"documentType": "BUSINESS_REGISTRATION_DOC",
"document": [
{
"document": "iVBORw0KGgoAAAANSUhEUgAAAAgAAAAIAQMAAAD+wSzIAAAABlBMVEX///+/v7+jQ3Y5AAAADklEQVQI12P4AIX8EAgALgAD/aNpbtEAAAAASUVORK5CYII",
"fileName": "BRD.pdf",
"fileType": "application/pdf"
}
]
}
],
"stakeholders": [
{
"referenceId": "d25c5c6f-d4b0-47a5-986e-7b50641b65fc",
"stakeholderDetails": {
"firstName": "Narendra",
"middleName": "C",
"lastName": "Bhargav",
"dateOfBirth": "1982-07-17",
"nationality": "IN",
"kycMode": "MANUAL_KYC",
"professionalDetails": [
{
"position": "DIRECTOR"
},
{
"position": "UBO",
"sharePercentage": "60"
}
],
"address": {
"addressLine1": "7 Ang Mo Kio Street",
"addressLine2": "64 No.01-01",
"city": "Singapore",
"country": "SG",
"postcode": "28046"
},
"documentDetails": [
{
"documentType": "PASSPORT",
"documentExpiryDate": "2029-09-10",
"documentIssuanceCountry": "IN",
"documentNumber": "098734524",
"document": [
{
"document": "iVBORw0KGgoAAAANSUhEUgAAAAgAAAAIAQMAAAD+wSzIAAAABlBMVEX///+/v7+jQ3Y5AAAADklEQVQI12P4AIX8EAgALgAD/aNpbtEAAAAASUVORK5CYII",
"fileName": "Passport.pdf",
"fileType": "application/pdf"
}
]
}
]
}
},
{
"referenceId": "006ebeeb-3ede-4f49-8381-1e382334131c",
"businessPartner": {
"legalDetails": {
"registeredCountry": "FR"
},
"businessEntityType": "SHAREHOLDER",
"businessName": "Farto AgriTECH LIMITED",
"businessRegistrationNumber": "822843822"
}
}
],
"applicantDetails": {
"referenceId": "0c61376b-70c3-4d45-9193-0a6ddece4e0e",
"firstName": "Hardik",
"middleName": "",
"lastName": "Roshan",
"dateOfBirth": "1982-07-17",
"nationality": "SG",
"kycMode": "E_KYC",
"contactDetails": {
"contactNo": "222268870",
"countryCode": "SG",
"email": "hardik@singel.com"
},
"professionalDetails": [
{
"position": "SIGNATORY"
}
],
"address": {
"addressLine1": "7 Ang Mo Kio Street",
"addressLine2": "64 No.01-01",
"city": "Singapore",
"country": "SG",
"postcode": "28046"
}
},
"additionalInfo": {
"isSameBusinessAddress": "Yes",
"searchId": "6nf3aac9-cbd9-423k-8fd6-07ea9345dfec"
}
},
"riskAssessmentInfo": {
"totalEmployees": "EM009",
"annualTurnover": "SG011",
"industrySector": "IS144",
"intendedUseOfAccount": "IU003",
"countryOfOperation": [
"SG",
"US",
"GB"
],
"transactionCountry": [
"DE",
"JP",
"IN"
]
},
"tags": [
{
"key": "tag1",
"value": "tag1value"
},
{
"key": "tag2",
"value": "tag2value"
}
]
}