Verification status

Get the status of specific verification requests in the verification process. Returns the status of pending and completed verifications. You can retrieve the status of verification requests by using the ID of the request, the phone number of the user being verified, or a custom reference string.

Get verification by ID

Queries the verification result by sending the verification ID. With this query you can get the result of a verification.

SecurityBasic or Application
Request
path Parameters
id
required
string

The ID of the verification.

Responses
200

A success response, or an Error.

Response Schema: application/json
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.

reference
string

The reference ID that was optionally passed together with the verification request.

object (Identity)

Specifies the type of endpoint that will be verified and the particular endpoint. number is currently the only supported endpoint type.

countryId
string (CountryId)

The ID of the country to which the verification was sent.

verificationTimestamp
string (VerificationTimestamp)

The timestamp in UTC format.
Note: The formatting does not respect ISO-8601 and the returned value has the format YYYY-MM-DDThh:mm:ss.SSS. If you need to parse this value into a specific date object in your programming language, please append Z (Zulu time = UTC) at the end of the date value to match the ISO-8601 format: YYYY-MM-DDThh:mm:ss.SSSZ.

method
string

The method of the verification request. This will always be sms.

object

Prices associated with this verification

source
string (Source)

With the PIN SMS verification method, a user's phone number is verified by sending an SMS containing a PIN code that must be manually returned. If you are are using an Android handset, you could instead intercept the SMS message delivery and capture the PIN code automatically.

Enum Value Description
intercepted

PIN verification was performed automatically

manual

PIN verification was manually performed

get/verification/v1/verifications/id/{id}
Request samples
Response samples
application/json
{
  • "id": "1234567890",
  • "status": "PENDING",
  • "reason": "Expired",
  • "reference": "12345",
  • "identity": {
    • "type": "number",
    • "endpoint": "+11235551234"
    },
  • "countryId": "US",
  • "verificationTimestamp": "2023-04-21T14:45:51",
  • "method": "sms",
  • "price": {
    • "verificationPrice": {
      }
    },
  • "source": "intercepted"
}

Get verification by Identity

Queries the verification result by sending the verification Identity (usually a phone number) and its method. With this query you can get the result of a verification.

SecurityBasic or Application
Request
path Parameters
endpoint
required
string

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

method
required
string

The method of the verification.

Responses
200

A success response, or an Error.

Response Schema: application/json
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.

reference
string

The reference ID that was optionally passed together with the verification request.

object (Identity)

Specifies the type of endpoint that will be verified and the particular endpoint. number is currently the only supported endpoint type.

countryId
string (CountryId)

The ID of the country to which the verification was sent.

verificationTimestamp
string (VerificationTimestamp)

The timestamp in UTC format.
Note: The formatting does not respect ISO-8601 and the returned value has the format YYYY-MM-DDThh:mm:ss.SSS. If you need to parse this value into a specific date object in your programming language, please append Z (Zulu time = UTC) at the end of the date value to match the ISO-8601 format: YYYY-MM-DDThh:mm:ss.SSSZ.

method
string

The method of the verification request. This will always be sms.

object

Prices associated with this verification

source
string (Source)

With the PIN SMS verification method, a user's phone number is verified by sending an SMS containing a PIN code that must be manually returned. If you are are using an Android handset, you could instead intercept the SMS message delivery and capture the PIN code automatically.

Enum Value Description
intercepted

PIN verification was performed automatically

manual

PIN verification was manually performed

get/verification/v1/verifications/{method}/number/{endpoint}
Request samples
Response samples
application/json
{
  • "id": "1234567890",
  • "status": "PENDING",
  • "reason": "Expired",
  • "reference": "12345",
  • "identity": {
    • "type": "number",
    • "endpoint": "+11235551234"
    },
  • "countryId": "US",
  • "verificationTimestamp": "2023-04-21T14:45:51",
  • "method": "sms",
  • "price": {
    • "verificationPrice": {
      }
    },
  • "source": "intercepted"
}

Get verification by Reference

Queries the verification result by sending the verification Reference. With this query you can get the result of a verification.

SecurityBasic or Application
Request
path Parameters
reference
required
string

The custom reference of the verification.

Responses
200

A success response, or an Error.

Response Schema: application/json
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.

reference
string

The reference ID that was optionally passed together with the verification request.

object (Identity)

Specifies the type of endpoint that will be verified and the particular endpoint. number is currently the only supported endpoint type.

countryId
string (CountryId)

The ID of the country to which the verification was sent.

verificationTimestamp
string (VerificationTimestamp)

The timestamp in UTC format.
Note: The formatting does not respect ISO-8601 and the returned value has the format YYYY-MM-DDThh:mm:ss.SSS. If you need to parse this value into a specific date object in your programming language, please append Z (Zulu time = UTC) at the end of the date value to match the ISO-8601 format: YYYY-MM-DDThh:mm:ss.SSSZ.

method
string

The method of the verification request. This will always be sms.

object

Prices associated with this verification

source
string (Source)

With the PIN SMS verification method, a user's phone number is verified by sending an SMS containing a PIN code that must be manually returned. If you are are using an Android handset, you could instead intercept the SMS message delivery and capture the PIN code automatically.

Enum Value Description
intercepted

PIN verification was performed automatically

manual

PIN verification was manually performed

get/verification/v1/verifications/reference/{reference}
Request samples
Response samples
application/json
{
  • "id": "1234567890",
  • "status": "PENDING",
  • "reason": "Expired",
  • "reference": "12345",
  • "identity": {
    • "type": "number",
    • "endpoint": "+11235551234"
    },
  • "countryId": "US",
  • "verificationTimestamp": "2023-04-21T14:45:51",
  • "method": "sms",
  • "price": {
    • "verificationPrice": {
      }
    },
  • "source": "intercepted"
}