SG request examples
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 = PUBLIC_COMPANY.
{
"region": "SG",
"businessDetails": {
"referenceId": "6913aac9-cbd9-4783-8fd6-07ea9655dfec",
"businessName": "Singapore Electronics",
"businessRegistrationNumber": "903287324",
"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": "<Base64 Encoded Document>",
"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"
}
],
"address": {
"addressLine1": "7 Ang Mo Kio Street",
"addressLine2": "64 No.01-01",
"city": "Singapore",
"country": "SG",
"postcode": "28046"
},
"documentDetails": [
{
"documentType": "PASSPORT",
"documentExpiryDate": "2024-12-01",
"documentIssuanceCountry": "IN",
"documentNumber": "098734524",
"document": [
{
"document": "<Base64 Encoded Document>",
"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": "SG",
"kycMode": "E_KYC",
"contactDetails": {
"contactNo": "222268870",
"countryCode": "SG",
"email": "[email protected]"
},
"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"
],
"annualTurnover": "SG005",
"industrySector": "IS010",
"intendedUseOfAccount": "IU009",
"totalEmployees": "EM005"
},
"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": "<Base64 Encoded Document>",
"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": "2024-12-01",
"documentIssuanceCountry": "IN",
"documentNumber": "098734524",
"document": [
{
"document": "<Base64 Encoded Document>",
"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": "[email protected]"
},
"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"
],
"annualTurnover": "SG005",
"industrySector": "IS010",
"intendedUseOfAccount": "IU009",
"totalEmployees": "EM005"
},
"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": "<Base64 Encoded Document>",
"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": "2024-12-01",
"documentIssuanceCountry": "SG",
"documentNumber": "098734524",
"document": [
{
"document": "<Base64 Encoded Document>",
"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": "[email protected]"
},
"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"
],
"annualTurnover": "SG005",
"industrySector": "IS010",
"intendedUseOfAccount": "IU009",
"totalEmployees": "EM002"
},
"tags": [
{
"key": "tag1",
"value": "tag1value"
},
{
"key": "tag2",
"value": "tag2value"
}
]
}
Generating mock scenarios
The following scenarios can be generated by following the steps given below and using the businessRegistrationNumber (BRN) and example request given in the table below.
| Example request scenario | Condition on businessRegistrationNumber | Example BRN |
|---|---|---|
| Auto-approval | Contains A01 | A01324536, 234A01456, 12A01B325 |
| Action required | Contains A02 | A02324536, 234A02456, 12A02B325 |
| In progress (with documents required) | Contains A03 | A03324536, 234A03456, 12A03B325 |
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 will receive multiple businesses in the response. Pick the one with with matching businessRegistrationNumber and copy the searchReferenceId.
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 sample requests in the table and call Onboard Corporate Customer API. Ensure the following before calling the API:
- Change businessRegistrationNumber and businessName to those received in the response of Exhaustive details API
- Use the searchID received in the response of Exhaustive details API
- Change
stakeholderDetails.firstName,stakeholderDetails.lastName,businessPartner.businessNameto those received in the response of Exhaustive details API. - Give a Unique non-repeated name to the applicant. Expectation is that different businesses will have different Applicant Name
Step 4: Use the redirect URL and complete Applicant KYC on the MyInfo Page and wait for the webhook. Verification can be completed with dummy credentials by clicking on the link in preproduction.
Example responses for Exhaustive Corporate Details API
You can also generate responses for different businessType by following the table below. This can be used for testing the pre-population flow after calling the Exhaustive Details 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 |
Example request: 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": "[email protected]"
},
"professionalDetails": [
{
"position": "DIRECTOR",
"sharePercentage": null
}
],
"documentDetails": null
},
"additionalInfo": {
"searchId": "2ea658b7-6ce3-4f2b-b22d-dab0b1ea0abb",
"companyStatus": "LIVE COMPANY",
"isSameBusinessAddress": "yes"
}
},
"riskAssessmentInfo": {
"totalEmployees": "EM004",
"annualTurnover": "SG007",
"industrySector": "IS014",
"intendedUseOfAccount": "IU003",
"countryOfOperation": [
"SG",
"US",
"GB"
],
"transactionCountry": [
"DE",
"JP",
"IN"
]
}
}
Example request: 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": "[email protected]"
},
"professionalDetails": [
{
"position": "DIRECTOR",
"sharePercentage": null
}
],
"documentDetails": null
},
"additionalInfo": {
"searchId": "2ea658b7-6ce3-4f2b-b22d-dab0b1ea0abb",
"isSameBusinessAddress": "yes"
}
},
"riskAssessmentInfo": {
"totalEmployees": "EM004",
"annualTurnover": "SG007",
"industrySector": "IS014",
"intendedUseOfAccount": "IU003",
"countryOfOperation": [
"SG",
"US",
"GB"
],
"transactionCountry": [
"DE",
"JP",
"IN"
]
}
}
Example request: 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": "[email protected]"
},
"professionalDetails": [
{
"position": "DIRECTOR",
"sharePercentage": null
}
],
"documentDetails": null
},
"additionalInfo": {
"searchId": "c0be4204-698b-4c76-b17b-48d977304286",
"isSameBusinessAddress": "yes"
}
},
"riskAssessmentInfo": {
"totalEmployees": "EM004",
"annualTurnover": "SG007",
"industrySector": "IS014",
"intendedUseOfAccount": "IU003",
"countryOfOperation": [
"SG",
"US",
"GB"
],
"transactionCountry": [
"DE",
"JP",
"IN"
]
}
}
Updated about 4 hours ago