ABHA creation, driving licence or PAN

Create an ABHA from an identity document

The route for somebody who cannot complete Aadhaar authentication. A driving licence is one accepted document. The account created this way is restricted until it is upgraded through Aadhaar KYC, so tell the person that rather than letting them discover it later.

Optional

Certification cases CRT_ABHA_401, CRT_ABHA_402, CRT_ABHA_403, CRT_ABHA_404, CRT_ABHA_405, CRT_ABHA_406, CRT_ABHA_407, CRT_ABHA_408, CRT_ABHA_410, CRT_ABHA_411

POST/v3/enrollment/enrol/byDocument

Authorizations

Authorizationbearer tokenRequired

The accessToken from POST /api/hiecm/gateway/v3/sessions. Send it as Authorization: Bearer <ACCESS_TOKEN>.

Headers

REQUEST-IDstringRequired

Unique UUID v4 per request. Used for idempotency and distributed tracing. Generate a fresh UUID for every call.

TIMESTAMPstringRequired

ISO 8601 UTC timestamp of the request.

Body

txnIdstringRequired

documentTypestringRequired

documentIdstringRequired

firstNamestringRequired

middleNamestringRequired

lastNamestringRequired

dobstringRequired

genderstringRequired

frontSidePhotostringRequired

backSidePhotostringRequired

addressstringRequired

statestringRequired

districtstringRequired

pinCodestringRequired

consentobjectRequired

consent.codestringRequired

consent.versionstringRequired

Responses

200

The specification does not describe this body. Send the call with Try it to see what comes back.

400

Bad Request, invalid scope, loginHint, or encrypted field

Error codes for this module

401

Unauthorized, missing, invalid, or expired Bearer token

Everything returns 401

403

Forbidden, the token is valid but not permitted for this operation

Error codes for this module

422

Unprocessable, the request parsed but failed validation

Error codes for this module

500

Server error, retry

Error codes for this module

Create an ABHA from an identity document

curl --request POST \
  --url https://abhasbx.abdm.gov.in/abha/api/v3/enrollment/enrol/byDocument \
  --header 'Authorization: Bearer <ACCESS_TOKEN_FROM_SESSIONS_CALL>' \
  --header 'REQUEST-ID: <REQUEST_ID>' \
  --header 'TIMESTAMP: <TIMESTAMP>' \
  --header 'Content-Type: application/json' \
  --data '{
  "txnId": "<TXN_ID>",
  "documentType": "DRIVING_LICENCE",
  "documentId": "DL0820****858",
  "firstName": "<FIRST_NAME>",
  "middleName": "<MIDDLE_NAME>",
  "lastName": "<LAST_NAME>",
  "dob": "<DATE_OF_BIRTH>",
  "gender": "M",
  "frontSidePhoto": "<ENCRYPTED_VALUE>",
  "backSidePhoto": "<ENCRYPTED_VALUE>",
  "address": "<ADDRESS>",
  "state": "<STATE>",
  "district": "<DISTRICT>",
  "pinCode": "<PIN_CODE>",
  "consent": {
    "code": "abha-enrollment",
    "version": "1.4"
  }
}'

The specification does not describe this body. Send the call with Try it to see what comes back.