UK required parameters
The API fields shown on this page are relevant to the UK regulatory region only. To see the full payload, refer to the Unified Add Customer API Reference.
Required Parameters
The following table is used when kycMode = E_DOC_VERIFY.
| Field Name | Description | Required |
|---|---|---|
firstName | This field contains the first name of the customer. The maximum limit is 40 characters. | Yes |
middleName | This field contains the middle name of the customer. The maximum limit is 40 characters. | No |
lastName | This field contains the last name of the customer. The maximum limit is 40 characters. | 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 limit is 20 numerals. | Yes |
email | This field contains the email address of the customer which must not already be in the system. The maximum limit is 60 characters. | 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_DOC_VERIFY for UK customers. | Yes |
billingAddress1 | This field contains the first line of the customer’s billing address. The maximum limit is 40 characters. | Yes |
billingAddress2 | This field contains the second line of the customer's billing address. The maximum limit is 40 characters. | No |
billingCity | This field contains the city of the customer’s billing address. The maximum limit is 20 characters. | Yes |
billingLandmark | This field contains the landmark for the customer’s billing address. The maximum limit is 40 characters. | No |
billingState | This field contains the state of the customer's billing address. The maximum limit is 30 characters. | No |
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 limit is 10 characters. | 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 limit is 64 characters. | No |
verificationConsent | This field specifies if the electronic verification consent to process customer data for compliance is required or not. | Yes |
additionalInfo | This field contains additional information. | No |
intendedUseOfAccount | This field contains the customer’s intended use of their account. Use Fetch corporate constants API for valid values. | Yes |
estimatedMonthlyFundingCurrency | This field contains the 3-letter ISO-4217 currency code in which estimated monthly funding is expected in the wallet. | Yes |
estimatedMonthlyFunding | This field contains the estimated monthly funding amount expected in the wallet. Note: This field is required when the estimatedMonthlyFundingCurrency field is provided in the request. Use Fetch corporate constants API for valid values. | Yes * |
internationalPaymentsSupported | This field specifies if the customer will be doing International send/receive/card payments. The default value is false. | Yes * |
expectedCountriesToSendReceiveFrom | This array specifies the 2-letter ISO Alpha-2 country codes that the client expects their international payment to be spent in, sent to, or received from. Note: This field is required when the internationalPaymentsSupported field is true. | Yes * |
tags | This object contains the user defined key-value pairs provided by the client. The maximum number of tags allowed is 15. | No |
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 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 * |
Updated 7 months ago