EU required parameters

The API fields shown on this page are relevant to the European Union 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 end corporate customer is located and is onboarded. To onboard an EU-based customer, use the EU value.Yes
businessDetailsAn object that contains business details about the corporate customer.Yes
riskAssessmentInfoAn object that contains the risk assessment information.Yes
tagsAn object that contains the tags.No
clientIdThis field contains 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 contains the unique customer identifier generated at the time of the 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:

Association
Sole trader
Trust
Government
Private
Public
LLP
ASSOCIATION
SOLE_TRADER
TRUST
GOVERNMENT_ENTITY
PRIVATE_COMPANY
PUBLIC_COMPANY
LIMITED_LIABILITY_PARTNERSHIP

businessDetails object

An object that contains business details about the corporate customer.

PropertyDescriptionAssociation
Sole trader
Trust
Government
Private
Public
LLP
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.RequiredRequiredRequired
tradeNameIn case the corporate customer is doing business under a different name than their licensed business name.N/ARequiredOptional
websiteThe corporate customer's website.OptionalOptionalOptional
businessTypeThe legal entity type of the business. Use Fetch corporate constants API for a valid set of values.RequiredRequiredRequired
legalDetailsAn object that contains the legal details.RequiredRequiredRequired
taxDetailsAn array of objects that contains the business taxation details.RequiredRequiredRequired
addressesAn object that contains the registered and business addresses of the corporate customer.RequiredRequiredRequired
documentDetailsAn array of objects that contains the business documents.
Note: For a complete list of required documents, see EU required documents.
Required *Required *Required *
stakeholdersAn array of objects 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

legalDetails object

An object within the businessDetails object that contains legal details.

PropertyDescriptionAssociation
Sole trader
Trust
Government
Private
Public
LLP
registeredDateThe date the business was registered entered in the YYYY-MM-DD format. Registered date cannot be a past date.RequiredRequiredRequired
registeredCountryThe country where the business is registered. Use Fetch corporate constants API for a valid set of values.RequiredRequiredRequired

taxDetails array

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

PropertyDescriptionAssociation
Sole trader
Trust
Government
Private
Public
LLP
countryThe country in which the corporate customer is paying taxes. This will be the same as the registered country, unless the customer is paying taxes in other countries as well.
Note: If the customer is a subsidiary or a part of a group of companies, the customer needs to provide countries where taxes are paid for its own legal entity and not for the entire group of companies.
Use Fetch corporate constants API for a valid set of values.
RequiredRequiredRequired
taxNumberThe tax ID number for this country. Max character length is 64 charactersRequiredRequiredRequired

addresses object

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

PropertyDescriptionAssociation
Sole trader
Trust
Government
Private
Public
LLP
registeredAddressAn object that contains the address where the business is registered.RequiredRequiredRequired
businessAddressAn object that contains the address where the business is mainly conducted, if different than the registered address.
Note: This is required if isSameBusinessAddress = No
Required *Required *Required *

registeredAddress object

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

PropertyDescriptionAssociation
Sole trader
Trust
Government
Private
Public
LLP
addressLine1The first address line of the registered business.RequiredRequiredRequired
addressLine2The second address line of the registered business.OptionalOptionalOptional
cityThe city where the corporate customer is registered.RequiredRequiredRequired
stateThe state where the corporate customer is registered.RequiredRequiredRequired
countryThe country where the corporate customer is registered. Use Fetch corporate constants API for a valid set of values.RequiredRequiredRequired
postcodeThe postal code where the corporate customer is registered.RequiredRequiredRequired

businessAddress object

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

* This object is required only if businessDetails.additionalInfo.isSameBusinessAddress = No.

PropertyDescriptionAssociation
Sole trader
Trust
Government
Private
Public
LLP
addressLine1The first address line of the principal place of business if different than the registered business.Required *Required *Required *
addressLine2The second address line of the principal place of business if different than the registered business.OptionalOptionalOptional
cityThe city of the principal place of business if different than the registered address.Required *Required *Required *
stateThe state of the principal place of business if different than the registered address.Required *Required *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 *Required *Required *
postcodeThe postal code where the principal place of business occurs if different than the registered address.Required *Required *Required *

documentDetails object

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

* For a complete list of required documents, see EU required documents.

PropertyDescriptionAssociation
Sole trader
Trust
Government
Private
Public
LLP
documentTypeThe type of business document. Use Fetch corporate constants API for a valid set of values.Required *Required *Required *
documentAn array of objects that contains a copy of the document.Required *Required *Required *

document object

An array object within the businessDetails.documentDetails object.

PropertyDescriptionAssociation
Sole trader
Trust
Government
Private
Public
LLP
fileNameThe name of the file.Required *Required *Required *
fileTypeThe type of the file. Valid types are application/pdf, image/jpeg, image/jpg, image/png, jpeg, jpg, and png.Required *Required *Required *
documentThe file as a base64 encoded string.Required *Required *Required *

additionalInfo object

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

PropertyDescriptionAssociation
Sole trader
Trust
Government
Private
Public
LLP
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: Required only if Yes; optional if No.
OptionalOptionalOptional
searchIdThis field is required for eKYB and is returned in the response of the Exhaustive Corporate Details using Business ID API.OptionalOptionalOptional

stakeholders object

An array of objects within the businessDetails object that contains information about one or more stakeholders.

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

PropertyDescriptionAssociation
Sole trader
Trust
Government
Private
Public
LLP
referenceIdThe 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.OptionalOptionalOptional
stakeholderDetailsAn object that contains the details of the individual stakeholder.RequiredRequiredRequired
businessPartnerAn object that contains the details of the corporate stakeholder, if available.RequiredRequiredRequired

stakeholderDetails object

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

PropertyDescriptionAssociation
Sole trader
Trust
Government
Private
Public
LLP
kycModeThe KYC mode for verifying the individual stakeholder. Ignore this field if searchId is passed. When searchId isn't passed, MANUAL_KYC has to be passed if position is UBO, TRUSTEE or PARTNERRequiredRequiredRequired
firstNameThe first name of the individual stakeholder.RequiredRequiredRequired
middleNameThe middle name of the individual stakeholder.OptionalOptionalOptional
lastNameThe surname of the individual stakeholder.RequiredRequiredRequired
nationalityThe nationality of the individual stakeholder.RequiredRequiredRequired
dateOfBirthThe date the individual stakeholder was born in the YYYY-MM-DD format. Date of birth cannot be a future date.RequiredRequiredRequired
birthCountryThe country of birth.RequiredRequiredRequired
taxDetailsThe taxation details of the individual stakeholder.
Note: This field is required if the position is UBO, TRUSTEE, or PARTNER.
Required *Required *Required *
professionalDetailsThe professional details of the individual stakeholder.RequiredRequiredRequired
addressAn object that contains the residential address of the individual stakeholder.RequiredRequiredRequired
contactDetailsAn object that contains the contact details of the individual stakeholder.OptionalOptionalOptional
documentDetailsAn object that contains the document details of the individual stakeholder.
Note: This field is required if position is UBO, TRUSTEE or PARTNER regardless of kycMode
Required *Required *Required *
additionalInfoAn object that contains additional information about the individual stakeholder.RequiredRequiredRequired

taxDetails array

An array of objects within the businessDetails.stakeholders.stakeholderDetails object that contains the individual stakeholder's tax details of one or more countries.

* This object is required if the position is UBO, TRUSTEE, or PARTNER.

PropertyDescriptionAssociation
Sole trader
Trust
Government
Private
Public
LLP
countryThe country of the stakeholder's residence. Use Fetch corporate constants API for a valid set of values.Required *Required *Required *
taxNumberThe tax ID number for the corresponding country.Required *Required *Required *

professionalDetails object

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

PropertyDescriptionAssociation
Sole trader
Trust
Government
Private
Public
LLP
positionThe position of the individual stakeholder. Use Fetch corporate constants API for a valid set of values.RequiredRequiredRequired
sharePercentageThe share percentage of the individual stakeholder in the company.
Note: This field is a required input parameter If the stakeholder’s position is UBO.
Required *Required *Required *
positionStartDateThe date the individual stakeholder started the position of UBO.
Note: This field s required if the individual stakeholder is currently an UBO or TRUSTEE or PARTNER. Position start date cannot be a future date.
Required *Required *Required *

address object

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

PropertyDescriptionAssociation
Sole trader
Trust
Government
Private
Public
LLP
addressLine1The first address line of the individual stakeholder.RequiredRequiredRequired
addressLine2The second address line of the individual stakeholder.OptionalOptionalOptional
cityThe city or suburb of the individual stakeholder.RequiredRequiredRequired
stateThe state of the individual stakeholder.RequiredRequiredRequired
countryThe country where the individual stakeholder resides. Use Fetch corporate constants API for a valid set of values.RequiredRequiredRequired
postcodeThe postal code of the individual stakeholder.RequiredRequiredRequired

contactDetails object

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

PropertyDescriptionAssociation
Sole trader
Trust
Government
Private
Public
LLP
emailThe individual stakeholder's email address.OptionalOptionalOptional
contactNoThe contact phone number of the individual stakeholder.OptionalOptionalOptional

documentDetails object

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

📌

IMPORTANT

* This object is required if position is UBO or TRUSTEE or PARTNER regardless of kycMode

PropertyDescriptionAssociation
Sole trader
Trust
Government
Private
Public
LLP
documentTypeThe type of document. Use Fetch corporate constants API for a valid set of values.Required *Required *Required *
documentNumberThe ID number for the given document type.Required *Required *Required *
documentIssuanceCountryThe country that issued the business document. Use Fetch corporate constants API for a valid set of values. Not required if documentType= POWER_OF_ATTORNEYRequired *Required *Required *
documentExpiryDateThe date the document expires in the YYYY-MM-DD format.
Note: This is required only if documentType = PASSPORT. Expiry date cannot be a past date.
Required *Required *Required *
documentAn array of objects that contains a copy of a document. Document is required only if kycMode=MANUAL_KYCRequired *Required *Required *

document object

An array of objects within the businessDetails.stakeholders.stakeholderDetails.documentDetails object that contains a copy of the individual stakeholder's document.

PropertyDescriptionAssociation
Sole trader
Trust
Government
Private
Public
LLP
fileNameThe name of the file.Required *Required *Required *
fileTypeThe type of the file. Valid types are application/pdf, image/jpeg, image/jpg, image/png, jpeg, jpg, and png.Required *Required *Required *
documentThe file as a base64 encoded string.Required *Required *Required *

additionalInfo object

An object within the businessDetails.stakeholders.stakeholderDetails object that contains additional information about the individual stakeholder.

PropertyDescriptionAssociation
Sole trader
Trust
Government
Private
Public
LLP
isPepThis field accepts Yes or No to indicate if the individual stakeholder is a politically exposed person.RequiredRequiredRequired

businessPartner

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

📌

IMPORTANT

This object is required if a corporate stakeholder exists.

PropertyDescriptionAssociation
Sole trader
Trust
Government
Private
Public
LLP
businessNameThe registered business name of the corporate stakeholder.RequiredRequiredRequired
businessRegistrationNumberThe business registration number.RequiredRequiredRequired
businessEntityTypeThe position of the corporate stakeholder in the company. Use Fetch corporate constants API for a valid set of values.RequiredRequiredRequired
sharePercentageThe share percentage of the corporate stakeholder in the company.
Note: This field is a required input parameter If the stakeholder’s position is UBO.
Required *Required *Required *
legalDetailsAn object that contains the legal details of the corporate stakeholder.RequiredRequiredRequired

legalDetails object

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

PropertyDescriptionAssociation
Sole trader
Trust
Government
Private
Public
LLP
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.

PropertyDescriptionAssociation
Sole trader
Trust
Government
Private
Public
LLP
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.OptionalOptionalOptional
kycModeThe KYC mode for verifying the identity of the applicant. The only valid value is E_DOC_VERIFY.RequiredRequiredRequired
firstNameThe first name of the applicant. The maximum length is 40 alphabetic characters or spaces.RequiredRequiredRequired
middleNameThe middle name of the applicant. The maximum length is 40 alphabetic characters or spaces.OptionalOptionalOptional
lastNameThe surname of the applicant. The maximum length is 40 alphabetic characters or spaces.RequiredRequiredRequired
nationalityThe nationality of the applicant. Use Fetch corporate constants API for valid values.RequiredRequiredRequired
dateOfBirthThe date on which the applicant was born in the YYYY-MM-DD format. Date of birth cannot be a future date. Applicant age cannot be less than 18 yrs.RequiredRequiredRequired
birthCountryThe country of birth.
Note: This field is required if the applicant's position is UBO, TRUSTEE, or PARTNER.
Required *Required *Required *
professionalDetailsAn array of objects that contains the professional details about the applicant.RequiredRequiredRequired
addressAn object that contains the address of the applicant.RequiredRequiredRequired
contactDetailsAn object that contains the contact details about the applicant.RequiredRequiredRequired
documentDetailsAn array of objects that contains the document details of the applicant.RequiredRequiredRequired
additionalInfoAn object that contains additional information about the applicant.RequiredRequiredRequired

professionalDetails object

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

PropertyDescriptionAssociation
Sole trader
Trust
Government
Private
Public
LLP
positionThe position of the applicant. Use Fetch corporate constants API for a valid set of values.RequiredRequiredRequired
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 *Required *Required *
positionStartDateThe date the applicant started the position at the corporate customer. Position start date cannot be a future date.RequiredRequiredRequired

address object

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

PropertyDescriptionAssociation
Sole trader
Trust
Government
Private
Public
LLP
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. Use Fetch corporate constants API for a valid set of values.RequiredRequiredRequired
postcodeThe postal code of the applicant. The minimum length is 3 and the maximum is 10 alphanumeric characters or spaces.RequiredRequiredRequired

contactDetails object

An object within the businessDetails.applicantDetails object that contains the applicant's contact information.

PropertyDescriptionAssociation
Sole trader
Trust
Government
Private
Public
LLP
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.

PropertyDescriptionAssociation
Sole trader
Trust
Government
Private
Public
LLP
documentTypeThe type of document. Use Fetch corporate constants API for a valid set of values.RequiredRequiredRequired
documentNumberThe ID number for the given document type.RequiredRequiredRequired
documentIssuanceCountryThe country that issued the business document. Use Fetch corporate constants API for a valid set of values.
Note: This field is required if documentType = PASSPORT.
Required *Required *Required *
documentExpiryDateThe date the document expires in the YYYY-MM-DD format. This field is required if documentType = PASSPORT.. Expiry date cannot be a past date.Required *Required *Required *
documentThe copy of the document.
Note: This is required for POWER_OF_ATTORNEY. This field is an array.
Required *Required *Required *

document object

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

* This object is required for POWER_OF_ATTORNEY.

PropertyDescriptionAssociation
Sole trader
Trust
Government
Private
Public
LLP
fileNameThe name of the file.Required *Required *Required *
fileTypeThe type of the file. Valid types are application/pdf, image/jpeg, image/jpg, image/png, jpeg, jpg, and png.Required *Required *Required *
documentThe copy of the document.Required *Required *Required *

additionalInfo object

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

PropertyDescriptionAssociation
Sole trader
Trust
Government
Private
Public
LLP
isPepThis field accepts Yes or No to indicate if the applicant is a politically exposed person.RequiredRequiredRequired

riskAssessmentInfo object

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

PropertyDescriptionAssociation
Sole trader
Trust
Government
Private
Public
LLP
totalEmployeesThe corporate customer's total number of employees. Use Fetch corporate constants API for a valid set of values.RequiredRequiredRequired
annualTurnoverThe corporate customer's amount of annual turnover.
Use Fetch corporate constants API for a valid set of values.
RequiredRequiredRequired
industrySectorThe corporate customer's industry sector. Use Fetch corporate constants API for a valid set of values.RequiredRequiredRequired
countryOfOperationThe country the corporate customer operates in. Use Fetch corporate constants API for a valid set of values. This field is an array.RequiredRequiredRequired
transactionCountriesThe array of countries where the transactions occur. Use Fetch corporate constants API for a valid set of values.RequiredRequiredRequired
intendedUseOfAccountThe customer's intended use of the account. Use Fetch corporate constants API for a valid set of values.RequiredRequiredRequired

tags object

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

PropertyDescriptionAssociation
Sole trader
Trust
Government
Private
Public
LLP
keyThe name of the tag. The maximum character length is 128. Key should be unique.OptionalOptionalOptional
valueThe value of the tag. The maximum character length is 256.OptionalOptionalOptional