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
One of:
id
string

The unique ID of the verification request.

method
string

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

status
string

The status of the verification request.

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

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

Enum: "“Fraud”" "Not enough credit" "Blocked" "Denied by callback" "Invalid callback" "Internal error" "Destination denied" "Network error or number unreachable" "Failed pending" "SMS delivery failure" "Invalid CLI" "Invalid code" "Expired" "Hung up without entering valid code"
reference
string

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

object

Prices associated with this verification

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.

source
string

Free text that the client is sending, used to show if the call/SMS was intercepted or not.

Enum: "intercepted" "manual"
get/verification/v1/verifications/id/{id}
Request samples 
Response samples 
application/json
{
  • "id": "1234567890",
  • "method": "string",
  • "status": "SUCCESSFUL",
  • "reason": "“Fraud”",
  • "reference": "12345",
  • "price": {
    • "verificationPrice": {
      }
    },
  • "identity": {
    • "type": "number",
    • "endpoint": "+11235551234"
    },
  • "countryId": "US",
  • "verificationTimestamp": "2023-04-21T14:45:51",
  • "source": "intercept"
}
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
One of:
id
string
The unique ID of the verification request.


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


 
status
string
The status of the verification request.


 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
Displays the reason why a verification has FAILED, was DENIED, or was ABORTED.


 Enum: "“Fraud”" "Not enough credit" "Blocked" "Denied by callback" "Invalid callback" "Internal error" "Destination denied" "Network error or number unreachable" "Failed pending" "SMS delivery failure" "Invalid CLI" "Invalid code" "Expired" "Hung up without entering valid code"  
reference
string
The reference ID that was optionally passed together with the verification request.


 
object
Prices associated with this verification


 
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.


 
source
string
Free text that the client is sending, used to show if the call/SMS was intercepted or not.


 Enum: "intercepted" "manual"  
get/verification/v1/verifications/{method}/number/{endpoint}
Request samples 
Response samples 
application/json
{
  • "id": "1234567890",
  • "method": "string",
  • "status": "SUCCESSFUL",
  • "reason": "“Fraud”",
  • "reference": "12345",
  • "price": {
    • "verificationPrice": {
      }
    },
  • "identity": {
    • "type": "number",
    • "endpoint": "+11235551234"
    },
  • "countryId": "US",
  • "verificationTimestamp": "2023-04-21T14:45:51",
  • "source": "intercept"
}
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
One of:
id
string
The unique ID of the verification request.


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


 
status
string
The status of the verification request.


 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
Displays the reason why a verification has FAILED, was DENIED, or was ABORTED.


 Enum: "“Fraud”" "Not enough credit" "Blocked" "Denied by callback" "Invalid callback" "Internal error" "Destination denied" "Network error or number unreachable" "Failed pending" "SMS delivery failure" "Invalid CLI" "Invalid code" "Expired" "Hung up without entering valid code"  
reference
string
The reference ID that was optionally passed together with the verification request.


 
object
Prices associated with this verification


 
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.


 
source
string
Free text that the client is sending, used to show if the call/SMS was intercepted or not.


 Enum: "intercepted" "manual"  
get/verification/v1/verifications/reference/{reference}
Request samples 
Response samples 
application/json
{
  • "id": "1234567890",
  • "method": "string",
  • "status": "SUCCESSFUL",
  • "reason": "“Fraud”",
  • "reference": "12345",
  • "price": {
    • "verificationPrice": {
      }
    },
  • "identity": {
    • "type": "number",
    • "endpoint": "+11235551234"
    },
  • "countryId": "US",
  • "verificationTimestamp": "2023-04-21T14:45:51",
  • "source": "intercept"
}
SecurityPrivacyLegal & ComplianceCookie Statement
© 2024 Sinch. All rights reserved.