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": {
    "record_type": "requirement",
    "country_code": "FR",
    "locality": "Nice",
    "phone_number_type": "local",
    "action": "ordering",
    "requirement_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"
  }
}

Changes

Changed in 4 of the 99 revisions of this API.615

  • a6a61a29ecdd2See the full diff
    • ▲

      the // response's property type changed from string to integer, and format from no format to int32 for status

      response-property-type-changed

    • ▲

      the // response's property type changed from string to integer, and format from no format to int32 for status

      response-property-type-changed

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

  • 1571b0380bd72See the full diff
    • ▲

      the // response's property type changed from integer to string, and format from int32 to no format for status

      response-property-type-changed

    • ▲

      the // response's property type changed from integer to string, and format from int32 to no format for status

      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 // response's property type changed from string to integer, and format from no format to int32 for status

      response-property-type-changed

    • ▲

      the // response's property type changed from string to integer, and format from no format to int32 for status

      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 / from the response with the status

      response-optional-property-removed

    • ○

      added the new optional query request parameter version

      new-optional-request-parameter

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

Of the 99 revisions, 1 has no diff computed.