VKYC Auth Token API

This API generates the authentication token required by the Customer Session Creation API and the Status Check API. Send the returned token as a bearer token in the Authorization header of those requests.

POSThttps://sandbox/api/v1/vkyc/auth/token/

Content-Type: application/json

Request headers

Header	Type	Required	Description
merchantcode	string	Yes	Unique merchant identifier issued during onboarding.
merchantname	string	Yes	Name of the merchant.
key	string	Yes	JWT-based authentication key.

Example

POST/api/v1/vkyc/auth/token/

curl --location --request POST 'https://sandbox/api/v1/vkyc/auth/token/' --header 'merchantcode: SCOREME' --header 'merchantname: SCOREME' --header 'key: <JWT_KEY>'

200

{
"status": true,
"status_code": 200,
"message": "Success",
"data": {
  "message": "Token generated successfully",
  "data": "<ACCESS_TOKEN>"
}
}

Response

Field	Type	Description
status	boolean	true when the token was generated successfully.
status_code	integer	HTTP status code echoed in the body.
message	string	Human-readable outcome of the request.
data.message	string	Description of the token operation.
data.data	string	The access token to send as Authorization: Bearer <access_token>.

Using the token

POST /api/v1/vkyc/create/customer/ HTTP/1.1
Host: sandbox
Content-Type: application/json
Authorization: Bearer <access_token>