Customer
- PERSON
- LEGAL_ENTITY
- ARCHITECTURE_CARTOGRAPHY_SURVEYOR - "Architecture, Cartography, Surveyor"
- LIFE_PHYSICAL_AND_SOCIAL_SCIENCES - "Life, Physical, and Social Sciences"
- COMMUNITY_AND_SOCIAL_SERVICES - "Community and Social Services"
- NEWS_AND_REPORTING_SERVICES - "News and Reporting Services"
- HEALTHCARE_SERVICES - "Healthcare Services"
- LAW_ENFORCEMENT_AND_PUBLIC_SAFETY - "Law Enforcement and Public Safety"
- FOOD_AND_BEVERAGE_INDUSTRY - "Food and Beverage Industry"
- DOMESTIC_SERVICES - "Domestic Services"
- PERSONAL_CARE_PROFESSIONAL_SERVICES - "Personal Care Professional Services"
- SALES_AND_RELATED_OCCUPATIONS - "Sales and Related Occupations"
- OFFICE_ADMINISTRATION_AND_SUPPORT - "Office Administration and Support"
- FARMING_FISHING_AND_FORESTRY_SERVICES - "Farming, Fishing and Forestry Services"
- CONSTRUCTION_AND_RELATED_SERVICES - "Construction and Related Services"
- MANUFACTURING_SERVICES - "Manufacturing Services"
- TRANSPORTATION_SERVICES - "Transportation Services"
- ENTERTAINMENT_MEDIA - "Entertainment and Media"
- UNEMPLOYED - "Unemployed"
- STUDENT - "Student"
- PENSIONER - "Pensioner"
- SPORTS_INDUSTRY - "Sports Industry"
- BETTING_INDUSTRY - "Betting Industry"
- ART_AND_DESIGN - "Art and Design"
- EDUCATION_AND_EDUCATIONAL_SURVICES - "Education and Educational Support Services"
- ENGINEERING - "Engineering"
- FINANCIAL_AND_INSURANCE_SERVICES - "Financial and Insurance Services"
- IT_SOFTWARE_HARDWARE_AND_WEBSITE_DEVELOPMENT - "IT Software, Hardware and Website Development"
- LEGAL_AND_COMPLIANCE_SERVICES - "Legal and Compliance Services"
- MANAGEMENT_CONSULTING - "Management Consulting"
- WEAPON_INDUSTRY - "Weapon Industry"
- CHARITY_AND_NON_PROFIT_SERVICES - "Charity, Non-Profit Services"
- FREELANCER_SELF_EMPLOYED - "Freelancer, Self-employed"
- PUBLIC_SECTOR - "Public Sector"
Array [
]
Array [
Array [
]
]
Array [
Array [
]
]
Array [
Array [
]
]
Array [
- ALL_TRANSACTIONS - Block all types of transactions.
- OUTGOING_TRANSACTIONS - Block withdrawals and send money transactions.
- INCOMING_TRANSACTIONS - Block all types of bank ( ACH, bankwire) and card deposits, including EFT deposits; received money from other customers and merchants; sell crypto and stocks.
- SEND_MONEY - Block all send money transactions to other customers and merchants.
- INCOMING_TRANSACTIONS_AND_SEND_MONEY - Block all types of bank ( ACH, bankwire) and card deposits, including EFT deposits; received money from other customers and merchants; sell crypto and stocks. Block all send money transactions to other customers and merchants.
- CARD_DEPOSITS - Block all deposit made by card.
- CARD_AND_ACH_DEPOSITS - Block all deposit made by card and ACH bank deposits.
- DEPOSITS - Block all types of bank ( ACH, bankwire) and card deposits, including EFT deposits.
- OUTGOING_TRANSACTIONS_AND_CARD_DEPOSITS - Block withdrawals and send money transactions and all card deposits.
- OUTGOING_TRANSACTIONS_AND_ACH_DEPOSITS - Block all types of withdrawals (including ATM and POS trn with prepaid card) and ACH deposits.
- DEPOSITS_AND_WITHDRAWALS - Bocks all withdrawals and deposits.
- CRYPTO_TRANSACTIONS - Block all crypto trn including buy and sell, received and send crypto.
- OTHER - Other restrictions.
- RISK_CONTROLS - The reason for setting up the restriction requires additional risk checks to the end-customer's account.
- COMPLIANCE - The reason for setting up the restriction is related to the customer's due diligence and requires an additional compliance check of the end-customer's account.
- CLOSE_ACCOUNT - Account closure.
- DUPLICATE_ACCOUNT - The reason for setting up the restriction shows that the same person already exists as the account owner.
- KYC - The reason for setting up the restriction is related to the customer's KYC verification and requires KYC document submissions.
- NO_SERVICE_COUNTRY - No service country.
- PREPAID_CARD_CHARGEBACK - Pre-paid card chargeback.
- T_C_ABUSE - Terms & Conditions Abuse
- TERMINATED - Account terminated.
- UNDER_18 - Customer under 18.
- MERCHANT_REQUEST - Merchant placed the restriction.
- CONFIRM_TXN_ACTIVITY - Contact customer to confirm pre-paid card transactional activities.
- OTHER - Other reason.
]
Array [
Array [
- SEPA_BANK_ACCOUNT
- UK_BANK_ACCOUNT
- US_BANK_ACCOUNT
]
Array [
]
]
Possible values: <= 20 characters
Possible values: non-empty
and <= 40 characters
Customer identifier used in Partner system.
type
string
Possible values: [PERSON
, LEGAL_ENTITY
]
Type of Customer
Possible values: <= 50 characters
First name. Only latin characters, spaces, single quotes, and hyphens are allowed.
Possible values: <= 50 characters
Last name. Only latin characters, spaces, single quotes, and hyphens are allowed.
Possible values: <= 15 characters
Personal title, Mr., Dr., etc.
Possible values: <= 200 characters
Address line 1.
Possible values: <= 200 characters
Address line 2.
Possible values: <= 100 characters
City of residence.
Possible values: <= 30 characters
Postal code.
Possible values: <= 2 characters
US state postal abbreviation. Not used for non US territories.
Possible values: >= 2 characters
and <= 2 characters
ISO-3166 Alpha 2
Birth date in YYYY-MM-DD format.
Possible values: >= 2 characters
and <= 2 characters
ISO-3166 Alpha 2
Possible values: [ARCHITECTURE_CARTOGRAPHY_SURVEYOR
, LIFE_PHYSICAL_AND_SOCIAL_SCIENCES
, COMMUNITY_AND_SOCIAL_SERVICES
, NEWS_AND_REPORTING_SERVICES
, HEALTHCARE_SERVICES
, LAW_ENFORCEMENT_AND_PUBLIC_SAFETY
, FOOD_AND_BEVERAGE_INDUSTRY
, DOMESTIC_SERVICES
, PERSONAL_CARE_PROFESSIONAL_SERVICES
, SALES_AND_RELATED_OCCUPATIONS
, OFFICE_ADMINISTRATION_AND_SUPPORT
, FARMING_FISHING_AND_FORESTRY_SERVICES
, CONSTRUCTION_AND_RELATED_SERVICES
, MANUFACTURING_SERVICES
, TRANSPORTATION_SERVICES
, ENTERTAINMENT_MEDIA
, UNEMPLOYED
, STUDENT
, PENSIONER
, SPORTS_INDUSTRY
, BETTING_INDUSTRY
, ART_AND_DESIGN
, EDUCATION_AND_EDUCATIONAL_SURVICES
, ENGINEERING
, FINANCIAL_AND_INSURANCE_SERVICES
, IT_SOFTWARE_HARDWARE_AND_WEBSITE_DEVELOPMENT
, LEGAL_AND_COMPLIANCE_SERVICES
, MANAGEMENT_CONSULTING
, WEAPON_INDUSTRY
, CHARITY_AND_NON_PROFIT_SERVICES
, FREELANCER_SELF_EMPLOYED
, PUBLIC_SECTOR
]
Valid occupation:
Possible values: [PHYSICAL_DISABILITY
, LOW_MENTAL_CAPACITY
, GAMBLING_ADDICTION
, FINANCE_MISMANAGEMENT
, POOR_LITERACY
, POOR_LANGUAGE_SKILLS
, POOR_DIGITAL_SKILLS
, CARING_RESPONSIBILITIES
, FRAUDULENT_LOCATION
]
List of vulnerabilities
additionalAttributes
object
List of additional attributes not covered in standard list. Specifics need to be aligned during integration with Paysafe.
Possible values: <= 100 characters
Name of the company
Possible values: <= 100 characters
The official company id according to local business registration agency in the country of registration
registrationAddress
object
required
Possible values: >= 2 characters
and <= 2 characters
ISO-3166 Alpha 2
Possible values: <= 50 characters
Possible values: non-empty
and <= 50 characters
Possible values: <= 200 characters
Possible values: <= 200 characters
operatingAddress
object
required
Possible values: >= 2 characters
and <= 2 characters
ISO-3166 Alpha 2
Possible values: <= 50 characters
Possible values: non-empty
and <= 50 characters
Possible values: <= 200 characters
Possible values: <= 200 characters
Possible values: <= 500 characters
expectedTransactionVolume
object
Expected transaction volume of the legal entity for a rolling period of 1 year
Possible values: < 10000000000000
Amount in minor units
Possible values: >= 3 characters
and <= 3 characters
Currency alphabetic code as specified by ISO 4217
representative
object
required
Possible values: <= 20 characters
Possible values: non-empty
and <= 50 characters
First name. Only latin characters, spaces, single quotes, and hyphens are allowed.
Possible values: <= 50 characters
Middle name. Only latin characters, spaces, single quotes, and hyphens are allowed.
Possible values: non-empty
and <= 50 characters
Last name. Only latin characters, spaces, single quotes, and hyphens are allowed.
Possible values: >= 2 characters
and <= 2 characters
ISO-3166 Alpha 2
Possible values: non-empty
and <= 40 characters
Official person id as registered in a national agency; e.g. NINO in UK, Taxpayer Identification Number in Germany, INSEE in France, etc.
Possible values: >= 2 characters
and <= 2 characters
ISO-3166 Alpha 2
Possible values: <= 20 characters
ID of a CustomerLegalEntity to which this person is related to.
kyc
object
Possible values: [COMPLETED
, IN_PROGRESS
, NOT_COMPLETED
]
KYC Status enumeration
idVerification
object
Possible values: [COMPLETED
, NOT_COMPLETED
, IN_PROGRESS
]
Represents RFC 3339, section 5.6 date-time.
Possible values: <= 50 characters
Name of the vendor that performed the electronic verification
addressVerification
object
Possible values: [COMPLETED
, NOT_COMPLETED
, IN_PROGRESS
]
Represents RFC 3339, section 5.6 date-time.
Possible values: <= 50 characters
Name of the vendor that performed the electronic verification
faceMatch
object
Possible values: [COMPLETED
, NOT_COMPLETED
, IN_PROGRESS
]
Represents RFC 3339, section 5.6 date-time.
Possible values: <= 50 characters
Name of the vendor that performed the electronic verification
EDD
object
Possible values: [COMPLETED
, NOT_COMPLETED
, IN_PROGRESS
]
Represents RFC 3339, section 5.6 date-time.
Possible values: <= 50 characters
Name of the vendor that performed the electronic verification
Possible values: [BANK_STATEMENT
, CREDIT_CARD_STATEMENT
, UTILITY_BILL
, CREDIT_CARD
, PHONE_BILL
, TAX_RETURN
, COUNCIL_BILL
, SCHOOL_ENROLLMENT_LETTER
, COURT_DOCUMENT
, PENSION_DOCUMENT
, LEASE_TENANT_CONTRACT
, OTHER_AV_DOCUMENT
, CUSTOM_AV_DOCUMENT
]
pep
object
Possible values: [NO_MATCH
, MATCH
, NOT_SCREENED
, RESOLVED
, DISMISSED
, IN_PROGRESS
]
sanctions
object
Possible values: [NO_MATCH
, MATCH
, NOT_SCREENED
, RESOLVED
, DISMISSED
, IN_PROGRESS
]
kybDocuments
object[]
Possible values: [CORPORATE_ONBOARDING_CHECKLIST
, SANCTIONS_OFAC_QUESTIONNARIE
, ARTICLES_OF_ASSOCIATION
, CERTIFICATE_OF_INCORPORATION
, DIRECTORS_REGISTER
, SHAREHOLDERS_REGISTER
, LETTER_OF_AUTHORIZATION
, OWNERSHIP_STRUCTURE
, COMPANY_BANK_STATEMENT
, CORPORATE_PROOF_OF_ADDRESS
, STATEMENT_OF_WORK
, STATEMENT_OF_FINANCING
, CERTIFICATE_OF_INTELLECTUAL_PROPERTY
, SUB_INVESTMENT_MANAGEMENT_AGREEMENT
, CASE_SCREENING
, COMPANY_ORIGINAL_CERTIFICATE
, COMPANY_MEMORANDUM
, FUND_PARTNERSHIP_AGREEMENT
, COMPANY_REPORT
, COMPANY_ORGANISATION_STRUCTURE
, COMPANY_SANCTIONS_QUESTION
, COMPANY_GOVEARNMENT_DETAIL
, COMPANY_GOOD_STANDING
, COMPANY_SUPPLEMENT_INFO
, COMPANY_WEB_SITE
, COMPANY_REGISTER_DIRECTOR
, COMPANY_REGISTER_MEMBER
, COMPANY_TRUST_DEED
, COMPANY_TRUST_DECLARA
, COMPANY_ARTICLES
, COMPANY_REGISTER_MANAGER
, COMPANY_PARTNERSHIP
, COMPANY_MEMBER_LETTER
, OTHER
, TRUST_REGISTRATION_DOCUMENT
, CURRENT_OPERATION_STATUS
, INTERMEDIARIES
, ASIC_EXTRACT
, REGISTER_BENEFICIARY
, UBO_ADDRESS_PROOF
, COMPANY_ADDRESS_PROOF
, COMPANY_AML_QUESTIONNAIRE
, COMPANY_OPERATING_LICENSE
, RELATED_ADDRESS_PROOF
, ASIC_OR_CNPJ_FILE
, FUND_MARKETING_MATERIAL
, FUND_WARRANTIES_LETTER
, OUTSOURCING_SERVICE_AGREEMENT
, COMPANY_RELATED_CREDENTIALS
, COMPANY_RELATED_SELFIES
, ON_BEHALF_TRADING
]
Possible values: <= 500 characters
directors
object[]
Possible values: >= 1
List of directors. Used only when creating a new CustomerLegalEntity, ignored when updating.
Possible values: <= 20 characters
Possible values: non-empty
and <= 50 characters
First name. Only latin characters, spaces, single quotes, and hyphens are allowed.
Possible values: <= 50 characters
Middle name. Only latin characters, spaces, single quotes, and hyphens are allowed.
Possible values: non-empty
and <= 50 characters
Last name. Only latin characters, spaces, single quotes, and hyphens are allowed.
Possible values: >= 2 characters
and <= 2 characters
ISO-3166 Alpha 2
Possible values: non-empty
and <= 40 characters
Official person id as registered in a national agency; e.g. NINO in UK, Taxpayer Identification Number in Germany, INSEE in France, etc.
Possible values: >= 2 characters
and <= 2 characters
ISO-3166 Alpha 2
Possible values: <= 20 characters
ID of a CustomerLegalEntity to which this person is related to.
kyc
object
Possible values: [COMPLETED
, IN_PROGRESS
, NOT_COMPLETED
]
KYC Status enumeration
idVerification
object
Possible values: [COMPLETED
, NOT_COMPLETED
, IN_PROGRESS
]
Represents RFC 3339, section 5.6 date-time.
Possible values: <= 50 characters
Name of the vendor that performed the electronic verification
addressVerification
object
Possible values: [COMPLETED
, NOT_COMPLETED
, IN_PROGRESS
]
Represents RFC 3339, section 5.6 date-time.
Possible values: <= 50 characters
Name of the vendor that performed the electronic verification
faceMatch
object
Possible values: [COMPLETED
, NOT_COMPLETED
, IN_PROGRESS
]
Represents RFC 3339, section 5.6 date-time.
Possible values: <= 50 characters
Name of the vendor that performed the electronic verification
EDD
object
Possible values: [COMPLETED
, NOT_COMPLETED
, IN_PROGRESS
]
Represents RFC 3339, section 5.6 date-time.
Possible values: <= 50 characters
Name of the vendor that performed the electronic verification
Possible values: [BANK_STATEMENT
, CREDIT_CARD_STATEMENT
, UTILITY_BILL
, CREDIT_CARD
, PHONE_BILL
, TAX_RETURN
, COUNCIL_BILL
, SCHOOL_ENROLLMENT_LETTER
, COURT_DOCUMENT
, PENSION_DOCUMENT
, LEASE_TENANT_CONTRACT
, OTHER_AV_DOCUMENT
, CUSTOM_AV_DOCUMENT
]
pep
object
Possible values: [NO_MATCH
, MATCH
, NOT_SCREENED
, RESOLVED
, DISMISSED
, IN_PROGRESS
]
sanctions
object
Possible values: [NO_MATCH
, MATCH
, NOT_SCREENED
, RESOLVED
, DISMISSED
, IN_PROGRESS
]
kybDocuments
object[]
Possible values: [CORPORATE_ONBOARDING_CHECKLIST
, SANCTIONS_OFAC_QUESTIONNARIE
, ARTICLES_OF_ASSOCIATION
, CERTIFICATE_OF_INCORPORATION
, DIRECTORS_REGISTER
, SHAREHOLDERS_REGISTER
, LETTER_OF_AUTHORIZATION
, OWNERSHIP_STRUCTURE
, COMPANY_BANK_STATEMENT
, CORPORATE_PROOF_OF_ADDRESS
, STATEMENT_OF_WORK
, STATEMENT_OF_FINANCING
, CERTIFICATE_OF_INTELLECTUAL_PROPERTY
, SUB_INVESTMENT_MANAGEMENT_AGREEMENT
, CASE_SCREENING
, COMPANY_ORIGINAL_CERTIFICATE
, COMPANY_MEMORANDUM
, FUND_PARTNERSHIP_AGREEMENT
, COMPANY_REPORT
, COMPANY_ORGANISATION_STRUCTURE
, COMPANY_SANCTIONS_QUESTION
, COMPANY_GOVEARNMENT_DETAIL
, COMPANY_GOOD_STANDING
, COMPANY_SUPPLEMENT_INFO
, COMPANY_WEB_SITE
, COMPANY_REGISTER_DIRECTOR
, COMPANY_REGISTER_MEMBER
, COMPANY_TRUST_DEED
, COMPANY_TRUST_DECLARA
, COMPANY_ARTICLES
, COMPANY_REGISTER_MANAGER
, COMPANY_PARTNERSHIP
, COMPANY_MEMBER_LETTER
, OTHER
, TRUST_REGISTRATION_DOCUMENT
, CURRENT_OPERATION_STATUS
, INTERMEDIARIES
, ASIC_EXTRACT
, REGISTER_BENEFICIARY
, UBO_ADDRESS_PROOF
, COMPANY_ADDRESS_PROOF
, COMPANY_AML_QUESTIONNAIRE
, COMPANY_OPERATING_LICENSE
, RELATED_ADDRESS_PROOF
, ASIC_OR_CNPJ_FILE
, FUND_MARKETING_MATERIAL
, FUND_WARRANTIES_LETTER
, OUTSOURCING_SERVICE_AGREEMENT
, COMPANY_RELATED_CREDENTIALS
, COMPANY_RELATED_SELFIES
, ON_BEHALF_TRADING
]
Possible values: <= 500 characters
ultimateBeneficialOwners
object[]
Possible values: >= 1
List of owners of the legal entity. Used only when creating a new CustomerLegalEntity, ignored when updating.
Possible values: <= 20 characters
Possible values: non-empty
and <= 50 characters
First name. Only latin characters, spaces, single quotes, and hyphens are allowed.
Possible values: <= 50 characters
Middle name. Only latin characters, spaces, single quotes, and hyphens are allowed.
Possible values: non-empty
and <= 50 characters
Last name. Only latin characters, spaces, single quotes, and hyphens are allowed.
Possible values: >= 2 characters
and <= 2 characters
ISO-3166 Alpha 2
Possible values: non-empty
and <= 40 characters
Official person id as registered in a national agency; e.g. NINO in UK, Taxpayer Identification Number in Germany, INSEE in France, etc.
Possible values: >= 2 characters
and <= 2 characters
ISO-3166 Alpha 2
Possible values: <= 20 characters
ID of a CustomerLegalEntity to which this person is related to.
kyc
object
Possible values: [COMPLETED
, IN_PROGRESS
, NOT_COMPLETED
]
KYC Status enumeration
idVerification
object
Possible values: [COMPLETED
, NOT_COMPLETED
, IN_PROGRESS
]
Represents RFC 3339, section 5.6 date-time.
Possible values: <= 50 characters
Name of the vendor that performed the electronic verification
addressVerification
object
Possible values: [COMPLETED
, NOT_COMPLETED
, IN_PROGRESS
]
Represents RFC 3339, section 5.6 date-time.
Possible values: <= 50 characters
Name of the vendor that performed the electronic verification
faceMatch
object
Possible values: [COMPLETED
, NOT_COMPLETED
, IN_PROGRESS
]
Represents RFC 3339, section 5.6 date-time.
Possible values: <= 50 characters
Name of the vendor that performed the electronic verification
EDD
object
Possible values: [COMPLETED
, NOT_COMPLETED
, IN_PROGRESS
]
Represents RFC 3339, section 5.6 date-time.
Possible values: <= 50 characters
Name of the vendor that performed the electronic verification
Possible values: [BANK_STATEMENT
, CREDIT_CARD_STATEMENT
, UTILITY_BILL
, CREDIT_CARD
, PHONE_BILL
, TAX_RETURN
, COUNCIL_BILL
, SCHOOL_ENROLLMENT_LETTER
, COURT_DOCUMENT
, PENSION_DOCUMENT
, LEASE_TENANT_CONTRACT
, OTHER_AV_DOCUMENT
, CUSTOM_AV_DOCUMENT
]
pep
object
Possible values: [NO_MATCH
, MATCH
, NOT_SCREENED
, RESOLVED
, DISMISSED
, IN_PROGRESS
]
sanctions
object
Possible values: [NO_MATCH
, MATCH
, NOT_SCREENED
, RESOLVED
, DISMISSED
, IN_PROGRESS
]
kybDocuments
object[]
Possible values: [CORPORATE_ONBOARDING_CHECKLIST
, SANCTIONS_OFAC_QUESTIONNARIE
, ARTICLES_OF_ASSOCIATION
, CERTIFICATE_OF_INCORPORATION
, DIRECTORS_REGISTER
, SHAREHOLDERS_REGISTER
, LETTER_OF_AUTHORIZATION
, OWNERSHIP_STRUCTURE
, COMPANY_BANK_STATEMENT
, CORPORATE_PROOF_OF_ADDRESS
, STATEMENT_OF_WORK
, STATEMENT_OF_FINANCING
, CERTIFICATE_OF_INTELLECTUAL_PROPERTY
, SUB_INVESTMENT_MANAGEMENT_AGREEMENT
, CASE_SCREENING
, COMPANY_ORIGINAL_CERTIFICATE
, COMPANY_MEMORANDUM
, FUND_PARTNERSHIP_AGREEMENT
, COMPANY_REPORT
, COMPANY_ORGANISATION_STRUCTURE
, COMPANY_SANCTIONS_QUESTION
, COMPANY_GOVEARNMENT_DETAIL
, COMPANY_GOOD_STANDING
, COMPANY_SUPPLEMENT_INFO
, COMPANY_WEB_SITE
, COMPANY_REGISTER_DIRECTOR
, COMPANY_REGISTER_MEMBER
, COMPANY_TRUST_DEED
, COMPANY_TRUST_DECLARA
, COMPANY_ARTICLES
, COMPANY_REGISTER_MANAGER
, COMPANY_PARTNERSHIP
, COMPANY_MEMBER_LETTER
, OTHER
, TRUST_REGISTRATION_DOCUMENT
, CURRENT_OPERATION_STATUS
, INTERMEDIARIES
, ASIC_EXTRACT
, REGISTER_BENEFICIARY
, UBO_ADDRESS_PROOF
, COMPANY_ADDRESS_PROOF
, COMPANY_AML_QUESTIONNAIRE
, COMPANY_OPERATING_LICENSE
, RELATED_ADDRESS_PROOF
, ASIC_OR_CNPJ_FILE
, FUND_MARKETING_MATERIAL
, FUND_WARRANTIES_LETTER
, OUTSOURCING_SERVICE_AGREEMENT
, COMPANY_RELATED_CREDENTIALS
, COMPANY_RELATED_SELFIES
, ON_BEHALF_TRADING
]
Possible values: <= 500 characters
Possible values: non-empty
and <= 20 characters
Ownership percentage. Decimal number. Must be greater than 0 and lower or equal to 100. Supports up to 10 digit precision.
representatives
object[]
Possible values: <= 20 characters
Possible values: non-empty
and <= 50 characters
First name. Only latin characters, spaces, single quotes, and hyphens are allowed.
Possible values: <= 50 characters
Middle name. Only latin characters, spaces, single quotes, and hyphens are allowed.
Possible values: non-empty
and <= 50 characters
Last name. Only latin characters, spaces, single quotes, and hyphens are allowed.
Possible values: >= 2 characters
and <= 2 characters
ISO-3166 Alpha 2
Possible values: non-empty
and <= 40 characters
Official person id as registered in a national agency; e.g. NINO in UK, Taxpayer Identification Number in Germany, INSEE in France, etc.
Possible values: >= 2 characters
and <= 2 characters
ISO-3166 Alpha 2
Possible values: <= 20 characters
ID of a CustomerLegalEntity to which this person is related to.
kyc
object
Possible values: [COMPLETED
, IN_PROGRESS
, NOT_COMPLETED
]
KYC Status enumeration
idVerification
object
Possible values: [COMPLETED
, NOT_COMPLETED
, IN_PROGRESS
]
Represents RFC 3339, section 5.6 date-time.
Possible values: <= 50 characters
Name of the vendor that performed the electronic verification
addressVerification
object
Possible values: [COMPLETED
, NOT_COMPLETED
, IN_PROGRESS
]
Represents RFC 3339, section 5.6 date-time.
Possible values: <= 50 characters
Name of the vendor that performed the electronic verification
faceMatch
object
Possible values: [COMPLETED
, NOT_COMPLETED
, IN_PROGRESS
]
Represents RFC 3339, section 5.6 date-time.
Possible values: <= 50 characters
Name of the vendor that performed the electronic verification
EDD
object
Possible values: [COMPLETED
, NOT_COMPLETED
, IN_PROGRESS
]
Represents RFC 3339, section 5.6 date-time.
Possible values: <= 50 characters
Name of the vendor that performed the electronic verification
Possible values: [BANK_STATEMENT
, CREDIT_CARD_STATEMENT
, UTILITY_BILL
, CREDIT_CARD
, PHONE_BILL
, TAX_RETURN
, COUNCIL_BILL
, SCHOOL_ENROLLMENT_LETTER
, COURT_DOCUMENT
, PENSION_DOCUMENT
, LEASE_TENANT_CONTRACT
, OTHER_AV_DOCUMENT
, CUSTOM_AV_DOCUMENT
]
pep
object
Possible values: [NO_MATCH
, MATCH
, NOT_SCREENED
, RESOLVED
, DISMISSED
, IN_PROGRESS
]
sanctions
object
Possible values: [NO_MATCH
, MATCH
, NOT_SCREENED
, RESOLVED
, DISMISSED
, IN_PROGRESS
]
kybDocuments
object[]
Possible values: [CORPORATE_ONBOARDING_CHECKLIST
, SANCTIONS_OFAC_QUESTIONNARIE
, ARTICLES_OF_ASSOCIATION
, CERTIFICATE_OF_INCORPORATION
, DIRECTORS_REGISTER
, SHAREHOLDERS_REGISTER
, LETTER_OF_AUTHORIZATION
, OWNERSHIP_STRUCTURE
, COMPANY_BANK_STATEMENT
, CORPORATE_PROOF_OF_ADDRESS
, STATEMENT_OF_WORK
, STATEMENT_OF_FINANCING
, CERTIFICATE_OF_INTELLECTUAL_PROPERTY
, SUB_INVESTMENT_MANAGEMENT_AGREEMENT
, CASE_SCREENING
, COMPANY_ORIGINAL_CERTIFICATE
, COMPANY_MEMORANDUM
, FUND_PARTNERSHIP_AGREEMENT
, COMPANY_REPORT
, COMPANY_ORGANISATION_STRUCTURE
, COMPANY_SANCTIONS_QUESTION
, COMPANY_GOVEARNMENT_DETAIL
, COMPANY_GOOD_STANDING
, COMPANY_SUPPLEMENT_INFO
, COMPANY_WEB_SITE
, COMPANY_REGISTER_DIRECTOR
, COMPANY_REGISTER_MEMBER
, COMPANY_TRUST_DEED
, COMPANY_TRUST_DECLARA
, COMPANY_ARTICLES
, COMPANY_REGISTER_MANAGER
, COMPANY_PARTNERSHIP
, COMPANY_MEMBER_LETTER
, OTHER
, TRUST_REGISTRATION_DOCUMENT
, CURRENT_OPERATION_STATUS
, INTERMEDIARIES
, ASIC_EXTRACT
, REGISTER_BENEFICIARY
, UBO_ADDRESS_PROOF
, COMPANY_ADDRESS_PROOF
, COMPANY_AML_QUESTIONNAIRE
, COMPANY_OPERATING_LICENSE
, RELATED_ADDRESS_PROOF
, ASIC_OR_CNPJ_FILE
, FUND_MARKETING_MATERIAL
, FUND_WARRANTIES_LETTER
, OUTSOURCING_SERVICE_AGREEMENT
, COMPANY_RELATED_CREDENTIALS
, COMPANY_RELATED_SELFIES
, ON_BEHALF_TRADING
]
Possible values: <= 500 characters
Possible values: <= 100 characters
Possible values: <= 100 characters
Possible values: <= 200 characters
Possible values: <= 150 characters
Primary email address
Possible values: <= 50 characters
Mobile number
IPv4 address from which the customer has registered.
Date of registration at the Merchant system
restrictions
object[]
Possible values: [ALL_TRANSACTIONS
, OUTGOING_TRANSACTIONS
, INCOMING_TRANSACTIONS
, SEND_MONEY
, INCOMING_TRANSACTIONS_AND_SEND_MONEY
, CARD_DEPOSITS
, CARD_AND_ACH_DEPOSITS
, DEPOSITS
, OUTGOING_TRANSACTIONS_AND_CARD_DEPOSITS
, OUTGOING_TRANSACTIONS_AND_ACH_DEPOSITS
, DEPOSITS_AND_WITHDRAWALS
, CRYPTO_TRANSACTIONS
, OTHER
]
Represents the name of a restriction applied to a customer wallet.
Possible values: [RISK_CONTROLS
, COMPLIANCE
, CLOSE_ACCOUNT
, DUPLICATE_ACCOUNT
, KYC
, NO_SERVICE_COUNTRY
, PREPAID_CARD_CHARGEBACK
, T_C_ABUSE
, TERMINATED
, UNDER_18
, OTHER
, CONFIRM_TXN_ACTIVITY
, MERCHANT_REQUEST
]
Reason for placing the restriction.
Possible values: [CONTACT_CUSTOMER_SERVICE
, KYC_VERIFICATION
, SUBMIT_ID
, SUBMIT_SSN_CARD
, SECOND_FORM_OF_ID
, SUBMIT_AD
, PEP_DECLARATION
, BANK_ACCOUNT_VERIFICATION
, WAIT
, NO_REMEDIATION
, COMPLETE_ONBOARDING
, NATIONALITY
, OTHER
]
Actions to be completed in order to resolve
Represents RFC 3339, section 5.6 date-time.
Possible values: <= 36 characters
Restriction id
accounts
object[]
Accounts associated with this customer.
Possible values: <= 20 characters
Account id.
Possible values: <= 20 characters
Possible values: <= 40 characters
Possible values: >= 3 characters
and <= 3 characters
Currency alphabetic code as specified by ISO 4217
Amount in minor units
Amount in minor units
virtualInstrument
object[]
instrumentType
string
required
Possible values: [SEPA_BANK_ACCOUNT
, UK_BANK_ACCOUNT
, US_BANK_ACCOUNT
]
Instrument type.
The International Bank Account Number (IBAN) of the account.
The Bank Account Bank Identifier Code (BIC) code. Also known as SWIFT code.
A bank account number.
Use our sort code checker to easily find and check UK sort codes.
Possible values: >= 4 characters
and <= 17 characters
This is the bank account number.
Possible values: >= 9 characters
and <= 9 characters
For USD accounts, this is the 9-digit routing number of the bank.
Possible values: [ACTIVE
]
Instrument status.
virtualAccountAssignmentStatus
object[]
Possible values: [SEPA_BANK_ACCOUNT
, UK_BANK_ACCOUNT
, US_BANK_ACCOUNT
]
Instrument type.
Possible values: [ACCEPTED
, PENDING
, COMPLETED
, REJECTED
, FAILED
]
Status of the virtual payment instrument request.
Additional information for the current status of the virtual payment instrument request.
Create a virtual banking account for this e-money account.