Sign in

v1

latestOpenAPI 3.0.32026-07-26229361630.0 KB

Request otp to initialise the KYC flow

post/abdm/v1/profile/kyc/init

Query parameters

oidstring

OID is used to Identify the user.

OID is used to Identify the user.

Headers

X-Pt-Idstring

Eka User ID (OID)

X-Partner-Pt-Idstring

Partner User ID

X-Hip-Idstring

Partner HIP ID

Request body

identifierstring 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'abha-number' | 'aadhaar' required

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

user_x_tokenstring

user authorization token

Response

OK

txn_idstring

Transaction ID required for the next API call.