Skip to main content
PATCH
/
phone-service
/
verification
/
{referenceId}
Verification Match
curl --request PATCH \
  --url https://api-umbrella.io/api/services/phone-service/verification/{referenceId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "securityFactor": "12345"
}
'
import requests

url = "https://api-umbrella.io/api/services/phone-service/verification/{referenceId}"

payload = { "securityFactor": "12345" }
headers = {"Content-Type": "application/json"}

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

print(response.text)
const options = {
method: 'PATCH',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({securityFactor: '12345'})
};

fetch('https://api-umbrella.io/api/services/phone-service/verification/{referenceId}', 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://api-umbrella.io/api/services/phone-service/verification/{referenceId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'securityFactor' => '12345'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);

$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://api-umbrella.io/api/services/phone-service/verification/{referenceId}"

payload := strings.NewReader("{\n \"securityFactor\": \"12345\"\n}")

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

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.patch("https://api-umbrella.io/api/services/phone-service/verification/{referenceId}")
.header("Content-Type", "application/json")
.body("{\n \"securityFactor\": \"12345\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api-umbrella.io/api/services/phone-service/verification/{referenceId}")

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

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"securityFactor\": \"12345\"\n}"

response = http.request(request)
puts response.read_body
{
  "status": true,
  "data": {
    "status": {
      "code": 3900,
      "description": "Verified"
    }
  }
}
{
"message": "Invalid request payload"
}
{
"message": "Unauthorized request"
}
{
"message": "Journey not found"
}
{
"error": "Too Many Requests",
"message": "Rate limit exceeded.",
"code": "429"
}
{
"message": "Internal Server Error"
}
{
"error": "Service Unavailable",
"message": "Service is unavailable.",
"code": "503"
}
For a usage description of the Verification Match Service, please refer to the Verification Match page.

Endpoint

PATCH /phone-service/verification/{referenceId}

Swagger

Path Parameters

referenceId
string
required

Unique identifier for the verification process.

Body

application/json
securityFactor
string
required

The OTP provided by the end user (3–10 digits).

Pattern: ^\d{3,10}$
Example:

"12345"

Response

Verification result.

status
boolean
required

Indicates whether the request was successful (true or false).

Example:

true

data
object
required