Skip to main content

Enrol auth init

Help to generate transaction ID. This transaction ID will be used for whole face authentication process.

POST/abha/api/v3/enrollment/enrol/auth/init

<br><br> The user can submit this transaction ID to the <strong>ABHA</strong> app using either intent-based sharing or by generating a QR code. <br><br>User can use this transaction ID to generate QR code using any QR generator tool. Open ABHA app and scan this QR code on ABHA App to start and complete the face capture process.<br><br>The data format of the QR code should follow this pattern: <br>https://<PHR-env-base-URL>/face-auth?txnId=<txn-ID-from-the-response-of-init-API>. <br><br><strong>For example:</strong> https://phrsbx.ABDM.gov.in/face-auth?txnId=bac7251b-cd25-44d5-9707-f3d2ba181c1c <br><br> For Sandbox- PHR-env-base-URL - https://phrsbx.ABDM.gov.in<br> For Production - PHR-env-base-URL - https://phr.ABDM.gov.in

Authorizations

Authorizationbearer tokenRequired

Headers

REQUEST-IDstringRequired
TIMESTAMPstringRequired

Body

scopestring[]Required

Responses

200

The 200 response code indicates a successful request. In this context, it refers to the successful generation of Transaction Id.

400

The 400 response code indicates a bad request.

Error codes for this module

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

500

<b>Internal Server Error</b><br><br> 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