Company onboarding fields
Field reference for company account holder onboarding.
Work in progress
Field requirements and validations are being finalized. This section will be updated before release.
Account
| API v1 | API v2 |
|---|---|
accountCountry | accountInfo.country |
accountName | accountInfo.name |
Account administrator
| API v1 | API v2 |
|---|---|
legalRepresentativePersonalAddress.addressLine1 | accountAdmin.address.addressLine1 |
legalRepresentativePersonalAddress.addressLine2 | accountAdmin.address.addressLine2 |
legalRepresentativePersonalAddress.city | accountAdmin.address.city |
legalRepresentativePersonalAddress.country | accountAdmin.address.country |
legalRepresentativePersonalAddress.postalCode | accountAdmin.address.postalCode |
legalRepresentativePersonalAddress.state | accountAdmin.address.state |
| - | accountAdmin.birthInfo.birthDate (new) |
| - | accountAdmin.birthInfo.city (new) |
| - | accountAdmin.birthInfo.country (new) |
| - | accountAdmin.birthInfo.postalCode (new) |
email | accountAdmin.email |
| - | accountAdmin.firstName |
| - | accountAdmin.lastName (new) |
| - | accountAdmin.nationality (new) |
language | accountAdmin.preferredLanguage |
| - | accountAdmin.taxIdentificationNumber (new) |
typeOfRepresentation | accountAdmin.typeOfRepresentation |
| - | accountAdmin.unitedStatesTaxInfo.isUnitedStatesPerson (new) |
| - | accountAdmin.unitedStatesTaxInfo.unitedStatesTaxIdentificationNumber (new) |
| - | accountAdmin.userDeviceInfo.geoloc.lat (new) |
| - | accountAdmin.userDeviceInfo.geoloc.lng (new) |
| - | accountAdmin.userDeviceInfo.ip (new) |
| - | accountAdmin.userDeviceInfo.userAgent (new) |
Company
| API v1 | API v2 |
|---|---|
residencyAddress.addressLine1 | company.address.addressLine1 |
residencyAddress.addressLine2 | company.address.addressLine2 |
residencyAddress.city | company.address.city |
residencyAddress.country | company.address.country |
residencyAddress.postalCode | company.address.postalCode |
residencyAddress.state | company.address.state |
acquisitionChannel | company.acquisitionChannel |
businessActivityDescription | company.businessActivityDescription |
| - | company.businessActivityCode (new) |
companyType | company.companyType |
| - | company.forecastYearlyIncome (new) |
| - | company.headcount (new) |
| - | company.legalFormCode (new) |
monthlyPaymentVolume | company.monthlyPaymentVolume |
name | company.name |
| - | company.registrationDate (new) |
registrationNumber | company.registrationNumber |
| - | company.regulatoryClassification (new) |
| - | company.signupDate (new) |
taxIdentificationNumber | company.taxIdentificationNumber |
tradeName | company.tradeName |
vatNumber | company.vatNumber |
| - | company.websites (new) |
Legal representative information
| API v1 | API v2 |
|---|---|
representatives[i].residencyAddress.addressLine1 | company.representatives[i].address.addressLine1 |
representatives[i].residencyAddress.addressLine2 | company.representatives[i].address.addressLine2 |
representatives[i].residencyAddress.city | company.representatives[i].address.city |
representatives[i].residencyAddress.country | company.representatives[i].address.country |
representatives[i].residencyAddress.postalCode | company.representatives[i].address.postalCode |
representatives[i].residencyAddress.state | company.representatives[i].address.state |
representatives[i].birthDate | company.representatives[i].birthInfo.birthDate |
representatives[i].birthCity | company.representatives[i].birthInfo.city |
representatives[i].birthCountryCode | company.representatives[i].birthInfo.country |
representatives[i].birthCityPostalCode | company.representatives[i].birthInfo.postalCode |
representatives[i].entityName | company.representatives[i].entityName |
representatives[i].firstName | company.representatives[i].firstName |
representatives[i].lastName | company.representatives[i].lastName |
representatives[i].legalForm | company.representatives[i].legalForm |
representatives[i].nationality | company.representatives[i].nationality |
representatives[i].preferredFirstName | company.representatives[i].preferredFirstName |
representatives[i].registrationNumber | company.representatives[i].registrationNumber |
representatives[i].roles | company.representatives[i].roles |
representatives[i].gender | company.representatives[i].sex |
representatives[i].type | company.representatives[i].type |
| - | company.representatives[i].email (new) |
Ultimate Beneficial Owners
| API v1 | API v2 |
|---|---|
individualUltimateBeneficialOwners[i].residencyAddress.addressLine1 | company.ultimateBeneficialOwners[i].address.addressLine1 |
individualUltimateBeneficialOwners[i].residencyAddress.addressLine2 | company.ultimateBeneficialOwners[i].address.addressLine2 |
individualUltimateBeneficialOwners[i].residencyAddress.city | company.ultimateBeneficialOwners[i].address.city |
individualUltimateBeneficialOwners[i].residencyAddress.country | company.ultimateBeneficialOwners[i].address.country |
individualUltimateBeneficialOwners[i].residencyAddress.postalCode | company.ultimateBeneficialOwners[i].address.postalCode |
individualUltimateBeneficialOwners[i].residencyAddress.state | company.ultimateBeneficialOwners[i].address.state |
individualUltimateBeneficialOwners[i].birthDate | company.ultimateBeneficialOwners[i].birthInfo.birthDate |
individualUltimateBeneficialOwners[i].birthCity | company.ultimateBeneficialOwners[i].birthInfo.city |
individualUltimateBeneficialOwners[i].birthCountryCode | company.ultimateBeneficialOwners[i].birthInfo.country |
individualUltimateBeneficialOwners[i].birthCityPostalCode | company.ultimateBeneficialOwners[i].birthInfo.postalCode |
| - | company.ultimateBeneficialOwners[i].controlTypes (new) |
individualUltimateBeneficialOwners[i].firstName | company.ultimateBeneficialOwners[i].firstName |
individualUltimateBeneficialOwners[i].identityDocumentDetails.expiryDate | company.ultimateBeneficialOwners[i].identityDocumentDetails.expiryDate |
individualUltimateBeneficialOwners[i].identityDocumentDetails.issueDate | company.ultimateBeneficialOwners[i].identityDocumentDetails.issueDate |
individualUltimateBeneficialOwners[i].identityDocumentDetails.issuingAuthority | company.ultimateBeneficialOwners[i].identityDocumentDetails.issuingAuthority |
individualUltimateBeneficialOwners[i].identityDocumentDetails.number | company.ultimateBeneficialOwners[i].identityDocumentDetails.number |
individualUltimateBeneficialOwners[i].identityDocumentDetails.type | company.ultimateBeneficialOwners[i].identityDocumentDetails.type |
individualUltimateBeneficialOwners[i].lastName | company.ultimateBeneficialOwners[i].lastName |
individualUltimateBeneficialOwners[i].direct | company.ultimateBeneficialOwners[i].ownership.direct |
individualUltimateBeneficialOwners[i].indirect | company.ultimateBeneficialOwners[i].ownership.indirect |
individualUltimateBeneficialOwners[i].totalCapitalPercentage | company.ultimateBeneficialOwners[i].ownership.percentage |
| - | company.ultimateBeneficialOwners[i].qualificationType (new) |
individualUltimateBeneficialOwners[i].gender | company.ultimateBeneficialOwners[i].sex |
individualUltimateBeneficialOwners[i].taxIdentificationNumber | company.ultimateBeneficialOwners[i].taxIdentificationNumber |
| - | company.ultimateBeneficialOwners[i].unitedStatesTaxInfo.isUnitedStatesPerson (new) |
| - | company.ultimateBeneficialOwners[i].unitedStatesTaxInfo.unitedStatesTaxIdentificationNumber (new) |