Submits a sub-account's information for KYC verification. This lets you collect your merchant's verification data on your Platform's own interface and pass it to Xendit via API.
You may use this API for OWNED sub-accounts created with the /v2/accounts API,
or for sub-accounts created in the Dashboard. Upload the referenced documents with
the Upload File API (POST /files, purpose KYC_DOCUMENT) first, then reference
them by file_id.
Include the for-user-id header with the sub-account's business ID to submit
verification on its behalf.
Required fields, accepted document types, address fields and identification types vary by country of incorporation and entity type.
The business ID of the sub-account to submit or retrieve verification for
ISO 3166-1 alpha-2 country code of incorporation
Business entity type, e.g. CORPORATION or PARTNERSHIP. Availability is country-specific.
One of the accepted industry category codes for the country of incorporation
The KYC information of the business. Required fields, accepted document types and identification types vary by country of incorporation and entity type.
Indonesia only
Format YYYY-MM-DD
Indonesia only
Required for ID, TH, VN
Required for ID, TH
Required for ID, TH, PH, VN
Required for PH, MY
Required for VN
ISO 3166-1 alpha-2 country code
Required for ID, TH, VN
Required for ID, TH
Required for ID, TH, PH, VN
Required for PH, MY
Required for VN
ISO 3166-1 alpha-2 country code
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.
At least one of proof_of_business_websites or proof_of_business_documents
must be provided.
At least one of proof_of_business_websites or proof_of_business_documents
must be provided.
Country-specific document type, e.g. HK_CI, HK_NAR1, ID_NIB, ID_COMPANY_NPWP, ID_AKTA, ID_SKMENKEH
A document uploaded with the Upload File API (POST /files, purpose KYC_DOCUMENT)
A copy of the business bank account book or statement. Requirement varies by country of incorporation — optional for TH.
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.
Signed service agreement. Optional — this is normally generated through the consent flow, but you may also provide it directly via this API.
Indonesia only
Indonesia only
Indonesia only
ISO 3166-1 alpha-2 country code
Format YYYY-MM-DD
Required for ID, TH, VN
Required for ID, TH
Required for ID, TH, PH, VN
Required for PH, MY
Required for VN
ISO 3166-1 alpha-2 country code
A document uploaded with the Upload File API (POST /files, purpose KYC_DOCUMENT)
Country-specific identification type, e.g. PASSPORT, HK_NATIONAL_ID, ID_NATIONAL_ID_KTP
A document uploaded with the Upload File API (POST /files, purpose KYC_DOCUMENT)
A document uploaded with the Upload File API (POST /files, purpose KYC_DOCUMENT)
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).
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.
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
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.
ISO 3166-1 alpha-2 country code
Format YYYY-MM-DD
Required for ID, TH, VN
Required for ID, TH
Required for ID, TH, PH, VN
Required for PH, MY
Required for VN
ISO 3166-1 alpha-2 country code
Country-specific identification type, e.g. PASSPORT, HK_NATIONAL_ID, ID_NATIONAL_ID_KTP
A document uploaded with the Upload File API (POST /files, purpose KYC_DOCUMENT)
A document uploaded with the Upload File API (POST /files, purpose KYC_DOCUMENT)
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).
Whether any of the business's shareholders is a corporate entity (rather than
an individual). When true, business_shareholding_chart_document is required.
Results of verifications you have already performed through third parties
Date the verification was performed, format YYYY-MM-DD
Free-form JSON object documenting the verification outcome
Verification request created. Returns the KYC request with its current status.
{
"id": "kyc-request-id-12345",
"status": "PENDING_VERIFICATION",
"business_id": "sub-account-business-id",
"country_of_incorporation": "HK",
"business_entity_type": "CORPORATION"
}Unique ID of the KYC request
The KYC verification status of the sub-account
Business ID of the sub-account
The KYC information of the business. Required fields, accepted document types and identification types vary by country of incorporation and entity type.
Indonesia only
Format YYYY-MM-DD
Indonesia only
Required for ID, TH, VN
Required for ID, TH
Required for ID, TH, PH, VN
Required for PH, MY
Required for VN
ISO 3166-1 alpha-2 country code
Required for ID, TH, VN
Required for ID, TH
Required for ID, TH, PH, VN
Required for PH, MY
Required for VN
ISO 3166-1 alpha-2 country code
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.
At least one of proof_of_business_websites or proof_of_business_documents
must be provided.
At least one of proof_of_business_websites or proof_of_business_documents
must be provided.
Country-specific document type, e.g. HK_CI, HK_NAR1, ID_NIB, ID_COMPANY_NPWP, ID_AKTA, ID_SKMENKEH
A document uploaded with the Upload File API (POST /files, purpose KYC_DOCUMENT)
A copy of the business bank account book or statement. Requirement varies by country of incorporation — optional for TH.
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.
Signed service agreement. Optional — this is normally generated through the consent flow, but you may also provide it directly via this API.
Indonesia only
Indonesia only
Indonesia only
ISO 3166-1 alpha-2 country code
Format YYYY-MM-DD
Required for ID, TH, VN
Required for ID, TH
Required for ID, TH, PH, VN
Required for PH, MY
Required for VN
ISO 3166-1 alpha-2 country code
A document uploaded with the Upload File API (POST /files, purpose KYC_DOCUMENT)
Country-specific identification type, e.g. PASSPORT, HK_NATIONAL_ID, ID_NATIONAL_ID_KTP
A document uploaded with the Upload File API (POST /files, purpose KYC_DOCUMENT)
A document uploaded with the Upload File API (POST /files, purpose KYC_DOCUMENT)
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).
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.
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
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.
ISO 3166-1 alpha-2 country code
Format YYYY-MM-DD
Required for ID, TH, VN
Required for ID, TH
Required for ID, TH, PH, VN
Required for PH, MY
Required for VN
ISO 3166-1 alpha-2 country code
Country-specific identification type, e.g. PASSPORT, HK_NATIONAL_ID, ID_NATIONAL_ID_KTP
A document uploaded with the Upload File API (POST /files, purpose KYC_DOCUMENT)
A document uploaded with the Upload File API (POST /files, purpose KYC_DOCUMENT)
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).
Whether any of the business's shareholders is a corporate entity (rather than
an individual). When true, business_shareholding_chart_document is required.
| Error code | Description |
|---|---|
INVALID_DATA_SUBMITTED |
A field value is invalid or a required field is missing for the given country and entity type |
| Error code | Description |
|---|---|
INVALID_API_KEY |
The API key is missing or invalid |
| Error code | Description |
|---|---|
REQUEST_FORBIDDEN_ERROR |
The API key does not have permission to perform this request |
| Error code | Description |
|---|---|
XEN_PLATFORM_SUB_ACCOUNT_NOT_LIVE |
The sub-account referenced by for-user-id does not exist or is not live |
| Error code | Description |
|---|---|
SERVER_ERROR |
An unexpected error occurred — retry or contact support |