Retrieve a document requirement

GET 
/requirements/:id

Retrieve a document requirement record

Path Parameters

id uuidrequired
Uniquely identifies the requirement_type record
Example: a9dad8d5-fdbd-49d7-aa23-39bb08a5ebaa

200: Successful response

application/json

• Schema
• Example (from schema)

Schema

data

object

record_type string

Identifies the type of the resource.

country_code string

The 2-character (ISO 3166-1 alpha-2) country code where this requirement applies

locality string

The locality where this requirement applies

phone_number_type string

Possible values: [local, national, toll_free]

Indicates the phone_number_type this requirement applies to. Leave blank if this requirement applies to all number_types.

action string

Possible values: [both, ordering, porting]

Indicates whether this requirement applies to ordering, porting, or both

requirements_types

object[]

Lists the requirement types necessary to fulfill this requirement

Array [

acceptance_criteria

object

Specifies objective criteria for acceptance

time_limit string

Specifies time-based acceptance criteria

locality_limit string

Specifies geography-based acceptance criteria

acceptable_values string[]

Specifies the list of strictly possible values for the requirement. Ignored when empty

Specifies objective criteria for acceptance

description string

Describes the requirement type

example string

Provides one or more examples of acceptable documents

type string

Possible values: [document, address, textual]

Defines the type of this requirement type

name string

A short descriptive name for this requirement_type

record_type string

Identifies the type of the resource

id uuid

Identifies the associated document

created_at string

ISO 8601 formatted date-time indicating when the resource was created.

updated_at string

ISO 8601 formatted date-time indicating when the resource was last updated.

]

Lists the requirement types necessary to fulfill this requirement

id uuid

Identifies the associated document

created_at string

ISO 8601 formatted date-time indicating when the resource was created.

updated_at string

ISO 8601 formatted date-time indicating when the resource was last updated.

{
  "data": {
    "record_type": "requirement",
    "country_code": "FR",
    "locality": "Nice",
    "phone_number_type": "local",
    "action": "ordering",
    "requirements_types": [
      {
        "acceptance_criteria": {
          "time_limit": "Current and not expired",
          "locality_limit": "Issued by the same country that the phone number belongs to",
          "acceptable_values": [
            "US"
          ]
        },
        "description": "Proves the customer has a physical address in the same locality as the phone number",
        "example": "Utility bill, internet bill, phone bill, or lease",
        "type": "document",
        "name": "Proof of Address",
        "record_type": "requirement_type",
        "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
        "created_at": "2021-04-09T22:25:27.521Z",
        "updated_at": "2021-04-12T20:20:20.020Z"
      }
    ],
    "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    "created_at": "2021-04-09T22:25:27.521Z",
    "updated_at": "2021-04-12T20:20:20.020Z"
  }
}

default: Unexpected error

application/json

• Schema
• Example (from schema)

Schema

errors

Error[]

Array [

code intrequired

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/requirements/:id' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

• 200
• default

---

{
  "data": {
    "record_type": "requirement",
    "country_code": "FR",
    "locality": "Nice",
    "phone_number_type": "local",
    "action": "ordering",
    "requirements_types": [
      {
        "acceptance_criteria": {
          "time_limit": "Current and not expired",
          "locality_limit": "Issued by the same country that the phone number belongs to",
          "acceptable_values": [
            "US"
          ]
        },
        "description": "Proves the customer has a physical address in the same locality as the phone number",
        "example": "Utility bill, internet bill, phone bill, or lease",
        "type": "document",
        "name": "Proof of Address",
        "record_type": "requirement_type",
        "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
        "created_at": "2021-04-09T22:25:27.521Z",
        "updated_at": "2021-04-12T20:20:20.020Z"
      }
    ],
    "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    "created_at": "2021-04-09T22:25:27.521Z",
    "updated_at": "2021-04-12T20:20:20.020Z"
  }
}

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