Retrieve verification
GET/verifications/:verification_id
Retrieve verification
Request
Path Parameters
The identifier of the verification to retrieve.
Responses
200: Expected verifications response to a valid request.
- application/json
- Schema
- Example (from schema)
Schema
data
object
required
Possible values: [sms
, call
, flashcall
]
The possible types of verification.
Possible values: [verification
]
The possible verification record types.
+E164 formatted phone number.
The identifier of the associated Verify profile.
This is the number of seconds before the code of the request is expired. Once this request has expired, the code will no longer verify the user. Note: this will override the default_verification_timeout_secs
on the Verify profile.
Possible values: [pending
, accepted
, invalid
, expired
, error
]
The possible statuses of the verification request.
{
"data": {
"id": "12ade33a-21c0-473b-b055-b3c836e1c292",
"type": "sms",
"record_type": "verification",
"phone_number": "+13035551234",
"verify_profile_id": "12ade33a-21c0-473b-b055-b3c836e1c292",
"timeout_secs": 300,
"status": "accepted",
"created_at": "2020-09-14T17:03:32.965812",
"updated_at": "2020-09-14T17:03:32.965812"
}
}
400: Bad Request
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
errors
Error[]
source
object
JSON pointer (RFC6901) to the offending entity.
Indicates which query parameter caused the error.
meta
object
URL with additional information on the error.
{
"errors": [
{
"code": "10015",
"title": "Invalid sorting value",
"detail": "The value provided for sorting is not valid. Check the value used and try again.",
"source": {
"pointer": "/sort",
"parameter": "string"
},
"meta": {
"url": "https://developers.telnyx.com/docs/overview/errors/10015"
}
}
]
}