Skip to main content

List all requirements

GET 
/requirements

List all requirements with filtering, sorting, and pagination

Request ​

Query Parameters

    filter object

    Consolidated filter parameter for requirements (deepObject style). Originally: filter[country_code], filter[phone_number_type], filter[action]

    sort string[]

    Possible values: [created_at, updated_at, country_code, phone_number_type, -created_at, -updated_at, -country_code, -phone_number_type]

    Consolidated sort parameter for requirements (deepObject style). Originally: sort[]

    page object

    Consolidated page parameter (deepObject style). Originally: page[size], page[number]

Responses ​

200: Successful response

Schema

    data

    object[]

  • Array [

    • 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, branded_calling, ordering, porting]

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

    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

    max_length integer

    Maximum length allowed for the value

    min_length integer

    Minimum length allowed for the value

    acceptable_characters string

    Specifies the allowed characters as a string

    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.

  • ]

    • meta

    object

    total_pages integer
    total_results integer
    page_number integer
    page_size integer

default: Unexpected error

Schema

    errors

    object[]

  • Array [

    • code stringrequired
    title stringrequired
    detail string

    source

    object

    pointer string

    JSON pointer (RFC6901) to the offending entity.

    parameter string

    Indicates which query parameter caused the error.

    meta

    object

    property name* any

  • ]

Request samples

curl -L 'https://api.telnyx.com/v2/requirements' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

{
  "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"
            ],
            "max_length": 20,
            "min_length": 16,
            "acceptable_characters": "abcdef0123456789"
          },
          "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"
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}