Verification Match Service

Verification Match Service API Documentation

PATCH /phone-service/verification/{referenceId}

Try it

Verification Match

cURL

curl --request PATCH \
  --url https://sandbox-umbrella-api.azurewebsites.net/api/services/phone-service/verification/{referenceId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "securityFactor": "12345"
}
'

200

{
  "status": true,
  "data": {
    "status": {
      "code": 3900,
      "description": "Verified"
    }
  }
}

For a usage description of the Verification Match Service, please refer to the Verification Match page.

Endpoint

PATCH /phone-service/verification/{referenceId}

Swagger

⬇️ Download OpenAPI YAML

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).

Example:

"12345"

Response

200

application/json

Verification result.

status · boolean · required

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

Example:

true

data · object · required

Show child attributes

data. status · object · required

Show child attributes

data.status. code · integer · required

Numeric code representing the verification result.

Example:

3900

data.status. description · string · required

Human-readable description of the verification result.

Example:

"Verified"