ITR Journey - Create Auth Link
Introduction
Creates a new ITR auth link journey. Generates a unique requestId, builds the auth link URL, and sends it to the user via email.Returns the requestId , authlink and message.
Pre-requisite
The Create ITR Auth Link API reads your client's config from a pre-configured client config. This config must exist and be complete before calling this API. Please reach out to the Signzy support team at [email protected] to get your config set up before proceeding.
Sample Curl
curl --location 'https://api.signzy.app/api/v3/underwriting/create-itr-authlink' \
--header 'Authorization: <Access-Token>' \
--header 'Content-Type: application/json' \
--data '{
"userName": "ABCDE1234F",
"emails": ["[email protected]"],
"confirmationEmails": ["[email protected]"]
}'Request Headers
PARAMETER NAME | Value | DESCRIPTION |
|---|---|---|
Content-Type | application/json | Content Type |
Authorization | shared by Signzy | Authorization token for the api |
Input Parameters
PARAMETER NAME | REQUIRED/OPTIONAL | DESCRIPTION |
|---|---|---|
userName | One of userName/panNumber required | End user's PAN in uppercase (e.g.ABCDE1234F) |
panNumber | One of userName/panNumber required | End user's PAN in uppercase (e.g.ABCDE1234F) |
emails | REQUIRED | 1–5 end-user email addresses to send the auth link |
confirmationEmails | REQUIRED | 1–5 emails to notify after successful auth |
mobileNumbers | OPTIONAL | 1–5 Indian mobile numbers |
consumerId | OPTIONAL | Consumer UUID. |
Sample Response
{
"result": {
"requestId": "550e8400-e29b-41d4-a716-446655440000",
"authLink": "https://app.signzy.com/itr-authlink/550e8400-e29b-41d4-a716-446655440000",
"message": "An ITR auth link journey has been initiated for user - ABCDE1234F"
}
}Response Parameter
PARAMETER NAME | DESCRIPTION |
|---|---|
requestId | Unique UUID |
authLink | Auth link for the journey |
message | Confirmation text returned on success |
Status Codes
HTTP | Description |
|---|---|
200 | Journey created |
400 | Invalid Payload |
404 | Client/ITR config not found for consumerId |
409 | Something went wrong |
Error Responses
HTTP | Reason | Sample Response |
|---|---|---|
400 | VALIDATION_ERROR | {"error":{"reason":"VALIDATION_ERROR","status":400,"message":"userName must be a valid PAN (e.g. ABCDE1234F)"type":"Bad Request","statusCode":400,"name":"error"}} |
404 | NOT_FOUND | {"error":{"reason":"NOT_FOUND","status":404,"message":"Client config not found for consumerId:","type":"Not Found","statusCode":404,"name":"error"}} |
409 | CONFLICT | {"error":{"reason":"CONFLICT","status":409,"message":"Something went wrong. Please try again.","type":"Conflict","statusCode":409,"name":"error"}} |