CA required parameters

The API fields shown on this page are relevant to Canada 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 Canada -based customer, use the CA value.Yes
businessDetailsAn object that accepts 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 accepts the Nium client ID of the customer. It's received in the response to the previously executed Onboard Corporate Customer API.
Note: This field is required to reinitiate the KYB process.
Yes *
customerHashIdThis field accepts the unique customer identifier generated at the time of customer creation. It's received in the response to 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:

PublicTrustOther entity
PUBLIC_COMPANY
  • TRUST
  • WIDELY_HELD_TRUST
  • PRIVATE_COMPANY
  • CHARITY
  • PARTNERSHIP
  • SOLE_TRADER
  • businessDetails object

    An object that accepts business details about the corporate customer.

    PropertyDescriptionPublicTrustOther entity
    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. For US customers, pass only the employer identification number (TIN). This field accepts only 9 digits.RequiredRequiredRequired
    tradeNameAnother name that the corporate customer uses to do business under, which is different than their licensed business name.OptionalOptionalOptional
    websiteA company's set of related web pages located under a single domain name.OptionalOptionalOptional
    businessTypeThe legal entity type of the business. Use Fetch corporate constants API for a valid set of values.RequiredRequiredRequired
    descriptionA brief overview of the business. Max character length is 65535.RequiredRequiredRequired
    stockSymbolThe publicly traded stock or ticker symbol of the business.OptionalN/AN/A
    taxDetailsAn array of objects for Tax identification number of the entityRequiredRequiredRequired
    legalDetailsAn object that contains the legal details.RequiredRequiredRequired
    addressesAn object that contains the registered address and the business address of the corporate customer.RequiredRequiredRequired
    documentDetailsAn array of object that contains the business documents.
    Note: This object is required for MANUAL_KYB.
    Required *Required *Required *
    stakeholdersAn array of object 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

    taxDetails array

    An array of objects within the businessDetails object that contains multiple values of taxation details of the corporate customer.

    PropertyDescriptionRequired
    countryThis field will be CARequired
    taxNumberThe tax ID number of the business as found in tax filings.Required

    legalDetails object

    An object within the businessDetails object that accepts legal details.

    PropertyDescriptionRequired
    registeredDateThe date the business is registered entered in the YYYY-MM-DD format. Registered date cannot be future date.Required | Optional for Charity
    registeredCountryThe country where the business is registered. Use Fetch corporate constants API for a valid set of values.Required | Optional for Charity
    listedExchangeThe exchange where the business is publicly listed. Use Fetch corporate constants API for a valid set of values.Required for Public Company

    addresses object

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

    PropertyDescriptionRequired
    registeredAddressAn object that contains the address where the business is registered.Required
    businessAddressAn object that contains the address where the business correspondence can be conducted, if different than the registered address. This will also be the communication address.
    Note: This is required if isSameBusinessAddress=No
    Required *

    registeredAddress object

    An object within the businessDetails.address object that accepts the address details where the corporate customer is registered.

    PropertyDescriptionRequired
    addressLine1The first address line of the registered business.Required
    addressLine2The second address line of the registered business.Optional
    cityThe city where the corporate customer is registered.Required
    stateThe state where the corporate customer is registered. Use Fetch corporate constants API for a valid set of values.Required
    countryThe country where the corporate customer is registered. Use Fetch corporate constants API for a valid set of values.Required
    postcodeThe postal code where the corporate customer is registered. postcode is alphanumeric and follows the format 'A1A 1A1' e.g. , K1A 0T6Required

    businessAddress object

    An object within the businessDetails.address object that accepts the address details where the business correspondence can be conducted, if different than the registered address

    * This object is required if isSameBusinessAddress = No.

    PropertyDescriptionRequired
    addressLine1The first address line of the principal place of business if different than the registered business.Required *
    addressLine2The second address line of the principal place of business if different than the registered business.Optional
    cityThe city of the principal place of business if different than the registered address.Required *
    stateThe state of the principal place of business if different than the registered address. Use Fetch corporate constants API for a valid set of values.Required *
    countryThe country where the principal place of business occurs if different than the registered country. Use Fetch corporate constants API for a valid set of values.Required *
    postcodeThe postal code where the principal place of business occurs if different than the registered address. postcode is alphanumeric and follows the format 'A1A 1A1' e.g. , K1A 0T6Required *

    documentDetails array

    An array of objects within the businessDetails object that accepts one or more business documents.

    PropertyDescriptionRequired
    documentTypeThe type of business document. Use Fetch corporate constants API for a valid set of values.Required *
    documentAn object that contains a document copy.Required *

    document array

    An array of objects within the businessDetails.documentDetails object.

    PropertyDescriptionRequired
    fileNameThe name of the file.Required *
    fileTypeThe type of the file. Valid types are application/pdf, image/jpeg, image/jpg, image/png, jpeg, jpg, and png.Required *
    documentThe file as a base64 encoded string.Required *

    stakeholders object

    An array of objects within the businessDetails object that accepts one or many stakeholders' information.

    For every stakeholder object, send either the stakeholderDetails or the businessPartner parameters.

    PropertyDescriptionRequired
    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.Optional
    stakeholderDetailsAn object that contains the details about the individual stakeholder.Required
    businessPartnerAn object that contains the details of the corporate stakeholder, if available.Required

    stakeholderDetails object

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

    PropertyDescriptionRequired
    kycModeThe KYC mode for verifying the individual stakeholder. You can ignore this field as stakeholder KYC is not required.Optional
    firstNameThe first name of the individual stakeholder.Required
    middleNameThe middle name of the individual stakeholder.Optional
    lastNameThe last name of the individual stakeholder.Required
    nationalityThe nationality of the individual stakeholder.Required
    dateOfBirthThe date the individual stakeholder was born in the YYYY-MM-DD format. Date of birth cannot be a future date.Required if the position is UBO
    professionalDetailsThe professional details of the individual stakeholder. This field is an array.Required
    addressAn object that contains the residential address of the individual stakeholder.Required if the position is UBO
    contactDetailsAn object that contains the contact details of the individual stakeholderOptional

    professionalDetails object

    An array of object within the businessDetails.stakeholders.stakeholderDetails object that contains the individual stakeholder's professional details.

    PropertyDescriptionRequired
    positionThe position of the individual stakeholder.
    Use Fetch corporate constants API for a valid set of values.
    Required
    sharePercentageThe share percentage of the individual stakeholder in the company.Required when Position is UBO

    addresses object

    An object within the businessDetails.stakeholders.stakeholderDetails object that contains the individual stakeholder's residential address.

    PropertyDescriptionRequired
    addressLine1The first address line of the individual stakeholder.Required
    addressLine2The second address line of the individual stakeholder.Optional
    cityThe city or suburb of the individual stakeholder.Required
    stateThe state of the individual stakeholder.Required
    countryThe country where the individual stakeholder resides, specified in ISO 3166 format.Required
    postcodeThe postal code of the individual stakeholder.Required

    contactDetails object

    An optional object within the businessDetails.stakeholders.stakeholderDetails object that contains the individual stakeholder's contact information.

    PropertyDescriptionPublicTrustOther entity
    emailThe individual stakeholder's email address.OptionalOptionalOptional
    contactNoThe contact phone number of the individual stakeholder.OptionalOptionalOptional

    businessPartner

    An object within the businessDetails.stakeholders object with the business details of the corporate stakeholder.

    * This object is required if there's a corporate stakeholder.

    PropertyDescriptionRequired
    businessNameThe registered business name of the corporate stakeholder.Required
    businessRegistrationNumberThe business registration number.Required
    businessEntityTypeThe position of the corporate stakeholder in the company. Use Fetch corporate constants API for a valid set of values.Required
    sharePercentageThe share percentage of the corporate stakeholder in the company.
    Note: If the corporate stakeholder’s position is UBO, then the share percentage is a required input parameter.
    Required *
    legalDetailsAn object that contains the legal details of the corporate stakeholder.Required

    legalDetails object

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

    PropertyDescriptionPublicTrustOther entity
    registeredCountryThe country where the corporate stakeholder is registered. Use Fetch corporate constants API for a valid set of values.RequiredRequiredRequired

    applicantDetails object

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

    PropertyDescriptionRequired
    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.Optional
    kycModeThe KYC mode for verifying the identity of the applicant. Valid values are E_KYC , E_DOC_VERIFY, and MANUAL_KYC.Required
    firstNameThe first name of the applicant. The maximum length is 40 alphabetic characters or spaces.Required
    middleNameThe middle name of the applicant. The maximum length is 40 alphabetic characters or spaces.Optional
    lastNameThe last name or the applicant. The maximum length is 40 alphabetic characters or spaces.Required
    nationalityThe nationality of the applicant.Required
    dateOfBirthThe date when the applicant is born in the YYYY-MM-DD format. Date of birth cannot be a future date. Applicant cannot be less than 18 yrs of age.Required
    occupationOccupation of applicant. Use Fetch corporate constants API for a valid set of values.Required
    professionalDetailsAn array of objects that contains the professional details of the applicant.Required
    addressAn object that contains the address of the applicant.Required
    contactDetailsAn object that contains the contact details of the applicant.Required
    documentDetailsAn array of objects that contains the document details of the applicant.Required if kycMode is MANUAL_KYC
    additionalInfoAn object that contains additional information about the applicant.Required

    professionalDetails object

    An array of objects within the businessDetails.applicantDetails object that contains the professional details of the applicant.

    PropertyDescriptionRequired
    positionThe position of the applicant. Use Fetch corporate constants API for a valid set of values.Required
    sharePercentageThe share percentage of the applicant in the company.
    Note: This field is a required input parameter if the applicant's position is UBO.
    Required when positionis UBO or PARTNER

    address object

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

    PropertyDescriptionPublicTrustOther entity
    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. The maximum character length is 20.RequiredRequiredRequired
    stateThe state of the applicant. The Maximum character length is 30.RequiredRequiredRequired
    countryThe country where the applicant resides, specified in 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.

    PropertyDescriptionPublicTrustOther entity
    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.

    PropertyDescriptionRequired
    documentTypeThe type of document. Use Fetch corporate constants API for a valid set of values.Required
    documentNumberThe ID number for the given document type.Required
    documentIssuanceCountryThe country that issued the business document, specified in the ISO 3166 format.Required
    documentExpiryDateThe date the document expires in the YYYY-MM-DD format.
    Note: This field is required if documentType = PASSPORT or DRIVER_LICENCE. Expiry date cannot be a past date.
    Required *
    documentAn array of objects that contains the copy of the document.
    Note: This field is required for MANUAL_KYC.
    Required *

    document object

    An array of objects within the businessDetails.applicantDetails.documentDetails object that contains the document copy.

    * This object is required for MANUAL_KYC.

    PropertyDescriptionRequired
    fileNameThe name of the file.Required *
    fileTypeThe file type. Valid types are application/pdf, image/jpeg, image/jpg, image/png, jpeg, jpg, and png.Required *
    documentThe document saved as a base64 encoded string.Required *

    additionalInfo object

    An object within the businessDetails.applicantDetails object that contains additional information about the applicant.

    While building the form, you should ensure that the applicant declaration is a checkbox that is collected on a separate page after the applicant has already filled the Stakeholder information. This page should show the list of all stakeholders in view mode. The applicant declaration text should imply the following statements objectively:

    • The List of UBOs and their details provided are complete and verified by the applicant
    • The List of directors and their details provided are complete and verified by the applicant
    • All the other information provided by the applicant is complete and verified.
    PropertyDescriptionRequired
    applicantDeclarationThis field accepts the declaration from the Applicant. The only valid value is Yes.Required

    additionalInfo object

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

    PropertyDescriptionPublicTrustOther entity
    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.
    Note: This field is required if Yes; optional if No.
    OptionalOptionalOptional

    riskAssessmentInfo object

    An object that contains the following details that are required to determine a corporate customer's risk profile.

    PropertyDescriptionRequired
    totalEmployeesThe corporate customer's total number of employees. Use Fetch corporate constants API for a valid set of values.Required
    annualTurnoverThe corporate customer's amount of annual turnover. Use Fetch corporate constants API for a valid set of values.Required
    industrySectorThe corporate customer's industry sector. Use Fetch corporate constants API for a valid set of values.Required
    countryOfOperationAn array of countries the corporate customer operates in. Use Fetch corporate constants API for a valid set of values.Required
    transactionCountriesAn array of countries where the transactions occur. Use Fetch corporate constants API for a valid set of values.Required
    intendedUseOfAccountThe customer's intended use of the account. Use Fetch corporate constants API for a valid set of values.Required

    deviceDetails object

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

    PropertyDescriptionRequired
    countryIPCountry of the IP address e.g. US. Use Fetch corporate constants API for valid values.Required
    deviceInfoInformation of the device e.g. Mac OS.Required
    ipAddressIP address of the device e.g. 45.48.241.198Required
    sessionIdA unique identifier for the session, generated by your application.Required

    tags object

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

    PropertyDescriptionRequired
    keyThe name of the tag. The maximum character length is 128. Key should be unique.Optional
    valueThe value of the tag. The maximum character length is 256.Optional