Query KYC Status

Introduction

After the user initiates a KYC request, the merchant can call this API to update the user’s KYC status.

It can be used in conjunction with the KYC webhook.

API Description

Request Method: POST

Request Path: open/api/kyc/getKycStatus/v2

Request Parameters

Response Parameters

Body Parameters:

ParameterTypeDescription
successbooleansuccess
errorbooleanerror
codestringreturn code
msgstringreturn message
traceIdstringtraceId
modelobjectresponse entity

Model Entity Description

ParameterTypeDescription
kycStatusstringkyc status

KYC Status Description

ParameterDescription
NOT_INITKYC has not yet started
CA_COMPLETED_PENDING_SCANPart 1 registration is complete; preparing for identity scanning.
PROCESSING_SCANUser scans passport, waiting for information processing (approximately 15-20 seconds).
PENDING_ACTIONCustomer needs to take action to complete KYC, such as passport not yet scanned, or already scanned but requiring rescanning, or needing to re-add address.
COMPLETEDKYC success
MANUAL_REVIEWKYC submitted, but still under manual review due to regulatory reasons.
REJECTEDKYC failed

Response Parameter Example:

{
    "code": "0",
    "msg": "SUCCESS",
    "model": {
        "kycStatus": "COMPLETED"
    },
    "traceId": "6655923745b9b37cb000187a035002030",
    "success": true,
    "error": false
}