Deactivate customer wallet

DELETE 
/v2/customer-persons/:customerId

Deactivates a customer person.

Request

Path Parameters

customerId stringrequired

Responses

200

OK

application/json

Schema

Schema

id string

Possible values: <= 20 characters

externalId ExternalId (string)required

Possible values: non-empty and <= 40 characters

Customer identifier used in Partner system.

type

string

Possible values: [PERSON, LEGAL_ENTITY]

Type of Customer

PERSON

circular(CustomerPerson)

LEGAL_ENTITY

companyName stringrequired

Possible values: <= 100 characters

Name of the company

companyIdentifier stringrequired

Possible values: <= 100 characters

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

registrationAddress

object

required

countryCode CountryCode (string)required

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

ISO-3166 Alpha 2

stateProvince string

city stringrequired

Possible values: <= 50 characters

postalCode stringrequired

Possible values: non-empty and <= 50 characters

address1 stringrequired

Possible values: <= 200 characters

address2 string

Possible values: <= 200 characters

operatingAddress

object

required

countryCode CountryCode (string)required

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

ISO-3166 Alpha 2

stateProvince string

city stringrequired

Possible values: <= 50 characters

postalCode stringrequired

Possible values: non-empty and <= 50 characters

address1 stringrequired

Possible values: <= 200 characters

address2 string

Possible values: <= 200 characters

websiteUrl stringrequired

Possible values: <= 500 characters

expectedTransactionVolume

object

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

amount numberrequired

Possible values: < 10000000000000

Amount in minor units

currencyCode Currency (string)required

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

Currency alphabetic code as specified by ISO 4217

representative

object

required

id string

Possible values: <= 20 characters

firstName stringrequired

Possible values: non-empty and <= 50 characters

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

middleName string

Possible values: <= 50 characters

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

lastName stringrequired

Possible values: non-empty and <= 50 characters

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

dateOfBirth daterequired

countryCode CountryCode (string)required

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

ISO-3166 Alpha 2

identificationNumber stringrequired

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.

identificationNumberIssuingCountryCode CountryCode (string)required

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

ISO-3166 Alpha 2

customerLegalEntityId string

Possible values: <= 20 characters

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

kyc

object

status KycStatus (string)required

Possible values: [COMPLETED, IN_PROGRESS, NOT_COMPLETED]

KYC Status enumeration

idVerification

object

status stringrequired

Possible values: [COMPLETED, NOT_COMPLETED, IN_PROGRESS]

date date-time

Represents RFC 3339, section 5.6 date-time.

electronicallyVerified boolean

vendor string

Possible values: <= 50 characters

Name of the vendor that performed the electronic verification

addressVerification

object

status stringrequired

Possible values: [COMPLETED, NOT_COMPLETED, IN_PROGRESS]

date date-time

Represents RFC 3339, section 5.6 date-time.

electronicallyVerified boolean

vendor string

Possible values: <= 50 characters

Name of the vendor that performed the electronic verification

faceMatch

object

status stringrequired

Possible values: [COMPLETED, NOT_COMPLETED, IN_PROGRESS]

date date-time

Represents RFC 3339, section 5.6 date-time.

electronicallyVerified boolean

vendor string

Possible values: <= 50 characters

Name of the vendor that performed the electronic verification

EDD

object

status stringrequired

Possible values: [COMPLETED, NOT_COMPLETED, IN_PROGRESS]

date date-time

Represents RFC 3339, section 5.6 date-time.

electronicallyVerified boolean

vendor string

Possible values: <= 50 characters

Name of the vendor that performed the electronic verification

addressVerificationDocumentsReceived string[]

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

status stringrequired

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

lastScreenDate date-timerequired

reason string

sanctions

object

status stringrequired

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

lastScreenDate date-timerequired

reason string

kybDocuments

object[]

Array [

type stringrequired

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]

documentUrls string[]required

Possible values: <= 500 characters

]

directors

object[]

Possible values: >= 1

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

Array [

id string

Possible values: <= 20 characters

firstName stringrequired

Possible values: non-empty and <= 50 characters

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

middleName string

Possible values: <= 50 characters

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

lastName stringrequired

Possible values: non-empty and <= 50 characters

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

dateOfBirth daterequired

countryCode CountryCode (string)required

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

ISO-3166 Alpha 2

identificationNumber stringrequired

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.

identificationNumberIssuingCountryCode CountryCode (string)required

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

ISO-3166 Alpha 2

customerLegalEntityId string

Possible values: <= 20 characters

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

kyc

object

status KycStatus (string)required

Possible values: [COMPLETED, IN_PROGRESS, NOT_COMPLETED]

KYC Status enumeration

idVerification

object

status stringrequired

Possible values: [COMPLETED, NOT_COMPLETED, IN_PROGRESS]

date date-time

Represents RFC 3339, section 5.6 date-time.

electronicallyVerified boolean

vendor string

Possible values: <= 50 characters

Name of the vendor that performed the electronic verification

addressVerification

object

status stringrequired

Possible values: [COMPLETED, NOT_COMPLETED, IN_PROGRESS]

date date-time

Represents RFC 3339, section 5.6 date-time.

electronicallyVerified boolean

vendor string

Possible values: <= 50 characters

Name of the vendor that performed the electronic verification

faceMatch

object

status stringrequired

Possible values: [COMPLETED, NOT_COMPLETED, IN_PROGRESS]

date date-time

Represents RFC 3339, section 5.6 date-time.

electronicallyVerified boolean

vendor string

Possible values: <= 50 characters

Name of the vendor that performed the electronic verification

EDD

object

status stringrequired

Possible values: [COMPLETED, NOT_COMPLETED, IN_PROGRESS]

date date-time

Represents RFC 3339, section 5.6 date-time.

electronicallyVerified boolean

vendor string

Possible values: <= 50 characters

Name of the vendor that performed the electronic verification

addressVerificationDocumentsReceived string[]

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

status stringrequired

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

lastScreenDate date-timerequired

reason string

sanctions

object

status stringrequired

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

lastScreenDate date-timerequired

reason string

kybDocuments

object[]

Array [

type stringrequired

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]

documentUrls string[]required

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.

Array [

id string

Possible values: <= 20 characters

firstName stringrequired

Possible values: non-empty and <= 50 characters

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

middleName string

Possible values: <= 50 characters

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

lastName stringrequired

Possible values: non-empty and <= 50 characters

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

dateOfBirth daterequired

countryCode CountryCode (string)required

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

ISO-3166 Alpha 2

identificationNumber stringrequired

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.

identificationNumberIssuingCountryCode CountryCode (string)required

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

ISO-3166 Alpha 2

customerLegalEntityId string

Possible values: <= 20 characters

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

kyc

object

status KycStatus (string)required

Possible values: [COMPLETED, IN_PROGRESS, NOT_COMPLETED]

KYC Status enumeration

idVerification

object

status stringrequired

Possible values: [COMPLETED, NOT_COMPLETED, IN_PROGRESS]

date date-time

Represents RFC 3339, section 5.6 date-time.

electronicallyVerified boolean

vendor string

Possible values: <= 50 characters

Name of the vendor that performed the electronic verification

addressVerification

object

status stringrequired

Possible values: [COMPLETED, NOT_COMPLETED, IN_PROGRESS]

date date-time

Represents RFC 3339, section 5.6 date-time.

electronicallyVerified boolean

vendor string

Possible values: <= 50 characters

Name of the vendor that performed the electronic verification

faceMatch

object

status stringrequired

Possible values: [COMPLETED, NOT_COMPLETED, IN_PROGRESS]

date date-time

Represents RFC 3339, section 5.6 date-time.

electronicallyVerified boolean

vendor string

Possible values: <= 50 characters

Name of the vendor that performed the electronic verification

EDD

object

status stringrequired

Possible values: [COMPLETED, NOT_COMPLETED, IN_PROGRESS]

date date-time

Represents RFC 3339, section 5.6 date-time.

electronicallyVerified boolean

vendor string

Possible values: <= 50 characters

Name of the vendor that performed the electronic verification

addressVerificationDocumentsReceived string[]

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

status stringrequired

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

lastScreenDate date-timerequired

reason string

sanctions

object

status stringrequired

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

lastScreenDate date-timerequired

reason string

kybDocuments

object[]

Array [

type stringrequired

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]

documentUrls string[]required

Possible values: <= 500 characters

]

ownershipPercentage stringrequired

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[]

Array [

id string

Possible values: <= 20 characters

firstName stringrequired

Possible values: non-empty and <= 50 characters

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

middleName string

Possible values: <= 50 characters

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

lastName stringrequired

Possible values: non-empty and <= 50 characters

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

dateOfBirth daterequired

countryCode CountryCode (string)required

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

ISO-3166 Alpha 2

identificationNumber stringrequired

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.

identificationNumberIssuingCountryCode CountryCode (string)required

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

ISO-3166 Alpha 2

customerLegalEntityId string

Possible values: <= 20 characters

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

kyc

object

status KycStatus (string)required

Possible values: [COMPLETED, IN_PROGRESS, NOT_COMPLETED]

KYC Status enumeration

idVerification

object

status stringrequired

Possible values: [COMPLETED, NOT_COMPLETED, IN_PROGRESS]

date date-time

Represents RFC 3339, section 5.6 date-time.

electronicallyVerified boolean

vendor string

Possible values: <= 50 characters

Name of the vendor that performed the electronic verification

addressVerification

object

status stringrequired

Possible values: [COMPLETED, NOT_COMPLETED, IN_PROGRESS]

date date-time

Represents RFC 3339, section 5.6 date-time.

electronicallyVerified boolean

vendor string

Possible values: <= 50 characters

Name of the vendor that performed the electronic verification

faceMatch

object

status stringrequired

Possible values: [COMPLETED, NOT_COMPLETED, IN_PROGRESS]

date date-time

Represents RFC 3339, section 5.6 date-time.

electronicallyVerified boolean

vendor string

Possible values: <= 50 characters

Name of the vendor that performed the electronic verification

EDD

object

status stringrequired

Possible values: [COMPLETED, NOT_COMPLETED, IN_PROGRESS]

date date-time

Represents RFC 3339, section 5.6 date-time.

electronicallyVerified boolean

vendor string

Possible values: <= 50 characters

Name of the vendor that performed the electronic verification

addressVerificationDocumentsReceived string[]

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

status stringrequired

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

lastScreenDate date-timerequired

reason string

sanctions

object

status stringrequired

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

lastScreenDate date-timerequired

reason string

kybDocuments

object[]

Array [

type stringrequired

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]

documentUrls string[]required

Possible values: <= 500 characters

]

]

sourceOfFunding stringrequired

Possible values: <= 100 characters

natureOfBusiness stringrequired

Possible values: <= 100 characters

reasonToApply string

Possible values: <= 200 characters

email stringrequired

Possible values: <= 150 characters

Primary email address

mobile string

Possible values: <= 50 characters

Mobile number

registrationIp ipv4required

IPv4 address from which the customer has registered.

registrationDate date-time

Date of registration at the Merchant system

restrictions

object[]

Array [

name RestrictionName (string)required

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.

reason RestrictionReason (string)required

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.

requiredActions RestrictionAction (string)[]

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

lastChangeDate date-time

Represents RFC 3339, section 5.6 date-time.

id stringrequired

Restriction id

activationTime date-time

Represents RFC 3339, section 5.6 date-time.

dueDate date-time

Represents RFC 3339, section 5.6 date-time.

]

accounts

object[]

Accounts associated with this customer.

Array [

id string

Possible values: <= 20 characters

Account id.

customerId string

Possible values: <= 20 characters

externalId string

Possible values: <= 40 characters

currencyCode Currency (string)required

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

Currency alphabetic code as specified by ISO 4217

totalBalance int64

Amount in minor units

availableBalance int64

Amount in minor units

virtualInstrument

object[]

Array [

instrumentType

string

required

Possible values: [SEPA_BANK_ACCOUNT, UK_BANK_ACCOUNT, US_BANK_ACCOUNT]

Instrument type.

SEPA_BANK_ACCOUNT

iban stringrequired

The International Bank Account Number (IBAN) of the account.

bic stringrequired

The Bank Account Bank Identifier Code (BIC) code. Also known as SWIFT code.

UK_BANK_ACCOUNT

accountNumber stringrequired

A bank account number.

sortCode stringrequired

Use our sort code checker to easily find and check UK sort codes.

US_BANK_ACCOUNT

accountNumber stringrequired

Possible values: >= 4 characters and <= 17 characters

This is the bank account number.

routingNumber stringrequired

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

For USD accounts, this is the 9-digit routing number of the bank.

status string

Possible values: [ACTIVE]

Instrument status.

]

creationTime date-time

hasVirtualInstrument booleanrequired

]

firstName stringrequired

Possible values: <= 50 characters

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

lastName stringrequired

Possible values: <= 50 characters

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

title string

Possible values: <= 15 characters

Personal title, Mr., Dr., etc.

address1 stringrequired

Possible values: <= 200 characters

Address line 1.

address2 string

Possible values: <= 200 characters

Address line 2.

city stringrequired

Possible values: <= 100 characters

City of residence.

zip stringrequired

Possible values: <= 30 characters

Postal code.

state string

Possible values: <= 2 characters

US state postal abbreviation. Not used for non US territories.

countryCode CountryCode (string)required

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

ISO-3166 Alpha 2

birthDate daterequired

Birth date in YYYY-MM-DD format.

nationality CountryCode (string)

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

ISO-3166 Alpha 2

occupation Occupation (string)required
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:
• 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"
vulnerabilities Vulnerability (string)[]

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

Example (from schema)

{
  "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-17T12:55:47.501Z",
  "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,
      "virtualInstrument": [
        {
          "instrumentType": "SEPA_BANK_ACCOUNT",
          "status": "ACTIVE"
        }
      ],
      "creationTime": "2019-08-24T14:15:22Z",
      "hasVirtualInstrument": true
    }
  ],
  "firstName": "string",
  "lastName": "string",
  "title": "string",
  "address1": "string",
  "address2": "string",
  "city": "string",
  "zip": "string",
  "state": "string",
  "countryCode": "GB",
  "birthDate": "2024-09-17",
  "nationality": "GB",
  "occupation": "ARCHITECTURE_CARTOGRAPHY_SURVEYOR",
  "vulnerabilities": [
    "PHYSICAL_DISABILITY"
  ]
}

404

Customer with the requested ID was not found.

409

The customer with the requested ID has already been deactivated.

application/json

Schema

Schema

error

object

Additional details about an error

code string

The error code.

message string

A description of the error.

details string[]

Details of any parameter value errors.

fieldErrors

object[]

Array [

field string

Identifies the JSON request field.

error string

The problem associated with the field.

]

Example (from schema)

{
  "error": {
    "code": "string",
    "message": "string",
    "details": [
      "string"
    ],
    "fieldErrors": [
      {
        "field": "string",
        "error": "string"
      }
    ]
  }
}

Loading...