Send Instant Link

7 min

Introduction

This API generates an instant link that serves as a verification mechanism for the user. The generated link is sent to the mobile number provided by the merchant via an SMS. When the merchant receives the SMS and clicks on the link, they will be redirected to the target URL provided by your financial institution.

How to call the API

You must first log in before sending the request. The authorization header in the request must include the access token obtained from the login API call.

API Input Guidelines

Need to pass the following information as mandatory fields -

Phone Number
Target URL

Sample cURL

Production

Pre-Production

curl --location 'https://api.signzy.app/api/v3/us-kyc/send-instant-link' \
--header 'Content-Type: application/json' \
--header 'Authorization: <Auth Token>' \
--data '{
  "targetUrl": "https://www.google.com",
  "mobileNumber": "2001001686"
}'

curl --location 'https://api-preproduction.signzy.app/api/v3/us-kyc/send-instant-link' \
--header 'Content-Type: application/json' \
--header 'Authorization: <Auth Token>' \
--data '{
  "targetUrl": "https://www.google.com",
  "mobileNumber": "2001001686"
}'

Input Parameters

Key	Type	Mandatory	Description
targetUrl	string	true	The URL of the client server that will be called back by the phone, providing the VFP for the result call
mobileNumber	string	true	The mobile number of the user who will receive the SMS.
sourceIp	string	false	The IP address of the device the request initiates from. This adds an additional fraud detection indicator, as Signzy can use this value to complete an IP comparison with the IP of the device that actually clicks the link sent.
customSms	string	false	The optional custom SMS message to be prefixed with the URL.

Response Parameter

Key	Type	Description
requestId	string	The unique identifier for the request.
sessionId	string	The session ID associated with the request.

Sample Response

{
    "result": {
        "requestID": "f64d44f8-3b0c-449c-8b79-9e2bbe0b2f3b",
        "sessionId": "f64d44f8-3b0c-449c-8b79-9e2bbe0b2f3b"
    }

}

Getting help

Please feel free to contact us if you have any questions, require clarification, or have ideas for how to make the documents or any of our services better.

You can reach out to us at [email protected].