Trust

  1. Home
  2. API Library
  3. Trust
Trust is the best solution to prevent malicious actions on your platform through APIs.

Verify the validity of your customers' and users' information in seconds: from mobile number to email and personal data.

All the knowledge you need

Here you can find some advice to consider to approach this API. If you prefer, we provide code samples, OAS3 documentation, the ability to try the API live via the Swagger UI or import the entire collection into Postman. We also offer a Sandbox environment where you can experiment with all kinds of requests completely free of charge.

Useful tips to start with Trust

Get the token in the appropriate section before you start.

Use the the online tool or generate it via API. Set the expire date, a usefull name and now add a bunch of scopes to limit the possible actions your token can do.
Read more on oauth API Manage my tokens

API trust

Use the following endpoints to validate phone numbers or email addresses:

Validate phone

POST /mobile-start/{mobile-phone-number}

Create a new request, the body post is used to specify "callback" parameters. The system will start a globl HLR lookup on the specified phone number.
Some mobile carriers and network congestion can slow down the request.
If the search takes longer than 10 seconds, you'll get a partial result with a status of "NEW" or "WAIT". Just wait for a notification when the search is finished. You can also check the status manually using the GET method and the provided ID.

Validate email

POST /email-start/{email}

Create a new request to validate an email address. The body can specify callback parameters. The system will start an email validation process.
If the validation takes longer than a few seconds, you might get a partial result with status 'NEW' or 'WAIT'. Check status manually using GET /email-start/{id} or wait for callback.

Retrieve a validation request

GET /mobile-start/{id}
Returns a request detail to check the "state"

GET /email-start/{id}
Returns a request detail to check the "state"

API docs by Redocly

Trust (1.0.0)

URL: https://openapi.it/en/support License: Apache 2.0 Terms of Service

Use this API to verify the validity and trustworthiness of data such as email addresses and mobile phone numbers.

First time here? Generate a new access token

HLR

"Home Location Register" query for mobile phone numbers validation

Retrive a request

Returns a request detail to check the "state"

Authorizations:
bearerAuth
path Parameters
id
required
string
Example: 66c881896de559cb65055392

request id obtained using the "POST" method

Responses

Response Schema: application/json
object (mobile-start)
success
boolean
message
string
error
string

Request samples 

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "https://trust.openapi.com/mobile-start/%7Bid%7D");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Authorization: Bearer REPLACE_BEARER_TOKEN");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

Response samples

Content type
application/json
{
  • "data": {
    },
  • "success": true,
  • "message": "",
  • "error": ""
}

Create a new HLR request

Create a new request, the body post is used to specify "callback" parameters. The system will start a globl HLR lookup on the specified phone number.
Some mobile carriers and network congestion can slow down the request. If the search takes longer than 10 seconds, you'll get a partial result with a status of "NEW" or "WAIT". Just wait for a notification when the search is finished. You can also check the status manually using the GET method and the provided ID.

Authorizations:
bearerAuth
path Parameters
mobile-phone-number
required
string
Example: +393939989747

The mobile phone in complete of the international prefix

Request Body schema: application/json
object

This is our standardized OpenAPI callback system. It enables the configuration of parameters for receiving notifications about status updates of asynchronous requests to this endpoint.

Responses

Response Schema: application/json
object (mobile-start)
success
boolean
message
string
error
string

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "success": true,
  • "message": "",
  • "error": null
}

Email

Email validation services

Retrieve an email validation request

Returns an email validation request detail to check the "state" and results.

Authorizations:
bearerAuth
path Parameters
id
required
string
Example: 77e9e92216065fa37f3c9842

Request ID obtained using the POST /email-start/{email} method

Responses

Response Schema: application/json
object (email-start)
success
boolean
message
string
error
string

Request samples 

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "https://trust.openapi.com/email-start/%7Bid%7D");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Authorization: Bearer REPLACE_BEARER_TOKEN");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

Response samples

Content type
application/json
{
  • "data": {
    },
  • "success": true,
  • "message": "",
  • "error": null
}

Create a new email validation request

Create a new request to validate an email address. The body can specify callback parameters. The system will start an email validation process. If the validation takes longer than a few seconds, you might get a partial result with status 'NEW' or 'WAIT'. Check status manually using GET /email-start/{id} or wait for callback.

Authorizations:
bearerAuth
path Parameters
email
required
string <email>

The email address to validate.

Request Body schema: application/json
object

This is our standardized OpenAPI callback system. It enables the configuration of parameters for receiving notifications about status updates of asynchronous requests to this endpoint.

Responses

Response Schema: application/json
object (email-start)
success
boolean
message
string
error
string

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "success": true,
  • "message": "",
  • "error": null
}
Web Service Revision: 2.0.0