Voice Verify API - Get transaction status

📘

NOTE:

To add this product to your account, contact a Telesign expert. This product is available for full-service accounts only.

This page explains how to retrieve the processing status of a Telesign Voice Verify API transaction. You can use this method to retrieve the status of a transaction for up to 12 hours after you send your request. Telesign recommends that you wait 3-5 minutes after a transaction occurs before querying the API to request status.

The fastest way to get started is to use the Try It widget on the GET /v1/verify/{reference_id} reference page. You need to enter a reference ID from the HTTP response to a Voice Verify API request.

Before you begin

Ensure that you have the following:

• Authentication credentials: Your Customer ID and API Key. If you need help finding these items, go to the support article How do I find my Customer ID and API Key.

Try it

🚧

CAUTION:

Using your account credentials in the API Explorer to make a request results in your account being charged for the transaction.

You are subject to all compliance rules as appropriate for your transaction.

1. Open the reference page for the GET /v1/verify/{reference_id} endpoint.
2. Under the AUTHENTICATION header in the right panel of the page, put your Customer ID in the Customer ID field and your API key in the API Key field.
3. Go to the PATH PARAMS section in the middle panel of the page. For reference_id, enter the reference ID for the Voice Verify API transaction you want to retrieve status for.
4. Select Try It! in the right panel to send your request to Telesign. You will be charged the standard rate for this transaction.
5. You can also select the copy icon to the left of Try It! to copy the code snippet displayed. To change the programming language of the snippet, select one of the options under the LANGUAGE header in the right sidebar.

Congratulations! You’ve retrieved status information about a transaction and generated a code snippet.

You can see more about available parameters for requests as well as response information on the GET /v1/verify/{reference_id} reference page.

Example

Request

GET https://rest-ww.telesign.com/v1/verify/0123456789ABCDEF0123456789ABCDEF HTTP/1.1
Authorization: Basic 12345678-9ABC-DEF0-1234-56789ABCDEF0:Uak4fcLTTH/Tv8c/Q6QMwl5t4ck=
Host: rest-ww.telesign.com

Response

HTTP/1.1 200 OK
Content-Type: application/json
{
   "reference_id" : "ABCDEF0123456789ABCDEF0123456789",
   "sub_resource" : "call",
   "errors": [],
   "status" : {
      "updated_on" : "2015-04-17T22:26:43.784963Z",
      "code" : 100,
      "description" : "Call answered"
   },
   "verify" : {
      "code_state" : "UNKNOWN",
      "code_entered" : ""
   }
}