Menu

Track Verify Conversion or Verify Request Usage

Questions

How do I track my Verify spending?

Why do I have extra SMS costs on my account for Verify?

How can I view my Verify service usage?

Where can I see all my Verify charges?

 

Answer:

Verify charges consist of the Verify software fee, messaging fees, and call fees. However, currently the Customer Dashboard only reflects the deduction of the software fee, also known as the conversion fee associated with the product. The cost of messaging (SMS) and calls (text-to-speech or TTS) associated with Verify does not currently appear in the statistics exposed in your Customer Dashboard. Therefore, using the Customer Dashboard only gives you a partial view of your true Verify usage.

The easiest way to track all Verify usage is by making full use of the programmatic features made available via the API. Both the Verify Check and Verify Search actions will give you insight into the fees associated with Verify.

Verify Check

When you conduct a Verify Check, the API will deliver back the software fee (aka the conversion fee) or "price" as well as the sum of the messaging and calls associated with the verification attempt known as "estimated_price_messages_sent".

{
"request_id""ec1exxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"status""0",
"event_id""21c1ec53-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"price""0.05000000",
"currency""EUR",
"estimated_price_messages_sent""0.01403167"
}

(NB - the term "estimated" in "estimated_price_messages_sent" is used because it is an estimate depending on the time when you submit your Verify Check. There could be messages and/or calls in flight that may have not been recorded yet)

Verify Search

You can also use the Verify Search action to retrieve details about your verification attempt while in process or after the verification attempt has completed. This action gives you more analytics around your verification attempt but the data fields relevant to tracking Verify usage are still the same as described above.

"Price" reflects the software fee (aka the conversion fee) and "estimated_price_messages_sent"  is the sum of the messaging and calls associated with the verification attempt. Both numerical values are in Euros.

{
"request_id""ec1exxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"account_id""xxxxxxxxx",
"number""1415xxxxxxx",
"sender_id""verify",
"date_submitted""2019-10-28 18:44:03",
"date_finalized""2019-10-28 18:49:14",
"checks": [
{
"date_received""2019-10-28 18:49:14",
"code""xxxx",
"status""VALID",
"ip_address"""
}
],
"first_event_date""2019-10-28 18:44:03",
"last_event_date""2019-10-28 18:48:11",
"price""0.05000000",
"currency""EUR",
"status""SUCCESS",
"estimated_price_messages_sent""0.01403167",
"events": [
{
"id""1500xxxxxxxxxxxx",
"type""sms"
},
{
"id""1b01c676-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"type""tts"
},
{
"id""21c1ec53-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"type""tts"
}
]
}

Reports API

The Reports API can be used for invoice reconciliation on a monthly basis (NB: The Reports API is free for the first 10 successful API calls. Customers who require more than 10 API requests can sign-up for paid access). The recommended process for tracking your Verify usage using the Reports API incorporates the Verify Search action mentioned above.

Using the Verify Search action, under "events", the SMS and TTS "id" on behalf of Verify are returned back to you via the API. Be sure to programmatically save these IDs as well as corresponding Verify request_id from each request so that you can cross-reference SMS and call IDs that are related to each Verify request_id:

"events": [
{
"id""1500xxxxxxxxxxxx",
"type""sms"
},
{
"id""1b01c676-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"type""tts"
},
{
"id""21c1ec53-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"type""tts"
}
]

These SMS and TTS ids are the message_id and the call_id, respectively, in the SMS and VOICE-CALL reports from the Reports API. You can then cross reference the SMS and TTS related to each Verify request_id.

Please find below CSV file preview for SMS report returned via the Reports API:

Please find below CSV file preview for VOICE-CALL report returned via the Reports API:

 

Was this article helpful?
0 out of 0 found this helpful
Follow
Have more questions? Submit a request