Create Verification

Endpoint

[POST] https://usenotifier.com/api/verify

Example Request

$response = Http::withToken('YOUR_API_KEY')
               ->post('https://usenotifier.com/api/verify', [
                  "to" => "+447700900389"
                ]);

$client = new Client();
$headers = [
  'Accept' => 'application/json',
  'Authorization' => 'Bearer YOUR_API_KEY',
  'Content-Type' => 'application/x-www-form-urlencoded'
];
$options = [
'form_params' => [
  'to' => '+447700900389'
]];
$request = new Request('POST', 'https://usenotifier.com/api/verify', $headers);
$res = $client->sendAsync($request, $options)->wait();
echo $res->getBody();

curl --location --request POST 'https://usenotifier.com/api/verify'
--header 'Accept: application/json'
--header 'Authorization: Bearer YOUR_API_KEY'
--header 'Content-Type: application/x-www-form-urlencoded'
--data-urlencode 'to=+447700900389'

var client = new RestClient("https://usenotifier.com/api/verify");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer YOUR_API_KEY");
request.AddHeader("Content-Type", "application/x-www-form-urlencoded");
request.AddParameter("to", "+447700900389");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Read the Authentication docs to get your API KEY

to: required

The recipient's phone number in international format. This must start with a + and the country code. For example the UK phone number 07700900389 should be sent as +447700900389

body: optional

You can customise the Verification message by sending over a body. Please note that the message must contain a {verification_code} placeholder which will get replaced when the verification message is sent to the user. If you do not send a customised message the default will be used.

uuid: optional

You may pass an optional UUID if you want to know the id of the verification in advance. This is optional and we will create a UUID per verification. The response of your request will give you this UUID.

If you want generate your own you can do so programmatically or use a tool like https://www.uuidgenerator.net/version1

sender: optional

You can pass over the name of an approved sender. If you have more than one approved sender you can switch between them by passing over this key, with the name of the sender as its value. If you do not pass the sender we will use the default sender set up in your Settings area.

Example Response

All you get back from this endpoint is a UUID, which you can check and attempt verification on and its current status. For security purposes you will never see the code that was sent to the user, either in the endpoints here, or in your message send history where the code will show as {verification_code}.

{
    "data": [
        {
            "uuid": "5f0beecd-ff5f-42d1-bfcd-19c563d67f97",
            "status": "PENDING"
        }
    ]
}

Your new Verification will expire in 10 minutes. After this time the status will be updated to EXPIRED and you will have to create a new Verification to continue.

PreviousView All SMS NextAttempt Verification

Last updated 2 years ago

hashtagEndpoint

hashtagExample Request

hashtagExample Response

hashtag

Endpoint

Example Request

Example Response