Verify Account

9 min

Introduction

You can get the Digilocker ID from a mobile number or Aadhaar number using Verify Account API. This API takes in aadhaar number/ mobile number as an input and if digilocker is registered with any of those, it returns the digilockerid as response .

How to call the API

You will need to log in before sending the request. You are required to pass the access token received from the login call, as the authorization header in the request.

API Input Guidelines

NOTE: Either mobileNumber or aadhaarNumber parameter is compulsory. Only one parameter must be sent.

Sample Curl

Preproduction

Production

curl --location --request POST 'https://api-preproduction.signzy.app/api/v3/digilocker/verifyAccount' \
--header 'Authorization: <auth-token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "aadhaarNumber" : "<Aadhaar Number>"
}'

curl --location --request POST 'https://api.signzy.app/api/v3/digilocker/verifyAccount' \
--header 'Authorization: <auth-token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "aadhaarNumber" : "<Aadhaar Number>"
}'

Input Parameters

PARAMETERS	DESCRIPTION	TYPE	VALUE
mobileNumber	Mobile Number	String	conditionally COMPULSORY
aadhaarNumber	Aadhaar Number	String	conditionally COMPULSORY

Sample Response

{
    "result": {
        "registered": true/false,
        "digilockerid": "..digilockerid.."                          
    }
}

Response Parameter

PARAMETERS	DESCRIPTION	TYPE	VALUE
registered	Provides information whether Mobile number or Aadhaar number is available with Digilocker	Boolean	true/false
digilockerid	Digilocker Id	String	Alpha numeric value(xxxxxxx-xxxxx-xxxxxx-......)

Sample Error

{
    "message": "No API key found in request"
}

Error Parameter

PARAMETER NAME	DESCRIPTION
error	This parameter contains the error.
error.name	the name of the error
error.message	the error message
error.status	status of the api
error.statusCode	Request Status code from Signzy
error.reason	Reason for error
error.type	Type of the error

Error Codes

CODE	DESCRIPTION
400	Invalid inputs
401	Authorization Token is invalid
409	If Upstream service not reachable

Getting help

Please feel free to contact us if you have any questions, require clarification, or have ideas for how to make the documents or any of our services better.

You can reach out to us at [email protected].