Skip to main content

List porting order requirements

GET 
/porting_orders/:id/requirements

Returns a list of all requirements based on country/number type for this porting order.

Request ​

Path Parameters

    id uuidrequired

    Porting Order id

Query Parameters

    page[number] integer

    Possible values: >= 1

    Default value: 1

    The page number to load

    page[size] integer

    Possible values: >= 1 and <= 250

    Default value: 20

    The size of the page

Responses ​

200: Successful response

Schema

    data

    object[]

  • Array [

    • field_type string

    Possible values: [document, textual]

    Type of value expected on field_value field

    field_value string

    Identifies the document that satisfies this requirement

    requirement_type

    object

    Identifies the requirement type that meets this requirement

    acceptance_criteria object

    The acceptance criteria for the requirement type

    description string

    A description of the requirement type

    example string

    An example of the requirement type

    id string

    Identifies the requirement type

    name string

    The name of the requirement type

    type string

    The type of the requirement type

    Identifies the requirement type that meets this requirement

    requirement_status string

    Status of the requirement

    record_type string

    Identifies the type of the resource.

  • ]

    • meta

    object

    total_pages integer
    total_results integer
    page_number integer
    page_size integer

401: Unauthorized

422: Unprocessable entity. Check message field in response for details.

Request samples

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

Response samples

{
  "data": [
    {
      "field_type": "document",
      "field_value": "9787fb5f-cbe5-4de4-b765-3303774ee9fe",
      "requirement_type": {
        "acceptance_criteria": {
          "acceptable_values": []
        },
        "description": "A copy of the latest phone bill from the current provider",
        "example": "Most recent phone bill",
        "id": "53970723-fbff-4f46-a975-f62be6c1a585",
        "name": "Latest Invoice",
        "type": "document"
      },
      "requirement_status": "approved",
      "record_type": "porting_requirement"
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}