Verify code

POST

validations

{token}

verify

Verify code

curl --request POST \
  --url https://verify-api.smsmanager.com/v1/validations/{token}/verify \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "code": "123456"
}
'

import requests

url = "https://verify-api.smsmanager.com/v1/validations/{token}/verify"

payload = { "code": "123456" }
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({code: '123456'})
};

fetch('https://verify-api.smsmanager.com/v1/validations/{token}/verify', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://verify-api.smsmanager.com/v1/validations/{token}/verify",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'code' => '123456'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://verify-api.smsmanager.com/v1/validations/{token}/verify"

	payload := strings.NewReader("{\n  \"code\": \"123456\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://verify-api.smsmanager.com/v1/validations/{token}/verify")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"code\": \"123456\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://verify-api.smsmanager.com/v1/validations/{token}/verify")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"code\": \"123456\"\n}"

response = http.request(request)
puts response.read_body

{
  "verified": true,
  "phoneNumber": "1234567890",
  "token": "61591bd88d8fbe7736bca535809d1216dd71cb0b5cbf2b07e5a08adfbeb5d35b",
  "code": "123456",
  "timestamp": "2024-01-15T10:30:00Z",
  "proof": "86dd8444ed76402c93ce62497cb29a0d7af7215261b8497cb355e617b13f4ef2",
  "verifiedAt": "2024-01-15T10:31:15Z"
}

Autorizace

X-API-Key

string

header

povinné

Your tenant's API key

Parametry cesty

token

string

povinné

The validation token returned from the start validation endpoint

Příklad:

"val_7af7215261b8497cb355e617b13f4ef2"

Tělo

application/json

code

string

povinné

The 6-digit verification code from SMS

Pattern: ^[0-9]{6}$

Příklad:

"123456"

Odpověď

Code verified successfully

verified

boolean

povinné

Whether the verification was successful

Příklad:

true

phoneNumber

string

The verified phone number (only present if verified is true)

Příklad:

"1234567890"

token

string

The validation token (only present if verified is true)

Příklad:

"550e8400-e29b-41d4-a716-446655440000_abc123"

code

string

The verification code that was verified (only present if verified is true)

Příklad:

"123456"

timestamp

string<date-time>

When the validation was started (only present if verified is true)

Příklad:

"2024-01-15T10:30:00Z"

proof

string

HMAC proof for this verification (only present if verified is true and tenant has verificationSecret)

Příklad:

"86dd8444ed76402c93ce62497cb29a0d7af7215261b8497cb355e617b13f4ef2"

verifiedAt

string<date-time>

When the verification was completed (only present if verified is true)

Příklad:

"2024-01-15T10:31:15Z"

Start phone validation

Předchozí

Verify proof (optional)

Další

Verify code

curl --request POST \
  --url https://verify-api.smsmanager.com/v1/validations/{token}/verify \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "code": "123456"
}
'

import requests

url = "https://verify-api.smsmanager.com/v1/validations/{token}/verify"

payload = { "code": "123456" }
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({code: '123456'})
};

fetch('https://verify-api.smsmanager.com/v1/validations/{token}/verify', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://verify-api.smsmanager.com/v1/validations/{token}/verify",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'code' => '123456'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://verify-api.smsmanager.com/v1/validations/{token}/verify"

	payload := strings.NewReader("{\n  \"code\": \"123456\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://verify-api.smsmanager.com/v1/validations/{token}/verify")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"code\": \"123456\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://verify-api.smsmanager.com/v1/validations/{token}/verify")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"code\": \"123456\"\n}"

response = http.request(request)
puts response.read_body

{
  "verified": true,
  "phoneNumber": "1234567890",
  "token": "61591bd88d8fbe7736bca535809d1216dd71cb0b5cbf2b07e5a08adfbeb5d35b",
  "code": "123456",
  "timestamp": "2024-01-15T10:30:00Z",
  "proof": "86dd8444ed76402c93ce62497cb29a0d7af7215261b8497cb355e617b13f4ef2",
  "verifiedAt": "2024-01-15T10:31:15Z"
}

JSON API v2

JSON API v1

REST API

Verify API

WhatsApp Partner API

Referenční tabulky

Autorizace

Parametry cesty

Tělo

Odpověď