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

PropertyDescriptionRequired
regionThe 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
businessDetailsAn object that contains business details about the corporate customer.Yes
riskAssessmentInfoAn object that contains the risk assessment information.Yes
deviceDetailsAn object that contains information about the customer's device and IP address.Yes
tagsAn object that contains the tags.No
clientIdThis 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 *
customerHashIdThis 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
PublicAssociation
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.

    PropertyDescriptionGovernment
    Private
    Sole trader
    PublicAssociation
    Partner
    Trust
    referenceIdThe 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.OptionalOptionalOptional
    businessNameThe name a corporate customer is registered under.RequiredRequiredRequired
    businessRegistrationNumberThe business registration number.RequiredRequiredRequired
    tradeNameAnother name that the corporate customer uses to do business under, which is different than their licensed business name.OptionalOptionalOptional
    formerNameIn case the corporate customer did business under a different name than their licensed business name.OptionalOptionalOptional
    websiteThe corporate customer's website.OptionalOptionalOptional
    businessTypeThe legal entity type of the business. Use Fetch corporate constants API for a valid set of values.RequiredRequiredRequired
    associationDetailsAn object that contains the association details.
    Note: Required only for ASSOCIATION.
    N/AN/ARequired *
    legalDetailsAn object that contains the legal details.RequiredRequiredRequired
    regulatoryDetailsAn object that contains the client's regulatory status.
    Note: This field is required only for TRUST.
    N/AN/ARequired *
    addressesAn object that contains the registered and business addresses of the corporate customer.RequiredRequiredRequired
    documentDetailsAn array of objects that contains the business documents.
    Note: This field is required if specified in SG required documents.
    Required *Required *Required *
    stakeholdersAn array of objects that contains the individual and corporate stakeholders of the corporate customer.RequiredRequiredRequired
    applicantDetailsAn object that contains the applicant's details.RequiredRequiredRequired
    additionalInfoAn object that contains additional information about the business.OptionalOptionalOptional

    associationDetails object

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

    This is required if businessType = ASSOCIATION.

    PropertyDescriptionGovernment
    Private
    Sole trader
    PublicAssociation
    Partner
    Trust
    associationNameThe complete name of the association.
    Note: This field is required only for ASSOCIATION.
    N/AN/ARequired *
    associationNumberThe number of the association that an applicable state or territory issues.
    Note: This field is required only for ASSOCIATION.
    N/AN/ARequired *
    associationChairPersonThe complete name of an association chairperson, secretary, or treasurer.
    Note: This field is required only for ASSOCIATION.
    N/AN/ARequired *

    legalDetails object

    An object within the businessDetails object that contains legal details.

    PropertyDescriptionGovernment
    Private
    Sole trader
    PublicAssociation
    Partner
    Trust
    registeredDateThe date the business was registered entered in the YYYY-MM-DD format. Registered date cannot be future date.RequiredRequiredRequired
    registeredCountryThe country where the business is registered, specified in the ISO 3166 format.RequiredRequiredRequired
    listedExchangeThe exchange where the business is publicly listed. Use Fetch corporate constants API for a valid set of values.N/ARequiredN/A

    regulatoryDetails array

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

    PropertyDescriptionGovernment
    Private
    Sole trader
    PublicAssociation
    Partner
    Trust
    unregulatedTrustTypeUnregulated trust type details.
    Note: This field is required only for TRUST. This field is an array.
    N/AN/ARequired *

    addresses object

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

    PropertyDescriptionGovernment
    Private
    Sole trader
    PublicAssociation
    Partner
    Trust
    registeredAddressAn object that contains the address where the business is registered.RequiredRequiredRequired
    businessAddressAn 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.

    PropertyDescriptionGovernment
    Private
    Sole trader
    PublicAssociation
    Partner
    Trust
    addressLine1The first address line of the registered business.RequiredRequiredRequired
    addressLine2The second address line of the registered business.OptionalOptionalOptional
    cityThe city where the corporate customer is registered.OptionalOptionalOptional
    stateThe state where the corporate customer is registered.OptionalOptionalOptional
    countryThe country where the corporate customer is registered, specified in the ISO 3166 format.RequiredRequiredRequired
    postcodeThe postal code where the corporate customer is registered.RequiredRequiredRequired

    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.

    PropertyDescriptionGovernment
    Private
    Sole trader
    PublicAssociation
    Partner
    Trust
    addressLine1The first address line of the principal place of business if different than the registered business.Required *Required *Required *
    addressLine2The second address line of the principal place of business if different than the registered business.OptionalOptionalOptional
    cityThe city of the principal place of business if different than the registered address.OptionalOptionalOptional
    stateThe state of the principal place of business if different than the registered address.OptionalOptionalOptional
    countryThe country where the principal place of business occurs if different than the registered country, specified in the ISO 3166 format.Required *Required *Required *
    postcodeThe 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.

    PropertyDescriptionGovernment
    Private
    Sole trader
    PublicAssociation
    Partner
    Trust
    documentTypeThe type of business document. Use Fetch corporate constants API for a valid set of values.Required *Required *Required *
    documentAn array of object that contains a copy of the document.Required *Required *Required *

    document object

    An array of object within the businessDetails.documentDetails object.

    PropertyDescriptionGovernment
    Private
    Sole trader
    PublicAssociation
    Partner
    Trust
    fileNameThe name of the file.Required *Required *Required
    fileTypeThe type of the file. Valid types are application/pdf, image/jpeg, image/jpg, image/png, jpeg, jpg, and png.Required *Required *Required
    documentThe file as a base64 encoded string.Required *Required *Required

    additionalInfo object

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

    PropertyDescriptionGovernment
    Private
    Sole trader
    PublicAssociation
    Partner
    Trust
    isSameBusinessAddressThis field accepts Yes or No to indicate if the principal place of business is the same or different from the registered business entity address.OptionalOptionalOptional
    searchIdThis field is required for eKYB and is returned in the response of the Exhaustive Corporate Details using Business ID API.ConditionalConditionalConditional

    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.

    PropertyDescriptionGovernment
    Private
    Sole trader
    PublicAssociation
    Partner
    Trust
    referenceIdThe 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.OptionalOptionalOptional
    stakeholderDetailsAn object that contains the details about the individual stakeholder. Required only if an individual stakeholder exists.RequiredRequiredRequired
    businessPartnerAn object that contains the details about the corporate stakeholder, if available. Required only if a business partner exists.RequiredRequiredRequired

    stakeholderDetails object

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

    PropertyDescriptionGovernment
    Private
    Sole trader
    PublicAssociation
    Partner
    Trust
    kycModeThe 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 *
    firstNameThe first name of the individual stakeholder.RequiredRequiredRequired
    middleNameThe middle name of the individual stakeholder.OptionalOptionalOptional
    lastNameThe last name of the individual stakeholder.RequiredRequiredRequired
    nationalityThe nationality of the individual stakeholder.RequiredRequiredRequired
    dateOfBirthThe date the individual stakeholder was born in the YYYY-MM-DD format. Date of birth cannot be future date.OptionalOptionalOptional
    professionalDetailsThe array of professional details about the individual stakeholder.RequiredRequiredRequired
    addressAn object that contains the residential address of the individual stakeholder. This field is required only if position = DIRECTOR, UBO, SIGNATORY, REPRESENTATIVE, TRUSTEE, PARTNERRequired *Required *Required *
    contactDetailsAn object that contains the contact details about the individual stakeholder.OptionalOptionalOptional
    documentDetailsAn 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.

    PropertyDescriptionGovernment
    Private
    Sole trader
    PublicAssociation
    Partner
    Trust
    positionThe position of the individual stakeholder. Use Fetch corporate constants API for a valid set of values.RequiredRequiredRequired
    sharePercentageThe share percentage of the individual stakeholder in the company.OptionalOptionalOptional

    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

    PropertyDescriptionGovernment
    Private
    Sole trader
    PublicAssociation
    Partner
    Trust
    addressLine1The first address line of the individual stakeholder.Required *Required *Required *
    addressLine2The second address line of the individual stakeholder.OptionalOptionalOptional
    cityThe city or suburb of the individual stakeholder.OptionalOptionalOptional
    stateThe state of the individual stakeholder.OptionalOptionalOptional
    countryThe country where the individual stakeholder resides, specified in the ISO 3166 format.Required *Required *Required *
    postcodeThe 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.

    PropertyDescriptionGovernment
    Private
    Sole trader
    PublicAssociation
    Partner
    Trust
    emailThe individual stakeholder's email address.OptionalOptionalOptional
    contactNoThe contact phone number of the individual stakeholder.OptionalOptionalOptional

    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.

    PropertyDescriptionGovernment
    Private
    Sole trader
    PublicAssociation
    Partner
    Trust
    documentTypeThe type of document. Use Fetch corporate constants API for a valid set of values.Required *Required *Required *
    documentNumberThe ID number for the given document type.Required *Required *Required *
    documentIssuanceCountryThe country that issued the business document, specified in the ISO 3166 format.
    This field is required for NATIONAL_ID, DRIVER_LICENCE, and PASSPORT.
    Required *Required *Required *
    documentExpiryDateThe date the document will expire in YYYY-MM-DD format.
    Note: This field is required for DRIVER_LICENCE and PASSPORT. Expiry date cannot be past date.
    Required *Required *Required *
    documentAn 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.

    PropertyDescriptionGovernment
    Private
    Sole trader
    PublicAssociation
    Partner
    Trust
    fileNameThe name of the file.Required *Required *Required *
    fileTypeThe type of the file. Valid types are application/pdf, image/jpeg, image/jpg, image/png, jpeg, jpg, and png.Required *Required *Required *
    documentThe 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.

    PropertyDescriptionGovernment
    Private
    Sole trader
    PublicAssociation
    Partner
    Trust
    businessNameThe registered business name of the corporate stakeholder.RequiredRequiredRequired
    businessRegistrationNumberThe business registration number.RequiredRequiredRequired
    businessEntityTypeThe position of the corporate stakeholder in the company. Use Fetch corporate constants API for a valid set of values.RequiredRequiredRequired
    sharePercentageThe share percentage of the corporate stakeholder in the company.OptionalOptionalOptional
    legalDetailsAn object that contains the legal details about the corporate stakeholder.RequiredRequiredRequired

    legalDetails object

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

    PropertyDescriptionGovernment
    Private
    Sole trader
    PublicAssociation
    Partner
    Trust
    registeredCountryThe country where the corporate stakeholder is registered, specified in the ISO 3166 format.RequiredRequiredRequired

    applicantDetails object

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

    PropertyDescriptionGovernment
    Private
    Sole trader
    PublicAssociation
    Partner
    Trust
    referenceIdThe 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.OptionalOptionalOptional
    kycModeThe 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 KYCRequiredRequiredRequired
    firstNameThe first name of the applicant. The maximum length is 40 alphabetic characters or spaces.RequiredRequiredRequired
    middleNameThe middle name of the applicant. Maximum length is 40 alphabetic characters or spaces.OptionalOptionalOptional
    lastNameThe last name or the applicant. The maximum length is 40 alphabetic characters or spaces.RequiredRequiredRequired
    nationalityNationality of the applicant. Use Fetch corporate constants API for valid values.RequiredRequiredRequired
    dateOfBirthThe 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.RequiredRequiredRequired
    professionalDetailsAn array of objects that contains the professional details about the applicant.RequiredRequiredRequired
    addressAn object that contains the address of the applicant..RequiredRequiredRequired
    contactDetailsAn object that contains the contact details about the applicant.RequiredRequiredRequired
    documentDetailsAn 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.

    PropertyDescriptionGovernment
    Private
    Sole trader
    PublicAssociation
    Partner
    Trust
    positionThe position of the applicant. Use Fetch corporate constants API for a valid set of values.RequiredRequiredRequired
    sharePercentageThe share percentage of the applicant in the company.OptionalOptionalOptional

    address object

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

    PropertyDescriptionGovernment
    Private
    Sole trader
    PublicAssociation
    Partner
    Trust
    addressLine1The first address line of the applicant. The maximum character length is 40.RequiredRequiredRequired
    addressLine2The second address line of the applicant. The maximum character length is 40.OptionalOptionalOptional
    cityThe city of the applicant. Maximum character length is 20.RequiredRequiredRequired
    stateThe state of the applicant. Maximum character length is 30.OptionalOptionalOptional
    countryThe country where the applicant resides, specified in the ISO 3166 format.RequiredRequiredRequired
    postcodeThe postal code of the applicant. The minimum length is 3 and the maximum length is 10 alphanumeric characters or spaces.RequiredRequiredRequired

    contactDetails object

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

    PropertyDescriptionGovernment
    Private
    Sole trader
    PublicAssociation
    Partner
    Trust
    emailThe applicant's email address. The maximum character length is 40 and needs to be a valid email address. See Email regexRequiredRequiredRequired
    countryCode.The country code of the applicant's phone number.RequiredRequiredRequired
    contactNoThe applicant's phone number. The maximum length is 20 numeric characters.RequiredRequiredRequired

    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.

    PropertyDescriptionGovernment
    Private
    Sole trader
    PublicAssociation
    Partner
    Trust
    documentTypeThe type of document. Use Fetch corporate constants API for a valid set of values.Required *Required *Required *
    documentNumberThe ID number for the given document type.Required *Required *Required *
    documentIssuanceCountryThe country that issued the business document, specified in the ISO 3166 format. This is required only if documentType = DRIVER_LICENCE, NATIONAL_ID, PASSPORT.Required *Required *Required *
    documentExpiryDateThe date the document expires in theYYYY-MM-DD format. This is required only if documentType = DRIVER_LICENCE, PASSPORT. Expiry date should not be past date.Required *Required *Required *
    documentAn array of objects that contains the copy of the document. For details, see SG required documents. Required only for MANUAL_KYCRequired *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.

    PropertyDescriptionGovernment
    Private
    Sole trader
    PublicAssociation
    Partner
    Trust
    fileNameThe name of the file.Required *Required *Required *
    fileTypeThe file type. Valid types are application/pdf, image/jpeg, image/jpg, image/png, jpeg, jpg, and png.Required *Required *Required *
    documentThe 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.

    PropertyDescriptionGovernment
    Private
    Sole trader
    PublicAssociation
    Partner
    Trust
    totalEmployeesThe corporate customer's total number of employees. Use Fetch corporate constants API for a valid set of values.RequiredRequiredRequired
    annualTurnoverThe corporate customer's amount of annual turnover. Use Fetch corporate constants API for a valid set of values.RequiredRequiredRequired
    industrySectorThe corporate customer's industry sector. Use Fetch corporate constants API for a valid set of values.RequiredRequiredRequired
    countryOfOperationAn array of countries the corporate customer operates in, specified in the ISO 3166 format.RequiredRequiredRequired
    transactionCountriesAn array of countries where the transactions occur, specified in the ISO 3166 format.RequiredRequiredRequired
    intendedUseOfAccountThe customer's intended use of the account. Use Fetch corporate constants API for a valid set of values.RequiredRequiredRequired

    deviceDetails object

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

    PropertyDescriptionGovernment
    Private
    Sole trader
    PublicAssociation
    Partner
    Trust
    countryIPCountry of the IP address e.g. US. Use Use Fetch corporate constants API for valid values.RequiredRequiredRequired
    deviceInfoInformation of the device e.g. Mac OS.RequiredRequiredRequired
    ipAddressIP address of the device e.g. 45.48.241.198RequiredRequiredRequired
    sessionIdA unique identifier for the session, generated by your application.RequiredRequiredRequired

    tags object

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

    PropertyDescriptionGovernment
    Private
    Sole trader
    PublicAssociation
    Partner
    Trust
    keyThe name of the tag. The maximum character length is 128. Key should be unique.OptionalOptionalOptional
    valueThe value of the tag. The maximum character length is 256.OptionalOptionalOptional