Digilocker 2.0 Get Apaar

Introduction

Get Apaar API is specifically tailored to accept a request ID, which is generated by our Create URL API. Upon receiving this request ID, the API retrieves the Apaar id details once the consent is given.

API details

Endpoint

POST https://api.signzy.app/api/v3/digilocker-v2/getApaar

POST https://api-preproduction.signzy.app/api/v3/digilocker-v2/getApaar

Request headers

Name	Value	Required	Description
Content-Type	application/json	Mandatory	The type of content that the request body contains.
Authorization	XXXXXXXXXXXXXXX	Mandatory	An authentication token to authorize the request. Reach out to the Signzy support team to get one created.

Request body parameters

Parameter	Data Type	Description	Required
requestId	String	Unique ID allocated after the authorization in digilocker iframe. This is returned as requestId in Create URL API.	Mandatory

{
    "requestId": "65797035c4f51c00108aec41"
}

Code samples

curl --location 'https://api.signzy.app/api/v3/digilocker-v2/getApaar' \
--header 'Authorization: <Your access token>' \
--header 'Content-Type: application/json' \
--data '{
    "requestId": "65797035c4f51c00108aec41"
}'

Response body parameters

Parameter	Data Type	Description
result	Object	Contains the result of the task being performed.
result.apaarID	Strings	Contains the the Apaar Number
resuly.studentDetails	String	Contains the list of data for which the end customer has given consent.

{
    "error": {
        "reason": "NOT_FOUND",
        "status": 404,
        "message": "RequestID not Found",
        "type": "Not Found",
        "statusCode": 404,
        "name": "error"
    }
}

Contact Us for Any Assistance

If you have any questions or need assistance, please reach out to our customer support team. You can contact us via email at [email protected]. We strive to provide prompt and reliable assistance, ensuring your queries are addressed effectively.

We value your feedback and are committed to making your experience smooth and enjoyable. Our team is dedicated to assisting you with any needs you may have. Thank you for choosing our services. We look forward to helping you!