Verify verification code by phone number

POST 
/verifications/by_phone_number/:phone_number/actions/verify

Verify verification code by phone number

Path Parameters

phone_number stringrequired

The phone number associated with the verification code being verified.

application/json

Body

required

code stringrequired

This is the code the user submits for verification.

verify_profile_id uuidrequired

The identifier of the associated Verify profile.

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/by_phone_number/:phone_number/actions/verify' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "code": "17686",
  "verify_profile_id": "12ade33a-21c0-473b-b055-b3c836e1c292"
}'

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