---
title: "Retrieve a document requirement"
method: GET
path: "/requirements/{id}"
tags: ["Requirements"]
---

# Retrieve a document requirement

`GET /requirements/{id}`

Retrieve a document requirement record

## Path parameters

- `id` string, uuid, required

## Query parameters

- `version` integer

## Response `200`

Successful response

- object
  - `data` DocReqsRequirement
    - `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` 'local' | 'national' | 'toll_free' — Indicates the phone_number_type this requirement applies to. Leave blank if this requirement applies to all number_types.
    - `action` 'both' | 'branded_calling' | 'ordering' | 'porting' — Indicates whether this requirement applies to branded_calling, ordering, porting, or both ordering and porting
    - `requirement_types` DocReqsRequirementType[] — Lists the requirement types necessary to fulfill this requirement
      - `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
      - `description` string — Describes the requirement type
      - `example` string — Provides one or more examples of acceptable documents
      - `type` '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` string, 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.
    - `id` string, 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.
    - `version` integer — Version number. Increments with each new version. Defaults to 1.
    - `effective_start_at` string, date-time, nullable — When this version became (or will become) active.
    - `effective_end_at` string, date-time, nullable — When this version was superseded. NULL means this is the active or pending version.

## Other responses

- `422` — Unprocessable entity. Check the 'detail' field in response for details.
- `default` — Unexpected error

---

[API](https://skmtc.net/team-telnyx/apis/telnyx-api-2.md) · [All operations](https://skmtc.net/team-telnyx/apis/telnyx-api-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/team-telnyx/telnyx-api-2/versions/8f5f4e537994/schema)