Field |
Accepted value(s) or format(s) |
Required? (yes/no) |
Description |
Max length |
customer.configuration.screening_configuration_identifier |
n/a |
yes |
The identifier for the screening configuration you have set up in Mesh |
|
customer.monitoring.entity_screening.enabled |
TRUE FALSE |
no |
A boolean indicating if the customer should be monitored on an ongoing basis for screening |
|
customer.external_identifier |
n/a |
yes |
The identifier you assign each customer to uniquely identify them |
256 |
customer.person.full_name |
n/a |
yes (if last_name is not present) |
The person's full name, if any other name fields are populated this field should be null |
256 |
customer.person.title |
n/a |
no |
The person's title |
50 |
customer.person.first_name |
n/a |
no |
The person's first name |
50 |
customer.person.middle_name |
n/a |
no |
The person's middle name |
50 |
customer.person.last_name |
n/a |
yes (if full_name is not present) |
The person's last name |
50 |
customer.person.suffix |
n/a |
no |
The person's suffix |
50 |
customer.person.mothers_name |
n/a |
no |
The last name of the person's mother |
50 |
customer.person.fathers_name |
n/a |
no |
The last name of the person's father |
50 |
customer.person.date_of_birth.day |
number between 1 and 31 |
no |
The day of birth |
|
customer.person.date_of_birth.month |
number between 1 and 12 |
no |
The month of birth |
|
customer.person.date_of_birth.year |
number |
no |
The year of birth |
|
customer.person.gender |
MALE FEMALE OTHER |
no |
The person's gender |
|
customer.person.nationality[X] |
iso-3166-alpha-2 |
no |
The person's nationality |
|
customer.person.country_of_birth |
iso-3166-alpha-2 |
no |
The person's country of birth |
|
customer.person.residential_information[X].country_of_residence |
iso-3166-alpha-2 |
no |
The person's country of residence or citizenship |
|
customer.person.residential_information[X].residential_status |
RESIDENT PERMANENT_RESIDENT NON_RESIDENT |
no |
The residential status the person holds for that country of residence |
|
customer.person.address[X].type |
RESIDENTIAL_ADDRESS MAILING_ADDRESS BILLING_ADDRESS |
no |
The address type |
|
customer.person.address[X].address_line1 |
n/a |
no |
The first line of the address |
50 |
customer.person.address[X].address_line2 |
n/a |
no |
The second line of the address |
50 |
customer.person.address[X].town_name |
n/a |
no |
The town or city |
50 |
customer.person.address[X].postal_code |
n/a |
no |
The zip code or postal code |
50 |
customer.person.address[X].country_subdivision |
n/a |
no |
The country subdivision or state |
50 |
customer.person.address[X].country |
iso-3166-alpha-2 |
no |
The address country |
|
customer.person.contact_information.email_address[X] |
n/a |
no |
The customer's email address |
|
customer.person.contact_information.fax_number[X] |
Must start with a '+' followed by the country code and then the rest of the number |
no |
The customer's fax number |
|
customer.person.contact_information.phone_number[X] |
Must start with a '+' followed by the country code and then the rest of the number |
no |
The customer's phone number |
|
customer.person.contact_information.url[X] |
RFC-2369 (like http://www.complyadvantage.com |
no |
The customer's URL |
|
customer.person.personal_identification[X].type |
SOCIAL_SECURITY_NUMBER DRIVING_LICENCE PASSPORT IDENTITY_CARD TAX_REGISTRATION ALIEN_IDENTIFICATION EMPLOYER_IDENTIFICATION OTHER |
no |
The type of identity document |
|
customer.person.personal_identification[X].document_identifier |
n/a |
no |
The identity document's official number or identifier |
|
customer.person.personal_identification[X].issuing_country |
iso-3166-alpha-2 |
no |
The country that issued the identity document |
|
customer.person.personal_identification[X].date_of_issue.day |
number between 1 and 31 |
no |
The day the document was issued |
|
customer.person.personal_identification[X].date_of_issue.month |
number between 1 and 12 |
no |
The month the document was issued |
|
customer.person.personal_identification[X].date_of_issue.year |
number |
no |
The year the document was issued |
|
customer.person.personal_identification[X].date_of_expiry.day |
number between 1 and 31 |
no |
The day the document expires |
|
customer.person.personal_identification[X].date_of_expiry.month |
number between 1 and 12 |
no |
The month the document expires |
|
customer.person.personal_identification[X].date_of_expiry.year |
number |
no |
The year the document was expires |
|
customer.person.profession[X] |
n/a |
no |
The person's profession or occupation |
|
customer.person.source_of_wealth |
n/a |
no |
The person's source of wealth |
|
customer.person.salary.amount.high |
number |
no |
The upper limit for the person's annual salary |
|
customer.person.salary.amount.low |
number |
no |
The lower limit for the person's annual salary |
|
customer.person.salary.currency |
iso-4217 |
no |
The currency of the person's salary |
|
product[X].name |
n/a |
no |
The name of the product |
50 |
product[X].status |
n/a |
no |
The product status |
50 |
product[X].bank_account.account_number |
n/a |
no |
The bank account number |
34 |
product[X].bank_account.sort_code |
n/a |
no |
The sort code |
11 |
product[X].bank_account.iban |
n/a |
no |
The international bank account number (IBAN) |
36 |
product[X].bank_account.bban |
n/a |
no |
The basic bank account number (BBAN) |
30 |
product[X].bank_account.bank.bic |
n/a |
no |
The bank identifier code (BIC) |
11 |
product[X].crypto_wallet.wallet_id |
n/a |
no |
The public crypto wallet address identifier |
256 |
product[X].crypto_wallet.managing_exchange |
n/a |
no |
The exchange that manages the crypto wallet |
50 |
product[X].currency |
iso-4217 |
no |
The product base currency |
|
product[X].monthly_payment_amount |
n/a |
no |
The expected monthly amount sent from the account |
|
product[X].monthly_received_amount |
n/a |
no |
The expected month amount received into the account |
|
product[X].monthly_transaction_count |
n/a |
no |
The expected number of transactions per month |
|
product[X].purpose |
n/a |
no |
The account purpose |
256 |
product[X].onboarding_channel.online.ip_format |
IPv4 IPv6 |
no |
The format of the IP address |
|
product[X].onboarding_channel.online.ip_address |
n/a |
no |
The IP address used during online sign up |
|
product[X].onboarding_channel.online.device_identifier |
n/a |
no |
The device identifier used during online sign up |
256 |
product[X].onboarding_channel.online.device_type |
n/a |
no |
The type of device used during online sign up |
50 |
product[X].onboarding_channel.in_branch.branch_identifier |
n/a |
no |
The identifier of the branch used during in person sign up |
256 |