CustomerLegalEntity

idstring

Possible values: <= 20 characters

Example: 10040500

externalIdExternalId (string)required

Customer identifier used in Partner system.

Possible values: non-empty and <= 40 characters

Example: af5c8b52-0afd-4799-85ab-fe659a076932

typestring

Type of Customer

Possible values: [LEGAL_ENTITY, PERSON]

Default value: PERSON

Example: PERSON

emailstringrequired

Primary email address

Possible values: <= 150 characters

Example: john.smith@mail.com

mobilestring

Mobile number

Possible values: <= 50 characters

Example: +12025550120

registrationIpipv4required

IPv4 address from which the customer has registered.

registrationDatedate-time

Date of registration at the Merchant system

restrictions object[]

Array [

nameRestrictionName (string)required

Represents the name of a restriction applied to a customer wallet.

• ALL_TRANSACTIONS - Block all types of transactions.
• OUTGOING_TRANSACTIONS - Block withdrawals and send money transactions.
• INCOMING_TRANSACTIONS - Block all types of bank ( ACH, bankwire) and card deposits, including EFT deposits; received money from other customers and merchants; sell crypto and stocks.
• SEND_MONEY - Block all send money transactions to other customers and merchants.
• INCOMING_TRANSACTIONS_AND_SEND_MONEY - Block all types of bank ( ACH, bankwire) and card deposits, including EFT deposits; received money from other customers and merchants; sell crypto and stocks. Block all send money transactions to other customers and merchants.
• CARD_DEPOSITS - Block all deposit made by card.
• CARD_AND_ACH_DEPOSITS - Block all deposit made by card and ACH bank deposits.
• DEPOSITS - Block all types of bank ( ACH, bankwire) and card deposits, including EFT deposits.
• OUTGOING_TRANSACTIONS_AND_CARD_DEPOSITS - Block withdrawals and send money transactions and all card deposits.
• OUTGOING_TRANSACTIONS_AND_ACH_DEPOSITS - Block all types of withdrawals (including ATM and POS trn with prepaid card) and ACH deposits.
• DEPOSITS_AND_WITHDRAWALS - Bocks all withdrawals and deposits.
• CRYPTO_TRANSACTIONS - Block all crypto trn including buy and sell, received and send crypto.
• OTHER - Other restrictions.

Possible values: [ALL_TRANSACTIONS, OUTGOING_TRANSACTIONS, INCOMING_TRANSACTIONS, SEND_MONEY, INCOMING_TRANSACTIONS_AND_SEND_MONEY, CARD_DEPOSITS, CARD_AND_ACH_DEPOSITS, DEPOSITS, OUTGOING_TRANSACTIONS_AND_CARD_DEPOSITS, OUTGOING_TRANSACTIONS_AND_ACH_DEPOSITS, DEPOSITS_AND_WITHDRAWALS, CRYPTO_TRANSACTIONS, OTHER]

Example: ALL_TRANSACTIONS

reasonRestrictionReason (string)required

Reason for placing the restriction.

• RISK_CONTROLS - The reason for setting up the restriction requires additional risk checks to the end-customer's account.
• COMPLIANCE - The reason for setting up the restriction is related to the customer's due diligence and requires an additional compliance check of the end-customer's account.
• CLOSE_ACCOUNT - Account closure.
• DUPLICATE_ACCOUNT - The reason for setting up the restriction shows that the same person already exists as the account owner.
• KYC - The reason for setting up the restriction is related to the customer's KYC verification and requires KYC document submissions.
• NO_SERVICE_COUNTRY - No service country.
• PREPAID_CARD_CHARGEBACK - Pre-paid card chargeback.
• T_C_ABUSE - Terms & Conditions Abuse
• TERMINATED - Account terminated.
• UNDER_18 - Customer under 18.
• MERCHANT_REQUEST - Merchant placed the restriction.
• CONFIRM_TXN_ACTIVITY - Contact customer to confirm pre-paid card transactional activities.
• OTHER - Other reason.

Possible values: [RISK_CONTROLS, COMPLIANCE, CLOSE_ACCOUNT, DUPLICATE_ACCOUNT, KYC, NO_SERVICE_COUNTRY, PREPAID_CARD_CHARGEBACK, T_C_ABUSE, TERMINATED, UNDER_18, OTHER, CONFIRM_TXN_ACTIVITY, MERCHANT_REQUEST]

requiredActionsRequiredAction (string)[]

Actions to be completed in order to resolve

Possible values: [CONTACT_CUSTOMER_SERVICE, KYC_VERIFICATION, SUBMIT_ID, SUBMIT_SSN_CARD, SECOND_FORM_OF_ID, SUBMIT_AD, PEP_DECLARATION, BANK_ACCOUNT_VERIFICATION, WAIT, NO_REMEDIATION, COMPLETE_ONBOARDING, NATIONALITY, OTHER]

creationTimedate-time

Represents RFC 3339, section 5.6 date-time.

Example: 2021-07-15T17:54:12Z

idstringrequired

Restriction id

Possible values: <= 36 characters

Example: 084666a4-cd47-40c1-afe2-4a575e341d59

]

accounts object[]

Accounts associated with this customer.

Array [

idstring

Account id.

Possible values: <= 20 characters

customerIdstring

Possible values: <= 20 characters

Example: 5435323362

externalIdstring

Possible values: <= 40 characters

currencyCodeCurrency (string)required

Currency alphabetic code as specified by ISO 4217

Possible values: >= 3 characters and <= 3 characters

Example: EUR

totalBalanceint64

Amount in minor units

availableBalanceint64

Amount in minor units

virtualInstrument object[]

Array [

instrumentTypeVirtualInstrumentType (string)required

Instrument type.

Possible values: [SEPA_BANK_ACCOUNT, UK_BANK_ACCOUNT, US_BANK_ACCOUNT]

Example: SEPA_BANK_ACCOUNT

statusstring

Instrument status.

Possible values: [ACTIVE]

]

virtualAccountAssignmentStatus object[]

Array [

instrumentTypeVirtualInstrumentType (string)required

Instrument type.

Possible values: [SEPA_BANK_ACCOUNT, UK_BANK_ACCOUNT, US_BANK_ACCOUNT]

Example: SEPA_BANK_ACCOUNT

requestDatedate-timerequired

Example: 2019-08-24T14:15:22Z

lastChangeDatedate-time

Example: 2019-08-24T14:15:22Z

statusstringrequired

Status of the virtual payment instrument request.

Possible values: [ACCEPTED, PENDING, COMPLETED, REJECTED, FAILED]

Example: COMPLETED

statusReasonstring

Additional information for the current status of the virtual payment instrument request.

Example: Request has been denied by the issuing bank.

]

creationTimedate-time

Example: 2019-08-24T14:15:22Z

hasVirtualInstrumentbooleandeprecated

Default value: false

virtualAccountAssignmentboolean

Create a virtual banking account for this e-money account.

Default value: false

]

companyNamestringrequired

Name of the company

Possible values: <= 100 characters

companyIdentifierstringrequired

The official company id according to local business registration agency in the country of registration

Possible values: <= 100 characters

registrationAddress objectrequired

countryCodeCountryCode (string)required

ISO-3166 Alpha 2

Possible values: >= 2 characters and <= 2 characters

Example: GB

stateProvincestring

citystringrequired

Possible values: <= 50 characters

postalCodestringrequired

Possible values: non-empty and <= 50 characters

address1stringrequired

Possible values: <= 200 characters

address2string

Possible values: <= 200 characters

operatingAddress objectrequired

countryCodeCountryCode (string)required

ISO-3166 Alpha 2

Possible values: >= 2 characters and <= 2 characters

Example: GB

stateProvincestring

citystringrequired

Possible values: <= 50 characters

postalCodestringrequired

Possible values: non-empty and <= 50 characters

address1stringrequired

Possible values: <= 200 characters

address2string

Possible values: <= 200 characters

websiteUrlstringrequired

Possible values: <= 500 characters

expectedTransactionVolume object

Expected transaction volume of the legal entity for a rolling period of 1 year

amountnumberrequired

Amount in minor units

Possible values: < 10000000000000

currencyCodeCurrency (string)required

Currency alphabetic code as specified by ISO 4217

Possible values: >= 3 characters and <= 3 characters

Example: EUR

representative objectrequired

idstring

Possible values: <= 20 characters

firstNamestringrequired

First name. Only latin characters, spaces, single quotes, and hyphens are allowed.

Possible values: non-empty and <= 50 characters

middleNamestring

Middle name. Only latin characters, spaces, single quotes, and hyphens are allowed.

Possible values: <= 50 characters

lastNamestringrequired

Last name. Only latin characters, spaces, single quotes, and hyphens are allowed.

Possible values: non-empty and <= 50 characters

dateOfBirthdaterequired

countryCodeCountryCode (string)required

ISO-3166 Alpha 2

Possible values: >= 2 characters and <= 2 characters

Example: GB

identificationNumberstringrequired

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: non-empty and <= 40 characters

Example: AA 01 23 44 B

identificationNumberIssuingCountryCodeCountryCode (string)required

ISO-3166 Alpha 2

Possible values: >= 2 characters and <= 2 characters

Example: GB

customerLegalEntityIdstring

ID of a CustomerLegalEntity to which this person is related to.

Possible values: <= 20 characters

kyc object

statusKycStatus (string)required

KYC Status enumeration

Possible values: [COMPLETED, IN_PROGRESS, NOT_COMPLETED]

idVerification object

statusstringrequired

Possible values: [COMPLETED, NOT_COMPLETED, IN_PROGRESS]

datedate-time

Represents RFC 3339, section 5.6 date-time.

Example: 2021-07-15T17:54:12Z

electronicallyVerifiedboolean

vendorstring

Name of the vendor that performed the electronic verification

Possible values: <= 50 characters

addressVerification object

statusstringrequired

Possible values: [COMPLETED, NOT_COMPLETED, IN_PROGRESS]

datedate-time

Represents RFC 3339, section 5.6 date-time.

Example: 2021-07-15T17:54:12Z

electronicallyVerifiedboolean

vendorstring

Name of the vendor that performed the electronic verification

Possible values: <= 50 characters

faceMatch object

statusstringrequired

Possible values: [COMPLETED, NOT_COMPLETED, IN_PROGRESS]

datedate-time

Represents RFC 3339, section 5.6 date-time.

Example: 2021-07-15T17:54:12Z

electronicallyVerifiedboolean

vendorstring

Name of the vendor that performed the electronic verification

Possible values: <= 50 characters

EDD object

statusstringrequired

Possible values: [COMPLETED, NOT_COMPLETED, IN_PROGRESS]

datedate-time

Represents RFC 3339, section 5.6 date-time.

Example: 2021-07-15T17:54:12Z

electronicallyVerifiedboolean

vendorstring

Name of the vendor that performed the electronic verification

Possible values: <= 50 characters

addressVerificationDocumentsReceivedstring[]

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

statusstringrequired

Possible values: [NO_MATCH, MATCH, NOT_SCREENED, RESOLVED, DISMISSED, IN_PROGRESS]

lastScreenDatedate-timerequired

reasonstring

sanctions object

statusstringrequired

Possible values: [NO_MATCH, MATCH, NOT_SCREENED, RESOLVED, DISMISSED, IN_PROGRESS]

lastScreenDatedate-timerequired

reasonstring

kybDocuments object[]

Array [

typestringrequired

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]

documentUrlsstring[]required

Possible values: <= 500 characters

]

directors object[]

List of directors. Used only when creating a new CustomerLegalEntity, ignored when updating.

Possible values: >= 1

Array [

idstring

Possible values: <= 20 characters

firstNamestringrequired

First name. Only latin characters, spaces, single quotes, and hyphens are allowed.

Possible values: non-empty and <= 50 characters

middleNamestring

Middle name. Only latin characters, spaces, single quotes, and hyphens are allowed.

Possible values: <= 50 characters

lastNamestringrequired

Last name. Only latin characters, spaces, single quotes, and hyphens are allowed.

Possible values: non-empty and <= 50 characters

dateOfBirthdaterequired

countryCodeCountryCode (string)required

ISO-3166 Alpha 2

Possible values: >= 2 characters and <= 2 characters

Example: GB

identificationNumberstringrequired

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: non-empty and <= 40 characters

Example: AA 01 23 44 B

identificationNumberIssuingCountryCodeCountryCode (string)required

ISO-3166 Alpha 2

Possible values: >= 2 characters and <= 2 characters

Example: GB

customerLegalEntityIdstring

ID of a CustomerLegalEntity to which this person is related to.

Possible values: <= 20 characters

kyc object

statusKycStatus (string)required

KYC Status enumeration

Possible values: [COMPLETED, IN_PROGRESS, NOT_COMPLETED]

idVerification object

statusstringrequired

Possible values: [COMPLETED, NOT_COMPLETED, IN_PROGRESS]

datedate-time

Represents RFC 3339, section 5.6 date-time.

Example: 2021-07-15T17:54:12Z

electronicallyVerifiedboolean

vendorstring

Name of the vendor that performed the electronic verification

Possible values: <= 50 characters

addressVerification object

statusstringrequired

Possible values: [COMPLETED, NOT_COMPLETED, IN_PROGRESS]

datedate-time

Represents RFC 3339, section 5.6 date-time.

Example: 2021-07-15T17:54:12Z

electronicallyVerifiedboolean

vendorstring

Name of the vendor that performed the electronic verification

Possible values: <= 50 characters

faceMatch object

statusstringrequired

Possible values: [COMPLETED, NOT_COMPLETED, IN_PROGRESS]

datedate-time

Represents RFC 3339, section 5.6 date-time.

Example: 2021-07-15T17:54:12Z

electronicallyVerifiedboolean

vendorstring

Name of the vendor that performed the electronic verification

Possible values: <= 50 characters

EDD object

statusstringrequired

Possible values: [COMPLETED, NOT_COMPLETED, IN_PROGRESS]

datedate-time

Represents RFC 3339, section 5.6 date-time.

Example: 2021-07-15T17:54:12Z

electronicallyVerifiedboolean

vendorstring

Name of the vendor that performed the electronic verification

Possible values: <= 50 characters

addressVerificationDocumentsReceivedstring[]

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

statusstringrequired

Possible values: [NO_MATCH, MATCH, NOT_SCREENED, RESOLVED, DISMISSED, IN_PROGRESS]

lastScreenDatedate-timerequired

reasonstring

sanctions object

statusstringrequired

Possible values: [NO_MATCH, MATCH, NOT_SCREENED, RESOLVED, DISMISSED, IN_PROGRESS]

lastScreenDatedate-timerequired

reasonstring

kybDocuments object[]

Array [

typestringrequired

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]

documentUrlsstring[]required

Possible values: <= 500 characters

]

]

ultimateBeneficialOwners object[]

List of owners of the legal entity. Used only when creating a new CustomerLegalEntity, ignored when updating.

Possible values: >= 1

Array [

idstring

Possible values: <= 20 characters

firstNamestringrequired

First name. Only latin characters, spaces, single quotes, and hyphens are allowed.

Possible values: non-empty and <= 50 characters

middleNamestring

Middle name. Only latin characters, spaces, single quotes, and hyphens are allowed.

Possible values: <= 50 characters

lastNamestringrequired

Last name. Only latin characters, spaces, single quotes, and hyphens are allowed.

Possible values: non-empty and <= 50 characters

dateOfBirthdaterequired

countryCodeCountryCode (string)required

ISO-3166 Alpha 2

Possible values: >= 2 characters and <= 2 characters

Example: GB

identificationNumberstringrequired

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: non-empty and <= 40 characters

Example: AA 01 23 44 B

identificationNumberIssuingCountryCodeCountryCode (string)required

ISO-3166 Alpha 2

Possible values: >= 2 characters and <= 2 characters

Example: GB

customerLegalEntityIdstring

ID of a CustomerLegalEntity to which this person is related to.

Possible values: <= 20 characters

kyc object

statusKycStatus (string)required

KYC Status enumeration

Possible values: [COMPLETED, IN_PROGRESS, NOT_COMPLETED]

idVerification object

statusstringrequired

Possible values: [COMPLETED, NOT_COMPLETED, IN_PROGRESS]

datedate-time

Represents RFC 3339, section 5.6 date-time.

Example: 2021-07-15T17:54:12Z

electronicallyVerifiedboolean

vendorstring

Name of the vendor that performed the electronic verification

Possible values: <= 50 characters

addressVerification object

statusstringrequired

Possible values: [COMPLETED, NOT_COMPLETED, IN_PROGRESS]

datedate-time

Represents RFC 3339, section 5.6 date-time.

Example: 2021-07-15T17:54:12Z

electronicallyVerifiedboolean

vendorstring

Name of the vendor that performed the electronic verification

Possible values: <= 50 characters

faceMatch object

statusstringrequired

Possible values: [COMPLETED, NOT_COMPLETED, IN_PROGRESS]

datedate-time

Represents RFC 3339, section 5.6 date-time.

Example: 2021-07-15T17:54:12Z

electronicallyVerifiedboolean

vendorstring

Name of the vendor that performed the electronic verification

Possible values: <= 50 characters

EDD object

statusstringrequired

Possible values: [COMPLETED, NOT_COMPLETED, IN_PROGRESS]

datedate-time

Represents RFC 3339, section 5.6 date-time.

Example: 2021-07-15T17:54:12Z

electronicallyVerifiedboolean

vendorstring

Name of the vendor that performed the electronic verification

Possible values: <= 50 characters

addressVerificationDocumentsReceivedstring[]

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

statusstringrequired

Possible values: [NO_MATCH, MATCH, NOT_SCREENED, RESOLVED, DISMISSED, IN_PROGRESS]

lastScreenDatedate-timerequired

reasonstring

sanctions object

statusstringrequired

Possible values: [NO_MATCH, MATCH, NOT_SCREENED, RESOLVED, DISMISSED, IN_PROGRESS]

lastScreenDatedate-timerequired

reasonstring

kybDocuments object[]

Array [

typestringrequired

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]

documentUrlsstring[]required

Possible values: <= 500 characters

]

ownershipPercentagestringrequired

Ownership percentage. Decimal number. Must be greater than 0 and lower or equal to 100. Supports up to 10 digit precision.

Possible values: non-empty and <= 20 characters

]

representatives object[]

Array [

idstring

Possible values: <= 20 characters

firstNamestringrequired

First name. Only latin characters, spaces, single quotes, and hyphens are allowed.

Possible values: non-empty and <= 50 characters

middleNamestring

Middle name. Only latin characters, spaces, single quotes, and hyphens are allowed.

Possible values: <= 50 characters

lastNamestringrequired

Last name. Only latin characters, spaces, single quotes, and hyphens are allowed.

Possible values: non-empty and <= 50 characters

dateOfBirthdaterequired

countryCodeCountryCode (string)required

ISO-3166 Alpha 2

Possible values: >= 2 characters and <= 2 characters

Example: GB

identificationNumberstringrequired

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: non-empty and <= 40 characters

Example: AA 01 23 44 B

identificationNumberIssuingCountryCodeCountryCode (string)required

ISO-3166 Alpha 2

Possible values: >= 2 characters and <= 2 characters

Example: GB

customerLegalEntityIdstring

ID of a CustomerLegalEntity to which this person is related to.

Possible values: <= 20 characters

kyc object

statusKycStatus (string)required

KYC Status enumeration

Possible values: [COMPLETED, IN_PROGRESS, NOT_COMPLETED]

idVerification object

statusstringrequired

Possible values: [COMPLETED, NOT_COMPLETED, IN_PROGRESS]

datedate-time

Represents RFC 3339, section 5.6 date-time.

Example: 2021-07-15T17:54:12Z

electronicallyVerifiedboolean

vendorstring

Name of the vendor that performed the electronic verification

Possible values: <= 50 characters

addressVerification object

statusstringrequired

Possible values: [COMPLETED, NOT_COMPLETED, IN_PROGRESS]

datedate-time

Represents RFC 3339, section 5.6 date-time.

Example: 2021-07-15T17:54:12Z

electronicallyVerifiedboolean

vendorstring

Name of the vendor that performed the electronic verification

Possible values: <= 50 characters

faceMatch object

statusstringrequired

Possible values: [COMPLETED, NOT_COMPLETED, IN_PROGRESS]

datedate-time

Represents RFC 3339, section 5.6 date-time.

Example: 2021-07-15T17:54:12Z

electronicallyVerifiedboolean

vendorstring

Name of the vendor that performed the electronic verification

Possible values: <= 50 characters

EDD object

statusstringrequired

Possible values: [COMPLETED, NOT_COMPLETED, IN_PROGRESS]

datedate-time

Represents RFC 3339, section 5.6 date-time.

Example: 2021-07-15T17:54:12Z

electronicallyVerifiedboolean

vendorstring

Name of the vendor that performed the electronic verification

Possible values: <= 50 characters

addressVerificationDocumentsReceivedstring[]

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

statusstringrequired

Possible values: [NO_MATCH, MATCH, NOT_SCREENED, RESOLVED, DISMISSED, IN_PROGRESS]

lastScreenDatedate-timerequired

reasonstring

sanctions object

statusstringrequired

Possible values: [NO_MATCH, MATCH, NOT_SCREENED, RESOLVED, DISMISSED, IN_PROGRESS]

lastScreenDatedate-timerequired

reasonstring

kybDocuments object[]

Array [

typestringrequired

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]

documentUrlsstring[]required

Possible values: <= 500 characters

]

]

sourceOfFundingstringrequired

Possible values: <= 100 characters

natureOfBusinessstringrequired

Possible values: <= 100 characters

reasonToApplystring

Possible values: <= 200 characters

CustomerLegalEntity

{
  "id": "10040500",
  "externalId": "af5c8b52-0afd-4799-85ab-fe659a076932",
  "type": "PERSON",
  "email": "john.smith@mail.com",
  "mobile": "+12025550120",
  "registrationIp": "198.51.100.42",
  "registrationDate": "2024-07-29T15:51:28.071Z",
  "restrictions": [
    {
      "name": "ALL_TRANSACTIONS",
      "reason": "RISK_CONTROLS",
      "requiredActions": [
        "CONTACT_CUSTOMER_SERVICE"
      ],
      "creationTime": "2021-07-15T17:54:12Z",
      "id": "084666a4-cd47-40c1-afe2-4a575e341d59"
    }
  ],
  "accounts": [
    {
      "id": "string",
      "customerId": "5435323362",
      "externalId": "string",
      "currencyCode": "EUR",
      "totalBalance": 0,
      "availableBalance": 0,
      "virtualInstrument": [
        {
          "instrumentType": "SEPA_BANK_ACCOUNT",
          "status": "ACTIVE"
        }
      ],
      "virtualAccountAssignmentStatus": [
        {
          "instrumentType": "SEPA_BANK_ACCOUNT",
          "requestDate": "2019-08-24T14:15:22Z",
          "lastChangeDate": "2019-08-24T14:15:22Z",
          "status": "COMPLETED",
          "statusReason": "Request has been denied by the issuing bank."
        }
      ],
      "creationTime": "2019-08-24T14:15:22Z",
      "virtualAccountAssignment": false
    }
  ],
  "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-07-29",
    "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-07-29T15:51:28.071Z",
        "reason": "string"
      },
      "sanctions": {
        "status": "NO_MATCH",
        "lastScreenDate": "2024-07-29T15:51:28.071Z",
        "reason": "string"
      }
    },
    "kybDocuments": [
      {
        "type": "CORPORATE_ONBOARDING_CHECKLIST",
        "documentUrls": [
          "string"
        ]
      }
    ]
  },
  "directors": [
    {
      "id": "string",
      "firstName": "string",
      "middleName": "string",
      "lastName": "string",
      "dateOfBirth": "2024-07-29",
      "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-07-29T15:51:28.071Z",
          "reason": "string"
        },
        "sanctions": {
          "status": "NO_MATCH",
          "lastScreenDate": "2024-07-29T15:51:28.071Z",
          "reason": "string"
        }
      },
      "kybDocuments": [
        {
          "type": "CORPORATE_ONBOARDING_CHECKLIST",
          "documentUrls": [
            "string"
          ]
        }
      ]
    }
  ],
  "ultimateBeneficialOwners": [
    {
      "id": "string",
      "firstName": "string",
      "middleName": "string",
      "lastName": "string",
      "dateOfBirth": "2024-07-29",
      "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-07-29T15:51:28.071Z",
          "reason": "string"
        },
        "sanctions": {
          "status": "NO_MATCH",
          "lastScreenDate": "2024-07-29T15:51:28.071Z",
          "reason": "string"
        }
      },
      "kybDocuments": [
        {
          "type": "CORPORATE_ONBOARDING_CHECKLIST",
          "documentUrls": [
            "string"
          ]
        }
      ],
      "ownershipPercentage": "string"
    }
  ],
  "representatives": [
    {
      "id": "string",
      "firstName": "string",
      "middleName": "string",
      "lastName": "string",
      "dateOfBirth": "2024-07-29",
      "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-07-29T15:51:28.071Z",
          "reason": "string"
        },
        "sanctions": {
          "status": "NO_MATCH",
          "lastScreenDate": "2024-07-29T15:51:28.071Z",
          "reason": "string"
        }
      },
      "kybDocuments": [
        {
          "type": "CORPORATE_ONBOARDING_CHECKLIST",
          "documentUrls": [
            "string"
          ]
        }
      ]
    }
  ],
  "sourceOfFunding": "string",
  "natureOfBusiness": "string",
  "reasonToApply": "string"
}