Verifications report

Report on existing verification requests.

Report a verification using Identity

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

SecurityBasic or Application
Request
path Parameters
endpoint
required
string

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

Request Body schema: application/json
required
method
required
string

The type of verification.

required
object

A configuration object containing settings specific to SMS verifications.

Responses
200

A success response, or an Error.

Response Schema: application/json
method
required
string (VerificationMethod)

The type of the verification request.

id
string

The unique ID of the verification request.

status
string (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.

reason
string (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 destinaton 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.

callComplete
boolean

Displays if the call was completed successfully.

put/verification/v1/verifications/number/{endpoint}
Request samples
application/json
{
  • "method": "sms",
  • "sms": {
    • "code": "123"
    }
}
Response samples
application/json
{
  • "id": "1234567890",
  • "method": "sms",
  • "status": "PENDING",
  • "reason": "Expired"
}

Report a verification with ID

Report the received verification code to verify it, using the Verification ID of the Verification request.

SecurityBasic or Application
Request
path Parameters
id
required
string
Request Body schema: application/json
required
method
required
string

The type of verification.

required
object

A configuration object containing settings specific to SMS verifications.

Responses
200

A success response, or an Error.

Response Schema: application/json
method
required
string (VerificationMethod)

The type of the verification request.

id
string

The unique ID of the verification request.

status
string (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.

reason
string (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 destinaton 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.

callComplete
boolean

Displays if the call was completed successfully.

put/verification/v1/verifications/id/{id}
Request samples
application/json
{
  • "method": "sms",
  • "sms": {
    • "code": "123"
    }
}
Response samples
application/json
{
  • "id": "1234567890",
  • "method": "sms",
  • "status": "PENDING",
  • "reason": "Expired"
}
SecurityPrivacyLegal & ComplianceCookie Statement
© 2024 Sinch. All rights reserved.