Voice Verify - Get transaction status

This page explains how to use the Verify API to retrieve the processing status of a Telesign Voice Verify 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 request.

Try it

  1. Click the Auth [basic] tab.
  2. In the Username field, enter your Customer ID.
  3. In the Password field, enter your API key.
  4. Click the Variables tab.
  5. In the reference_id field, enter the reference ID for the Voice Verify transaction you want to retrieve status for.
  6. Click Send.
  7. If you want the code for your request, click the Code Generation tab and use the Language and Library drop-downs to choose the language you want your code snippet in. The Language drop-down shows you what languages you can generate code in, and the Library drop-down shows you what libraries you could use to create the code.

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 that same 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" : ""
   }
}

Did this page help you?