SG required parameters

The API fields shown on this page are relevant to Singapore only. To see the full payload, refer to the Onboard Corporate Customer API Reference.

📘
Note
All fields have a maximum limit of 255 characters unless stated otherwise.

Request parameters

Property	Description	Required
`region`	The country or geographic region where the corporate end customer is located and is onboarded. To onboard a Singapore-based customer, use the `SG` value.	Yes
businessDetails	An object that contains business details about the corporate customer.	Yes
riskAssessmentInfo	An object that contains the risk assessment information.	Yes
deviceDetails	An object that contains information about the customer's device and IP address.	Yes
expectedAccountUsage	An object that contains the expected usage of the account	Yes
tags	An object that contains the tags.	No
`clientId`	This field contains the Nium client ID of the customer. It's received in the response of the previously executed Onboard Corporate Customer API. Note: This field is required to reinitiate the KYB process.	Yes *
`customerHashId`	This field contins the unique customer identifier generated at the time of the customer creation. It's received in the response of the previously executed Onboard Corporate Customer API. Note: This field is required to reinitiate the KYB process.	Yes *

Table header API fields

The below table headers refer to the businessType fields:

Government Private Sole trader	Public	Association Partner Trust
`GOVERNMENT_ENTITY` `PRIVATE_COMPANY` `SOLE_TRADER`	`PUBLIC_COMPANY`	`ASSOCIATION` `PARTNERSHIP` `TRUST`

`businessDetails` object

An object that contains business details about the corporate customer.

Property	Description	Government Private Sole trader	Public	Association Partner Trust
`referenceId`	The universally unique identifier (UUID) of the business entity that Nium uses to identify the `businessDetails` entity. If it's not provided, Nium generates one. The UUID is used to respond to a request for information (RFI) or to upload required documents for the business entity.	Optional	Optional	Optional
`businessName`	The name a corporate customer is registered under.	Required	Required	Required
`businessRegistrationNumber`	The business registration number.	Required	Required	Required
`tradeName`	Another name that the corporate customer uses to do business under, which is different than their licensed business name.	Optional	Optional	Optional
`formerName`	In case the corporate customer did business under a different name than their licensed business name.	Optional	Optional	Optional
`website`	The corporate customer's website.	Optional	Optional	Optional
`businessType`	The legal entity type of the business. Use Fetch corporate constants API for a valid set of values.	Required	Required	Required
associationDetails	An object that contains the association details. Note: Required only for `ASSOCIATION`.	N/A	N/A	Required *
legalDetails	An object that contains the legal details.	Required	Required	Required
regulatoryDetails	An object that contains the client's regulatory status. Note: This field is required only for `TRUST`.	N/A	N/A	Required *
addresses	An object that contains the registered and business addresses of the corporate customer.	Required	Required	Required
documentDetails	An array of objects that contains the business documents. Note: This field is required if specified in SG required documents.	Required *	Required *	Required *
stakeholders	An array of objects that contains the individual and corporate stakeholders of the corporate customer.	Required	Required	Required
applicantDetails	An object that contains the applicant's details.	Required	Required	Required
additionalInfo	An object that contains additional information about the business.	Optional	Optional	Optional

`associationDetails` object

An object within the businessDetails object that contains the association details.

This is required if businessType = ASSOCIATION.

Property	Description	Government Private Sole trader	Public	Association Partner Trust
`associationName`	The complete name of the association. Note: This field is required only for `ASSOCIATION`.	N/A	N/A	Required *
`associationNumber`	The number of the association that an applicable state or territory issues. Note: This field is required only for `ASSOCIATION`.	N/A	N/A	Required *
`associationChairPerson`	The complete name of an association chairperson, secretary, or treasurer. Note: This field is required only for `ASSOCIATION`.	N/A	N/A	Required *

`legalDetails` object

An object within the businessDetails object that contains legal details.

Property	Description	Government Private Sole trader	Public	Association Partner Trust
`registeredDate`	The date the business was registered entered in the `YYYY-MM-DD` format. Registered date cannot be future date.	Required	Required	Required
`registeredCountry`	The country where the business is registered, specified in the ISO 3166 format.	Required	Required	Required
`listedExchange`	The exchange where the business is publicly listed. Use Fetch corporate constants API for a valid set of values.	N/A	Required	N/A

`regulatoryDetails` array

An array of objects within the businessDetails object that contains the regulatory status of the corporate customer.

Property	Description	Government Private Sole trader	Public	Association Partner Trust
`unregulatedTrustType`	Unregulated trust type details. Note: This field is required only for `TRUST`. This field is an array.	N/A	N/A	Required *

`addresses` object

An object within the businessDetails object that contains registered and business addresses.

Property	Description	Government Private Sole trader	Public	Association Partner Trust
registeredAddress	An object that contains the address where the business is registered.	Required	Required	Required
businessAddress	An object that contains the address where the business is mainly conducted, if different than the registered address. Note: This is required if `isSameBusinessAddress = No`	Required *	Required *	Required *

`registeredAddress` object

An object within the businessDetails.address object that contains the address details where the corporate customer is registered.

Property	Description	Government Private Sole trader	Public	Association Partner Trust
`addressLine1`	The first address line of the registered business.	Required	Required	Required
`addressLine2`	The second address line of the registered business.	Optional	Optional	Optional
`city`	The city where the corporate customer is registered.	Optional	Optional	Optional
`state`	The state where the corporate customer is registered.	Optional	Optional	Optional
`country`	The country where the corporate customer is registered, specified in the ISO 3166 format.	Required	Required	Required
`postcode`	The postal code where the corporate customer is registered.	Required	Required	Required

`businessAddress` object

An object within the businessDetails.address object that contains the address details about the principal place of business only when the registered address is different.

📌
IMPORTANT
* Use these fields only if the principal place of business is different than the registered address.
These fields are required only if isSameBusinessAddress = No.

Property	Description	Government Private Sole trader	Public	Association Partner Trust
`addressLine1`	The first address line of the principal place of business if different than the registered business.	Required *	Required *	Required *
`addressLine2`	The second address line of the principal place of business if different than the registered business.	Optional	Optional	Optional
`city`	The city of the principal place of business if different than the registered address.	Optional	Optional	Optional
`state`	The state of the principal place of business if different than the registered address.	Optional	Optional	Optional
`country`	The country where the principal place of business occurs if different than the registered country, specified in the ISO 3166 format.	Required *	Required *	Required *
`postcode`	The postal code where the principal place of business occurs if different than the registered address.	Required *	Required *	Required *

`documentDetails` object

An array of object within the businessDetails object that contains one or more business documents.

📌
IMPORTANT
* For a complete list of required documents, see SG required documents.

Property	Description	Government Private Sole trader	Public	Association Partner Trust
`documentType`	The type of business document. Use Fetch corporate constants API for a valid set of values.	Required *	Required *	Required *
document	An array of object that contains a copy of the document.	Required *	Required *	Required *

`document` object

An array of object within the businessDetails.documentDetails object.

Property	Description	Government Private Sole trader	Public	Association Partner Trust
`fileName`	The name of the file.	Required *	Required *	Required
`fileType`	The type of the file. Valid types are `application/pdf`, `image/jpeg`, `image/jpg`, `image/png`, `jpeg`, `jpg`, and `png`.	Required *	Required *	Required
`document`	The file as a base64 encoded string.	Required *	Required *	Required

`additionalInfo` object

An object within the businessDetails object that contains additional information about the business.

Property	Description	Government Private Sole trader	Public	Association Partner Trust
`isSameBusinessAddress`	This field accepts `Yes` or `No` to indicate if the principal place of business is the same or different from the registered business entity address.	Optional	Optional	Optional
`searchId`	This field is required for eKYB and is returned in the response of the Exhaustive Corporate Details using Business ID API.	Conditional	Conditional	Conditional

`stakeholders` object

An array of object within the businessDetails object that contains information about one or many stakeholders. For every stakeholder object, you need to send either the stakeholderDetails or the businessPartner parameters.

Property	Description	Government Private Sole trader	Public	Association Partner Trust
`referenceId`	The UUID associated with the stakeholder and stakeholder object. If the UUID isn't provided, Nium generates one. The UUID can be used to respond to an RFI or to upload the required documents.	Optional	Optional	Optional
stakeholderDetails	An object that contains the details about the individual stakeholder. Required only if an individual stakeholder exists.	Required	Required	Required
businessPartner	An object that contains the details about the corporate stakeholder, if available. Required only if a business partner exists.	Required	Required	Required

`stakeholderDetails` object

An object within the stakeholders object that contains the details about an individual stakeholder.

Property	Description	Government Private Sole trader	Public	Association Partner Trust
`kycMode`	The KYC mode for the individual stakeholder. Note: This field is required to be `MANUAL_KYC` for `position`= `SIGNATORY`, `REPRESENTATIVE`, `DIRECTOR`, `UBO`, `TRUSTEE`, `PARTNER`. Else ignore this field.	Required *	Required *	Required *
`firstName`	The first name of the individual stakeholder.	Required	Required	Required
`middleName`	The middle name of the individual stakeholder.	Optional	Optional	Optional
`lastName`	The last name of the individual stakeholder.	Required	Required	Required
`nationality`	The nationality of the individual stakeholder.	Required	Required	Required
`dateOfBirth`	The date the individual stakeholder was born in the `YYYY-MM-DD` format. Date of birth cannot be future date.	Optional	Optional	Optional
professionalDetails	The array of professional details about the individual stakeholder.	Required	Required	Required
address	An object that contains the residential address of the individual stakeholder. This field is required only if `position = DIRECTOR, UBO, SIGNATORY`, `REPRESENTATIVE`, `TRUSTEE`, `PARTNER`	Required *	Required *	Required *
contactDetails	An object that contains the contact details about the individual stakeholder.	Optional	Optional	Optional
documentDetails	An array of object that contains the document details about the individual stakeholder. Note: This field is required only if `MANUAL_KYC`.	Required *	Required *	Required *

`professionalDetails` object

An array of object within the businessDetails.stakeholders.stakeholderDetails object that contains the individual stakeholder's professional details.

Property	Description	Government Private Sole trader	Public	Association Partner Trust
`position`	The position of the individual stakeholder. Use Fetch corporate constants API for a valid set of values.	Required	Required	Required
`sharePercentage`	The share percentage of the individual stakeholder in the company.	Optional	Optional	Optional

`address` object

An object within the businessDetails.stakeholders.stakeholderDetails object that contains the individual stakeholder's residential address.

📌
IMPORTANT
* This object is required only if position = DIRECTOR, UBO, SIGNATORY, REPRESENTATIVE, TRUSTEE, PARTNER

Property	Description	Government Private Sole trader	Public	Association Partner Trust
`addressLine1`	The first address line of the individual stakeholder.	Required *	Required *	Required *
`addressLine2`	The second address line of the individual stakeholder.	Optional	Optional	Optional
`city`	The city or suburb of the individual stakeholder.	Optional	Optional	Optional
`state`	The state of the individual stakeholder.	Optional	Optional	Optional
`country`	The country where the individual stakeholder resides, specified in the ISO 3166 format.	Required *	Required *	Required *
`postcode`	The postal code of the individual stakeholder.	Required *	Required *	Required *

`contactDetails` object

An optional object within the businessDetails.stakeholders.stakeholderDetails object that contains the stakeholder's contact information.

Property	Description	Government Private Sole trader	Public	Association Partner Trust
`email`	The individual stakeholder's email address.	Optional	Optional	Optional
`contactNo`	The contact phone number of the individual stakeholder.	Optional	Optional	Optional

`documentDetails` object

An array of object within the businessDetails.stakeholders.stakeholderDetails object that contains the individual stakeholder's document details.

📌
IMPORTANT
* This object is required only if kycMode = MANUAL_KYC.

Property	Description	Government Private Sole trader	Public	Association Partner Trust
`documentType`	The type of document. Use Fetch corporate constants API for a valid set of values.	Required *	Required *	Required *
`documentNumber`	The ID number for the given document type.	Required *	Required *	Required *
`documentIssuanceCountry`	The country that issued the business document, specified in the ISO 3166 format. This field is required for NATIONAL_ID``, and PASSPORT`.	Required *	Required *	Required *
`documentExpiryDate`	The date the document will expire in `YYYY-MM-DD` format. Note: This field is required for `PASSPORT`. Expiry date cannot be past date.	Required *	Required *	Required *
document	An array of object that contains a copy of the document.	Required *	Required *	Required *

`document` object

An array of object within the businessDetails.stakeholders.stakeholderDetails.documentDetails object.

Property	Description	Government Private Sole trader	Public	Association Partner Trust
`fileName`	The name of the file.	Required *	Required *	Required *
`fileType`	The type of the file. Valid types are `application/pdf`, `image/jpeg`, `image/jpg`, `image/png`, `jpeg`, `jpg`, and `png`.	Required *	Required *	Required *
`document`	The file as a base64 encoded string.	Required *	Required *	Required *

`businessPartner`

An object within the businessDetails.stakeholders object with the business details about the corporate stakeholder.

📌
IMPORTANT
This object is required if a business partner exists.

Property	Description	Government Private Sole trader	Public	Association Partner Trust
`businessName`	The registered business name of the corporate stakeholder.	Required	Required	Required
`businessRegistrationNumber`	The business registration number.	Required	Required	Required
`businessEntityType`	The position of the corporate stakeholder in the company. Use Fetch corporate constants API for a valid set of values.	Required	Required	Required
`sharePercentage`	The share percentage of the corporate stakeholder in the company.	Optional	Optional	Optional
legalDetails	An object that contains the legal details about the corporate stakeholder.	Required	Required	Required

`legalDetails` object

An object within the businessDetails.stakeholders.businessPartner object that contains the corporate stakeholder's legal details.

Property	Description	Government Private Sole trader	Public	Association Partner Trust
`registeredCountry`	The country where the corporate stakeholder is registered, specified in the ISO 3166 format.	Required	Required	Required

`applicantDetails` object

An object within the businessDetails object that contains details about the applicant.

Property	Description	Government Private Sole trader	Public	Association Partner Trust
`referenceId`	The universally unique identifier (UUID) associated with the applicant and applicant object. If the UUID isn't provided, Nium generates one. The UUID can be used to respond to an RFI or to upload required documents.	Optional	Optional	Optional
`kycMode`	The KYC mode for verifying the identity of the applicant. Applicable values are `E_KYC`, `E_DOC_VERIFY`, and `MANUAL_KYC`. For details, see SG Applicant KYC	Required	Required	Required
`firstName`	The first name of the applicant. The maximum length is 40 alphabetic characters or spaces.	Required	Required	Required
`middleName`	The middle name of the applicant. Maximum length is 40 alphabetic characters or spaces.	Optional	Optional	Optional
`lastName`	The last name or the applicant. The maximum length is 40 alphabetic characters or spaces.	Required	Required	Required
`nationality`	Nationality of the applicant. Use Fetch corporate constants API for valid values.	Required	Required	Required
`dateOfBirth`	The date on which the applicant was born in `YYYY-MM-DD` format. Date of birth cannot be future date. Applicant age should be less than 18 yrs.	Required	Required	Required
professionalDetails	An array of objects that contains the professional details about the applicant.	Required	Required	Required
address	An object that contains the address of the applicant..	Required	Required	Required
contactDetails	An object that contains the contact details about the applicant.	Required	Required	Required
documentDetails	An object that contains the document details about the applicant. Note: This field is required if `kycMode = MANUAL_KYC` or `E_DOC_VERIFY`.	Required *	Required *	Required *

`professionalDetails` object

An array of objects within the businessDetails.applicantDetails object that contains the professional details about the applicant.

Property	Description	Government Private Sole trader	Public	Association Partner Trust
`position`	The position of the applicant. Use Fetch corporate constants API for a valid set of values.	Required	Required	Required
`sharePercentage`	The share percentage of the applicant in the company.	Optional	Optional	Optional

`address` object

An object within the businessDetails.applicantDetails object that contains the applicant's residential address.

Property	Description	Government Private Sole trader	Public	Association Partner Trust
`addressLine1`	The first address line of the applicant. The maximum character length is 40.	Required	Required	Required
`addressLine2`	The second address line of the applicant. The maximum character length is 40.	Optional	Optional	Optional
`city`	The city of the applicant. Maximum character length is 20.	Required	Required	Required
`state`	The state of the applicant. Maximum character length is 30.	Optional	Optional	Optional
`country`	The country where the applicant resides, specified in the ISO 3166 format.	Required	Required	Required
`postcode`	The postal code of the applicant. The minimum length is 3 and the maximum length is 10 alphanumeric characters or spaces.	Required	Required	Required

`contactDetails` object

An object within the businessDetails.applicantDetails object that contains the applicant's contact information.

Property	Description	Government Private Sole trader	Public	Association Partner Trust
`email`	The applicant's email address. The maximum character length is 40 and needs to be a valid email address. See Email regex	Required	Required	Required
`countryCode`.	The country code of the applicant's phone number.	Required	Required	Required
`contactNo`	The applicant's phone number. The maximum length is 20 numeric characters.	Required	Required	Required

`documentDetails` object

An array of objects within the businessDetails.applicantDetails object that contains the applicant's document information.

📌
IMPORTANT
* This object is required if kycMode = MANUAL_KYC or E_DOC_VERIFY.

Property	Description	Government Private Sole trader	Public	Association Partner Trust
`documentType`	The type of document. Use Fetch corporate constants API for a valid set of values.	Required *	Required *	Required *
`documentNumber`	The ID number for the given document type.	Required *	Required *	Required *
`documentIssuanceCountry`	The country that issued the business document, specified in the ISO 3166 format. This is required only if `documentType = NATIONAL_ID, PASSPORT`.	Required *	Required *	Required *
`documentExpiryDate`	The date the document expires in the`YYYY-MM-DD` format. This is required only if `documentType = PASSPORT`. Expiry date should not be past date.	Required *	Required *	Required *
document	An array of objects that contains the copy of the document. For details, see SG required documents. Required only for `MANUAL_KYC`	Required *	Required *	Required *

`document` object

An array of objects within the businessDetails.applicantDetails.documentDetails object that contains the document copy.

📌
IMPORTANT
* This object is required if kycMode = MANUAL_KYC. Not required for E_DOC_VERIFY

For details, see SG required documents.

Property	Description	Government Private Sole trader	Public	Association Partner Trust
`fileName`	The name of the file.	Required *	Required *	Required *
`fileType`	The file type. Valid types are `application/pdf`, `image/jpeg`, `image/jpg`, `image/png`, `jpeg`, `jpg`, and `png`.	Required *	Required *	Required *
`document`	The document saved as a base64 encoded string.	Required *	Required *	Required *

`riskAssessmentInfo` object

An object that contains the following details that are required to determine a corporate customer's risk profile.

Property	Description	Government Private Sole trader	Public	Association Partner Trust
`totalEmployees`	The corporate customer's total number of employees. Use Fetch corporate constants API for a valid set of values.	Required	Required	Required
`annualTurnover`	The corporate customer's amount of annual turnover. Use Fetch corporate constants API for a valid set of values.	Required	Required	Required
`industrySector`	The corporate customer's industry sector. Use Fetch corporate constants API for a valid set of values.	Required	Required	Required
`transactionCountries`	An array of countries where the transactions occur, specified in the ISO 3166 format.	Required	Required	Required
`countryOfOperation`	An array of countries the corporate customer operates in, specified in the ISO 3166 format.	Required	Required	Required

`deviceDetails` object

This object contains the information about the customer's device and IP address where the onboarding request originated.

Property	Description	Government Private Sole trader	Public	Association Partner Trust
`countryIP`	Country of the IP address e.g. US. Use Use Fetch corporate constants API for valid values.	Required	Required	Required
`deviceInfo`	Information of the device e.g. Mac OS.	Required	Required	Required
`ipAddress`	IP address of the device e.g. 45.48.241.198	Required	Required	Required
`sessionId`	A unique identifier for the session, generated by your application.	Required	Required	Required

`expectedAccountUsage` object

This object contains the details regarding the expected usage of the account

Property	Description	Government Private Sole trader	Public	Association Partner Trust
`intendedUses`	Array of Intended uses of the account. Use Fetch corporate constants API for a valid set of values.	Required	Required	Required

`tags` object

This object contains the user-defined key-value pairs that the client provides. The maximum number of tags is 15.

Property	Description	Government Private Sole trader	Public	Association Partner Trust
`key`	The name of the tag. The maximum character length is 128. Key should be unique.	Optional	Optional	Optional
`value`	The value of the tag. The maximum character length is 256.	Optional	Optional	Optional

SG required parameters

📘
Note

Request parameters

Table header API fields

`businessDetails` object

`associationDetails` object

`legalDetails` object

`regulatoryDetails` array

`addresses` object

`registeredAddress` object

`businessAddress` object

📌
IMPORTANT

`documentDetails` object

📌
IMPORTANT

`document` object

`additionalInfo` object

`stakeholders` object

`stakeholderDetails` object

`professionalDetails` object

`address` object

📌
IMPORTANT

`contactDetails` object

`documentDetails` object

📌
IMPORTANT

`document` object

`businessPartner`

📌
IMPORTANT

`legalDetails` object

`applicantDetails` object

`professionalDetails` object

`address` object

`contactDetails` object

`documentDetails` object

📌
IMPORTANT

`document` object

📌
IMPORTANT

`riskAssessmentInfo` object

`deviceDetails` object

`expectedAccountUsage` object

`tags` object

📘Note

Request parameters

Table header API fields

businessDetails object

associationDetails object

legalDetails object

regulatoryDetails array

addresses object

registeredAddress object

businessAddress object

📌IMPORTANT

documentDetails object

📌IMPORTANT

document object

additionalInfo object

stakeholders object

stakeholderDetails object

professionalDetails object

address object

📌IMPORTANT

contactDetails object

documentDetails object

📌IMPORTANT

document object

businessPartner

📌IMPORTANT

legalDetails object

applicantDetails object

professionalDetails object

address object

contactDetails object

documentDetails object

📌IMPORTANT

document object

📌IMPORTANT

riskAssessmentInfo object

deviceDetails object

expectedAccountUsage object

tags object

📘
Note

`businessDetails` object

`associationDetails` object

`legalDetails` object

`regulatoryDetails` array

`addresses` object

`registeredAddress` object

`businessAddress` object

📌
IMPORTANT

`documentDetails` object

📌
IMPORTANT

`document` object

`additionalInfo` object

`stakeholders` object

`stakeholderDetails` object

`professionalDetails` object

`address` object

📌
IMPORTANT

`contactDetails` object

`documentDetails` object

📌
IMPORTANT

`document` object

`businessPartner`

📌
IMPORTANT

`legalDetails` object

`applicantDetails` object

`professionalDetails` object

`address` object

`contactDetails` object

`documentDetails` object

📌
IMPORTANT

`document` object

📌
IMPORTANT

`riskAssessmentInfo` object

`deviceDetails` object

`expectedAccountUsage` object

`tags` object