API Reference

The Trusted Entity Object

AttributeDescriptionFormat / ENUMS
id
string		Unique identifier of the Business Trusted Entity.e.g. eus_j82rl497g47g5ykvzn
business.companyName
string		Official Company NameCan be built of multiple space separated segments
Cannot contain any of these special chars:
<!&|$*;^%_>#@="~
{}\
business.tradingName
string		Trading Company NameCan be built of multiple space separated segments
business.type
string		Type of the business (Limited only)LIMITED
business.registrationNumber
string		Company registration number e.g. 56292646
business.registrationDate
LocalDate		Date when the company has been registered
business.website
string		Company websiteValidation regex: ((http(s)?)://)?(www\\.)?[a-zA-Z0-9\\-_.~]{2,256}(\\.[a-zA-Z]{2,6})(/\[a-zA-Z0-9!#$&'()\*+,/:;=?@\\[\\]\\-\_.~]{2,})?

JavaScript:
("^((http(s)?)://)?(www\\.)?[a-zA-Z0-9\\-_.~]{2,256}(\\.[a-zA-Z]{2,6})(/\[a-zA-Z0-9!#$&'()\*+,/:;=?@\\[\\]\\-\_.~]{2,})?$");
business.registeredAddress
string		Address under which company has been registeredIs required
business.registeredAddress.line1
string		First line of the company registration addressSpace and hyphen are allowed between the characters.
Max length 50
e.g. Silent Hill 123/34
business.registeredAddress.line2
string		Second line of the company registration addressSpace and hyphen are allowed between the characters.
Max length 50
business.registeredAddress.city
string		City of the registration addressSpace and hyphen are allowed between the characters.
Max length 50
e.g. London
business.registeredAddress.state
string		State or region of the registration addressSpace and hyphen are allowed between the characters.
Max length 35
e.g. Ile de France
business.registeredAddress.postalCode
string		Postal code of the registration addressThe format and presence of this field may vary depending on the country.
Space and hyphen are allowed between the characters. Please trim spaces at the end
Validation regex:

- for GB: ^[a-zA-Z]{1,2}[0-9R][0-9a-zA-Z]? ?[0-9]a-zA-Z[cikmovCIKMOV]]{2}$
- for Estonia: ^\\d{5}\$
- for Ireland: (?:[AC-FHKNPRTV-Y][0-9]{2}|D6W)[ -]?[0-9AC-FHKNPRTV-Y]{4}$
- others: ^[\p{L}\d] [\p{L}\s\d\-]{1,8}[\p{L}\d]$
business.registeredAddress.country
string		Country code of the registration addressThe two-letter code used to identify a country.
ISO 3166-1 alpha-2 country code e.g. GB or US
business.tradingAddress
string		Trading address of the company (might be the same as registration address)
business.tradingAddress.line1
string		First line of the company trading addressSpace and hyphen are allowed between the characters.
Max length 50
business.tradingAddress.line2
string		Second line of the company trading addressSpace and hyphen are allowed between the characters.
Max length 50
business.tradingAddress.city
string		City of the company trading addressSpace and hyphen are allowed between the characters.
Max length 50
business.tradingAddress.state
string		State of the company trading addressSpace and hyphen are allowed between the characters.
Max length 35
business.tradingAddress.postalCode
string		Postal code of the company trading addressThe format and presence of this field may vary depending on the country.
Space and hyphen are allowed between the characters. Please trim spaces at the end
e.g. 67999, 30-555, SW1A 1AA
Validation regex:

- for GB: ^[a-zA-Z]{1,2}[0-9R][0-9a-zA-Z]? ?[0-9]a-zA-Z[cikmovCIKMOV]]{2}$
- for Estonia: ^\\d{5}\$
- for Ireland: (?:[AC-FHKNPRTV-Y][0-9]{2}|D6W)[ -]?[0-9AC-FHKNPRTV-Y]{4}$
- others: ^[\p{L}\d] [\p{L}\s\d\-]{1,8}[\p{L}\d]$
business.tradingAddress.country
string		Country od the company trading addressThe two-letter code used to identify a country.
ISO 3166-1 alpha-2 country code e.g. GB or US
business.businessPersons.person.firstNameFirst name of the Business Person.Can be built of singular value.
Must have only letters, hyphens and apostrophes.
Regex:^\\p{L}[\p{L}'-]\*$
business.businessPersons.person.middleName
string		Middle name of the Business Person.Can be built of multiple space separated segments.
Should be between 1 and 100 characters long and contain only letters, hyphens, dots and apostrophes.
Regex: ^[\\p{L}'][ \p{L}.'-]\*\\p{L}$
business.businessPersons.person.lastName
string		Last name of the Business Person.Can be built of multiple space separated segments.
Must consist of words that have only letters, hyphens and apostrophes.
Regex: ^[\\p{L}'][ \p{L}'-]\*\\p{L}$
business.businessPersons.person.birthCountry
string		Country of birth of the Business Person.The two-letter code used to identify a country.
ISO 3166-1 alpha-2 country code e.g. GB or US
business.businessPersons.person.nationality
array of strings		One or more nationalities of the Business Person.The two-letter code used to identify a country.
ISO 3166-1 alpha-2 country code e.g. GB or US
business.businessPersons.person.dob
Date		Date of birth of the Business Person.YYYY-MM-DD format e.g. 1975-04-05
business.businessPersons.person.address.line1
string		First line of the Business Person's home address.Space and hyphen are allowed between the characters.
Max length 50
business.businessPersons.person.address.line2
string		Second line of the Business Person's home address.Space and hyphen are allowed between the characters.
Max length 50
business.businessPersons.person.address.city
string		City of the Business Person.Space and hyphen are allowed between the characters.
Max length 50
business.businessPersons.person.address.state
string		Region or state of the Business Person.Space and hyphen are allowed between the characters.
Max length 35
business.businessPersons.person.address.postalCode
string		Postal/Zip code of the Business Person.The format and presence of this field may vary depending on the country.
Space and hyphen are allowed between the characters. Please trim spaces at the end
e.g. 67999, 30-555, SW1A 1AA
Validation regex:

- for GB: ^[a-zA-Z]{1,2}[0-9R][0-9a-zA-Z]? ?[0-9]a-zA-Z[cikmovCIKMOV]]{2}$
- for Estonia: ^\\d{5}\$
- for Ireland: (?:[AC-FHKNPRTV-Y][0-9]{2}|D6W)[ -]?[0-9AC-FHKNPRTV-Y]{4}$
- others: ^[\p{L}\d] [\p{L}\s\d\-]{1,8}[\p{L}\d]$
business.businessPersons.person.address.country
string		Business Person's Country of residence.The two-letter code used to identify a country.
ISO 3166-1 alpha-2 country code e.g. GB or US
business.businessPersons.person.phone
string		Phone number of the Business Person.Including the country prefix e.g. +447788661100

- must start with a plus sign (+).

- should have country code (e.g., +1, +44, etc.) followed by the appropriate number of digits (min = 8, ma
business.businessPersons.person.email
string		Email of the Business Person.This is required
business.businessPersons.person.
identificationDocument.number		Number of identity document
business.businessPersons.person.
identificationDocument.type		Type of identity documentExamples:
WORK_PERMIT,
PASSPORT,
NATIONAL_ID,
DRIVERS_LICENCE
business.businessPersons.types
string		Type of the Business Person. Can be CONTACT / DIRECTOR / UBOThere must be at least 1 DIRECTOR and 1 UBO
business.businessPersons.ownership
BigDecimal		Amount of shares hold by the Business Person (in %)e.g. 50.00
business.createdAt
integer		Epoch Timestamp at which the object was last updated.e.g. 1637049210552
business.updatedAt
integer		Epoch Timestamp at which the object was last updated.e.g. 1637049210552
business.ipAddress
string		The IP address from where the individual signed up on your platform.e.g. 86.23.22.163
trustedBankDetails.currency
string		Currency of the Trusted Entity.3 letter ISO 4217 code of the currency in which you want to create the Fiat Account. e.g. GBP for Pound Sterling
trustedBankDetails.bankDetails
object		Depending on the currency and country, account will typically have at least an IBAN or an accountNumber.
trustedBankDetails.bankDetails.iban
string		IBAN of the Trusted Entity's bank account. An international bank account number for secure cross-border transactions.International Bank Account Number
trustedBankDetails.bankDetails.bic
string		BIC of the Trusted Entity's bank account.A unique alphanumeric code that is a bank identification code used globally.
trustedBankDetails.bankDetails.accountNumber
string		Account Number of the Trusted Entity's bank account. Depending on the currency and country, account will typically have at least an IBAN or an accountNumber.
trustedBankDetails.bankDetails.routingCodes
object		One or more routing codes associated with the Trusted Entity's bank account. Typically used in conjunction with the account number.
trustedBankDetails.bankDetails.routingCodes.type
string		Type of the routing code.SORT_CODE
trustedBankDetails.bankDetails.routingCodes.value
string		Value of the routing code.
trustedBankDetails.label
string		An label to easily identify the Trusted EntityUp to 128 characters
annualTurnoverRange
string		Value of annual turnover range of the Business Trusted Entity (in EUR)Ranges:

- 0 to 50000
- 50000 to 250000
- 250000 to 1000000
- 1000000 to 5000000
- above 5000000
linkedCryptoWallets
string		Details of any known crypto wallets linked with the individual being created.
tags
string		Tags allowing you to provide additional risk-related information for the individual.PEP
sector
string		Sector in which business operatese.g. crypto, blockchain
riskRating
string		Rating of the risk level assigned to the user.LOW, MEDIUM, HIGH
signupAt
integer		A date of registration of Trusted Entity profile within Member platforme.g. 1637049210552
metadata
array of strings		Additional data in JSON key:value format.See Metadata for more information
status
string		Status of the Business Trusted Entity.CREATED , IN_REVIEW,ACTIVE, SUSPENDED,REJECTED, CLOSED
trustedBankDetails.status
string		Status of the Business Trusted Entity Bank DetailsCREATED , CONFIRMED, REJECTED, UNAVAILABLE