DigiLocker initiate

Returns the DigiLocker authorization link and an access_request_id. The customer completes the OAuth flow on the DigiLocker portal, after which you finalize with DigiLocker verify.

post/api/v1/sub-accounts/{sub_auth_id}/kyc/digilocker/initiate

Request

Base URL
https://api.vobiz.ai
Auth
API key in header X-Auth-ID and API key in header X-Auth-Token
TypeScript
https://skmtc.dev/vobiz/apis/vobiz-api/docs/api/v1/sub-accounts/:sub_auth_id/kyc/digilocker/initiate/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

sub_auth_idstring required

Example:SA_XXXXXX

The sub-account's Auth ID.

Request body

redirect_urlstring uri required

oauth_statestring

Opaque value echoed back on the redirect for CSRF protection.

Example request

{
  "redirect_url": "https://partner.example.com/kyc/callback",
  "oauth_state": "opaque-state-xyz"
}

Response

DigiLocker authorization link

Changes

No recorded changes to this operation across all 1 revision of this API.