E-Kyc Status

E-Kyc Status

Postman Collection

AEPS

URL

POST : /v1/service/aeps/kycStatus

Headers

Content-Type  (String)   required
application/json

Authorization  (String)   required
Basic Auth

Accept  (String)   required
application/json

Body Params

merchantCode  (String)   Required
Merchant unique Code (You will get merchantCode from Merchant Onboarding API) (Max Length: 50)

routeType  (String)   Optional
Api Service Type (Like ICICI) (Max Length: Fixed)

Request

Example

curl --location --request POST '/v1/service/aeps/kycStatus' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Basic e3tsb2NfdXNlcn19Ont7bG9jX3Bhc3N9fQ==' \
    --data-raw '{
            "merchantCode": "MC9377279"
        }'

Example - when optional param passed

curl --location --request POST '/v1/service/aeps/kycStatus' \
    --header 'Content-Type: application/json' \
    --header 'Accept: application/json' \
    --data-raw '{
            "merchantCode": "MC9377279",
            "routeType": "airtel"
        }'

Response Samples

SUCCESS

{
    "code": "0x0200",
    "message": "Record fetched successfully.",
    "status": "SUCCESS",
    "data": {
        "documents": {
            "kycStatus": "rejected",
            "kycDate": "2022-07-10 16:00:39",
            "remark": "KYC rejected. test rejected"
        },
        "sbm": {
            "kycStatus": "rejected",
            "kycDate": "2022-07-10 16:00:40",
            "kycExpireDate": "NA"
        },
        "icici": {
            "kycStatus": "pending",
            "kycDate": "2022-01-01 10:41:17",
            "kycExpireDate": "2022-02-07 10:41:17"
        },
        "paytm": {
            "kycStatus": "rejected",
            "kycDate": "2022-07-10 16:00:40",
            "kycExpireDate": "NA"
        },
        "airtel": {
            "kycStatus": "active",
            "kycDate": "2022-05-20 12:10:33",
            "kycExpireDate": "2022-06-24 12:10:33"
        }
    }
}

SUCCESS - when optional param passed

{
    "code": "0x0200",
    "message": "Record fetched successfully.",
    "status": "SUCCESS", 
    "data": {
        "documents": {
            "kycStatus": "rejected",
            "kycDate": "2022-07-10 16:00:39",
            "remark": "Test KYC rejected."
        },
        "airtel": {
            "kycStatus": "active",
            "kycDate": "2022-05-24 12:10:33",
            "kycExpireDate": "2022-06-24 12:10:33"
        }
    }
}

FAILED

{
    "code": "0x0203",
    "status": "MISSING_PARAMETER",
    "message": {
        "merchantCode": [
            "This merchant code not valid."
        ]
    }
}

Response Code

Status Code	Status	Message
0x0200	SUCCESS	TRANSACTION SUCCESSFULL
0x0201	UNAUTHORIZED	UNAUTHORIZED USER
0x0202	FAILURE	FAILURE USER
0x0203	MISSING_PARAMETER	MISSING PARAMETER
0x0204	CONNECTION_TIMEOUT	CONNECTION TIMEOUT
0x0205	SOMETHING_WENT_WRONG	SOMETHING WENT WRONG
0x0206	PENDING	TRANSACTION PENDING
0x0208	2FA	TWO FACTOR AUNTHENTICATION