PATCH
/
phone-service
/
verificationMatch
/
{referenceId}
Verification Match
curl --request PATCH \
  --url https://sandbox-umbrella-api.azurewebsites.net/api/services/phone-service/verificationMatch/{referenceId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "action": "finalize",
  "securityFactor": "123456"
}'
{
  "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/verificationMatch/{referenceId}

​
Swagger

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
referenceId
string
required

Unique identifier for the verification process.

Body

application/json
​
action
enum<string>
required

Specifies how to change the verification state.

Available options:
finalize
Example:

"finalize"

​
securityFactor
string
required

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

Example:

"123456"

Response

Successfully validated verification code.

​
status
object
required