Skip to main content

List all requirement types

GET 
/requirement_types

List all requirement types ordered by created_at descending

Request ​

Query Parameters

    filter[name][contains] string

    Filters requirement types to those whose name contains a certain string.

    sort[] string

    Possible values: [created_at, name, updated_at]

    Specifies the sort order for results. If you want to sort by a field in ascending order, include it as a sort parameter. If you want to sort in descending order, prepend a - in front of the field name.

Responses ​

200: Successful response

Schema

    data

    object[]

  • 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.

  • ]

    • meta

    object

    total_pages integer
    total_results integer
    page_number integer
    page_size integer

default: Unexpected error

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

  • ]

Request samples

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

Response samples

{
  "data": [
    {
      "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"
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}