Skip to main content

ABHA creation, Aadhaar biometric

Submit a captured biometric or face authentication block

Hands over the PID block produced by the Aadhaar RD service. The block is encrypted by the device and is time limited, so send it as soon as the capture returns rather than storing it.

POST/v3/enrollment/enrol/capturePID

This is a polling loop. All three states come back as HTTP 200, so branch on status and not on the status code. PENDING and VERIFIED both mean the capture has not landed yet and carry the same message, Awaiting PID capture. Only COMPLETE carries the txnId you take into the next call. Keep polling until you see it.

One caveat about where these came from. NHA saved the COMPLETE example against enrollment/enrol/capturePID, and saved the PENDING and VERIFIED examples against enrollment/enrol/internal/capturePID, a path that appears nowhere else in the collection and that NHA's M1 document never mentions. Whether the two paths are one endpoint is unresolved here.

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

scopestring[]Required
txnIdstringRequired

Responses

200

The capture status, a message, and the transaction id.

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

500

Server error, retry

Error codes for this module

Last updated on