Check the status of the transaction ID
Verify the status of a transaction ID that was generated during the invocation of the <code>auth/init</code> API.
It serves as a follow-up mechanism to ensure that the transaction is still valid, active, and has not expired or been invalidated.
<br> <br> 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 <strong>PENDING,VERIFIED,FAILED,COMPLETE.</strong> <br> <br> Once the status in the response of this API is returned as <strong> COMPLETE </strong>, it indicates that the face authentication process has been successfully completed. At this stage, the next step is to invoke the <code>/enrollment/enrol/byAadhaar</code> (You can find this API in ABHA ENROLLMENT Via Aadhaar section) API to proceed further. <br><br>User can poll the <code>/capturePID</code> API in every 5 - 10 seconds interval to check the status of face capture process or alternatively skip this step and call the <code>/enrollment/enrol/byAadhaar</code> API once they see the PID submission success message in the ABHA app. The 200 response code indicates a successful request. The reponse of the API will return status of that transactionId. It can be either <strong>PENDING,VERIFIED,FAILED,COMPLETE. </strong> 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 <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.Authorizations
Authorizationbearer tokenRequiredHeaders
REQUEST-IDstringRequiredTIMESTAMPstringRequiredBody
scopestring[]RequiredtxnIdstringRequiredResponses
200401500