Verify verification code by ID

POST 
/verifications/:verification_id/actions/verify

Verify verification code by ID

Path Parameters

verification_id uuidrequired

The identifier of the verification to retrieve.

application/json

Body

required

code string

This is the code the user submits for verification.

status string

Possible values: [accepted, rejected]

Identifies if the verification code has been accepted or rejected. Only permitted if custom_code was used for the verification.

200: Expected verify response to a valid request.

application/json

• Schema
• Example (from schema)

Schema

data

object

required

phone_number stringrequired

+E164 formatted phone number.

response_code stringrequired

Possible values: [accepted, rejected]

Identifies if the verification code has been accepted or rejected.

{
  "data": {
    "phone_number": "+13035551234",
    "response_code": "accepted"
  }
}

400: Bad Request

application/json

• Schema
• Example (from schema)

Schema

errors

Error[]

Array [

code integerrequired

title stringrequired

detail string

source

object

pointer json-pointer

JSON pointer (RFC6901) to the offending entity.

parameter string

Indicates which query parameter caused the error.

meta

object

url string

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"
      }
    }
  ]
}

Request samples

• cURL

---

curl -L 'https://api.telnyx.com/v2/verifications/:verification_id/actions/verify' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "code": "17686",
  "status": "accepted"
}'

Response samples

• 200
• 400

---

{
  "data": {
    "phone_number": "+13035551234",
    "response_code": "accepted"
  }
}

{
  "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"
      }
    }
  ]
}