Submit KYC

post

https://openapi.sandbox.xenithpay.com/v1/kyc

You can use this endpoint to Submit KYC Request

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

❗
Only for JPY - VIRTUAL ACCOUNT
KYC is currently only required for JPY - VIRTUAL ACCOUNT transactions.

Submit a customer for KYC. Xenith validates the request, creates a PENDING KYC record, returns a kycId, and proceeds with the verification process. An APPROVED KYC status is required before the customer can transact in the applicable channel, and may continue transacting in other channels for which KYC approval is not required.

Body Params

customerReference

string

required

length between 1 and 64

Merchant-provided identifier for the customer. Must be unique per merchant.

currency

string

enum

required

ISO 4217 currency code. KYC is currently supported for JPY only.

Allowed:

callbackUrl

uri

required

Your HTTPS webhook URL to receive KYC status updates.

metadata

object

required

For JPY, nameKatakana is mandatory.

Headers

Xenith-Api-Key

string

required

API Keys can be generated through dashboard. Refer to API Keys page.

Xenith-Request-Timestamp

string

required

ISO 8601 date time format, should be in (UTC+0)

Xenith-Request-Signature

string

required

Refer to page Build Signature and Set Headers for instructions on how to build a signature

X-Idempotency-Key

string

required

length ≤ 100

A unique key to prevent duplicate KYC submissions. Must be unique across all KYC submissions for the merchant. Max 100 characters. Reusing the key with a different body returns DUPLICATE_TRANSACTION_ERROR.

Responses

Callback

Only for JPY - VIRTUAL ACCOUNT

200An existing PENDING or APPROVED KYC record was returned. Repeating the submission does not create a new attempt.

201KYC submission accepted and created in PENDING status.

400KYC submission failed due to failing request validation. See the KYC Errors dictionary for more detail.

500An error occurred while connecting to our server. This could be due to temporary server issues. Reconcile via Get KYC Status API. See the KYC Errors dictionary for more detail.

503Service is temporarily unavailable. See the KYC Errors dictionary for more detail.