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.
Queries the verification result by sending the verification ID. With this query you can get the result of a verification.
A success response, or an Error.
{- "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": {
- "currencyId": "USD",
- "amount": 0.0127
}
}, - "source": "intercepted"
}
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.
endpoint required | string For type |
method required | string The method of the verification. |
A success response, or an Error.
id | string The unique ID of the verification request. | ||||||||||||||||||||||||||||||
status | string (VerificationStatus) The status of the verification
| ||||||||||||||||||||||||||||||
reason | string (VerificationStatusReason) Displays the reason why a verification has
| ||||||||||||||||||||||||||||||
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. | |||||||||||||||||||||||||||||||
countryId | string (CountryId) The ID of the country to which the verification was sent. | ||||||||||||||||||||||||||||||
verificationTimestamp | string (VerificationTimestamp) The timestamp in UTC format.
| ||||||||||||||||||||||||||||||
method | string The method of the verification request. This will always be | ||||||||||||||||||||||||||||||
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.
|
{- "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": {
- "currencyId": "USD",
- "amount": 0.0127
}
}, - "source": "intercepted"
}
Queries the verification result by sending the verification Reference. With this query you can get the result of a verification.
A success response, or an Error.
id | string The unique ID of the verification request. | ||||||||||||||||||||||||||||||
status | string (VerificationStatus) The status of the verification
| ||||||||||||||||||||||||||||||
reason | string (VerificationStatusReason) Displays the reason why a verification has
| ||||||||||||||||||||||||||||||
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. | |||||||||||||||||||||||||||||||
countryId | string (CountryId) The ID of the country to which the verification was sent. | ||||||||||||||||||||||||||||||
verificationTimestamp | string (VerificationTimestamp) The timestamp in UTC format.
| ||||||||||||||||||||||||||||||
method | string The method of the verification request. This will always be | ||||||||||||||||||||||||||||||
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.
|
{- "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": {
- "currencyId": "USD",
- "amount": 0.0127
}
}, - "source": "intercepted"
}