US required parameters
The API fields shown on this page are relevant to the US regulatory region only. To see the full payload, refer to the Unified Add Customer API Reference.
Required Parameters
The following table is used for customer onboarding in the US.
| Field Name | Description | Required |
|---|---|---|
firstName | This field contains the first name of the customer. The maximum character limit is 40. | Yes |
middleName | This field contains the middle name of the customer. The maximum character limit is 40. | No |
lastName | This field contains the last name of the customer. The maximum character limit is 40. | Yes |
nationality | This field contains the 2-letter ISO Alpha-2 country code denoting the customer's citizenship. | Yes |
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. | No |
countryCode | This field contains the 2-letter ISO Alpha-2 country code denoting the country prefix code to the customer's mobile number. | Yes |
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. | Yes |
email | This field contains the email address of the customer which must not already be in the system. The maximum character limit is 60. | Yes |
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. | Yes |
kycMode | This field can accept only E_KYC for US customers. | Yes |
billingAddress1 | This field contains the first line of the customer’s billing address. The maximum character limit is 40. | Yes |
billingAddress2 | This field contains the second line of the customer's billing address. The maximum character limit is 40. | No |
billingCity | This field contains the city of the customer’s billing address. The maximum character limit is 20. | Yes |
billingLandmark | This field contains the landmark for the customer’s billing address. The maximum character limit is 40. | No |
billingState | This field contains the state of the customer's billing address. The maximum character limit is 30. | Yes |
billingZipCode | This field contains the ZIP code of the customer’s billing address. The maximum alphanumeric character limit is 10. | Yes |
billingCountry | This field contains the 2-letter ISO Alpha-2 country code denoting the country of the customer's billing address. | Yes |
deviceInfo | This field contains the OS of the device used by the customer for initiating the request. | No |
ipAddress | This field contains the IP address of the device used by the customer for initiating the request. | No |
countryIP | This field contains the country IP address for the device by the customer for initiating the request. | No |
sessionId | This field contains the session ID of the customer's session that is initiating the request. | No |
segment | This field contains the fee segment associated with a client. The maximum character limit is 64. | No |
| identificationDoc | This array of objects contains identification documents. The maximum size of this array is 10 MB. | Yes |
additionalInfo | This field contains additional information. | No |
| tags | This object contains the user defined key-value pairs provided by the client. The maximum number of tags allowed is 15. | No |
identificationDoc object
identificationDoc objectThis array of objects contains identification documents. The maximum size of this array is 10 MB.
| Field name | Description | Required |
|---|---|---|
identificationType | This field contains the name of the document type being uploaded. | Yes |
identificationValue | This field contains the unique document identifier. | Yes |
tags object
tags objectThis 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 character limit is 128. 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 character limit is 256. Note: This field is required if the key field is provided in the request. | Yes * |
Updated 4 months ago