Sign in
Requirements

Retrieve a document requirement

Returns a single document requirement record by its identifier, describing the documentation needed for number-related actions. A specific requirement version can be requested.

get/requirements/{id}

Path parameters

idstring uuid required

Uniquely identifies the requirement_type record

Query parameters

versioninteger

Filter by requirement version number. When omitted, returns the currently-active version.

Response

Successful response

Example response

{
  "data": {
    "action": "ordering",
    "country_code": "FR",
    "created_at": "2021-04-09T22:25:27.521Z",
    "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    "locality": "Nice",
    "phone_number_type": "local",
    "record_type": "requirement",
    "requirement_types": [
      {
        "acceptance_criteria": {
          "acceptable_characters": "abcdef0123456789",
          "acceptable_values": [
            "US"
          ],
          "locality_limit": "Issued by the same country that the phone number belongs to",
          "max_length": 20,
          "min_length": 16,
          "time_limit": "Current and not expired"
        },
        "created_at": "2021-04-09T22:25:27.521Z",
        "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",
        "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
        "name": "Proof of Address",
        "record_type": "requirement_type",
        "type": "document",
        "updated_at": "2021-04-12T20:20:20.020Z"
      }
    ],
    "updated_at": "2021-04-12T20:20:20.020Z"
  }
}

Changes

Changed in 3 of the 61 revisions of this API.415

  • 1571b0380bd72See the full diff
    • ▲

      the errors/items/code response's property type/format changed from integer/int32 to string/ for status 422

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from integer/int32 to string/ for status default

      response-property-type-changed

    This revision also has 64 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 8f5f4e5379942See the full diff
    • ▲

      the errors/items/code response's property type/format changed from string/ to integer/int32 for status 422

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from string/ to integer/int32 for status default

      response-property-type-changed

    This revision also has 41 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 047830bb7e8315See the full diff
    • ●

      removed the optional property data/requirements_types from the response with the 200 status

      response-optional-property-removed

    • ○

      added the new optional query request parameter version

      new-optional-request-parameter

    • ○

      added the optional property data/effective_end_at to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/effective_start_at to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/requirement_types to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/version to the response with the 200 status

      response-optional-property-added