Get KYC Status

Get the current status of KYC verification

This endpoint will return the current KYC status mapped with the customerId only after the login OTP validation. First login to kycUrl link (received in /kyc/url), then check the kyc status.

GET the current KYC verification status.

POST https://integration.coinmena.com/onramp-bank/api/v1/kyc/status

Request Body

Name	Type	Description
customerId*	String	Unique id received from /kyc/url

200: OK

{
    "status": 1,
    "code": 200,
    "data": {
        "status": "COMPLETED",
        "countryISO": "IN",
        "currentKycVerificationStep": "EDD",
        "previousSuccessfulKycStep": "VIDEO_KYC"
    }
}

400: Bad Request Missing required parameter

{
    "status": 0,
    "code": 400,
    "error": "Missing customerId."
}

500: Internal Server Error Internal Servor Error

{
    "status": 0,
    "code": 500,
    "error": "Internal Server Error."
}

Response

{
    "status": 1,
    "code": 200,
    "data": {
        "status": "COMPLETED",
        "countryISO": "IN",
        "currentKycVerificationStep": "EDD",
        "previousSuccessfulKycStep": "VIDEO_KYC"
    }
}

Explanation

• status -> 0 is for unsuccessful request, 1 is for a successful one

• data -> current kycStatus can be

  • COMPLETED

  • BASIC_KYC_COMPLETED

  • INTERMEDIATE_KYC_COMPLETED

  • ADVANCE_KYC_COMPLETED

  • EDD_COMPLETED (for INDIA only)

  • PERMANENT_FAILURE

  • TEMPORARY_FAILURE

  • IN_REVIEW

  • OTP_COMPLETED -> The user has signed in, but the KYC verification has not yet begun.

  • LOGIN_REQUIRED -> The user has not completed the login verification.

• updatedAt -> time when kyc status is updated.

• currentKycVerificationStep -> current ongoing or next kyc verification step.

• previousSuccessfulKycStep -> last verified kyc verification step.

• Possible values of currentKycVerificationStep/previousSuccessfulKycStep ->

  • BASIC_KYC

  • INTERMEDIATE_KYC

  • ADVANCE_KYC

  • VIDEO_KYC (corresponding to COMPLETED kycStatus)

  • EDD

• countryISO -> ISO Alpha-2 countryCode