SG required parameters

The API fields shown on this page are relevant to the SG regulatory region only. To see the full payload, refer to the Unified Add Customer API Reference.

Required Parameters

The following table list which parameters are required for each KYC mode.

Field Name	Description	eKYC	eDocVerify	Manual KYC
`firstName`	This field contains the first name of the customer. The maximum limit is 40 characters.	N/A	Required	Required
`middleName`	This field contains the middle name of the customer. The maximum limit is 40 characters.	N/A	Optional	Optional
`lastName`	This field contains the last name of the customer. The maximum limit is 40 characters.	N/A	Required	Required
`nativeLanguageName`	The field contains the customer's name in their native language. If the customer's name is mentioned in their native language in their identity document, then this information should be provided for ease of verification. The maximum limit is 40 characters or 20 double-byte characters.	N/A	Optional	Optional
`nationality`	This field contains the 2-letter ISO Alpha-2 country code denoting the customer's citizenship.	N/A	Required	Required
`complianceLevel`	This field contains the compliance level for the customer. It is useful when the client has multiple compliance setups. The possible values are `SCREENING` and `SCREENING_KYC`.	Optional	Optional	Optional
`countryCode`	This field contains the 2-letter ISO Alpha-2 country code denoting the country prefix code to the customer's mobile number.	Required	Required	Required
`mobile`	This field contains the mobile number of the customer without the country prefix code. The maximum character limit is 20 and can contain only numerals.	Required	Required	Required
`email`	This field contains the email address of the customer which must not already be in the system. The maximum character limit is 60.	Required	Required	Required
`dateOfBirth`	This field contains the customer's date of birth in `YYYY-MM-DD` format. Customers need to be at least 18 years old. For any special use cases, discuss with your Nium account manager.	N/A	Required	Required
`kycMode`	This field contains the KYC mode used during verification.	`E_KYC`	`E_DOC_VERIFY`	`MANUAL_KYC`
`billingAddress1`	This field contains the first line of the customer’s billing address. The maximum character limit is 40.	N/A	Required	Required
`billingAddress2`	This field contains the second line of the customer's billing address. The maximum character limit is 40.	N/A	Optional	Optional
`billingCity`	This field contains the city of the customer’s billing address. The maximum character limit is 20.	N/A	Required	Required
`billingLandmark`	This field contains the landmark for the customer’s billing address. The maximum character limit is 40.	N/A	Optional	Optional
`billingState`	This field contains the state of the customer's billing address. The maximum character limit is 30.	N/A	Optional	Optional
`billingZipCode`	This field contains the postcode of the customer’s billing address. For UK, specify the postcode value in the following `SW4 6EH` format. The maximum alphanumeric character limit is 10.	N/A	Required	Required
`billingCountry`	This field contains the 2-letter ISO Alpha-2 country code denoting the country of the customer's billing address.	N/A	Required	Required
`deviceInfo`	This field contains the OS of the device used by the customer for initiating the request.	Optional	Optional	Optional
`ipAddress`	This field contains the IP address of the device used by the customer for initiating the request.	Optional	Optional	Optional
`countryIP`	This field contains the country IP address for the device by the customer for initiating the request.	Optional	Optional	Optional
`sessionId`	This field contains the session ID of the customer's session that is initiating the request.	Optional	Optional	Optional
`segment`	This field contains the fee segment associated with a client. The maximum character limit is 64.	Optional	Optional	Optional
`identificationDoc`	This field contains an array which contains identification documents. The maximum array size is 10 MB.	N/A	N/A	Required
`identificationType`	This field contains the identification type for the document being uploaded for KYC. Use Fetch corporate constants API for valid values.	N/A	N/A	Required
`identificationValue`	This field contains the identification value. Note: Required depending on the identification document type	N/A	N/A	Required *
`identificationIssuingDate`	This field contains the identification document issuing date. Note: Required depending on the identification document type	N/A	N/A	Required *
`identificationDocExpiry`	This field contains the identification document expiration date. Note: Required depending on the identification document type	N/A	N/A	Required *
`identificationDocIssuanceCountry`	This field contains the country that issued the identification document. Note: Required depending on the identification document type	N/A	N/A	Required *
`identificationDocument`	This field contains the document saved as a base64 encoded string.	N/A	N/A	Required
`fileName`	This field contains the name of the file being uploaded.	N/A	N/A	Required
`fileType`	This field contains the type of the file being uploaded. The supported file types are: `JPG` `PNG` `PDF`	N/A	N/A	Required
`document`	This field contains the base64 encoded document being uploaded.	N/A	N/A	Required
`verificationConsent`	This field specifies if the electronic verification consent to process customer data for compliance is required or not.	N/A	Required	N/A
`additionalInfo`	This field contains additional information.	Optional	Optional	Optional
`tags`	This object contains the user defined key-value pairs provided by the client. The maximum number of tags allowed is 15.	Optional	Optional	Optional

`tags` object

This object contains the user defined key-value pairs provided by the client. The maximum number of tags allowed is 15.

Field name	Description	Required
`key`	This field contains the name of the tag. The maximum limit is 128 characters. Note: This field is required if the `value` field is provided in the request.	Yes *
`value`	This field contains the value of the tag. The maximum limit is 256 characters. Note: This field is required if the `key` field is provided in the request.	Yes *

Required Parameters

tags object

`tags` object