Required Parameters

The page list the fields that apply to customers onboarded under the EU region. To view the complete request payload, see the Onboard Corporate Customer request.

note

All fields have a maximum length of 255 characters unless stated otherwise.

Request parameters

Property	Description	Required
region	The regulatory region under which the corporate customer is being onboarded. To onboard under the EU region, use the EU value.	Yes
businessDetails	Contains information about the business, including the applicant and stakeholders.	Yes
riskAssessmentInfo	Provides additional business profile information, such as total number of employees and annual turnover.	Yes
deviceDetails	Includes the device and IP address from which the onboarding request originated.	Yes
expectedAccountUsage	Describes how the customer expects to use the account.	Yes
natureOfBusiness	Contains information about the nature of the business, such as the industrySector.	Yes
tags	Contains user-defined key-value pairs submitted by the client.	No
customerHashId	A unique identifier returned in the response to the Onboard Corporate Customer request. Note:* Required only when reinitiating KYB after a rejection.	Yes *

Note

note

Only customers registered in EEA are eligible to be onboarded under EU region. Please contact your account manager, in case you need to onboard customers registered outside of EEA. For more information, see Regulatory region.

All the fields listed below are applicable for all entity types:

• Associations
• Government Body
• Limited Liability Partnership
• Public Company
• Private Limited Company
• Sole Trader
• Trust

businessDetails object

Contains information about the corporate customer, including the applicant and stakeholders.

Property	Description	Required
referenceId	A unique identifier for the business entity. If not provided, Nium generates one. Used to respond to RFIs or upload documents.	No
businessName	The registered name of the business.	Yes
businessRegistrationNumber	The official registration number of the business.	Yes
tradeName	The name the business operates under. If the business doesn't use a trade name, set tradeName : businessName.	Yes
website	The business’s website. If not available, submit a social media profile (such as Instagram or Facebook). If neither is available, upload a document with documentType : PROOF_OF_BUSINESS.	No
businessType	The legal entity type, such as a private or public company. Use the Fetch Corporate Constants requests with category : businessType.	Yes
legalDetails	Registration and legal information for the business.	Yes
taxDetails	Tax identification details.	No
addresses	Registered and operating addresses.	Yes
documentDetails	Business documents. For details, see EU Required Documents.	Yes
stakeholders	Information about the business’s stakeholders, such as directors or UBOs.	Yes
applicantDetails	Information about the individual submitting the application.	Yes
additionalInfo	Optional details related to the application.	No

legalDetails object

Contains registration and legal information for the business.

Property	Description	Required
registeredDate	The date the business was registered entered in the YYYY-MM-DD format. Registered date cannot be a future date.	Yes
registeredCountry	The country where the business is registered. Use Fetch Corporate Constants with category=countryName for a valid set of values.	Yes

taxDetails array

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

Property	Description	Required
country	The 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 for a valid set of values with category=countryName.	No
taxNumber	The tax ID number for this country. Max character length is 64 characters	No

addresses object

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

Property	Description	Required
registeredAddress	An object that contains the address where the business is registered.	Yes
businessAddress	An object that contains the address where the business is mainly conducted, if different than the registered address. Note: This is not required if isSameBusinessAddress= Yes is passed under businessDetails.additionalInfo.	Yes *

registeredAddress object

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

Property	Description	Required
addressLine1	The first address line of the registered address.	Yes
addressLine2	The second address line of the registered address.	No
city	The city of the registered address.	Yes
state	The state or province of the registered address. If the address doesn't contain state, city can be repeated as state.	Yes
country	The country of the registered address. Use Fetch Corporate Constants requests with category= countryName for a valid set of values.	Yes
postcode	The postal code where the corporate customer is registered.	Yes

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 not required if businessDetails.additionalInfo.isSameBusinessAddress = Yes.

Property	Description	Required
addressLine1	The first address line of the business address.	Yes *
addressLine2	The second address line of the business address.	No
city	The city of the business address.	Yes *
state	The state or province of the business address. If the address doesn't contain state, city can be repeated as state.	Yes *
country	The country of the business address. Use Fetch Corporate Constants requests with category=countryName for a valid set of values.	Yes *
postcode	The postal code where the business address.	Yes *

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.

Property	Description	Required
documentType	The type of business document such as Business Registration Document or Association Deed. Use Fetch Corporate Constants requests with category= documentType for a valid set of values.	Yes
document	An array of objects that contains a copy of the document.	Yes

document object

An array object within the businessDetails.documentDetails object. You can add multiple files under the same document object such as multiple pages of the Business Registration Document or addendum.

Property	Description	Required
fileName	The name of the file.	Yes
fileType	The type of the file. Valid types are application/pdf, image/jpeg, image/jpg, image/png, jpeg, jpg, and png.	Yes
document	The file as a base64 encoded string.	Yes

additionalInfo object

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

Property	Description	Required
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. Note: Business address can be skipped if this field is Yes	No
searchId	This field is required for eKYB and is returned in the response of the Exhaustive Corporate Details using Business ID API. Required documents for business will be dependent on this field.	No

stakeholders object

An array of objects within the businessDetails object that contains the stakeholders of the corporate customers such as Directors or UBOs. Stakeholder can be a business entity or a natural person. For every stakeholder object, you need to send either the stakeholderDetails or the businessPartner parameters.

Property	Description	Required
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.	No
stakeholderDetails	An object that contains the details of the individual stakeholder.	Yes
businessPartner	An object that contains the details of the corporate stakeholder, if available.	Yes *

stakeholderDetails object

An object within the stakeholders object that contains the details about an individual stakeholder (natural person). All the Signatories, Directors, UBOs, Trustees, Settlor, Partners as available in the Business registration document, or Register of Directors or Register of Shareholders have to be included in the application for all business Types.

How to add positions:

• Directors: All the management directors need to be added as stakeholders. Board of directors are not required.
• UBO: All shareholders owning more than 25% of share (directly or indirectly) should be tagged as UBOs. In case, no individual owns 25% of share (directly or indirectly) then the most senior director as per their position should be declared as UBO. In case no UBO is submitted, Nium’s team will identify the UBO. For sole traders, the owner should be declared as the UBO.
• Signatory/Representative: Individual(s) that will conduct transactions or add additional users should be declared as a Signatory/ Representative. Applicant is considered as Representative by default and should be added as such and will be eligible for conducting transactions. Any other users can be added as representatives as well. It is recommended to send all the users as part of the application. These users can be added later as well by sending an email to usermanagement@nium.com. KYC of such users should be completed as directed.
• Others: Other positions such as Partner/ Trustee / Settlor should be provided as applicable as per the Position mapping

Property	Description	Required
kycMode	The KYC mode for the individual stakeholder. Note: When positions include SIGNATORY, REPRESENTATIVE, UBO, TRUSTEE, PARTNER, this field is required to be one of E_DOC_VERIFY or MANUAL_KYC based on stakeholder preference. Else ignore this field.	Yes*
isLiveAuthorizer	Boolean. Set this as true to nominate this stakeholder as Live-Authorizer. Follow the process, implementation notes and validations listed under Live-Authorization	No
firstName	The first name of the individual stakeholder.	Yes
middleName	The middle name of the individual stakeholder.	No
lastName	The surname of the individual stakeholder.	Yes
nationality	The nationality of the individual stakeholder. Use Fetch Corporate Constants requests with category = countryName for a valid set of values.	Yes
dateOfBirth	The date the individual stakeholder was born in the YYYY-MM-DD format. Date of birth cannot be a future date.	Yes
birthCountry	The country of birth. Use Fetch Corporate Constants requests with category = countryName for a valid set of values. Required if position contains UBO,TRUSTEE or PARTNER.	Yes *
taxDetails	The taxation details of the individual stakeholder. Note: This field is required if the position is UBO, TRUSTEE, or PARTNER.	Yes *
professionalDetails	An array of objects to accept the positions held by the stakeholder in the business of the corporate customer and details related to the positions held.	Yes
address	An object that contains the residential address of the individual stakeholder.	Yes
contactDetails	An object that contains the contact details of the individual stakeholder.	No
documentDetails	An object that contains the document details of the individual stakeholder. Note: This field is required if kycMode=MANUAL_KYC. Additionally, documentDetails are required for DIRECTOR	Yes *
additionalInfo	An object that contains additional information required about the individual stakeholder such as isPEP.	Yes

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 includes UBO or TRUSTEE, or PARTNER.

Property	Description	Required
country	The country where the stakeholder is paying taxes. Use Fetch Corporate Constants requests with category=countryName for a valid set of values.	Yes *
taxNumber	The tax ID number for the corresponding country. Maximum 64 characters.	Yes *

professionalDetails object

An array of objects within the businessDetails.stakeholders.stakeholderDetails object that contains the individual stakeholder's professional details. Very often an individual can hold more that one position such as DIRECTOR/ UBO and all applicable positions must be selected.

Property	Description	Required
position	The position of the individual stakeholder such as UBO, DIRECTOR, SIGNATORY. Use Fetch Corporate Constants for a valid set of values with category=position	Yes
sharePercentage	The share percentage of the individual stakeholder in the company. Sharepercentage should be a number between 0 and 100. Eg. 23.4 Note: This field is required if position is UBO or SHAREHOLDER. Else ignore.	Yes *
positionStartDate	The date the individual stakeholder started the position of UBO. Note: This field is required if the position is UBO or TRUSTEE or PARTNER. Position start date cannot be a future date.	Yes *

address object

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

Property	Description	Required
addressLine1	The first address line of the individual stakeholder.	Yes
addressLine2	The second address line of the individual stakeholder.	No
city	The city or suburb of the individual stakeholder.	Yes
state	The state or province of the individual stakeholder. City can be passed as state if state is unavailable.	Yes
country	The country where the individual stakeholder resides. Use Fetch Corporate Constants requests with category = countryName for a valid set of values.	Yes
postcode	The postal code of the individual stakeholder.	Yes

contactDetails object

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

Property	Description	Required
email	The individual stakeholder's email address.	No
contactNo	The contact phone number of the individual stakeholder.	No

documentDetails object

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

Please note:

• If kycMode is MANUAL_KYC, system will validate for required documents. As a result, stakeholders whose positions include SIGNATORY, REPRESENTATIVE, UBO, TRUSTEE, PARTNER will require docuemntDetails and documents objects.
• If position is DIRECTOR, we will require the document number which means documentDetails object (that will include documentNumber , documentIssuanceCountry, documentExpiryDate) needs to be mandatorily provided. Document file (documentDetails.document object) is not required for the DIRECTOR position.
• documentDetails is not required in case kycMode is E_DOC_VERIFY
• Additionally, if additionalInfo.isPEP is Yes then SOURCE_OF_WEALTH should be submitted as a document.

* Note: Check EU required Documents for list of acceptable documents, their definitions and properties.

Property	Description	Required
documentType	The type of document. Use Fetch Corporate Constants requests with category=documentType for a valid set of values.	Yes *
documentNumber	The identification number for the document.	Yes *
documentIssuanceCountry	The country that issued the document. Use Fetch Corporate Constants requests with category=countryName for a valid set of values.	Yes *
documentExpiryDate	The 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.	Yes *
document	An array of objects that contains a copy of a document. Document is required only if kycMode=MANUAL_KYC or for sending additional documents such as SOURCE_OF_WEALTH .	Yes *

document object

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

Property	Description	Required
fileName	The name of the file.	Yes *
fileType	The type of the file. Valid types are application/pdf, image/jpeg, image/jpg, image/png, jpeg, jpg, and png.	Yes *
document	The file as a base64 encoded string.	Yes *

additionalInfo object

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

Property	Description	Required
isPep	This field accepts Yes or No to indicate if the individual stakeholder is a politically exposed person. If this field is Yes, it is recommended to submit SOURCE_OF_WEALTH as a document as this will, otherwise be requested via RFI.	Yes

A PEP (Politically Exposed Person) is someone who holds a prominent public position or has held one in the recent past and, as a result, may be more vulnerable to being involved in bribery, corruption, or money laundering.

businessPartner

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

• If the customer is a multilayered company with another corporate owning more than 25% of share directly or indirectly then all such corporate stakeholders should be declared in the application.
• Refer Multi-layered ownership structure to understand if the customer is a multi-layered company.
• Additionally, Corporate Structure (or ownership structure) should be submitted to validate the structure under businessDetails.documentType = CORPORATE_STRUCTURE. Refer to EU Required documents.

Property	Description	Required
businessName	The registered business name of the corporate stakeholder.	Yes
businessRegistrationNumber	The business registration number.	Yes
businessEntityType	The primary position of the corporate stakeholder in the business of the company. Use Fetch Corporate Constants requests with category = position for a valid set of values. Corporate stakeholders can typically hold positions such as UBO, SHAREHOLDER, PARTNER, TRUSTEE. Sometimes, corporate stakeholder can be a DIRECTOR as well.	Yes
sharePercentage	The share percentage of the corporate stakeholder in the company. Note: This field is required if the stakeholder’s position is UBO or SHAREHOLDER. Else ignore. Sharepercentage should be a number between 0 and 100. Eg. 23.4	Yes *
legalDetails	An object that contains the registration and legal details of the corporate stakeholder.	Yes

legalDetails object

Contains registration and legal information for the business.

Property	Description	Required
registeredCountry	The country where the corporate stakeholder is registered. Use Fetch corporate constants API with category = countryName for a valid selection.	Yes

applicantDetails object

Contains details about the individual applicant representing the corporate customer.

Property	Description	Required
referenceId	A UUID associated with the applicant.	No
kycMode	The KYC mode for verifying the identity of the applicant. Set kycMode : E_DOC_VERIFY.	Yes
firstName	The applicant’s first name. Maximum: 40 alphabetic characters or spaces.	Yes
middleName	The applicant’s middle name. Maximum: 40 alphabetic characters or spaces.	No
lastName	The applicant’s last name. Maximum: 40 alphabetic characters or spaces.	Yes
nationality	The applicant’s nationality (e.g., US, IN). Use the Fetch Corporate Constants request with category : countryName.	Yes
dateOfBirth	The applicant’s date of birth. Format: YYYY-MM-DD. Cannot be a future date. Must be at least 18 years old.	Yes
birthCountry	The applicant’s country of birth. . Use the Fetch Corporate Constants request with category : countryName.	Yes
professionalDetails	Array of objects that describe the applicant’s roles in the business.	Yes
taxDetails	The applicant’s tax identification details. Required if position is UBO, TRUSTEE, or PARTNER.	Yes *
address	The applicant’s residential address.	Yes
contactDetails	Contact details for the applicant.	Yes
documentDetails	Optional. An array of additional documents for the applicant (e.g., POWER_OF_ATTORNEY, SOURCE_OF_WEALTH).	Yes *
additionalInfo	Additional applicant information, such as isPEP.	Yes

professionalDetails object

Describes the roles held by the applicant in the corporate customer’s business.

Property	Description	Required
position	The position of the applicant. Use Fetch corporate constants API for a valid set of values. An applicant is a REPRESENTATIVE by default. In addition, all applicable positions like UBO or DIRECTOR should be added.	Yes
sharePercentage	The share percentage of the applicant in the company. Number between 0 and 100 Note: This field is required if the position is UBO/ SHAREHOLDER	Yes *
positionStartDate	The date the applicant started the position at the corporate customer. Position start date cannot be a future date. This field is required for UBO/ TRUSTEE/ PARTNER.	Yes *

taxDetails array

An array of objects within the businessDetails.applicantDetails. object that contains the applicant's tax details of one or more countries.

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

Property	Description	Required
country	The country of the applicant's tax paying country. Use Fetch Corporate Constants requests with category=countryName for a valid set of values.	Yes *
taxNumber	The tax ID number for the corresponding country. Maximum 64 characters.	Yes *

address object

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

Property	Description	Required
addressLine1	The first address line of the applicant. The maximum character length is 40.	Yes
addressLine2	The second address line of the applicant. The maximum character length is 40.	No
city	The city of the applicant. The maximum character length is 20.	Yes
state	The state or province of the applicant. City can be passed as state if state is unavailable. The maximum character length is 30.	Yes
country	The country where the applicant residence. Use Fetch Corporate Constants for category=countryName for a valid set of values.	Yes
postcode	The postal code of the applicant. The minimum length is 3 and the maximum is 10 alphanumeric characters or spaces.	Yes

contactDetails object

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

| Property | Description | Required | |---------------|--------------------------------------****----------------------------------------------------------------------------------------------------------------------------------------|----------| | email | The applicant's email address. The maximum character length is 40 and needs to be a valid email address. See Email regex. | Yes | | countryCode | The country code of the applicant's phone number. | Yes | | contactNo | The applicant's phone number. The maximum length is 20 numeric characters. | Yes |

documentDetails object

An array of objects within the businessDetails.applicantDetails object that contains the applicant's document information. documentType and the document object are required for applicant in the below conditions:

• If positions does not include DIRECTOR / UBO / PARTNER / TRUSTEE then POWER_OF_ATTORNEY is required.
• If isPEP=Yes then SOURCE_OF_WEALTH is required.

* Check EU required Documents for list of acceptable documents, their definitions and properties.

Property	Description	Required
documentType	The type of document. Use Fetch Corporate Constants for a valid set of values.	Yes
document	The copy of the document. Note: This is required for POWER_OF_ATTORNEY. This field is an array.	Yes *

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 or SOURCE_OF_WEALTH.

Applicant can nominate one of the directors to Live-Authorize and skip submitting Power of Attorney. See Live-Authorization for details.

Property	Description	Required
fileName	The name of the file.	Yes *
fileType	The type of the file. Valid types are application/pdf, image/jpeg, image/jpg, image/png, jpeg, jpg, and png.	Yes *
document	The copy of the document.	Yes *

additionalInfo object

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

Property	Description	Required
isPep	This field accepts Yes or No to indicate if the applicant is a politically exposed person. If this field is Yes, it is recommended to submit SOURCE_OF_WEALTH as a document as this will, otherwise be requested via RFI.	Yes

See PEP definition

expectedAccountUsage object

This object contains the details regarding the expected usage of the account

Property	Description	Required
debit	Object containing expected account usage of all outward transactions.	Yes
credit	Object containing expected account usage of all inward transactions.	Yes
intendedUses	Array of intended uses of the account. Send all applicable values. Use Fetch Corporate Constants with category = intendedUses for valid values.	Yes
intendedUsesDescription	Text field description of the intended use of the account of the corporate customer if other is passed in the intendedUses field. Min 20 characters.	Yes*

debitobject

This object containing expected account usage of all outward transactions

Property	Description	Required
monthlyTransactionVolume	Estimated total monthly payout transaction amount converted to EUR. Use Fetch Corporate Constants requests with category=monthlyTransactionVolume for a valid set of values.	Yes
monthlyTransactions	Estimated count of payout transactions per month for the corporate customer. Use Fetch Corporate Constants requests with category=monthlyTransactions for a valid set of values.	Yes
averageTransactionValue	Estimated average transaction value per payout for the corporate customer converted to EUR. Use Fetch Corporate Constants requests with category=averageTransactionValue for a valid set of values.	Yes
topTransactionCountries	Array of top payout countries. Use Fetch Corporate Constants requests with category= countryName for a valid set of values.	Yes
topBeneficiaries	Array of expected primary beneficiaries. Can be specific companies or types of entities (e.g., Ryan Air, Ketan Meheta, Employees of corporate).	Yes

creditobject

This object containing expected account usage of all inward transactions.

* In case the customer is not enabled for payins, the client is expected to send the minimum bracket within the allowed ranges for monthlyTransactionVolume, monthlyTransactions, averageTransactionValue. The entire credit object is not applicable if the client is a Payroll client and/ or have requested Nium to switch off third party funding.

Property	Description	Required
monthlyTransactionVolume	Estimated total monthly payin transaction amount converted to EUR. Use Fetch Corporate Constants requests with category=monthlyTransactionVolume for a valid set of values.	Yes
monthlyTransactions	Estimated count of payin transactions per month for the corporate customer. Use Fetch Corporate Constants requests with category=monthlyTransactions for a valid set of values.	Yes
averageTransactionValue	Estimated average transaction value per payin for the corporate customer converted to EUR. Use Fetch Corporate Constants category=averageTransactionValue for a valid set of values.	Yes
topTransactionCountries	Array of top payin countries. Use Fetch Corporate Constants requests with category= countryName for a valid set of values.	Yes
topRemitters	Array of expected primary remitters. Can be specific companies or types of entities (e.g., Ryan Air, Ketan Meheta, Employees of corporate).	Yes

natureOfBusiness object

An object within the businessDetails.natureOfBusiness object to provide the nature of business such as industrySector.

* If the industrySector contains any prohibited industries, additional documentation might be requested and can affect the overall approval TAT. Refer to Prohibited and Restricted Business Categories

Property	Description	Required
industryCodes	An array of industry sector codes that apply for the corporate customer's business. Send all applicable values. Use Fetch Corporate Constants for a valid set of values using industrySector category	Yes
industryDescription	Text field explaining the business of the corporate customer in 2-3 sentences. Max Character limit: 300. Min 20 characters.	Yes

riskAssessmentInfo object

An object that contains the details related to the business profile of the corporate customers.

Property	Description	Required
totalEmployees	The corporate customer's total number of employees. Use Fetch Corporate Constants requests with category=totalEmployees for a valid set of values.	Yes
annualTurnover	The corporate customer’s annual turnover.If the company is less than one year old, provide the expected turnover; otherwise, provide the turnover from the previous year. Turnover refers to the total revenue generated by the business. Use Fetch Corporate Constants with category = annualTurnover for a valid set of values.	Yes
countryOfOperation	An array of all the countries the corporate customer has presence and does business. List all the countries you have branches, operations, factories etc… Use Fetch Corporate Constants for a valid set of values. This field is an array. Ex: ["IN", "FR", "LT"]	Yes

deviceDetails object

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

Property	Description	Required
countryIP	Country of the IP address e.g. US. Use Fetch Corporate Constants requests with category = countryName for valid values.	Yes
deviceInfo	Information of the device e.g. Mac OS.	Yes
ipAddress	IP address of the device e.g. 45.48.241.198	Yes
sessionId	A unique identifier for the session, generated by your application.	Yes

tags object

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

Property	Description	Required
key	The name of the tag. The maximum character length is 128. Key should be unique.	No
value	The value of the tag. The maximum character length is 256.	No