Skip to main content

Face auth - capture PID / track status

Endpoint: POST /abha/api/v3/enrollment/enrol/capturePID

POST/abha/api/v3/enrollment/enrol/capturePID

Flow: Login - Face Auth QR (v3.1) - step 2 of 3

  • Previous: Face auth - generate transaction ID (init)
  • Next: Login via Face Auth (QR) - verify

Note: The original description below says the next step is ABHA enrolment. In this flow the next step is the verify API named above.

This API is designed to verify the status of a transaction ID that was generated during the invocation of the auth/init API. It serves as a follow-up mechanism to ensure that the transaction is still valid, active, and has not expired or been invalidated.

Wait for PID capture and submission confirmation from the ABHA App. The response of the API will return status of that transactionId. It can be either PENDING,VERIFIED,FAILED,COMPLETE.

Once the status in the response of this API is returned as COMPLETE, it indicates that the face authentication process has been successfully completed. At this stage, the next step is to invoke the /enrollment/enrol/byAadhaar (You can find this API in ABHA ENROLLMENT Via Aadhaar section) API to proceed further.

User can poll the /capturePID API in every 5 - 10 seconds interval to check the status of face capture process or alternatively skip this step and call the /enrollment/enrol/byAadhaar API once they see the PID submission success message in the ABHA app.

Authorizations

Authorizationbearer tokenRequired

The access token from POST /api/hiecm/gateway/v3/sessions, sent with a Bearer prefix.

Headers

REQUEST-IDstringRequired

Unique UUID for every request.

TIMESTAMPstringRequired

Current UTC timestamp in ISO-8601 format.

Body

scopestring[]Required

The scopes of the request, which name the flow this call belongs to.

txnIdstringRequired

The transaction ID returned by the previous call in this flow.

Responses

200

The 200 response code indicates a successful request. The reponse of the API will return status of that transactionId. It can be either PENDING,VERIFIED,FAILED,COMPLETE.

statusstring
messagestring
400

The 400 response code indicates a bad request.

Error codes for this module

errorobject
error.codestring
error.messagestring
401

The 401 response code indicates an unauthorized request. In this context, it refers to the lack of proper authentication during the operation of the Invalid Credentials

Everything returns 401

codestring
messagestring
descriptionstring
500

Internal Server Error

An Internal Server Error (500) indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.

Error codes for this module