API Reference

Initiate DigiLocker session

post
https://prod.idto.ai/verify/digilocker/initiate_session

Initiates a DigiLocker session for the user. Requires user consent and redirect information. Accepts a JSON body with consent (bool), consent_purpose (string), redirect_url (string), redirect_to_signup (bool, optional), documents_for_consent (array, optional) and state (string, optional).

HTTP StatusCodeReasonMessageMerchant Action
2001000AUTH_URL_GENERATEDAuthorization URL generated.Redirect user to URL.
4003001INVALID_DOC_CODEOne or more documents_for_consent invalid.Pass correct document codes from master list.
4003002MISSING_REDIRECT_URLredirect_url missing.Pass valid redirect URL.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
boolean
required
string
required
uri
required
boolean
documents_for_consent
array of strings
documents_for_consent
string | null

Optional opaque value that will be returned as the state query parameter on the redirect URL.

Response

Updated 4 months ago

Did this page help you?
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?