v1

latestOpenAPI 3.0.3The MIT License (MIT)2026-07-1462239.9 KB

Verify Search

Use Verify search to check the status of past or current verification requests:

  1. Send a Verify search request containing the request_ids of the verification requests you are interested in.
  2. Use the status of each verification request in the checks array of the response object to determine the outcome.

Note that this endpoint is available by POST request as well as GET.

get/search/{format}

Path parameters

format'json' | 'xml' required

The response format.

Query parameters

api_keystring required

You can find your API key in your account dashboard

Example:abcd1234
api_secretstring required

You can find your API secret in your account dashboard

Example:Sup3rS3cr3t!!
request_idstring required

The request_id you received in the Verify Request Response. Required if request_ids not provided.

request_idsstring[]

More than one request_id. Each request_id is a new parameter in the Verify Search request. Required if request_id not provided.

[
  "abcdef0123456789abcdef0123456789"
]

Response

OK

OR

Example response

{
  "account_id": "abcdef01",
  "checks": [
    {
      "code": "987654",
      "date_received": "2020-01-01 12:00:00",
      "ip_address": "123.0.0.255"
    }
  ],
  "currency": "EUR",
  "date_finalized": "2020-01-01 12:00:00",
  "date_submitted": "2020-01-01 12:00:00",
  "estimated_price_messages_sent": "0.03330000",
  "first_event_date": "2020-01-01 12:00:00",
  "last_event_date": "2020-01-01 12:00:00",
  "number": "447700900000",
  "price": "0.10000000",
  "request_id": "abcdef0123456789abcdef0123456789",
  "sender_id": "mySenderId",
  "status": "IN PROGRESS"
}