CA required parameters

The page details the fields that are required to onboard individual Canadian customers. To review the request in it's entirety, see the Unified Add Customer request.

Required Parameters

The following table details the fields required to onboard individual customers in Canada.

Field NameDescriptionRequired
firstNameThis field contains the first name of the customer.
The maximum character limit is 40.
Yes
middleNameThis field contains the middle name of the customer.
The maximum character limit is 40.
No
lastNameThis field contains the last name of the customer.
The maximum character limit is 40.
Yes
nationalityThis field contains the 2-letter ISO Alpha-2 country code denoting the customer's citizenship.Yes
complianceLevelThis 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
countryCodeThis field contains the 2-letter ISO Alpha-2 country code denoting the country prefix code to the customer's mobile number.Yes
mobileThis 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
emailThis field contains the email address of the customer which must not already be in the system.
The maximum character limit is 60.
Yes
dateOfBirthThis 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
kycModeThis field can accept only E_KYC for CA customers.Yes
billingAddress1This field contains the first line of the customer’s billing address.
The maximum character limit is 40.
Yes
billingAddress2This field contains the second line of the customer's billing address.
The maximum character limit is 40.
No
billingCityThis field contains the city of the customer’s billing address.
The maximum character limit is 20.
Yes
billingLandmarkThis field contains the landmark for the customer’s billing address.
The maximum character limit is 40.
No
billingStateThis field contains the state of the customer's billing address.
The maximum character limit is 30.
Yes
billingZipCodeThis field contains the ZIP code of the customer’s billing address.
The maximum alphanumeric character limit is 10.
Yes
billingCountryThis field contains the 2-letter ISO Alpha-2 country code denoting the country of the customer's billing address.Yes
deviceInfoThis field contains the OS of the device used by the customer for initiating the request.No
occupationThis field contains the identification type for the document being uploaded for KYC. Use Fetch Corporate Constants for valid values.Yes
ipAddressThis field contains the IP address of the device used by the customer for initiating the request.No
countryIPThis field contains the country IP address for the device by the customer for initiating the request.No
sessionIdThis field contains the session ID of the customer's session that is initiating the request.No
segmentThis field contains the fee segment associated with a client.
The maximum character limit is 64.
No
identificationDocThis array of objects contains identification documents.
The maximum size of this array is 10 MB.
Yes
additionalInfoThis field contains additional information.No
tagsThis object contains the user defined key-value pairs provided by the client.
The maximum number of tags allowed is 15.
No

identificationDoc object

This array of objects contains identification documents. The maximum size of this array is 10 MB.

Field nameDescriptionRequired
identificationTypeThis field contains the name of the document type being uploaded.Yes
identificationValueThis field contains the unique document identifier.Yes

tags object

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

Field nameDescriptionRequired
keyThis 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 *
valueThis 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 *