Email Magic Link
Overview
The Email Link Verification API enables client applications to verify ownership of a customer's email address using a secure verification link (magic link) instead of an OTP.
Unlike the existing OTP-based verification flow, where a Relationship Manager (RM) must contact the customer to obtain the OTP, this solution allows the customer to verify their email independently by simply opening the verification link received in their inbox.
The service exposes two APIs:
- Send Verification Link API – Initiates an email verification request and sends a secure verification link to the customer's email address.
- Verification Status API – Allows the client application to check whether the customer has completed email verification.
API 1 – Send Verification Link
Purpose
This API initiates an email verification request for a customer.
When invoked, the API validates the request, creates a unique verification session, generates a secure verification link, and sends it to the customer's registered email address.
The API does not verify the email immediately. Instead, it confirms that the verification process has been successfully initiated.
The generated requestId uniquely identifies the verification session and should be used to track the verification status using the Verification Status API.
API 2 – Verification Status
Purpose
This API allows client applications to retrieve the current status of an email verification request.
After the verification email has been sent, the client can periodically call this API using the requestId received from the Send Verification Link API.
The API returns whether the customer has completed email verification by opening the secure verification link.
API 1 – Send Verification Link
Request Body
Request Parameters
Field | Type | Mandatory | Description |
|---|---|---|---|
String | Yes | Email address to which the verification link will be sent. |
Success Response
{
"result": {
"requestId": "6a4b94aeb4d15f026075eb8c"
},
"reason": "Verification email request triggered successfully",
"code": "S001"
}
Response Parameters
Field | Type | Description |
|---|---|---|
result.requestId | String | Unique identifier generated for the email verification request. This ID should be used to check the verification status. |
reason | String | Human-readable message indicating the outcome of the request. |
code | String | Response code indicating the status of the API request. S001 indicates that the verification email was successfully triggered. |
API 2 – Check Verification Status
Request Body
{
"requestId": "6a4b94aeb4d15f026075eb8c"
}
Request Parameters
Field | Type | Mandatory | Description |
|---|---|---|---|
requestId | String | Yes | Unique request identifier received from the Send Verification Link API. |
Success Response
{
"result": {
"status": "pending"
},
"reason": "Request Successful",
"code": "S001"
}
Response Parameters
Field | Type | Description |
|---|---|---|
result.status | String | Current status of the email verification request. Possible values are pending or completed. |
reason | String | Human-readable message indicating the outcome of the request. |
code | String | Response code indicating the status of the API request. S001 indicates the request was processed successfully. |