For archived content, access the previous documentation here or the previous API reference here.

Retrieve account verification

Prev Next
Get
/account_verification

Retrieves the KYC verification request and current verification status of a sub-account. Include the for-user-id header with the sub-account's business ID.

Security
HTTP
Type basic
Header parameters
for-user-id
stringRequired

The business ID of the sub-account to submit or retrieve verification for

Responses
200

The sub-account's verification request and status.

Expand All
object
id
string

Unique ID of the KYC request

Examplekyc-request-id-12345
status
string

The KYC verification status of the sub-account

Valid values[ "PENDING_VERIFICATION", "VERIFICATION_IN_PROGRESS", "AWAITING_RESUBMISSION", "PASSED", "FAILED" ]
business_id
string

Business ID of the sub-account

country_of_incorporation
string
business_entity_type
string
kyc_details
object (AccountVerificationKycDetails)

The KYC information of the business. Required fields, accepted document types and identification types vary by country of incorporation and entity type.

business_legal_name
string
business_description
string
business_registration_number
string
business_tax_number
string

Indonesia only

business_establishment_date
string

Format YYYY-MM-DD

business_average_monthly_basket_size
string
Example$50K - $300K
business_intents
Array of string
string
Valid values[ "PAYMENTS", "PAYOUT", "GLOBAL_PAYOUT", "BUSINESS_EXPENSES" ]
business_source_of_funds
Array of string
string
Valid values[ "REVENUE", "INVESTOR_SHAREHOLDER_FUNDING", "INVESTMENT_INCOME", "BUSINESS_LOAN", "PERSONAL_FUNDING", "DONATIONS", "GRANTS", "OTHER" ]
business_registration_documents_amended
boolean

Indonesia only

business_address
object (AccountVerificationAddress)
street_line_1
string
street_line_2
string
city
string
district
string

Required for ID, TH, VN

sub_district
string

Required for ID, TH

province
string

Required for ID, TH, PH, VN

state
string

Required for PH, MY

ward
string

Required for VN

postal_code
string
country_code
string

ISO 3166-1 alpha-2 country code

legal_entity_address
object (AccountVerificationAddress)
street_line_1
string
street_line_2
string
city
string
district
string

Required for ID, TH, VN

sub_district
string

Required for ID, TH

province
string

Required for ID, TH, PH, VN

state
string

Required for PH, MY

ward
string

Required for VN

postal_code
string
country_code
string

ISO 3166-1 alpha-2 country code

office_store_address_proof_document
object

Proof of the business's operating address. Required only when business_address differs from legal_entity_address. If the two addresses are the same, this document is not needed.

file_name
string
ExampleCertificate of Incorporation.pdf
file_id
string
Examplefile-c7bdf24b-738d-4c47-a919-55479daf7603
proof_of_business_websites
object

At least one of proof_of_business_websites or proof_of_business_documents must be provided.

website
string
website_staging_url
string
website_staging_username
string
website_staging_password
string
social_instagram_url
string
social_facebook_url
string
social_others_url
string
marketplace_url
string
proof_of_business_documents
Array of object

At least one of proof_of_business_websites or proof_of_business_documents must be provided.

object
file_name
string
ExampleCertificate of Incorporation.pdf
file_id
string
Examplefile-c7bdf24b-738d-4c47-a919-55479daf7603
type
string
Valid values[ "POSTER_BROCHURE_PAMPHLET_DOCUMENT", "INVOICE_PURCHASE_ORDER_DOCUMENT", "OFFLINE_STORE_PHOTO_DOCUMENT", "OTHER_DOCUMENT" ]
business_registration_documents
Array of object
object
file_name
string
ExampleCertificate of Incorporation.pdf
file_id
string
Examplefile-c7bdf24b-738d-4c47-a919-55479daf7603
type
string

Country-specific document type, e.g. HK_CI, HK_NAR1, ID_NIB, ID_COMPANY_NPWP, ID_AKTA, ID_SKMENKEH

business_license_documents
Array of object (AccountVerificationFile)
object

A document uploaded with the Upload File API (POST /files, purpose KYC_DOCUMENT)

file_name
string
ExampleCertificate of Incorporation.pdf
file_id
string
Examplefile-c7bdf24b-738d-4c47-a919-55479daf7603
business_bank_account_document
object

A copy of the business bank account book or statement. Requirement varies by country of incorporation — optional for TH.

file_name
string
ExampleCertificate of Incorporation.pdf
file_id
string
Examplefile-c7bdf24b-738d-4c47-a919-55479daf7603
business_shareholding_chart_document
object

A chart of the business's shareholding structure. Only applies to corporate entity types (e.g. corporation, limited company, joint stock company). Required when shareholders_include_corporate_entity is true.

file_name
string
ExampleCertificate of Incorporation.pdf
file_id
string
Examplefile-c7bdf24b-738d-4c47-a919-55479daf7603
service_agreement_document
object

Signed service agreement. Optional — this is normally generated through the consent flow, but you may also provide it directly via this API.

file_name
string
ExampleCertificate of Incorporation.pdf
file_id
string
Examplefile-c7bdf24b-738d-4c47-a919-55479daf7603
business_bank_account_number
string

Indonesia only

business_bank_channel_code
string

Indonesia only

business_bank_name
string

Indonesia only

authorized_person_first_name
string
authorized_person_last_name
string
authorized_person_gender
string
ExampleM
authorized_person_nationality
string

ISO 3166-1 alpha-2 country code

authorized_person_date_of_birth
string

Format YYYY-MM-DD

authorized_person_role
string
ExampleFOUNDER
authorized_person_mobile_country_code
string
Example+852
authorized_person_mobile_number_only
string
authorized_person_email_address
string
authorized_person_address
object (AccountVerificationAddress)
street_line_1
string
street_line_2
string
city
string
district
string

Required for ID, TH, VN

sub_district
string

Required for ID, TH

province
string

Required for ID, TH, PH, VN

state
string

Required for PH, MY

ward
string

Required for VN

postal_code
string
country_code
string

ISO 3166-1 alpha-2 country code

authorized_person_selfie_document
object (AccountVerificationFile)

A document uploaded with the Upload File API (POST /files, purpose KYC_DOCUMENT)

file_name
string
ExampleCertificate of Incorporation.pdf
file_id
string
Examplefile-c7bdf24b-738d-4c47-a919-55479daf7603
authorized_person_identification
Array of object (AccountVerificationIdentification)
object
type
string

Country-specific identification type, e.g. PASSPORT, HK_NATIONAL_ID, ID_NATIONAL_ID_KTP

number
string
document_front
object (AccountVerificationFile)

A document uploaded with the Upload File API (POST /files, purpose KYC_DOCUMENT)

file_name
string
ExampleCertificate of Incorporation.pdf
file_id
string
Examplefile-c7bdf24b-738d-4c47-a919-55479daf7603
document_back
object (AccountVerificationFile)

A document uploaded with the Upload File API (POST /files, purpose KYC_DOCUMENT)

file_name
string
ExampleCertificate of Incorporation.pdf
file_id
string
Examplefile-c7bdf24b-738d-4c47-a919-55479daf7603
authorized_person_proof_of_residency_document
object

Proof of the authorized person's residential address. Required when the submitted authorized_person_identification document does not itself contain a residential address (e.g. a passport or Hong Kong ID).

file_name
string
ExampleCertificate of Incorporation.pdf
file_id
string
Examplefile-c7bdf24b-738d-4c47-a919-55479daf7603
authorized_person_board_resolution_document
object

Board resolution proving the authorized person is empowered to act for the business. Applies to corporation-type entities (e.g. SG/HK/ID corporation, TH limited company, VN joint stock company).

Required unless the authorized person is declared in stakeholders (with is_authorized_person: true) holding the BOARD_DIRECTOR role — in that case the document is not needed.

file_name
string
ExampleCertificate of Incorporation.pdf
file_id
string
Examplefile-c7bdf24b-738d-4c47-a919-55479daf7603
authorized_person_letter_of_authorization_document
object

Letter of authorization proving the authorized person is empowered to act for the business.

Required unless the authorized person is declared in stakeholders (with is_authorized_person: true) holding the governing role for the entity type. The role that waives this document depends on the entity type:

  • Partnerships — LEGAL_PARTNER
  • Sole proprietorships — BUSINESS_OWNER
  • Mexico entities — AUTHORIZED_SIGNATORY
  • Indonesia non-profit, Malaysia private limited — BOARD_DIRECTOR
file_name
string
ExampleCertificate of Incorporation.pdf
file_id
string
Examplefile-c7bdf24b-738d-4c47-a919-55479daf7603
contact_person_first_name
string
contact_person_last_name
string
contact_person_mobile_country_code
string
contact_person_mobile_number_only
string
contact_person_email_address
string
stakeholders
Array of object (AccountVerificationStakeholder)
object
roles
Array of string

The stakeholder's role(s) in the business. When a stakeholder is the authorized person (is_authorized_person: true), their roles determine whether the authorized_person_board_resolution_document or authorized_person_letter_of_authorization_document is required — declaring the governing role for the entity type (e.g. BOARD_DIRECTOR, LEGAL_PARTNER, BUSINESS_OWNER, AUTHORIZED_SIGNATORY) waives that document.

string
Valid values[ "BOARD_DIRECTOR", "BUSINESS_OWNER", "LEGAL_PARTNER", "AUTHORIZED_SIGNATORY" ]
first_name
string
last_name
string
nationality
string

ISO 3166-1 alpha-2 country code

date_of_birth
string

Format YYYY-MM-DD

address
object (AccountVerificationAddress)
street_line_1
string
street_line_2
string
city
string
district
string

Required for ID, TH, VN

sub_district
string

Required for ID, TH

province
string

Required for ID, TH, PH, VN

state
string

Required for PH, MY

ward
string

Required for VN

postal_code
string
country_code
string

ISO 3166-1 alpha-2 country code

is_authorized_person
boolean
Defaultfalse
identification
Array of object (AccountVerificationIdentification)
object
type
string

Country-specific identification type, e.g. PASSPORT, HK_NATIONAL_ID, ID_NATIONAL_ID_KTP

number
string
document_front
object (AccountVerificationFile)

A document uploaded with the Upload File API (POST /files, purpose KYC_DOCUMENT)

file_name
string
ExampleCertificate of Incorporation.pdf
file_id
string
Examplefile-c7bdf24b-738d-4c47-a919-55479daf7603
document_back
object (AccountVerificationFile)

A document uploaded with the Upload File API (POST /files, purpose KYC_DOCUMENT)

file_name
string
ExampleCertificate of Incorporation.pdf
file_id
string
Examplefile-c7bdf24b-738d-4c47-a919-55479daf7603
proof_of_residency_document
object

Proof of the stakeholder's residential address. Required when the stakeholder's identification document does not itself contain a residential address (e.g. a passport or Hong Kong ID).

file_name
string
ExampleCertificate of Incorporation.pdf
file_id
string
Examplefile-c7bdf24b-738d-4c47-a919-55479daf7603
shareholders_include_corporate_entity
boolean

Whether any of the business's shareholders is a corporate entity (rather than an individual). When true, business_shareholding_chart_document is required.

401

Invalid API key

object
error_code
string
message
string
404

No verification request found for the sub-account

object
error_code
string
message
string