Create a new wallet for a customer
POST/wallets
Create a new wallet for a customer.
Request
Header Parameters
HMAC signature of the request
- application/json
Body
required
- PERSON
- LEGAL_ENTITY
Array [
]
Array [
Array [
]
]
Array [
Array [
]
]
Array [
Array [
]
]
Array [
]
Array [
]
- 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"
- 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 [
]
]
Array [
]
Array [
]
customer
object
Possible values: non-empty
and <= 40 characters
Customer identifier used in Partner system.
type
string
Possible values: [PERSON
, LEGAL_ENTITY
]
Type of Customer
circular(CustomerPerson)
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: 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: 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: 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: 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
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: <= 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
accounts
object[]
Accounts associated with this customer.
Possible values: <= 40 characters
Possible values: >= 3 characters
and <= 3 characters
Currency alphabetic code as specified by ISO 4217
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
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
]
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
legalEntity
object
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
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
]
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
circular(CustomerLegalEntity)
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
accounts
object[]
Accounts associated with this customer.
Possible values: <= 40 characters
Possible values: >= 3 characters
and <= 3 characters
Currency alphabetic code as specified by ISO 4217
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: 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: 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: 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: 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
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
accounts
object[]
required
Possible values: <= 40 characters
Possible values: >= 3 characters
and <= 3 characters
Currency alphabetic code as specified by ISO 4217
deviceInfo
object
required
Provides information about the device that the end-customer uses to access the service.
Possible values: [WEB_APP
, MOBILE_APP
, API
]
Possible values: <= 100 characters
ThreatMetrics session id.
Added at top level for compatibility with SingleAPI
risk
object
Additional information required for risk evaluation.
authentication
object
3DS Authentication details
Possible values: <= 1 characters
This indicates the outcome of the Authentication.
This is the Electronic Commerce Indicator code, which gets returned by the card issuer indicating whether the cardholder was successfully authenticated.
Possible values: <= 80 characters
This is the Cardholder Authentication Verification Value, indicating that the transaction is authenticated.
Responses
- 201
- 400
- 401
- 409
- 500
- 503
Created.
- application/json
- Schema
- Example (from schema)
- Wallet_Created
Schema
- PERSON
- LEGAL_ENTITY
Array [
]
Array [
Array [
]
]
Array [
Array [
]
]
Array [
Array [
]
]
Array [
]
Array [
]
Array [
]
- 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"
- 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 [
Array [
]
]
Array [
]
Array [
]
customer
object
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
circular(CustomerPerson)
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
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: <= 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
, CARD_DEPOSITS
, DEPOSITS
, OUTGOING_TRANSACTIONS_AND_CARD_DEPOSITS
, INCOMING_TRANSACTIONS_AND_SEND_MONEY
, BANK_WITHDRAWALS
, WITHDRAWALS
, DEPOSITS_AND_WITHDRAWALS
, INCOMING_TRANSACTIONS_AND_TRANSFERS
, OTHER
]
Restriction name
Note! The model is deprecated.
Possible values: [ACCOUNT_TAKEOVER_RECEIVER
, ACCOUNT_TAKEOVER_VICTIM
, AUP_VIOLATION
, BLACKLIST
, CHARGEBACK_RECEIVED
, CLOSE_ACCOUNT
, COLLECTIONS_CASE
, COMPLIANCE
, COMPLIANCE_EDD_RESTRICTED
, COMPLIANCE_LIMITS
, COMPLIANCE_PEP
, COMPLIANCE_SANCTIONS
, CONFIRMED_FRAUD
, CUSTOMER_REQUESTED_CLOSURE
, CUSTOMER_REQUESTED_CLOSURE_GAMBLING_PROBLEM
, DEBT_COLLECTION_AGENCY
, DUPLICATE_ACCOUNT_MANUAL
, DUPLICATE_ACCOUNT_SIGNUP
, EDD_TRANSACTION_CHECK
, EXTERNAL_NOTIFICATION
, FRAUD_ACCOUNT_CLOSURE
, INACTIVE_ACCOUNT
, KYC
, KYC_LIMITS
, LIMITS_EXCEEDED
, MERCHANT_REQUEST
, MLRO_LOCK
, NO_SERVICE_COUNTRY
, PAID_TO_DEBT_COLLECTOR
, PURCHASED_ID
, REGULATORY_LOCK
, REPORTED_FRAUD_ISSUER
, REQUEST_CERTIFIED_DOCS
, RETRIEVAL_REQUEST_RECEIVED
, RISK_ENGINE
, SCA
, SUSPECTED_FRAUD
, SUSPECTED_MONEY_LAUNDERING
, T_C_ABUSE
, TERMINATED
, UNDER_18
, UNDER_INVESTIGATION
, WALLET_RECOVERY_PROCEDURE
, OTHER
]
Reason for restricting
Note! The model is deprecated.
Possible values: [ADDRESS_REVERIFICATION
, CONTACT_INVESTIGATIONS_TEAM
, EDD_CASE_REQUIRED
, EDD_CONFIRMATION_REQUIRED
, EXPLANATION_OF_ACTIVITY
, KYC_DOCS_ONLY
, KYC_VERIFICATION
, MANUAL_REVIEW
, PEP_DECLARATION
, PEP_DECLARATION_OCCUPATION_SPOUSE
, PEP_SANCTIONS_ALL_QUESTIONS
, PEP_SANCTIONS_OCCUPATION_SPOUSE
, SUBMIT_AD
, SUBMIT_AD_BANK_STATEMENT
, SUBMIT_AD_COUNCIL_BILL
, SUBMIT_AD_COURT_DOCUMENT
, SUBMIT_AD_CREDIT_CARD_STATEMENT
, SUBMIT_AD_LEASE_TENANT_CONTRACT
, SUBMIT_AD_OTHER
, SUBMIT_AD_PENSION_DOCUMENT
, SUBMIT_AD_SCHOOL_ENROLLMENT_LETTER
, SUBMIT_AD_TAX_RETURN_FORM
, SUBMIT_AD_UTILITY_BILL
, SUBMIT_HOLDING_ID
, SUBMIT_ID
, SUBMIT_ID_DRIVER_LICENSE
, SUBMIT_ID_FACE_VERIFICATION
, SUBMIT_ID_IDENTITY_CARD
, SUBMIT_ID_PASSPORT
, SUBMIT_ID_RESIDENCE_PERMIT
, WAITING_FOR_DOCUMENTS
, WAIT
, OTHER
]
Actions to be completed in order to resolve
Represents RFC 3339, section 5.6 date-time.
Restriction id
Represents RFC 3339, section 5.6 date-time.
Represents RFC 3339, section 5.6 date-time.
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
IBAN associated with this account.
Possible values: <= 20 characters
Possible values: <= 40 characters
DKK account number.
Possible values: <= 20 characters
DKK bank code.
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
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
]
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
legalEntity
object
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
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
]
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
circular(CustomerLegalEntity)
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
, CARD_DEPOSITS
, DEPOSITS
, OUTGOING_TRANSACTIONS_AND_CARD_DEPOSITS
, INCOMING_TRANSACTIONS_AND_SEND_MONEY
, BANK_WITHDRAWALS
, WITHDRAWALS
, DEPOSITS_AND_WITHDRAWALS
, INCOMING_TRANSACTIONS_AND_TRANSFERS
, OTHER
]
Restriction name
Note! The model is deprecated.
Possible values: [ACCOUNT_TAKEOVER_RECEIVER
, ACCOUNT_TAKEOVER_VICTIM
, AUP_VIOLATION
, BLACKLIST
, CHARGEBACK_RECEIVED
, CLOSE_ACCOUNT
, COLLECTIONS_CASE
, COMPLIANCE
, COMPLIANCE_EDD_RESTRICTED
, COMPLIANCE_LIMITS
, COMPLIANCE_PEP
, COMPLIANCE_SANCTIONS
, CONFIRMED_FRAUD
, CUSTOMER_REQUESTED_CLOSURE
, CUSTOMER_REQUESTED_CLOSURE_GAMBLING_PROBLEM
, DEBT_COLLECTION_AGENCY
, DUPLICATE_ACCOUNT_MANUAL
, DUPLICATE_ACCOUNT_SIGNUP
, EDD_TRANSACTION_CHECK
, EXTERNAL_NOTIFICATION
, FRAUD_ACCOUNT_CLOSURE
, INACTIVE_ACCOUNT
, KYC
, KYC_LIMITS
, LIMITS_EXCEEDED
, MERCHANT_REQUEST
, MLRO_LOCK
, NO_SERVICE_COUNTRY
, PAID_TO_DEBT_COLLECTOR
, PURCHASED_ID
, REGULATORY_LOCK
, REPORTED_FRAUD_ISSUER
, REQUEST_CERTIFIED_DOCS
, RETRIEVAL_REQUEST_RECEIVED
, RISK_ENGINE
, SCA
, SUSPECTED_FRAUD
, SUSPECTED_MONEY_LAUNDERING
, T_C_ABUSE
, TERMINATED
, UNDER_18
, UNDER_INVESTIGATION
, WALLET_RECOVERY_PROCEDURE
, OTHER
]
Reason for restricting
Note! The model is deprecated.
Possible values: [ADDRESS_REVERIFICATION
, CONTACT_INVESTIGATIONS_TEAM
, EDD_CASE_REQUIRED
, EDD_CONFIRMATION_REQUIRED
, EXPLANATION_OF_ACTIVITY
, KYC_DOCS_ONLY
, KYC_VERIFICATION
, MANUAL_REVIEW
, PEP_DECLARATION
, PEP_DECLARATION_OCCUPATION_SPOUSE
, PEP_SANCTIONS_ALL_QUESTIONS
, PEP_SANCTIONS_OCCUPATION_SPOUSE
, SUBMIT_AD
, SUBMIT_AD_BANK_STATEMENT
, SUBMIT_AD_COUNCIL_BILL
, SUBMIT_AD_COURT_DOCUMENT
, SUBMIT_AD_CREDIT_CARD_STATEMENT
, SUBMIT_AD_LEASE_TENANT_CONTRACT
, SUBMIT_AD_OTHER
, SUBMIT_AD_PENSION_DOCUMENT
, SUBMIT_AD_SCHOOL_ENROLLMENT_LETTER
, SUBMIT_AD_TAX_RETURN_FORM
, SUBMIT_AD_UTILITY_BILL
, SUBMIT_HOLDING_ID
, SUBMIT_ID
, SUBMIT_ID_DRIVER_LICENSE
, SUBMIT_ID_FACE_VERIFICATION
, SUBMIT_ID_IDENTITY_CARD
, SUBMIT_ID_PASSPORT
, SUBMIT_ID_RESIDENCE_PERMIT
, WAITING_FOR_DOCUMENTS
, WAIT
, OTHER
]
Actions to be completed in order to resolve
Represents RFC 3339, section 5.6 date-time.
Restriction id
Represents RFC 3339, section 5.6 date-time.
Represents RFC 3339, section 5.6 date-time.
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
IBAN associated with this account.
Possible values: <= 20 characters
Possible values: <= 40 characters
DKK account number.
Possible values: <= 20 characters
DKK bank code.
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
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
accounts
object[]
required
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
IBAN associated with this account.
Possible values: <= 20 characters
Possible values: <= 40 characters
DKK account number.
Possible values: <= 20 characters
DKK bank code.
Added at top level for compatibility with SingleAPI
{
"customer": {
"id": "10040500",
"externalId": "af5c8b52-0afd-4799-85ab-fe659a076932",
"type": "PERSON",
"email": "john.smith@mail.com",
"mobile": "+12025550120",
"registrationIp": "198.51.100.42",
"registrationDate": "2024-09-11T12:08:49.718Z",
"restrictions": [
{
"name": "ALL_TRANSACTIONS",
"reason": "ACCOUNT_TAKEOVER_RECEIVER",
"requiredActions": [
"ADDRESS_REVERIFICATION"
],
"lastChangeDate": "2021-07-15T17:54:12Z",
"id": "string",
"activationTime": "2021-07-15T17:54:12Z",
"dueDate": "2021-07-15T17:54:12Z"
}
],
"accounts": [
{
"id": "string",
"customerId": "5435323362",
"externalId": "string",
"currencyCode": "EUR",
"totalBalance": 0,
"availableBalance": 0,
"iban": "string",
"bic": "string",
"accountNumber": "string",
"bankCode": "string",
"creationTime": "2019-08-24T14:15:22Z",
"hasIban": true
}
],
"firstName": "string",
"lastName": "string",
"title": "string",
"address1": "string",
"address2": "string",
"city": "string",
"zip": "string",
"state": "string",
"countryCode": "GB",
"birthDate": "2024-09-11",
"nationality": "GB",
"kyc": {
"status": "COMPLETED",
"idVerification": {
"status": "COMPLETED",
"date": "2021-07-15T17:54:12Z",
"electronicallyVerified": true,
"vendor": "string"
},
"addressVerification": {
"status": "COMPLETED",
"date": "2021-07-15T17:54:12Z",
"electronicallyVerified": true,
"vendor": "string"
},
"faceMatch": {
"status": "COMPLETED",
"date": "2021-07-15T17:54:12Z",
"electronicallyVerified": true,
"vendor": "string"
},
"EDD": {
"status": "COMPLETED",
"date": "2021-07-15T17:54:12Z",
"electronicallyVerified": true,
"vendor": "string"
},
"addressVerificationDocumentsReceived": [
"BANK_STATEMENT"
],
"pep": {
"status": "NO_MATCH",
"lastScreenDate": "2024-09-11T12:08:49.719Z",
"reason": "string"
},
"sanctions": {
"status": "NO_MATCH",
"lastScreenDate": "2024-09-11T12:08:49.719Z",
"reason": "string"
}
},
"occupation": "ARCHITECTURE_CARTOGRAPHY_SURVEYOR",
"vulnerabilities": [
"PHYSICAL_DISABILITY"
]
},
"legalEntity": {
"id": "10040500",
"externalId": "af5c8b52-0afd-4799-85ab-fe659a076932",
"type": "PERSON",
"email": "john.smith@mail.com",
"mobile": "+12025550120",
"registrationIp": "198.51.100.42",
"registrationDate": "2024-09-11T12:08:49.727Z",
"restrictions": [
{
"name": "ALL_TRANSACTIONS",
"reason": "ACCOUNT_TAKEOVER_RECEIVER",
"requiredActions": [
"ADDRESS_REVERIFICATION"
],
"lastChangeDate": "2021-07-15T17:54:12Z",
"id": "string",
"activationTime": "2021-07-15T17:54:12Z",
"dueDate": "2021-07-15T17:54:12Z"
}
],
"accounts": [
{
"id": "string",
"customerId": "5435323362",
"externalId": "string",
"currencyCode": "EUR",
"totalBalance": 0,
"availableBalance": 0,
"iban": "string",
"bic": "string",
"accountNumber": "string",
"bankCode": "string",
"creationTime": "2019-08-24T14:15:22Z",
"hasIban": true
}
],
"companyName": "string",
"companyIdentifier": "string",
"registrationAddress": {
"countryCode": "GB",
"stateProvince": "string",
"city": "string",
"postalCode": "string",
"address1": "string",
"address2": "string"
},
"operatingAddress": {
"countryCode": "GB",
"stateProvince": "string",
"city": "string",
"postalCode": "string",
"address1": "string",
"address2": "string"
},
"websiteUrl": "string",
"expectedTransactionVolume": {
"amount": 0,
"currencyCode": "EUR"
},
"representative": {
"id": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"dateOfBirth": "2024-09-11",
"countryCode": "GB",
"identificationNumber": "AA 01 23 44 B",
"identificationNumberIssuingCountryCode": "GB",
"customerLegalEntityId": "string",
"kyc": {
"status": "COMPLETED",
"idVerification": {
"status": "COMPLETED",
"date": "2021-07-15T17:54:12Z",
"electronicallyVerified": true,
"vendor": "string"
},
"addressVerification": {
"status": "COMPLETED",
"date": "2021-07-15T17:54:12Z",
"electronicallyVerified": true,
"vendor": "string"
},
"faceMatch": {
"status": "COMPLETED",
"date": "2021-07-15T17:54:12Z",
"electronicallyVerified": true,
"vendor": "string"
},
"EDD": {
"status": "COMPLETED",
"date": "2021-07-15T17:54:12Z",
"electronicallyVerified": true,
"vendor": "string"
},
"addressVerificationDocumentsReceived": [
"BANK_STATEMENT"
],
"pep": {
"status": "NO_MATCH",
"lastScreenDate": "2024-09-11T12:08:49.727Z",
"reason": "string"
},
"sanctions": {
"status": "NO_MATCH",
"lastScreenDate": "2024-09-11T12:08:49.727Z",
"reason": "string"
}
},
"kybDocuments": [
{
"type": "CORPORATE_ONBOARDING_CHECKLIST",
"documentUrls": [
"string"
]
}
]
},
"directors": [
{
"id": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"dateOfBirth": "2024-09-11",
"countryCode": "GB",
"identificationNumber": "AA 01 23 44 B",
"identificationNumberIssuingCountryCode": "GB",
"customerLegalEntityId": "string",
"kyc": {
"status": "COMPLETED",
"idVerification": {
"status": "COMPLETED",
"date": "2021-07-15T17:54:12Z",
"electronicallyVerified": true,
"vendor": "string"
},
"addressVerification": {
"status": "COMPLETED",
"date": "2021-07-15T17:54:12Z",
"electronicallyVerified": true,
"vendor": "string"
},
"faceMatch": {
"status": "COMPLETED",
"date": "2021-07-15T17:54:12Z",
"electronicallyVerified": true,
"vendor": "string"
},
"EDD": {
"status": "COMPLETED",
"date": "2021-07-15T17:54:12Z",
"electronicallyVerified": true,
"vendor": "string"
},
"addressVerificationDocumentsReceived": [
"BANK_STATEMENT"
],
"pep": {
"status": "NO_MATCH",
"lastScreenDate": "2024-09-11T12:08:49.728Z",
"reason": "string"
},
"sanctions": {
"status": "NO_MATCH",
"lastScreenDate": "2024-09-11T12:08:49.728Z",
"reason": "string"
}
},
"kybDocuments": [
{
"type": "CORPORATE_ONBOARDING_CHECKLIST",
"documentUrls": [
"string"
]
}
]
}
],
"ultimateBeneficialOwners": [
{
"id": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"dateOfBirth": "2024-09-11",
"countryCode": "GB",
"identificationNumber": "AA 01 23 44 B",
"identificationNumberIssuingCountryCode": "GB",
"customerLegalEntityId": "string",
"kyc": {
"status": "COMPLETED",
"idVerification": {
"status": "COMPLETED",
"date": "2021-07-15T17:54:12Z",
"electronicallyVerified": true,
"vendor": "string"
},
"addressVerification": {
"status": "COMPLETED",
"date": "2021-07-15T17:54:12Z",
"electronicallyVerified": true,
"vendor": "string"
},
"faceMatch": {
"status": "COMPLETED",
"date": "2021-07-15T17:54:12Z",
"electronicallyVerified": true,
"vendor": "string"
},
"EDD": {
"status": "COMPLETED",
"date": "2021-07-15T17:54:12Z",
"electronicallyVerified": true,
"vendor": "string"
},
"addressVerificationDocumentsReceived": [
"BANK_STATEMENT"
],
"pep": {
"status": "NO_MATCH",
"lastScreenDate": "2024-09-11T12:08:49.728Z",
"reason": "string"
},
"sanctions": {
"status": "NO_MATCH",
"lastScreenDate": "2024-09-11T12:08:49.728Z",
"reason": "string"
}
},
"kybDocuments": [
{
"type": "CORPORATE_ONBOARDING_CHECKLIST",
"documentUrls": [
"string"
]
}
],
"ownershipPercentage": "string"
}
],
"representatives": [
{
"id": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"dateOfBirth": "2024-09-11",
"countryCode": "GB",
"identificationNumber": "AA 01 23 44 B",
"identificationNumberIssuingCountryCode": "GB",
"customerLegalEntityId": "string",
"kyc": {
"status": "COMPLETED",
"idVerification": {
"status": "COMPLETED",
"date": "2021-07-15T17:54:12Z",
"electronicallyVerified": true,
"vendor": "string"
},
"addressVerification": {
"status": "COMPLETED",
"date": "2021-07-15T17:54:12Z",
"electronicallyVerified": true,
"vendor": "string"
},
"faceMatch": {
"status": "COMPLETED",
"date": "2021-07-15T17:54:12Z",
"electronicallyVerified": true,
"vendor": "string"
},
"EDD": {
"status": "COMPLETED",
"date": "2021-07-15T17:54:12Z",
"electronicallyVerified": true,
"vendor": "string"
},
"addressVerificationDocumentsReceived": [
"BANK_STATEMENT"
],
"pep": {
"status": "NO_MATCH",
"lastScreenDate": "2024-09-11T12:08:49.728Z",
"reason": "string"
},
"sanctions": {
"status": "NO_MATCH",
"lastScreenDate": "2024-09-11T12:08:49.728Z",
"reason": "string"
}
},
"kybDocuments": [
{
"type": "CORPORATE_ONBOARDING_CHECKLIST",
"documentUrls": [
"string"
]
}
]
}
],
"sourceOfFunding": "string",
"natureOfBusiness": "string",
"reasonToApply": "string",
"kybDocuments": [
{
"type": "CORPORATE_ONBOARDING_CHECKLIST",
"documentUrls": [
"string"
]
}
]
},
"accounts": [
{
"id": "string",
"customerId": "5435323362",
"externalId": "string",
"currencyCode": "EUR",
"totalBalance": 0,
"availableBalance": 0,
"iban": "string",
"bic": "string",
"accountNumber": "string",
"bankCode": "string",
"creationTime": "2019-08-24T14:15:22Z",
"hasIban": true
}
],
"termsAndConditionsAccepted": true,
"customerIp": "198.51.100.42"
}
{
"customer": {
"id": "5435323362",
"firstName": "John",
"lastName": "Doe",
"title": "Mr",
"email": "john.doe@example.com",
"mobile": "+4434525551511",
"address1": "23 Four Str",
"city": "London",
"zip": "E17 033",
"countryCode": "GB",
"birthDate": "1999-08-24",
"registrationIp": "115.148.82.143",
"registrationDate": "2019-08-24T14:15:22Z",
"nationality": "GB",
"occupation": "DOMESTIC_SERVICES",
"externalId": "d6f475fe-57c9-4865-9316-0c3b8e8128d4",
"kyc": {
"status": "COMPLETED",
"idVerification": {
"status": "COMPLETED",
"date": "2021-07-19T13:23:41Z"
},
"addressVerification": {
"status": "COMPLETED",
"date": "2021-07-19T13:25:41Z"
},
"faceMatch": {
"status": "COMPLETED",
"date": "2021-07-19T13:27:41Z"
},
"EDD": {
"status": "COMPLETED",
"date": "2021-07-19T13:35:41Z"
},
"addressVerificationDocumentsReceived": [
"BANK_STATEMENT",
"CREDIT_CARD",
"TAX_RETURN",
"PENSION_DOCUMENT",
"PHONE_BILL"
],
"pep": {
"status": "MATCH",
"lastScreenDate": "2021-07-19T13:35:41Z",
"reason": "In PEP lists"
},
"sanctions": {
"status": "NO_MATCH",
"lastScreenDate": "2021-07-19T13:35:41Z"
}
},
"type": "PERSON"
},
"accounts": [
{
"id": "42342355",
"customerId": "5435323362",
"currencyCode": "GBP",
"totalBalance": 0,
"availableBalance": 0,
"iban": "NL74ABNA1231242344",
"hasIban": true,
"bic": "ABNANL2A"
}
],
"termsAndConditionsAccepted": true,
"deviceInfo": {
"threatMetrixSessionId": "a71a475b-1956-4814-9c92-7faa8226b218",
"appType": "WEB_APP"
},
"customerIp": "73.82.192.17"
}
Validation failed.
- application/json
- Schema
- Example (from schema)
- INVALID_HMAC_SIGNATURE
- INVALID_DATA
- FORBIDDEN_COUNTRY
- RISK_ENGINE_DECLINED_REGISTRATION
Schema
Array [
]
error
object
Additional details about an error
The error code.
A description of the error.
Details of any parameter value errors.
fieldErrors
object[]
Identifies the JSON request field.
The problem associated with the field.
{
"error": {
"code": "string",
"message": "string",
"details": [
"string"
],
"fieldErrors": [
{
"field": "string",
"error": "string"
}
]
}
}
{
"error": {
"code": "DW-HMAC-SIGNATURE-INVALID",
"message": "Signature is invalid",
"details": [
"HMAC signature of the request is invalid"
]
}
}
{
"error": {
"code": "DW-CUSTOMER-BAD-REQUEST",
"message": "Bad request",
"details": [
"Bad request for customer operation"
],
"fieldErrors": [
{
"field": "birthDate | firstName | etc.",
"error": "birthDate | firstName | etc. is invalid."
}
]
}
}
{
"error": {
"code": "DW-CUSTOMER-IP-COUNTRY-SANCTIONED",
"message": "Country of IP address not allowed",
"details": [
"Customer's IP country falls into the list of sanctioned countries."
]
}
}
{
"error": {
"code": "DW-REGISTRATION-DECLINED-BY-RISK-ENGINE",
"message": "Registration declined",
"details": [
"Registration declined by the Risk engine."
]
}
}
Unauthorized request.
- application/json
- Schema
- Example (from schema)
- INVALID_CREDENTIALS
Schema
Array [
]
error
object
Additional details about an error
The error code.
A description of the error.
Details of any parameter value errors.
fieldErrors
object[]
Identifies the JSON request field.
The problem associated with the field.
{
"error": {
"code": "string",
"message": "string",
"details": [
"string"
],
"fieldErrors": [
{
"field": "string",
"error": "string"
}
]
}
}
{
"error": {
"code": "5279",
"message": "Invalid credentials",
"details": [
"The authentication credentials are invalid."
]
}
}
Conflict. Check body for details.
- application/json
- Schema
- Example (from schema)
- CUSTOMER_ALREADY_ONBOARDED
- DUPLICATED_MOBILE_NUMBER
Schema
Array [
]
error
object
Additional details about an error
The error code.
A description of the error.
Details of any parameter value errors.
fieldErrors
object[]
Identifies the JSON request field.
The problem associated with the field.
{
"error": {
"code": "string",
"message": "string",
"details": [
"string"
],
"fieldErrors": [
{
"field": "string",
"error": "string"
}
]
}
}
{
"error": {
"code": "DW-CUSTOMER-ALREADY-ONBOARDED",
"message": "Customer with the same details has already been onboarded.",
"details": [
"Customer with the same details has already been onboarded."
]
}
}
{
"error": {
"code": "MOBILE_NUMBER_ALREADY_EXISTS",
"message": "Mobile number already exists."
}
}
Internal Server Error
- application/json
- Schema
- Example (from schema)
- INTERNAL_SERVER_ERROR
- AUTO_KYC_VERIFICATION_FAILED
Schema
Array [
]
error
object
Additional details about an error
The error code.
A description of the error.
Details of any parameter value errors.
fieldErrors
object[]
Identifies the JSON request field.
The problem associated with the field.
{
"error": {
"code": "string",
"message": "string",
"details": [
"string"
],
"fieldErrors": [
{
"field": "string",
"error": "string"
}
]
}
}
{
"error": {
"code": "DW-INTERNAL-SERVER-ERROR",
"message": "Internal Server Error",
"details": [
"There was an error while processing the operation"
]
}
}
{
"error": {
"code": "DW-AUTO-KYC-VERIFICATION-FAILED",
"message": "KYC verification failed",
"details": [
"We couldn't add a KYC verified status to the user, please try again."
]
}
}
Service Unavailable. Please try again later.
- application/json
- Schema
- Example (from schema)
- SERVICE_UNAVAILABLE
Schema
Array [
]
error
object
Additional details about an error
The error code.
A description of the error.
Details of any parameter value errors.
fieldErrors
object[]
Identifies the JSON request field.
The problem associated with the field.
{
"error": {
"code": "string",
"message": "string",
"details": [
"string"
],
"fieldErrors": [
{
"field": "string",
"error": "string"
}
]
}
}
{
"error": {
"code": "DW-SERVICE-UNAVAILABLE",
"message": "Service Unavailable",
"details": [
"Service Unavailable"
]
}
}