US required fields

📘
NOTE
The API fields shown on this page are relevant to the United States only.
To see the full payload, see API Reference.

📘
NOTE
Throughout this page, the Other entities columns include:

Corporations

Estates

General partnerships

Limited liability companies (LLC)

Limited liability partnership firms

Limited partnerships

Sole trader

Unincorporated associations

Request parameters

Property	Description	Type
`region`	The country or geographic region where the end-corporate customer is located and is onboarded. To onboard a US-based customer, use the `US` value.	Required
businessDetails	An object that accepts business details about the corporate customer.	Required
riskAssessmentInfo	An object for the risk assessment information.	Required
tags	An object for the tags.	Optional
`clientId`	This field accepts the Nium client Id of the customer. It is received in the response of the previously executed Onboard Corporate Customer API. It's required only to re-initiate the KYB process.	Optional
`customerHashId`	This field accepts the unique customer identifier generated at the time of customer creation. It is received in the response of the previously executed Onboard Corporate Customer API. It's required only to re-initiate the KYB process.	Optional

`businessDetails` object

An object that accepts business details about the corporate customer.

Property	Description	Public companies	Trusts	Other entities
`referenceId`	The 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.	Optional	Optional	Optional
`businessName`	The name a corporate customer is registered under.	Required	Required	Required
`businessRegistrationNumber`	The business registration number. For US customers, pass the employer identification number.	Required	Required	Required
`tradeName`	If the corporate customer is doing business under a different name than their licensed business name.	Optional	Optional	Optional
`businessType`	The legal entity type of the business. See Enum values for a valid set of values.	Required	Required	Required
`stockSymbol`	The publicly traded stock or ticker symbol of the business.	Optional	N/A	N/A
legalDetails	An object for the legal details.	Required	Required	Required
regulatoryDetails	An object for the regulatory details.	N/A	Required	N/A
address	An object for the registered and business address of the corporate customer.	Required	Required	Required
documentDetails	An object for the business documents	Required	Required	Required
stakeholders	An object for the individual and corporate stakeholders of the corporate customer.	Required	Required	Required
applicantDetails	An object for the applicant details.	Required	Required	Required
additionalInfo	An object for additional information of the business.	Optional	Optional	Optional

`legalDetails` object

An object within the businessDetails object to accept legal details.

Property	Description	Public companies	Trusts	Other entities
`registeredDate`	The date the business was registered entered in `yyyy-mm-dd` format.	Required	Required	Required
`registeredCountry`	The country where the business is registered, specified in ISO 3166 format.	Required	Required	Required

`regulatoryDetails` object

An object within the businessDetails object to accept the regulatory status of the client.

Property	Description	Public companies	Trusts	Other entities
`unregulatedTrustType`	The array of one or more unregulated trust types. See Enum values for a valid set of values.	N/A	Required	N/A

`address` object

An object within the businessDetails object to accept registered and business addresses.

Property	Description	Public companies	Trusts	Other entities
registeredAddress	An object for the address where the business is registered.	Required	Required	Required
businessAddress	An object for the address where the business is mainly conducted, if different than the registered address.	Optional	Optional	Optional

`registeredAddress` object

An object within the businessDetails.address object to accept the address details where the corporate customer is registered.

Property	Description	Public companies	Trusts	Other entities
`addressLine1`	The first address line of the registered business.	Required	Required	Required
`addressLine2`	The second address line of the registered business.	Optional	Optional	Optional
`city`	The city where the corporate customer is registered.	Required	Required	Required
`state`	The state where the corporate customer is registered.	Required	Required	Required
`country`	The country where the corporate customer is registered, specified in ISO 3166 format.	Required	Required	Required
`postcode`	The postal code where the corporate customer is registered.	Required	Required	Required

`businessAddress` object

An object within the businessDetails.address object to accept the address details of the principal place of business only when the registered address is different.

📘
NOTE
Use these fields only if the principal place of business is different than the registered address.
These fields are required only if isSameBusinessAddress = NO.

Property	Description	Public companies	Trusts	Other entities
`addressLine1`	The first address line of the principal place of business if different than the registered business.	Conditional	Conditional	Conditional
`addressLine2`	The second address line of the principal place of business if different than the registered business.	Optional	Optional	Optional
`city`	The city of the principal place of business if different than the registered address.	Conditional	Conditional	Conditional
`state`	The state of the principal place of business if different than the registered address.	Conditional	Conditional	Conditional
`country`	The country where the principal place of business occurs if different than the registered country, specified in ISO 3166 format.	Conditional	Conditional	Conditional
`postcode`	The postal code where the principal place of business occurs if different than the registered address.	Conditional	Conditional	Conditional

`documentDetails` object

An object within the businessDetails object to accept one or more business documents.

Property	Description	Public companies	Trusts	Other entities
`documentType`	The type of business document. See Enum values for a valid set of values.	Required	Required	Required
document	An object for a copy of the document.	Required	Required	Required

`document` object

A required object within the businessDetails.documentDetails object.

Property	Description	Public companies	Trusts	Other entities
`fileName`	The name of the file.	Required	Required	Required
`fileType`	The type of the file.	Required	Required	Required
`document`	The file as a base64 encoded string.	Required	Required	Required

`stakeholders` object

An object within the businessDetails object to accept one or many stakeholders' information.

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

Property	Description	Public companies	Trusts	Other entities
`referenceId`	The universal unique identifier (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	Optional	Optional
stakeholderDetails	An object for the details of the individual stakeholder.	Required	Required	Required
businessPartner	An object for the details of the corporate stakeholder, if available.	Required	Required	Required

`stakeholderDetails` object

A required object within the stakeholders object for the details of an individual stakeholder.

Property	Description	Public companies	Trusts	Other entities
`kycMode`	The KYC mode for verifying the individual stakeholder. Applicable values are `E_KYC` and `MANUAL_KYC`.	Required	Required	Required
`firstName`	The first name of the individual stakeholder.	Required	Required	Required
`middleName`	The middle name of the individual stakeholder.	Optional	Optional	Optional
`lastName`	The surname of the individual stakeholder.	Required	Required	Required
`nationality`	The nationality of the individual stakeholder.	Required	Required	Required
`dateOfBirth`	The date the individual stakeholder was born in the `yyyy-MM-dd` format.	Required	Required	Required
professionalDetails	The professional details of the individual stakeholder.	Required	Required	Required
address	An object for the residential address of the individual stakeholder.	Required	Required	Required
contactDetails	An object for the contact details of the individual stakeholder.	Optional	Optional	Optional
documentDetails	An object for the document details of the individual stakeholder.	Required	Required	Required

`professionalDetails` object

A required object within the businessDetails.stakeholders.stakeholderDetails object for the individual stakeholder's professional details.

Property	Description	Public companies	Trusts	Other entities
`position`	The position of the individual stakeholder. At least one of the individual stakeholders should have a position as `CONTROL_PRONG`. See Enum values for a valid set of values.	Required	Required	Required
`sharePercentage`	The share percentage of the individual stakeholder in the company. If the individual stakeholder’s position is `ULTIMATE_BENEFICIAL_OWNER`, then the share percentage is a required input parameter.	Conditional	Conditional	Conditional

`address` object

A required object within the businessDetails.stakeholders.stakeholderDetails object for the individual stakeholder's residential address.

Property	Description	Public companies	Trusts	Other entities
`addressLine1`	The first address line of the individual stakeholder.	Required	Required	Required
`addressLine2`	The second address line of the individual stakeholder.	Optional	Optional	Optional
`city`	The city or suburb of the individual stakeholder.	Required	Required	Required
`state`	The state of the individual stakeholder.	Required	Required	Required
`country`	The country where the individual stakeholder resides, specified in ISO 3166 format.	Required	Required	Required
`postcode`	The postal code of the individual stakeholder.	Required	Required	Required

`contactDetails` object

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

Property	Description	Public companies	Trusts	Other entities
`email`	The individual stakeholder's email address.	Optional	Optional	Optional
`contactNo`	The contact phone number of the individual stakeholder.	Optional	Optional	Optional

`documentDetails` object

A required object within the businessDetails.stakeholders.stakeholderDetails object for the individual stakeholder's document details.

Property	Description	Public companies	Trusts	Other entities
`documentType`	The type of document. See enum Values for a valid set of values.	Required	Required	Required
`documentNumber`	The ID number for the given document type.	Required	Required	Required

`businessPartner`

If there is a corporate stakeholder, this is a required object within the businessDetails.stakeholders object with the business details of the corporate stakeholder.

Property	Description	Public companies	Trusts	Other entities
`businessName`	The registered business name of the corporate stakeholder.	Required	Required	Required
`businessRegistrationNumber`	The business registration number.	Required	Required	Required
`businessEntityType`	The position of the corporate stakeholder in the company. See Enum values for a valid set of values.	Required	Required	Required
`sharePercentage`	The share percentage of the corporate stakeholder in the company. If the corporate stakeholder’s position is `ULTIMATE_BENEFICIAL_OWNER`, then the share percentage is a required input parameter.	Conditional	Conditional	Conditional
legalDetails	An object for the legal details of the corporate stakeholder.	Required	Required	Required

`legalDetails` object

A required object within the businessDetails.stakeholders.businessPartner object for the corporate stakeholder's legal details.

Property	Description	Public companies	Trusts	Other entities
`registeredCountry`	The country where the corporate stakeholder is registered, specified in ISO 3166 format.	Required	Required	Required

`applicantDetails` object

A required object within the businessDetails object that contains details about the applicant.

Property	Description	Public companies	Trusts	Other entities
`referenceId`	The 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	Optional	Optional
`kycMode`	The KYC mode for verifying the identity of the applicant. Applicable values are `E_KYC` and `MANUAL_KYC`.	Required	Required	Required
`firstName`	The first name of the applicant. Maximum character length is 40.	Required	Required	Required
`middleName`	The middle name of the applicant. Maximum character length is 40.	Optional	Optional	Optional
`lastName`	The surname or the applicant. Maximum character length is 40.	Required	Required	Required
`nationality`	Nationality of the applicant.	Required	Required	Required
`dateOfBirth`	The date on which the applicant was born in `yyyy-MM-dd` format.	Required	Required	Required
professionalDetails	An object for the professional details of the applicant.	Required	Required	Required
address	An object for the address of the applicant.	Required	Required	Required
contactDetails	An object for the contact details of the applicant.	Required	Required	Required
documentDetails	An object for the document details of the applicant.	Required	Required	Required

`professionalDetails` object

A required object within the businessDetails.applicantDetails object for the professional details of the applicant.

Property	Description	Public companies	Trusts	Other entities
`position`	The position of the applicant. See Enum values for a valid set of values.	Required	Required	Required
`sharePercentage`	The share percentage of the applicant in the company. If the applicant's position is `ULTIMATE_BENEFICIAL_OWNER`, then the share percentage is a required input parameter.	Conditional	Conditional	Conditional

`address` object

A required object within the businessDetails.applicantDetails object for the applicant's residential address.

Property	Description	Public companies	Trusts	Other entities
`addressLine1`	The first address line of the applicant. Maximum character length is 40.	Required	Required	Required
`addressLine2`	The second address line of the applicant. Maximum character length is 40.	Optional	Optional	Optional
`city`	The city of the applicant. Maximum character length is 50.	Required	Required	Required
`state`	The state of the applicant. Maximum character length is 50.	Required	Required	Required
`country`	The country where the applicant resides, specified in ISO 3166 format.	Required	Required	Required
`postcode`	The postal code of the applicant. The character length minimum is 3 and maximum is 10.	Required	Required	Required

`contactDetails` object

A required object within the businessDetails.applicantDetails object for the applicant's contact information.

Property	Description	Public companies	Trusts	Other entities
`email`	The applicant's email address. Maximum character length is 40.	Required	Required	Required
`countryCode`.	The country code of the applicant's phone number.	Required	Required	Required
`contactNo`	The applicant's phone number. Maximum character length is 20.	Required	Required	Required

`documentDetails` object

A required object within the businessDetails.applicantDetails object for the applicant's document information.

Property	Description	Public companies	Trusts	Other entities
`documentType`	The type of document. See Enum values for a valid set of values.	Required	Required	Required
`documentNumber`	The ID number for the given document type.	Required	Required	Required
document	An object for the copy of the document.	Required	Required	Required

`document` object

Applicable only for trusts. A required object within the businessDetails.applicantDetails.documentDetails object for the document copy.

Property	Description	Public companies	Trusts	Other entities
`fileName`	The name of the file.	N/A	Required	N/A
`fileType`	The file type.	N/A	Required	N/A
`document`	The document saved as a base64 encoded string.	N/A	Required	N/A

`additionalInfo` object

This object contains additional information about the business.

Property	Description	Public companies	Trusts	Other entities
`isSameBusinessAddress`	This field accepts `Yes` or `No` to indicate if the principal place of business is the same or different from the registered business entity address.	Optional	Optional	Optional

`riskAssessmentInfo` object

The following are the details required to determine a Risk profile.

Property	Description	Public companies	Trusts	Other entities
`totalEmployees`	The corporate customer's total number of employees. See Enum values for valid values.	Required	Required	Required
`annualTurnover`	The corporate customer's amount of annual employee turnover. See Enum values for valid values.	Required	Required	Required
`industrySector`	The corporate customer's industry sector. See Enum values for valid values.	Required	Required	Required
`countryOfOperation`	The country the corporate customer operates in, specified in ISO 3166 format.	Required	Required	Required
`transactionCountries`	The array of countries where the transactions occur, specified in ISO 3166 format.	Required	Required	Required
`intendedUseOfAccount`	The customer's intended use of the account. See Enum values for valid values.	Required	Required	Required

`tags` object

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

Property	Description	Public companies	Trusts	Other entities
`key`	The name of the tag. The maximum character length is 128.	Optional	Optional	Optional
`value`	The value of the tag. The maximum character length is 256.	Optional	Optional	Optional

US required fields

📘
NOTE

📘
NOTE

Request parameters

`businessDetails` object

`legalDetails` object

`regulatoryDetails` object

`address` object

`registeredAddress` object

`businessAddress` object

📘
NOTE

`documentDetails` object

`document` object

`stakeholders` object

`stakeholderDetails` object

`professionalDetails` object

`address` object

`contactDetails` object

`documentDetails` object

`businessPartner`

`legalDetails` object

`applicantDetails` object

`professionalDetails` object

`address` object

`contactDetails` object

`documentDetails` object

`document` object

`additionalInfo` object

`riskAssessmentInfo` object

`tags` object

📘NOTE

📘NOTE

Request parameters

businessDetails object

legalDetails object

regulatoryDetails object

address object

registeredAddress object

businessAddress object

📘NOTE

documentDetails object

document object

stakeholders object

stakeholderDetails object

professionalDetails object

address object

contactDetails object

documentDetails object

businessPartner

legalDetails object

applicantDetails object

professionalDetails object

address object

contactDetails object

documentDetails object

document object

additionalInfo object

riskAssessmentInfo object

tags object

📘
NOTE

📘
NOTE

`businessDetails` object

`legalDetails` object

`regulatoryDetails` object

`address` object

`registeredAddress` object

`businessAddress` object

📘
NOTE

`documentDetails` object

`document` object

`stakeholders` object

`stakeholderDetails` object

`professionalDetails` object

`address` object

`contactDetails` object

`documentDetails` object

`businessPartner`

`legalDetails` object

`applicantDetails` object

`professionalDetails` object

`address` object

`contactDetails` object

`documentDetails` object

`document` object

`additionalInfo` object

`riskAssessmentInfo` object

`tags` object