Skip to main content
POST
/
kyc
/
digilocker
/
user
/
verify
curl --request POST \
  --url https://api.sandbox.co.in/kyc/digilocker/user/verify \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "@entity": "in.co.sandbox.kyc.digilocker.user.verification.request",
  "mobile": "9876543210"
}
'
{
  "code": 200,
  "timestamp": 1751975600361,
  "data": {
    "@entity": "in.co.sandbox.kyc.digilocker.user.verification.response",
    "user_exists": true
  },
  "transaction_id": "a11c4e00-fae1-4092-a55f-b4f0be92ffeb"
}
https://mintcdn.com/sandboxfinancialtechnologiesprivatelimited/gviqebbpT5NUt_6i/static/svg/Postman.svg?fit=max&auto=format&n=gviqebbpT5NUt_6i&q=85&s=da47f2b7e10d87befec951aed9468de3

Run in Postman

At least one of the fields aadhaar_number or mobile must be provided in the request.

Headers

ā€‹
Authorization
string
required

JWT access token. For token-generation steps, refer to the Quickstart Guide.

ā€‹
x-api-key
string
required

API key used to identify and authenticate the client.

ā€‹
x-api-version
string

Specifies the API version for the request.

Body

application/json

Request payload for Digilocker user verification. At least one of the fields 'aadhaar_number' or 'mobile' must be provided.

ā€‹
@entity
enum<string>
required

Entity identifier that specifies the type of request being made.

Available options:
in.co.sandbox.kyc.digilocker.user.verification.request
ā€‹
aadhaar_number
string
required

12-digit Aadhaar number without spaces or separators.

Pattern: ^[0-9]{12}$
ā€‹
mobile
string

10-digit Indian mobile number without country code.

Pattern: ^[0-9]{10}$

Response

200 - application/json
ā€‹
code
integer
required

HTTP status code.

ā€‹
timestamp
integer
required

Unix timestamp (in milliseconds) indicating when the server generated the response.

ā€‹
data
object
required

Response payload containing the requested data or error details.

ā€‹
transaction_id
string
required

Unique identifier for tracking the request across systems.