Validate the verification codes for the hosted numbers order

POST 
/messaging_hosted_number_orders/:id/validation_codes

Validate the verification codes sent to the numbers of the hosted order. The verification codes must be created in the verification codes endpoint.

Path Parameters

id stringrequired

Order ID related to the validation codes.

application/json

Body

Message payload

verification_codes

object[]

required

Array [

phone_number +E.164required

code stringrequired

]

200: Successful response with the phone numbers and their respective status of the validation codes.

application/json

• Schema
• Example (from schema)

Schema

data

object

phone_numbers

object[]

required

Array [

phone_number +E.164required

status stringrequired

Possible values: [verified, rejected]

]

order_id uuidrequired

{
  "data": {
    "phone_numbers": [
      {
        "phone_number": "string",
        "status": "verified"
      }
    ],
    "order_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }
}

default: Unexpected error

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

]

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string",
      "source": {
        "pointer": "string",
        "parameter": "string"
      },
      "meta": {}
    }
  ]
}

Request samples

• cURL

---

curl -L 'https://api.telnyx.com/v2/messaging_hosted_number_orders/:id/validation_codes' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "verification_codes": [
    {
      "phone_number": "string",
      "code": "string"
    }
  ]
}'

Response samples

• 200
• default

---

{
  "data": {
    "phone_numbers": [
      {
        "phone_number": "string",
        "status": "verified"
      }
    ],
    "order_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }
}

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string",
      "source": {
        "pointer": "string",
        "parameter": "string"
      },
      "meta": {}
    }
  ]
}