Verifications report

Report a verification using Identity

Request

Report the received verification code to verify it, using the identity of the user (in most cases, the phone number). For an SMS verification or Phone Call verification, this is the OTP code. For FlashCall, this is the CLI.

Security

Basic or Application

Path

endpointstringrequired

For type number use a E.164-compatible phone number.

Bodyapplication/jsonrequired

methodstringrequired

The type of verification.

Value	Description
sms	SMS verification type

Example:"sms"

Discriminator

smsobjectrequired

A configuration object containing settings specific to SMS verifications.

curl -i -X PUT \
  -u '<username>:<password>' \
  'https://verification.api.sinch.com/verification/v1/verifications/number/{endpoint}' \
  -H 'Content-Type: application/json' \
  -d '{
    "method": "sms",
    "sms": {
      "code": "123"
    }
  }'

Responses

A success response, or an Error.

Bodyapplication/json

methodstring(VerificationMethodReport)required

The type of the verification.

Enum Value	Description
sms	Verification by SMS message with an OTP code.
flashcall	Verification by placing a flashVerificationResultEvent call (missed call) and detecting the incoming calling number (CLI).
callout	Verification by placing a PSTN call to the user's phone and playing an announcement, asking the user to press a particular digit to verify the phone number.
whatsapp	Verification by WhatsApp message with an OTP code.

Example:"sms"

Discriminator

idstring

The unique ID of the verification request.

Example:"1234567890"

statusstring(VerificationStatus)

The status of the verification

Enum Value	Description
PENDING	The verification is ongoing.
SUCCESSFUL	The verification was successful.
FAIL	The verification attempt was made, but the number wasn't verified.
DENIED	The verification attempt was denied by Sinch or your backend.
ABORTED	The verification attempt was aborted by requesting a new verification.
ERROR	The verification couldn't be completed due to a network error or the number being unreachable.

Example:"PENDING"

reasonstring(VerificationStatusReason)

Displays the reason why a verification has FAILED, was DENIED, or was ABORTED.

Enum Value	Description
Fraud	Fraudulent activity.
Not enough credit	Not enough credit in dashboard account.
Blocked	Blocked number.
Denied by callback	Callback response denied the verification.
Invalid callback	Callback was invalid.
Internal error	Internal server error.
Destination denied	Verification destination denied.
Network error or number unreachable	Network error or destination number is otherwise unreachable.
Failed pending	Pending failure.
SMS delivery failure	Could not deliver SMS.
Invalid CLI	CLI is invalid.
Invalid code	Input code is invalid.
Expired	Verification request has expired.
Hung up without entering valid code	Phone call ended without entering code.

Example:"Expired"

callCompleteboolean

Displays if the call was completed successfully.

Response

{
  "id": "1234567890",
  "method": "sms",
  "status": "PENDING",
  "reason": "Expired",
  "callComplete": true
}

We'd love to hear from you!