UK required fields
The API fields shown on this page are relevant to the United Kingdom only. To see the full payload, refer to the Onboard Corporate Customer API Reference.
Request parameters
| Property | Description | Required |
|---|---|---|
region | The country or geographic region where the corporate end customer is located and is onboarded. To onboard a UK-based customer, use the UK value. | Yes |
| businessDetails | An object that contains business details about the corporate customer. | Yes |
| riskAssessmentInfo | An object that contains the risk assessment information. | Yes |
| tags | An object that contains the tags. | No |
clientId | This field contains the Nium client ID about 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 * |
customerHashId | This 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 entity API fields
The below object table columns apply to the following entity types:
ASSOCIATIONGOVERNMENT_ENTITYLIMITED_LIABILITY_PARTNERSHIPPRIVATE_COMPANYPUBLIC_COMPANYSOLE_TRADERTRUSTUNINCORPORATED_PARTNERSHIPOTHERS
businessDetails object
businessDetails objectAn object that contains business details about the corporate customer.
| Property | Description | Required |
|---|---|---|
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. | No |
businessName | The name a corporate customer is registered under. | Yes |
businessRegistrationNumber | The business registration number. | Yes |
tradeName | In case the corporate customer is doing business under a different name than their licensed business name. Note: This is required for all entity types except SOLE_TRADER. | Yes * |
website | The corporate customer's website. | No |
businessType | The legal entity type of the business. Use Fetch corporate constants API for a valid set of values. | Yes |
| legalDetails | An object that contains the legal details. | Yes |
| addresses | An object that contains the registered and business addresses of the corporate customer. | Yes |
| documentDetails | An object that contains the business documents. Note: This is required per UK required documents. | Yes * |
| stakeholders | An object that contains the individual and corporate stakeholders about the corporate customer. | Yes |
| applicantDetails | An object that contains the applicant's details. | Yes |
| additionalInfo | An object that contains additional information about the business. | No |
legalDetails object
legalDetails objectAn object within the businessDetails object that contains legal details.
| Property | Description | Required |
|---|---|---|
registeredDate | The date the business was registered entered in the YYYY-MM-DD format. | Yes |
registeredCountry | The country where the business is registered. Use Fetch corporate constants API for a valid set of values. | Yes |
addresses object
addresses objectAn object within the businessDetails object that contains 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 required if isSameBusinessAddress=No | Yes * |
registeredAddress object
registeredAddress objectAn 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 business. | Yes |
addressLine2 | The second address line of the registered business. | No |
city | The city where the corporate customer is registered. | No |
state | The state where the corporate customer is registered. | No |
country | The country where the corporate customer is registered. Use Fetch corporate constants API for a valid set of values. | Yes |
postcode | The postal code where the corporate customer is registered. | Yes |
businessAddress object
businessAddress objectAn object within the businessDetails.address object that contains the address details about the principal place of business only when the registered address is different.
| Property | Description | Required |
|---|---|---|
addressLine1 | The first address line of the principal place of business if different than the registered business. * Note: This is required if isSameBusinessAddress = No. | Yes * |
addressLine2 | The second address line of the principal place of business if different than the registered business. | No |
city | The city of the principal place of business if different than the registered address. | No |
state | The state of the principal place of business if different than the registered address. | No |
country | The 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. * This is required if isSameBusinessAddress = No. | Yes * |
postcode | The postal code where the principal place of business occurs if different than the registered address. * Note: This is required if isSameBusinessAddress = No. | Yes * |
documentDetails object
documentDetails objectAn array of objects within the businessDetails object that contains one or more business documents.
* This object is required if either of the following are true:
MANUAL_KYBis used.E_KYBis used andbusinessDetails.businessTypeis one of the following:LIMITED_LIABILITY_PARTNERSHIPTRUSTUNICORP_PARTNERSHIP
| Property | Description | Required |
|---|---|---|
documentType | The type of business document. Use Fetch corporate constants API for a valid set of values. | Yes * |
documentNumber | The document number. | Yes * |
| document | An object that contains a copy of the document. | Yes * |
document object
document objectAn object within the businessDetails.documentDetails object.
| 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 * |
stakeholders object
stakeholders objectAn object within the businessDetails object that contains information about one or many stakeholders.
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. Required if a corporate stakeholder exists. | Yes |
stakeholderDetails object
stakeholderDetails objectAn object within the stakeholders object that contains the details of an individual stakeholder.
| Property | Description | Required |
|---|---|---|
kycMode | The KYC mode for verifying the individual stakeholder. Valid values are E_KYC and MANUAL_KYC. | Yes |
firstName | The first name of the individual stakeholder. | Yes |
middleName | The middle name of the individual stakeholder. | No |
lastName | The last name of the individual stakeholder. | Yes |
nationality | The nationality of the individual stakeholder. | Yes |
dateOfBirth | The date the individual stakeholder was born in the YYYY-MM-DD format. | Yes |
| professionalDetails | The professional details of the individual stakeholder. | 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 is required if kycMode = MANUAL_KYC. | Yes * |
professionalDetails object
professionalDetails objectAn object within the businessDetails.stakeholders.stakeholderDetails object that contains the individual stakeholder's professional details.
| Property | Description | Business entity type |
|---|---|---|
position | The position of the individual stakeholder. Use Fetch corporate constants API for a valid set of values. | Required |
sharePercentage | The share percentage of the individual stakeholder in the company. Note: If the stakeholder’s position is UBO, then the share percentage is a required input parameter. | Yes * |
address object
address objectAn 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. | No |
state | The state of the individual stakeholder. | No |
country | The country where the individual stakeholder resides. Use Fetch corporate constants API for a valid set of values. | Yes |
postcode | The postal code of the individual stakeholder. | Yes |
contactDetails object
contactDetails objectAn 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
documentDetails objectAn object within the businessDetails.stakeholders.stakeholderDetails object that contains the individual stakeholder's document details.
* This object is required if kycMode = MANUAL_KYC.
| Property | Description | Required |
|---|---|---|
documentType | The type of document. Use Fetch corporate constants API for a valid set of values. | Yes * |
documentNumber | The ID number for the given document type. | Yes * |
documentIssuanceCountry | The country that issued the business document, specified in the ISO 3166 format. This field is required if documentType = PASSPORT or DRIVERS_LICENCE or NATIONAL_ID. | Yes * |
documentExpiryDate | The date the document expires in the YYYY-MM-DD format. This is required if documentType is PASSPORT or DRIVERS_LICENCE. | Yes * |
| document | An object that contains the document copy. | Yes * |
document object
document objectAn object 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 file type. Valid types are application/pdf, image/jpeg, image/jpg, image/png, jpeg, jpg, and png. | Yes * |
document | The document saved as a base64 encoded string. | Yes * |
businessPartner
businessPartnerAn object within the businessDetails.stakeholders object that contains the business details about the corporate stakeholder.
* This object is required if a corporate stakeholder exists.
| Property | Description | Required |
|---|---|---|
businessName | The registered business name of the corporate stakeholder. | Yes |
businessRegistrationNumber | The business registration number. | Yes |
businessEntityType | The position of the corporate stakeholder in the company. Use Fetch corporate constants API for a valid set of values. | Yes |
sharePercentage | The share percentage of the corporate stakeholder in the company. Note: If the stakeholder’s position is UBO, then the share percentage is a required input parameter. | Yes * |
| legalDetails | An object that contains the legal details of the corporate stakeholder. | Yes |
legalDetails object
legalDetails objectAn object within the businessDetails.stakeholders.businessPartner object that contains the corporate stakeholder's legal details.
| Property | Description | Required |
|---|---|---|
registeredCountry | The country where the corporate stakeholder is registered, specified in the ISO 3166 format. | Yes |
applicantDetails object
applicantDetails objectAn object within the businessDetails object that contains details about the applicant.
| Property | Description | Required |
|---|---|---|
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. | No |
kycMode | The KYC mode for verifying the identity of the applicant. The only valid value is E_DOC_VERIFY. | Yes |
firstName | The first name of the applicant. The maximum character length is 40. | Yes |
middleName | The middle name of the applicant. The maximum character length is 40. | No |
lastName | The last name or the applicant. The maximum character length is 40. | Yes |
nationality | Nationality of the applicant. | Yes |
dateOfBirth | The date on which the applicant was born in the YYYY-MM-DD format. | Yes |
| professionalDetails | An object that contains the professional details of the applicant. | Yes |
| address | An object that contains the address of the applicant. | Yes |
| contactDetails | An object that contains the contact details of the applicant. | Yes |
| documentDetails | An object that contains the document details of the applicant. | Yes |
professionalDetails object
professionalDetails objectAn object within the businessDetails.applicantDetails object that contains the professional details about the applicant.
| Property | Description | Required |
|---|---|---|
position | The position of the applicant. Use Fetch corporate constants API for a valid set of values. | Yes |
sharePercentage | The share percentage of the applicant in the company. Note: If the applicant's position is UBO, then the share percentage is a required input parameter. | Yes * |
address object
address objectAn 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 50. | No |
state | The state of the applicant. The maximum character length is 50. | No |
country | The country where the applicant resides, specified in the ISO 3166 format. | Yes |
postcode | The postal code of the applicant. The minimum character length is 3 and the maximum is 10. | Yes |
contactDetails object
contactDetails objectAn 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. | Yes |
countryCode. | The country code of the applicant's phone number. | Yes |
contactNo | The applicant's phone number. The maximum character length is 20. | Yes |
documentDetails object
documentDetails objectAn object within the businessDetails.applicantDetails object that contains the applicant's document information.
| Property | Description | Required |
|---|---|---|
documentType | The type of document. Use Fetch corporate constants API for a valid set of values. | Yes |
documentNumber | The ID number for the given document type. | Yes |
documentIssuanceCountry | The country that issued the business document, specified in the ISO 3166 format. Note: This is required if documentType = PASSPORT or NATIONAL_ID or DRIVERS_LICENCE. | Yes * |
documentExpiryDate | The date the passport or driver's license expires in the YYYY-MM-DD format. | Yes * |
| document | An object that contains a copy of the document. Note: This is required for POWER_OF_ATTORNEY. See UK required documents for the valid set of required fields. | Yes * |
document object
document objectAn object within the businessDetails.applicantDetails.documentDetails object that contains the document copy.
See UK required documents for the valid set of required fields.
* This object is required for POWER_OF_ATTORNEY.
| Property | Description | Required |
|---|---|---|
fileName | The name of the file. | Yes * |
fileType | The file type. Valid types are application/pdf, image/jpeg, image/jpg, image/png, jpeg, jpg, and png. | Yes * |
document | The document saved as a base64 encoded string. | Yes * |
additionalInfo object
additionalInfo objectAn 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: This is required if Yes; it's optional if No. | No |
searchId | This field is required for eKYB and is returned in the response of the Exhaustive Corporate Details using Business ID API. | No |
riskAssessmentInfo object
riskAssessmentInfo objectAn object that contains the following details which are required to determine a corporate customer's risk profile.
| Property | Description | Required |
|---|---|---|
totalEmployees | The corporate customer's total number of employees. Use Fetch corporate constants API for a valid set of values. | Yes |
annualTurnover | The corporate customer's amount of annual turnover. Use Fetch corporate constants API for a valid set of values. | Yes |
industrySector | The corporate customer's industry sector. Use Fetch corporate constants API for a valid set of values. | Yes |
countryOfOperation | An array of countries the corporate customer operates in, specified in the ISO 3166 format. | Yes |
travelRestrictedCountry | If the customer is an Online Travel Agency (OTA) and facilitates travel service to any travel-restricted country, then this field is Yes; otherwise, it's No. Note: This field is applicable when JPMC Virtual Account is offered to the client. | Yes * |
restrictedCountries | This field is optional. If the OTA customer is facilitating travel to any of the restricted countries, send the list of those countries. See Fetch corporate constants for the list of restricted countries. Note: This field is applicable when travelRestrictedCountry = Yes. | Yes * |
ofacLicencePresent | If the OTA customer has an OFAC license, send Yes; otherwise, send No. Note: This field is applicable when travelRestrictedCountry = Yes. | Yes * |
transactionCountries | An array of countries where the transactions occur, specified in the ISO 3166 format. | Yes |
intendedUseOfAccount | The customer's intended use of the account. Use Fetch corporate constants API for a valid set of values. | Yes |
tags object
tags objectAn optional object that 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. | No |
value | The value of the tag. The maximum character length is 256. | No |
Updated about 5 hours ago