Skip to main content
POST
/
abdm
/
v1
/
profile
/
kyc
/
init
cURL
curl --request POST \
  --url https://api.eka.care/abdm/v1/profile/kyc/init \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "identifier": "<string>",
  "method": "abha-number",
  "user_x_token": "<string>"
}
'
{
  "txn_id": "<string>"
}

Authorizations

​
Authorization
string
header
required

The API requires a Bearer token (JWT) for authentication.

Headers

​
X-Pt-Id
string

Eka User ID (OID)

​
X-Partner-Pt-Id
string

Partner User ID

​
X-Hip-Id
string

Partner HIP ID

Query Parameters

​
oid
string

OID is used to Identify the user.

Body

application/json
​
identifier
string
required

The identifier, which will be the 14-digit ABHA number for the 'abha-number' method or the 12-digit Aadhaar number for the 'aadhaar' method.

​
method
enum<string>
required

The method used for KYC, such as ABHA number or Aadhaar.

Available options:
abha-number,
aadhaar
​
user_x_token
string

user authorization token

Response

OK

​
txn_id
string

Transaction ID required for the next API call.