Generate KYC URL
The generate KYC URL API allows the API user to provide the link for the remitter to complete their eKYC for International Remittance
get/v1/client/onboarding/digilocker/url/{accountId}
Request
- Base URLhttps://uatclientapi-v2.stockal.com/client/v2
- Authnone required
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
accountIdstring required
"UserAccountId" for the Remitter, as generated at Create Entity API call, for remitter creation.
Headers
api-keystring required
API Key
auth-keystring required
The Auth key as received from Generate Auth Key API
userIdstring required
User Id as generated via the "Create Account (sign-Up) API". Identifier of an individual user, you can map this to the User identification at your end.
Response
200
Example response
{
"status": 200,
"message": "Success",
"data": {
"url": "https://api.digitallocker.gov.in/public/oauth2/1/authorize?client_id=E8FAB4A0&code_challenge=SJ9CB467wnnMSksay_l0I6Ax_MUdQRwdXcdwFzau0b4&code_challenge_method=S256&dl_flow&pla&redirect_uri=https%3A%2F%2Fdigilocker.signzy.tech%2Fdigilocker-auth-complete&response_type=code&state=65f9748973e07d0012f714dd",
"urlExpiryTs": "2024-03-19 17:18:33"
}
}Changes
No recorded changes to this operation across all 1 revision of this API.