Sub-Account KYC

DigiLocker verify

Finalize Aadhaar via DigiLocker after the customer completes OAuth.

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

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/verify/post.ts
A function with typed inputs. Its response is checked against the schema.

sub_auth_idstring required

Example:SA_XXXXXX

The sub-account's Auth ID.

access_request_idstring required

linked_numberstring

Optional. Binds the Aadhaar to a specific number (92-series).

{
  "access_request_id": "AR_xxxxxxxx",
  "linked_number": "+91XXXXXXXXXX"
}

Verification result

verification_type'pan' | 'gst' | 'cin' | 'aadhaar' required

status'verified' | 'failed' | 'pending' required

kyc_calls_blockedboolean

Recomputed sub-account call-blocking state after this verification.

mockboolean

Present and true on responses from the test-mode endpoints.

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