POST submits customer information for screening and due diligence checks. The endpoint evaluates the customer data and returns a persistent customerId, a calculated riskLevel, and supporting details such as score, caseStatus, and and so on.
To reprocess customer checks
Always use a POST request. This ensures that duplicate customer checks are not created in the system.
waitFor
customerChecks
Url that is called for any changes to the transaction status e.g.Operator marks the transactions as unsuspicious and systems posts to callback url.
Next customer review date
In case of a joint or shared account, the information on the main account holder should be sent under accountHoldingPartyData. The information on the secondary holders or co-owners should be sent via accountHoldingParties[]. accountHoldingPartyData need to contain values if accountHoldingParties[] is not empty
True if the account has been replaced before (see AccountReplacedNotes for reasoning)
Reasoning for why the account has been replaced
Distribution across business purposes. In addition to assignment of business purposes under companyDetails.businessPurposes
Specify the kind of distribution.
Share of the defined label
Delay of availability of deposited funds. Can be numeric (suffix 'd' for days) or categoric (reach out if categoric values are required).
Frequency of discount. Examples:
- DAILY
- WEEKLY
- MONTHLY
- QUARTERLY
Field describing status of employment
Expected contribution over channels.
Specify the kind of distribution.
Share of the defined label
Expected daily income (cashflow positive volume) in configured base currency
Expected monthly income (cashflow positive volume) in configured base currency
Expected income volume per year in configured base currency.
Expected avg ticket size in configured base currency
Max ticket size expected
Expected count of transactions per day
Expected count of transactions per month
Expected count of transactions per year
Expected daily volume (|in| + |out|) in configured base currency
Expected monthly volume (|in| + |out|) in configured base currency
Volatility of the volume. Examples:
- SEASONAL
- STABLE
- YEAR_END_SEASON
- ... (reach out for additional values)
Expected yearly volume (|in| + |out|) in configured base currency
List of major counterparty accounts of this account holder
Date when account was closed, provide full date (YYYY-MM-DD)
Email address that uniquely identifies the account within the scheme (e.g. for PayPal)
Id that identifies the account uniquely within the scheme or the sending sending tenant. E.g.
- merchant ID (MID) for credit card schemes
- tokenized card number if it is unique within the tenant
Account number that identifies the account uniquely withing the scheme along with other account details, if the scheme provides such an account number (e.g. IBAN, national account number).
Date when account was opened, provide full date (YYYY-MM-DD)
Status of the account
Type of account (e.g Money market account, checking account, savings account)
List of account attributes (e.g PND account, unacceptable risk account, partial assets freeze)
Country of the bank or financial insitution (ISO 3166 Alpha-2)
The bank identification code (BIC).
The bank name.
Currency the account is operated in. Examples:
- ETH
- BTC
- EUR
- USD ... (reach out if additional values are required)
Expiry month of the account details
The full name of the owner of the bank account with middle name, format: First Name, Middle Name, Last Name.
Last for digits of the account number if the full account number cannot be provided.E.g. for credit card payments
Date since the given postal address is valid. Provide date
List of all customer ids that are representing this account holder.
Id that helps referencing the contact information back to the system from which the data originates
Contact name if different from the name provided in PersonDetails/CompanyDetails. Leave empty otherwise.
Extension of the name line if required
Country of the contact address of the individual or company/organization
List of email addresses on which the customer can be reached.
List of phone numbers on which the customer can be reached.
Region of the contact address. Skip if not needed for a full address (Country subdivision code as defined in ISO 3166-2)
Extension field for region (e.g. county)
Street (incl. number if applicable)
Possible extention of the street line in the address block. Provide if required.
City of residence of the customer in case the customer is an individual. City where the main office of the company is located in case the account belongs to a company.
Unstructured address. Should be filled only if the address cannot be provided in the structured manner, that is, town, zip code, country or street.
List of web links (refer to WebLink data type) / or strings representing URLs. JsonNode type applied for backward compatibility.
Postal code of contact address of the individual or company
Overdraft limit amount
Code of the product used to facilitate the payment (as provided by the scheme operator)
See here for examples of such product codes
- Visa Product Id
- [Master/VISA product codes](https://payzen.io/in/webservices-payment/implementation-webservices-v5/ visa-mastercard-product-codes-cardresponse.productcode.html) Examples:
- BPD (MASTER Business Premium DEBIT)
- P (Visa Gold)
- WIC (EBT woman, infants, children )
- FOOD_STAMP
- ...
Type of the product or service. Examples:
- CHECKING_ACCOUNT
- CREDIT_CARD
- DEBIT_CARD
- PREPAID_CARD
- GIRO_ACCOUNT
- CHECKING_ACCOUNT
- SAVINGS_ACCOUNT
- STORED_VALUE_CARD
- TERM_ACCOUNT
- BASIS_ACCOUNT (as GIRO_ACCOUNT without the possibility to overdraft)
- VOUCHER (women, infants, children as part of EBT scheme),
- ... (reach out if additional values are required)
Scheme or processing network within the account details uniquely identify an account. Country code for national banking schemes (ISO 3166 Alpha-2).+ AMEX, AFFINBANK, AMBANK, BANCONTACT, BCMC, BITPAY, CARD_MERCHANTACCOUNT (for merchant accounts accepting card payments) , CARD2CARD, CCWEB, CIMBCLICKS, CITI, DE, DIRECTPAY, DRAGONPAY, DISCOVER, ENETS, EPS, ESAPAY, ESTONIANBANKS, FINNISH, GB , GIROPAY, HONGLEONGBANK, IDEAL, INSTANTTRANSFER, JCB, MAESTRO, MASTER, MAXIMA, MAYBANKTWOU, MULTIBANCO, MYBANK, MYCLEARFPX, P24 , P24PAYOUT, PAYSAFECARD, PAYSBUY, PAYSERA, PAYU, PUGGLEPAY, RHBBANK, SAFETYPAY, SEPA, SEVENELEVEN, SOLO, SINGPOST, SWITCH , TELEINGRESO, TRUSTLY, TRUSTPAY, UKASH, UNIONPAY, US, VERKKOPANKKI, VISA, WEBMONEY, WUQUICKPAY ... (reach out if additional values are required)
List of web links/urls to representations of the company or person in the internet or intranet
Title that should be displayed instead of link. If not provided, url will be used
web link/url to represent the company or person in the internet or intranet
List of assessments or scorings that have been conducted
Date the reflects the state of the information provided (YYYY-MM-DD)
Name of the conducted assessment. If it's a 3rd party assessment, pass the name of the provider or product Examples:
- EQUIFAX
- FICO
- IDOLOGY
- INTERNAL
- KYC
- OFAC
- SCHUFA
- VERID
- PEP_SCORE
- ADVERSE_MEDIA_SCORE
- SANCTION_SCORE
- ... (please reach out to request other values)
Free text for notes or comments regarding the assessment
Reference to the original assessment
Score that was given in the assessment. The range of the score depends on the assessment
Status of the assessment. _Examples:
- IN_PROGRESS
- DONE
Free text describing the business
List of business purposes of the company (ISO-18245 merchant category codes or an individually defined industry/sector list)
Id that helps referencing back the company information to the system from which the information is originated.
Name of the company according to commercial register
Country where the company was originally founded and registered (ISO 3166-1 alpha-2).
Tenants's company division or department contractually involved
List of documents linked to a company, such as business licenses, incorporation documents or corporate IDs
Identifies document issuing authority
Id/number identifiying as printed on the document. E.g. passport number
Identifies document issuing authority
Identifies document issuing country (ISO 3166-2)
Identifies document issuing state
Kind of identity document provided. Examples:
- DRIVING_LICENSE
- NATIONAL_IDENTITY_CARD
- PASSPORT
- SOCIAL_SECURITY
- ... (reach out if further values are required)
Link to scan of identity document
In business since
Legal form of the company (ISO-20275/ELF Code).
Type of organization. Examples:
- GOVERNMENTAL
- FOR_PROFIT
- NON_PROFIT
- PRIVATE_INVESTMENT_COMPANY
- ... (reach out to request more values)
List of shareholders/owners of the company/organization.
Date since the given postal address is valid. Provide date
List of all customer ids that are representing this account holder.
Id that helps referencing the contact information back to the system from which the data originates
Contact name if different from the name provided in PersonDetails/CompanyDetails. Leave empty otherwise.
Extension of the name line if required
Country of the contact address of the individual or company/organization
List of email addresses on which the customer can be reached.
List of phone numbers on which the customer can be reached.
Region of the contact address. Skip if not needed for a full address (Country subdivision code as defined in ISO 3166-2)
Extension field for region (e.g. county)
Street (incl. number if applicable)
Possible extention of the street line in the address block. Provide if required.
City of residence of the customer in case the customer is an individual. City where the main office of the company is located in case the account belongs to a company.
Unstructured address. Should be filled only if the address cannot be provided in the structured manner, that is, town, zip code, country or street.
List of web links (refer to WebLink data type) / or strings representing URLs. JsonNode type applied for backward compatibility.
Postal code of contact address of the individual or company
Liability taken. Examples:
- LIMITED
- PERSONAL
- ... (reach out of additional values are required)
List of assessments or scorings that have been conducted
Date the reflects the state of the information provided (YYYY-MM-DD)
Name of the conducted assessment. If it's a 3rd party assessment, pass the name of the provider or product Examples:
- EQUIFAX
- FICO
- IDOLOGY
- INTERNAL
- KYC
- OFAC
- SCHUFA
- VERID
- PEP_SCORE
- ADVERSE_MEDIA_SCORE
- SANCTION_SCORE
- ... (please reach out to request other values)
Free text for notes or comments regarding the assessment
Reference to the original assessment
Score that was given in the assessment. The range of the score depends on the assessment
Status of the assessment. _Examples:
- IN_PROGRESS
- DONE
Country where the customer was born.
Country where the customer currently lives.
Provide full date if available (YYYY-MM-DD). Otherwise provide the data available (e.g. year only)
Gender: 'f' (female), 'm' (male) or 'x' (other)
List of documents that identify a person
Identifies document issuing authority
Id/number identifiying as printed on the document. E.g. passport number
Identifies document issuing authority
Identifies document issuing country (ISO 3166-2)
Identifies document issuing state
Kind of identity document provided. Examples:
- DRIVING_LICENSE
- NATIONAL_IDENTITY_CARD
- PASSPORT
- SOCIAL_SECURITY
- ... (reach out if further values are required)
Link to scan of identity document
Nationality of the individual customer.
Occupation title
First name / given name
Last name / family name
Middle name(s) separated with space
Name given upon birth
City/place where the customer was born.
Social security number
Role/Title/function of the shareholder within the company Examples:
- FOUNDER
- COFOUNDER
- OWNER
- MAYORITY_SHAREHOLDER
- BOARD_MEMBER
- ... (reach of for further values)
Kept share up to max 1 (=100%)
List of tax IDs of the shareholder.
Tax type
Tax id
Indicates if the customer has a complex ownership structure. Possible values: 'Y' 'N'
List of the managing directors of the company/organization.
Date since the given postal address is valid. Provide date
List of all customer ids that are representing this account holder.
Id that helps referencing the contact information back to the system from which the data originates
Contact name if different from the name provided in PersonDetails/CompanyDetails. Leave empty otherwise.
Extension of the name line if required
Country of the contact address of the individual or company/organization
List of email addresses on which the customer can be reached.
List of phone numbers on which the customer can be reached.
Region of the contact address. Skip if not needed for a full address (Country subdivision code as defined in ISO 3166-2)
Extension field for region (e.g. county)
Street (incl. number if applicable)
Possible extention of the street line in the address block. Provide if required.
City of residence of the customer in case the customer is an individual. City where the main office of the company is located in case the account belongs to a company.
Unstructured address. Should be filled only if the address cannot be provided in the structured manner, that is, town, zip code, country or street.
List of web links (refer to WebLink data type) / or strings representing URLs. JsonNode type applied for backward compatibility.
Postal code of contact address of the individual or company
List of assessments or scorings that have been conducted
Date the reflects the state of the information provided (YYYY-MM-DD)
Name of the conducted assessment. If it's a 3rd party assessment, pass the name of the provider or product Examples:
- EQUIFAX
- FICO
- IDOLOGY
- INTERNAL
- KYC
- OFAC
- SCHUFA
- VERID
- PEP_SCORE
- ADVERSE_MEDIA_SCORE
- SANCTION_SCORE
- ... (please reach out to request other values)
Free text for notes or comments regarding the assessment
Reference to the original assessment
Score that was given in the assessment. The range of the score depends on the assessment
Status of the assessment. _Examples:
- IN_PROGRESS
- DONE
Country where the customer was born.
Country where the customer currently lives.
Provide full date if available (YYYY-MM-DD). Otherwise provide the data available (e.g. year only)
Gender: 'f' (female), 'm' (male) or 'x' (other)
List of documents that identify a person
Identifies document issuing authority
Id/number identifiying as printed on the document. E.g. passport number
Identifies document issuing authority
Identifies document issuing country (ISO 3166-2)
Identifies document issuing state
Kind of identity document provided. Examples:
- DRIVING_LICENSE
- NATIONAL_IDENTITY_CARD
- PASSPORT
- SOCIAL_SECURITY
- ... (reach out if further values are required)
Link to scan of identity document
Nationality of the individual customer.
Occupation title
First name / given name
Last name / family name
Middle name(s) separated with space
Name given upon birth
City/place where the customer was born.
Social security number
Role of the staffer. No need to provide the exact role name. " + Categorize into what makes sense from an AML perspective. Examples:
- MANAGER
- ACCOUNT_MANAGER
- ... (reach of for further values)
The trademark associated with the company
Date since the given postal address is valid. Provide date
List of all customer ids that are representing this account holder.
Id that helps referencing the contact information back to the system from which the data originates
Contact name if different from the name provided in PersonDetails/CompanyDetails. Leave empty otherwise.
Extension of the name line if required
Country of the contact address of the individual or company/organization
List of email addresses on which the customer can be reached.
List of phone numbers on which the customer can be reached.
Region of the contact address. Skip if not needed for a full address (Country subdivision code as defined in ISO 3166-2)
Extension field for region (e.g. county)
Street (incl. number if applicable)
Possible extention of the street line in the address block. Provide if required.
City of residence of the customer in case the customer is an individual. City where the main office of the company is located in case the account belongs to a company.
Unstructured address. Should be filled only if the address cannot be provided in the structured manner, that is, town, zip code, country or street.
List of web links (refer to WebLink data type) / or strings representing URLs. JsonNode type applied for backward compatibility.
Postal code of contact address of the individual or company
A hierarchy level for customers. Can be an internal grouping of customers or the name of a department the customer is assigned to
Customer number that identifies the customer uniquely in the system of the bank
End date of contract, provided in UTC YYYY-MM-DD
One time payment of contract, e.g. deposit. In configured base currency
Start date of contract, provided in UTC YYYY-MM-DD
In configured base currency
In configured base currency
In configured base currency
Country that has been designated settle transactions for this account holder
12323
Currency the limit is operated in
Date since the given postal address is valid. Provide date
List of all customer ids that are representing this account holder.
Id that helps referencing the contact information back to the system from which the data originates
Contact name if different from the name provided in PersonDetails/CompanyDetails. Leave empty otherwise.
Extension of the name line if required
Country of the contact address of the individual or company/organization
List of email addresses on which the customer can be reached.
List of phone numbers on which the customer can be reached.
Region of the contact address. Skip if not needed for a full address (Country subdivision code as defined in ISO 3166-2)
Extension field for region (e.g. county)
Street (incl. number if applicable)
Possible extention of the street line in the address block. Provide if required.
City of residence of the customer in case the customer is an individual. City where the main office of the company is located in case the account belongs to a company.
Unstructured address. Should be filled only if the address cannot be provided in the structured manner, that is, town, zip code, country or street.
List of web links (refer to WebLink data type) / or strings representing URLs. JsonNode type applied for backward compatibility.
Postal code of contact address of the individual or company
Title that should be displayed instead of link. If not provided, url will be used
web link/url to represent the company or person in the internet or intranet
Name of the business unit the customer is assigned to
Date since the given postal address is valid. Provide date
List of all customer ids that are representing this account holder.
Id that helps referencing the contact information back to the system from which the data originates
Contact name if different from the name provided in PersonDetails/CompanyDetails. Leave empty otherwise.
Extension of the name line if required
Country of the contact address of the individual or company/organization
List of email addresses on which the customer can be reached.
List of phone numbers on which the customer can be reached.
Region of the contact address. Skip if not needed for a full address (Country subdivision code as defined in ISO 3166-2)
Extension field for region (e.g. county)
Street (incl. number if applicable)
Possible extention of the street line in the address block. Provide if required.
City of residence of the customer in case the customer is an individual. City where the main office of the company is located in case the account belongs to a company.
Unstructured address. Should be filled only if the address cannot be provided in the structured manner, that is, town, zip code, country or street.
List of web links (refer to WebLink data type) / or strings representing URLs. JsonNode type applied for backward compatibility.
Postal code of contact address of the individual or company
List of assessments or scorings that have been conducted
Date the reflects the state of the information provided (YYYY-MM-DD)
Name of the conducted assessment. If it's a 3rd party assessment, pass the name of the provider or product Examples:
- EQUIFAX
- FICO
- IDOLOGY
- INTERNAL
- KYC
- OFAC
- SCHUFA
- VERID
- PEP_SCORE
- ADVERSE_MEDIA_SCORE
- SANCTION_SCORE
- ... (please reach out to request other values)
Free text for notes or comments regarding the assessment
Reference to the original assessment
Score that was given in the assessment. The range of the score depends on the assessment
Status of the assessment. _Examples:
- IN_PROGRESS
- DONE
Country where the customer was born.
Country where the customer currently lives.
Provide full date if available (YYYY-MM-DD). Otherwise provide the data available (e.g. year only)
Gender: 'f' (female), 'm' (male) or 'x' (other)
List of documents that identify a person
Identifies document issuing authority
Id/number identifiying as printed on the document. E.g. passport number
Identifies document issuing authority
Identifies document issuing country (ISO 3166-2)
Identifies document issuing state
Kind of identity document provided. Examples:
- DRIVING_LICENSE
- NATIONAL_IDENTITY_CARD
- PASSPORT
- SOCIAL_SECURITY
- ... (reach out if further values are required)
Link to scan of identity document
Nationality of the individual customer.
Occupation title
First name / given name
Last name / family name
Middle name(s) separated with space
Name given upon birth
City/place where the customer was born.
Social security number
Role of the staffer. No need to provide the exact role name. " + Categorize into what makes sense from an AML perspective. Examples:
- MANAGER
- ACCOUNT_MANAGER
- ... (reach of for further values)
The account holder is a customer since the provided date
Customer status of the account holding party
- KEY_ACCOUNT
- NEW
- MONITORING
- CLOSED
- ... (request additional values if required)
Type of customer. Example values:
- ASSOCIATION
- CORPORATION
- GOVERNMENT_AGENCY
- INDIVIDUAL
- INTERNAL_ORGANIZATION
- LIMITED_LIABILITY_COMPANY
- PARTNERSHIP
- TAX_EXEMPT_ORGANIZATION
- ORGANIZATION
- RETAIL
- BUYER
- LEGAL
- PRIVATE
- SUPPLIER
- IC
- UNKNOWN (provide only if unknown is exceptional) Other values are possible. Please reach out.
'Doing-business-as contact details
Date since the given postal address is valid. Provide date
List of all customer ids that are representing this account holder.
Id that helps referencing the contact information back to the system from which the data originates
Contact name if different from the name provided in PersonDetails/CompanyDetails. Leave empty otherwise.
Extension of the name line if required
Country of the contact address of the individual or company/organization
List of email addresses on which the customer can be reached.
List of phone numbers on which the customer can be reached.
Region of the contact address. Skip if not needed for a full address (Country subdivision code as defined in ISO 3166-2)
Extension field for region (e.g. county)
Street (incl. number if applicable)
Possible extention of the street line in the address block. Provide if required.
City of residence of the customer in case the customer is an individual. City where the main office of the company is located in case the account belongs to a company.
Unstructured address. Should be filled only if the address cannot be provided in the structured manner, that is, town, zip code, country or street.
List of web links (refer to WebLink data type) / or strings representing URLs. JsonNode type applied for backward compatibility.
Postal code of contact address of the individual or company
Unique identifier for the device used by the client (desktop, notebook, tablet, mobile).
Device and model used by the client (desktop, notebook, tablet, mobile).
Browser or application version used by the customer. Example: Google Chrome 104.0.5112.79 (Official Build) (64-bit).
Operating system and version used by the client.
Markers for client account.
List of assessments or scorings that have been conducted
Date the reflects the state of the information provided (YYYY-MM-DD)
Name of the conducted assessment. If it's a 3rd party assessment, pass the name of the provider or product Examples:
- EQUIFAX
- FICO
- IDOLOGY
- INTERNAL
- KYC
- OFAC
- SCHUFA
- VERID
- PEP_SCORE
- ADVERSE_MEDIA_SCORE
- SANCTION_SCORE
- ... (please reach out to request other values)
Free text for notes or comments regarding the assessment
Reference to the original assessment
Score that was given in the assessment. The range of the score depends on the assessment
Status of the assessment. _Examples:
- IN_PROGRESS
- DONE
Country where the customer was born.
Country where the customer currently lives.
Provide full date if available (YYYY-MM-DD). Otherwise provide the data available (e.g. year only)
Gender: 'f' (female), 'm' (male) or 'x' (other)
List of documents that identify a person
Identifies document issuing authority
Id/number identifiying as printed on the document. E.g. passport number
Identifies document issuing authority
Identifies document issuing country (ISO 3166-2)
Identifies document issuing state
Kind of identity document provided. Examples:
- DRIVING_LICENSE
- NATIONAL_IDENTITY_CARD
- PASSPORT
- SOCIAL_SECURITY
- ... (reach out if further values are required)
Link to scan of identity document
Nationality of the individual customer.
Occupation title
First name / given name
Last name / family name
Middle name(s) separated with space
Name given upon birth
City/place where the customer was born.
Social security number
Date when account was closed, provide full date (YYYY-MM-DD)
Email address that uniquely identifies the account within the scheme (e.g. for PayPal)
Id that identifies the account uniquely within the scheme or the sending sending tenant. E.g.
- merchant ID (MID) for credit card schemes
- tokenized card number if it is unique within the tenant
Account number that identifies the account uniquely withing the scheme along with other account details, if the scheme provides such an account number (e.g. IBAN, national account number).
Date when account was opened, provide full date (YYYY-MM-DD)
Status of the account
Type of account (e.g Money market account, checking account, savings account)
List of account attributes (e.g PND account, unacceptable risk account, partial assets freeze)
Country of the bank or financial insitution (ISO 3166 Alpha-2)
The bank identification code (BIC).
The bank name.
Currency the account is operated in. Examples:
- ETH
- BTC
- EUR
- USD ... (reach out if additional values are required)
Expiry month of the account details
The full name of the owner of the bank account with middle name, format: First Name, Middle Name, Last Name.
Last for digits of the account number if the full account number cannot be provided.E.g. for credit card payments
Date since the given postal address is valid. Provide date
List of all customer ids that are representing this account holder.
Id that helps referencing the contact information back to the system from which the data originates
Contact name if different from the name provided in PersonDetails/CompanyDetails. Leave empty otherwise.
Extension of the name line if required
Country of the contact address of the individual or company/organization
List of email addresses on which the customer can be reached.
List of phone numbers on which the customer can be reached.
Region of the contact address. Skip if not needed for a full address (Country subdivision code as defined in ISO 3166-2)
Extension field for region (e.g. county)
Street (incl. number if applicable)
Possible extention of the street line in the address block. Provide if required.
City of residence of the customer in case the customer is an individual. City where the main office of the company is located in case the account belongs to a company.
Unstructured address. Should be filled only if the address cannot be provided in the structured manner, that is, town, zip code, country or street.
List of web links (refer to WebLink data type) / or strings representing URLs. JsonNode type applied for backward compatibility.
Postal code of contact address of the individual or company
Overdraft limit amount
Code of the product used to facilitate the payment (as provided by the scheme operator)
See here for examples of such product codes
- Visa Product Id
- [Master/VISA product codes](https://payzen.io/in/webservices-payment/implementation-webservices-v5/ visa-mastercard-product-codes-cardresponse.productcode.html) Examples:
- BPD (MASTER Business Premium DEBIT)
- P (Visa Gold)
- WIC (EBT woman, infants, children )
- FOOD_STAMP
- ...
Type of the product or service. Examples:
- CHECKING_ACCOUNT
- CREDIT_CARD
- DEBIT_CARD
- PREPAID_CARD
- GIRO_ACCOUNT
- CHECKING_ACCOUNT
- SAVINGS_ACCOUNT
- STORED_VALUE_CARD
- TERM_ACCOUNT
- BASIS_ACCOUNT (as GIRO_ACCOUNT without the possibility to overdraft)
- VOUCHER (women, infants, children as part of EBT scheme),
- ... (reach out if additional values are required)
Scheme or processing network within the account details uniquely identify an account. Country code for national banking schemes (ISO 3166 Alpha-2).+ AMEX, AFFINBANK, AMBANK, BANCONTACT, BCMC, BITPAY, CARD_MERCHANTACCOUNT (for merchant accounts accepting card payments) , CARD2CARD, CCWEB, CIMBCLICKS, CITI, DE, DIRECTPAY, DRAGONPAY, DISCOVER, ENETS, EPS, ESAPAY, ESTONIANBANKS, FINNISH, GB , GIROPAY, HONGLEONGBANK, IDEAL, INSTANTTRANSFER, JCB, MAESTRO, MASTER, MAXIMA, MAYBANKTWOU, MULTIBANCO, MYBANK, MYCLEARFPX, P24 , P24PAYOUT, PAYSAFECARD, PAYSBUY, PAYSERA, PAYU, PUGGLEPAY, RHBBANK, SAFETYPAY, SEPA, SEVENELEVEN, SOLO, SINGPOST, SWITCH , TELEINGRESO, TRUSTLY, TRUSTPAY, UKASH, UNIONPAY, US, VERKKOPANKKI, VISA, WEBMONEY, WUQUICKPAY ... (reach out if additional values are required)
List of web links/urls to representations of the company or person in the internet or intranet
Title that should be displayed instead of link. If not provided, url will be used
web link/url to represent the company or person in the internet or intranet
Network and IP provider for the IP address used by the client to register the account.
IP address used by the client for account registration (for PEP/Sacntions checks).
Country where the IP used to register the account is located at (ISO 3166-1 alpha-2).
Expected level of risk, describing the likeliness that the bank customer is involved in fraudulent activities; allowed values: ("LOW", "MEDIUM", "HIGH", "PROHIBITED")
Role in the account ownership
List the products the account holder signed
Tax id (VAT, Tax number, permant tax identification) that uniquely identifies the holder
Tax ID type
In case of multiple counterparties, the information on the main counterparty should be sent under counterpartyData. The information on the remaining counterparties should be sent via counterparties[].counterpartyData need to contain values if counterparties[] is not empty
List of assessments or scorings that have been conducted
Date the reflects the state of the information provided (YYYY-MM-DD)
Name of the conducted assessment. If it's a 3rd party assessment, pass the name of the provider or product Examples:
- EQUIFAX
- FICO
- IDOLOGY
- INTERNAL
- KYC
- OFAC
- SCHUFA
- VERID
- PEP_SCORE
- ADVERSE_MEDIA_SCORE
- SANCTION_SCORE
- ... (please reach out to request other values)
Free text for notes or comments regarding the assessment
Reference to the original assessment
Score that was given in the assessment. The range of the score depends on the assessment
Status of the assessment. _Examples:
- IN_PROGRESS
- DONE
Free text describing the business
List of business purposes of the company (ISO-18245 merchant category codes or an individually defined industry/sector list)
Id that helps referencing back the company information to the system from which the information is originated.
Name of the company according to commercial register
Country where the company was originally founded and registered (ISO 3166-1 alpha-2).
Tenants's company division or department contractually involved
List of documents linked to a company, such as business licenses, incorporation documents or corporate IDs
Identifies document issuing authority
Id/number identifiying as printed on the document. E.g. passport number
Identifies document issuing authority
Identifies document issuing country (ISO 3166-2)
Identifies document issuing state
Kind of identity document provided. Examples:
- DRIVING_LICENSE
- NATIONAL_IDENTITY_CARD
- PASSPORT
- SOCIAL_SECURITY
- ... (reach out if further values are required)
Link to scan of identity document
In business since
Legal form of the company (ISO-20275/ELF Code).
Type of organization. Examples:
- GOVERNMENTAL
- FOR_PROFIT
- NON_PROFIT
- PRIVATE_INVESTMENT_COMPANY
- ... (reach out to request more values)
List of shareholders/owners of the company/organization.
Date since the given postal address is valid. Provide date
List of all customer ids that are representing this account holder.
Id that helps referencing the contact information back to the system from which the data originates
Contact name if different from the name provided in PersonDetails/CompanyDetails. Leave empty otherwise.
Extension of the name line if required
Country of the contact address of the individual or company/organization
List of email addresses on which the customer can be reached.
List of phone numbers on which the customer can be reached.
Region of the contact address. Skip if not needed for a full address (Country subdivision code as defined in ISO 3166-2)
Extension field for region (e.g. county)
Street (incl. number if applicable)
Possible extention of the street line in the address block. Provide if required.
City of residence of the customer in case the customer is an individual. City where the main office of the company is located in case the account belongs to a company.
Unstructured address. Should be filled only if the address cannot be provided in the structured manner, that is, town, zip code, country or street.
List of web links (refer to WebLink data type) / or strings representing URLs. JsonNode type applied for backward compatibility.
Postal code of contact address of the individual or company
Liability taken. Examples:
- LIMITED
- PERSONAL
- ... (reach out of additional values are required)
List of assessments or scorings that have been conducted
Date the reflects the state of the information provided (YYYY-MM-DD)
Name of the conducted assessment. If it's a 3rd party assessment, pass the name of the provider or product Examples:
- EQUIFAX
- FICO
- IDOLOGY
- INTERNAL
- KYC
- OFAC
- SCHUFA
- VERID
- PEP_SCORE
- ADVERSE_MEDIA_SCORE
- SANCTION_SCORE
- ... (please reach out to request other values)
Free text for notes or comments regarding the assessment
Reference to the original assessment
Score that was given in the assessment. The range of the score depends on the assessment
Status of the assessment. _Examples:
- IN_PROGRESS
- DONE
Country where the customer was born.
Country where the customer currently lives.
Provide full date if available (YYYY-MM-DD). Otherwise provide the data available (e.g. year only)
Gender: 'f' (female), 'm' (male) or 'x' (other)
List of documents that identify a person
Identifies document issuing authority
Id/number identifiying as printed on the document. E.g. passport number
Identifies document issuing authority
Identifies document issuing country (ISO 3166-2)
Identifies document issuing state
Kind of identity document provided. Examples:
- DRIVING_LICENSE
- NATIONAL_IDENTITY_CARD
- PASSPORT
- SOCIAL_SECURITY
- ... (reach out if further values are required)
Link to scan of identity document
Nationality of the individual customer.
Occupation title
First name / given name
Last name / family name
Middle name(s) separated with space
Name given upon birth
City/place where the customer was born.
Social security number
Role/Title/function of the shareholder within the company Examples:
- FOUNDER
- COFOUNDER
- OWNER
- MAYORITY_SHAREHOLDER
- BOARD_MEMBER
- ... (reach of for further values)
Kept share up to max 1 (=100%)
List of tax IDs of the shareholder.
Tax type
Tax id
Indicates if the customer has a complex ownership structure. Possible values: 'Y' 'N'
List of the managing directors of the company/organization.
Date since the given postal address is valid. Provide date
List of all customer ids that are representing this account holder.
Id that helps referencing the contact information back to the system from which the data originates
Contact name if different from the name provided in PersonDetails/CompanyDetails. Leave empty otherwise.
Extension of the name line if required
Country of the contact address of the individual or company/organization
List of email addresses on which the customer can be reached.
List of phone numbers on which the customer can be reached.
Region of the contact address. Skip if not needed for a full address (Country subdivision code as defined in ISO 3166-2)
Extension field for region (e.g. county)
Street (incl. number if applicable)
Possible extention of the street line in the address block. Provide if required.
City of residence of the customer in case the customer is an individual. City where the main office of the company is located in case the account belongs to a company.
Unstructured address. Should be filled only if the address cannot be provided in the structured manner, that is, town, zip code, country or street.
List of web links (refer to WebLink data type) / or strings representing URLs. JsonNode type applied for backward compatibility.
Postal code of contact address of the individual or company
List of assessments or scorings that have been conducted
Date the reflects the state of the information provided (YYYY-MM-DD)
Name of the conducted assessment. If it's a 3rd party assessment, pass the name of the provider or product Examples:
- EQUIFAX
- FICO
- IDOLOGY
- INTERNAL
- KYC
- OFAC
- SCHUFA
- VERID
- PEP_SCORE
- ADVERSE_MEDIA_SCORE
- SANCTION_SCORE
- ... (please reach out to request other values)
Free text for notes or comments regarding the assessment
Reference to the original assessment
Score that was given in the assessment. The range of the score depends on the assessment
Status of the assessment. _Examples:
- IN_PROGRESS
- DONE
Country where the customer was born.
Country where the customer currently lives.
Provide full date if available (YYYY-MM-DD). Otherwise provide the data available (e.g. year only)
Gender: 'f' (female), 'm' (male) or 'x' (other)
List of documents that identify a person
Identifies document issuing authority
Id/number identifiying as printed on the document. E.g. passport number
Identifies document issuing authority
Identifies document issuing country (ISO 3166-2)
Identifies document issuing state
Kind of identity document provided. Examples:
- DRIVING_LICENSE
- NATIONAL_IDENTITY_CARD
- PASSPORT
- SOCIAL_SECURITY
- ... (reach out if further values are required)
Link to scan of identity document
Nationality of the individual customer.
Occupation title
First name / given name
Last name / family name
Middle name(s) separated with space
Name given upon birth
City/place where the customer was born.
Social security number
Role of the staffer. No need to provide the exact role name. " + Categorize into what makes sense from an AML perspective. Examples:
- MANAGER
- ACCOUNT_MANAGER
- ... (reach of for further values)
The trademark associated with the company
Date since the given postal address is valid. Provide date
List of all customer ids that are representing this account holder.
Id that helps referencing the contact information back to the system from which the data originates
Contact name if different from the name provided in PersonDetails/CompanyDetails. Leave empty otherwise.
Extension of the name line if required
Country of the contact address of the individual or company/organization
List of email addresses on which the customer can be reached.
List of phone numbers on which the customer can be reached.
Region of the contact address. Skip if not needed for a full address (Country subdivision code as defined in ISO 3166-2)
Extension field for region (e.g. county)
Street (incl. number if applicable)
Possible extention of the street line in the address block. Provide if required.
City of residence of the customer in case the customer is an individual. City where the main office of the company is located in case the account belongs to a company.
Unstructured address. Should be filled only if the address cannot be provided in the structured manner, that is, town, zip code, country or street.
List of web links (refer to WebLink data type) / or strings representing URLs. JsonNode type applied for backward compatibility.
Postal code of contact address of the individual or company
Customer number that identifies the customer uniquely in the system of the bank
'Doing-business-as contact details
Date since the given postal address is valid. Provide date
List of all customer ids that are representing this account holder.
Id that helps referencing the contact information back to the system from which the data originates
Contact name if different from the name provided in PersonDetails/CompanyDetails. Leave empty otherwise.
Extension of the name line if required
Country of the contact address of the individual or company/organization
List of email addresses on which the customer can be reached.
List of phone numbers on which the customer can be reached.
Region of the contact address. Skip if not needed for a full address (Country subdivision code as defined in ISO 3166-2)
Extension field for region (e.g. county)
Street (incl. number if applicable)
Possible extention of the street line in the address block. Provide if required.
City of residence of the customer in case the customer is an individual. City where the main office of the company is located in case the account belongs to a company.
Unstructured address. Should be filled only if the address cannot be provided in the structured manner, that is, town, zip code, country or street.
List of web links (refer to WebLink data type) / or strings representing URLs. JsonNode type applied for backward compatibility.
Postal code of contact address of the individual or company
List of assessments or scorings that have been conducted
Date the reflects the state of the information provided (YYYY-MM-DD)
Name of the conducted assessment. If it's a 3rd party assessment, pass the name of the provider or product Examples:
- EQUIFAX
- FICO
- IDOLOGY
- INTERNAL
- KYC
- OFAC
- SCHUFA
- VERID
- PEP_SCORE
- ADVERSE_MEDIA_SCORE
- SANCTION_SCORE
- ... (please reach out to request other values)
Free text for notes or comments regarding the assessment
Reference to the original assessment
Score that was given in the assessment. The range of the score depends on the assessment
Status of the assessment. _Examples:
- IN_PROGRESS
- DONE
Country where the customer was born.
Country where the customer currently lives.
Provide full date if available (YYYY-MM-DD). Otherwise provide the data available (e.g. year only)
Gender: 'f' (female), 'm' (male) or 'x' (other)
List of documents that identify a person
Identifies document issuing authority
Id/number identifiying as printed on the document. E.g. passport number
Identifies document issuing authority
Identifies document issuing country (ISO 3166-2)
Identifies document issuing state
Kind of identity document provided. Examples:
- DRIVING_LICENSE
- NATIONAL_IDENTITY_CARD
- PASSPORT
- SOCIAL_SECURITY
- ... (reach out if further values are required)
Link to scan of identity document
Nationality of the individual customer.
Occupation title
First name / given name
Last name / family name
Middle name(s) separated with space
Name given upon birth
City/place where the customer was born.
Social security number
Date when account was closed, provide full date (YYYY-MM-DD)
Email address that uniquely identifies the account within the scheme (e.g. for PayPal)
Id that identifies the account uniquely within the scheme or the sending sending tenant. E.g.
- merchant ID (MID) for credit card schemes
- tokenized card number if it is unique within the tenant
Account number that identifies the account uniquely withing the scheme along with other account details, if the scheme provides such an account number (e.g. IBAN, national account number).
Date when account was opened, provide full date (YYYY-MM-DD)
Status of the account
Type of account (e.g Money market account, checking account, savings account)
List of account attributes (e.g PND account, unacceptable risk account, partial assets freeze)
Country of the bank or financial insitution (ISO 3166 Alpha-2)
The bank identification code (BIC).
The bank name.
Currency the account is operated in. Examples:
- ETH
- BTC
- EUR
- USD ... (reach out if additional values are required)
Expiry month of the account details
The full name of the owner of the bank account with middle name, format: First Name, Middle Name, Last Name.
Last for digits of the account number if the full account number cannot be provided.E.g. for credit card payments
Date since the given postal address is valid. Provide date
List of all customer ids that are representing this account holder.
Id that helps referencing the contact information back to the system from which the data originates
Contact name if different from the name provided in PersonDetails/CompanyDetails. Leave empty otherwise.
Extension of the name line if required
Country of the contact address of the individual or company/organization
List of email addresses on which the customer can be reached.
List of phone numbers on which the customer can be reached.
Region of the contact address. Skip if not needed for a full address (Country subdivision code as defined in ISO 3166-2)
Extension field for region (e.g. county)
Street (incl. number if applicable)
Possible extention of the street line in the address block. Provide if required.
City of residence of the customer in case the customer is an individual. City where the main office of the company is located in case the account belongs to a company.
Unstructured address. Should be filled only if the address cannot be provided in the structured manner, that is, town, zip code, country or street.
List of web links (refer to WebLink data type) / or strings representing URLs. JsonNode type applied for backward compatibility.
Postal code of contact address of the individual or company
Overdraft limit amount
Code of the product used to facilitate the payment (as provided by the scheme operator)
See here for examples of such product codes
- Visa Product Id
- [Master/VISA product codes](https://payzen.io/in/webservices-payment/implementation-webservices-v5/ visa-mastercard-product-codes-cardresponse.productcode.html) Examples:
- BPD (MASTER Business Premium DEBIT)
- P (Visa Gold)
- WIC (EBT woman, infants, children )
- FOOD_STAMP
- ...
Type of the product or service. Examples:
- CHECKING_ACCOUNT
- CREDIT_CARD
- DEBIT_CARD
- PREPAID_CARD
- GIRO_ACCOUNT
- CHECKING_ACCOUNT
- SAVINGS_ACCOUNT
- STORED_VALUE_CARD
- TERM_ACCOUNT
- BASIS_ACCOUNT (as GIRO_ACCOUNT without the possibility to overdraft)
- VOUCHER (women, infants, children as part of EBT scheme),
- ... (reach out if additional values are required)
Scheme or processing network within the account details uniquely identify an account. Country code for national banking schemes (ISO 3166 Alpha-2).+ AMEX, AFFINBANK, AMBANK, BANCONTACT, BCMC, BITPAY, CARD_MERCHANTACCOUNT (for merchant accounts accepting card payments) , CARD2CARD, CCWEB, CIMBCLICKS, CITI, DE, DIRECTPAY, DRAGONPAY, DISCOVER, ENETS, EPS, ESAPAY, ESTONIANBANKS, FINNISH, GB , GIROPAY, HONGLEONGBANK, IDEAL, INSTANTTRANSFER, JCB, MAESTRO, MASTER, MAXIMA, MAYBANKTWOU, MULTIBANCO, MYBANK, MYCLEARFPX, P24 , P24PAYOUT, PAYSAFECARD, PAYSBUY, PAYSERA, PAYU, PUGGLEPAY, RHBBANK, SAFETYPAY, SEPA, SEVENELEVEN, SOLO, SINGPOST, SWITCH , TELEINGRESO, TRUSTLY, TRUSTPAY, UKASH, UNIONPAY, US, VERKKOPANKKI, VISA, WEBMONEY, WUQUICKPAY ... (reach out if additional values are required)
List of web links/urls to representations of the company or person in the internet or intranet
Title that should be displayed instead of link. If not provided, url will be used
web link/url to represent the company or person in the internet or intranet
Role of the person in the transaction
Tax id (VAT, Tax number, permant tax identification) that uniquely identifies the holder
Tax ID type
The counterparty is verified since the provided date
Name of the underwriter
Id that helps referencing the information back to the system from which the data originates
Underlying technical network used. Esp when it does not align with the scheme.For Multichain cryptocurrencies use it to identify the underlying blockchain in case of native or bridged usage
Customer successfully checked
Unauthorized
Forbidden
Too early. Please do not send yet this customer. Try again later.
Too many requests. Please retry later