Check Instant Link Status

10 min

Introduction

This is also called as "Poll Check API". This is used to determine if the user has clicked on the link that was sent to them via SMS. This API allows you to periodically check the status of the user's verification process. If the link has been clicked, the API will return a successful response, indicating that the user can proceed with the Trust Score API and the PII Data API.

To initiate a poll check, you need to include the requestId and sessionId as parameters in the URL path. The format of the URL should be as follows: /request/{requestId}/session/{sessionId}.

The Poll Check API should be called at regular intervals, such as every 10 seconds, within a 10-minute window after the Send Instant Link API has been called. After this 10-minute period, the SMS link will become invalid, and further attempts to poll will not yield any results.

It is important to note that the requestId and sessionId parameters are obtained from the response of the Send Instant Link API. Make sure to retrieve and use the correct values associated with the specific user verification session.

Please ensure that your implementation includes the necessary logic to handle the API response appropriately, allowing you to proceed with the subsequent Trust Score API and PII Data API calls once the link has been clicked by the user.

Remember to adhere to the recommended polling frequency and time window to maintain the verification process's efficiency and accuracy.

If the API returns a successful response, you can proceed with the Trust Score API and the PII Data API to further evaluate the user's trustworthiness and retrieve their personally identifiable information (PII) for KYC purposes.

Please refer to the following sections of this documentation for details on how to utilize the Trust Score API and the PII Data API.

API Input Guidelines

Need to pass the following information. "requestId" and "sessionId" are generated from Instant link generation API.

requestId
sessionId

Sample cURL

Production

curl --location 'https://api-preproduction.signzy.app/api/v3/us-kyc/poll-check-verify/request/:requestId/session/:sessionId' \
--header 'Content-Type: application/json' \
--header 'Authorization: <Auth Token>'

Input Parameters

Key	Type	Mandatory	Description
requestId	string	true	Unique identifier associated with this request. Must be unique for each transaction.
sessionId	string	true	Unique identifier associated with session of this request. Must be unique for each transaction.

Output parameters

Key	Type	Description
TransactionId	string	Unique transaction identifier used to identify the results of the request.
LineType	string	Line type associated with the phone number. Possible values are: Mobile, Landline, FixedVoIP, NonFixedVoIP.
PhoneNumber	string	The phone number of the originating phone
Carrier	string	The carrier related to the phone number.
CountryCode	string	The country code associated with the phone number.
LinkClicked	boolean	Boolean informing of whether the Instant Link was clicked before it expired (5-minute limit).
PhoneMatch	string	Indicates if, after the link was clicked and carrier authentication successfully performed, the link was clicked on by the intended mobile device. Possible results: true, false, indeterminate
IpAddressMatch	boolean	Boolean indicating if the IP address of the reqeust matches the IP address of the original link generation request

Sample Response

{
  "result": {
    "TransactionId": "12225083692",
    "Carrier": "T-Mobile USA",
    "LineType": "Mobile",
    "CountryCode": "US",
    "LinkClicked": true,
    "PhoneMatch": "indeterminate",
    "SessionId": "646214d929c23b4d42c1fc39",
    "_id": "6462150e29c23b4d42352a63"
  }
}

Sample Error

{
    "error": {
        "name": "error",
        "message": "..message..",
        "status": 400,
        "reason": "BadRequest",
        "type": "OK",
        "statusCode": 200
    }
}

Response Parameter

PARAMETER NAME	DESCRIPTION
error	This parameter contains the error.
error.name	the name of the error
error.message	the error message
error.status	status of the api
error.reason	Reason for error
error.type	Type of the error
error.statusCode	Request Status code from Signzy

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].