v52

OpenAPI 3.1.0raw.githubusercontent.com2026-07-311,1941,9384.1 MB

Requirements

Schedule a future requirement version

Create a new pending version of a requirement with a future effective start date. Only one pending version may exist per requirement at a time.

post/requirements/{id}/versions

Path parameters

idstring uuid required

Uniquely identifies the requirement_type record

Request body

effective_start_atstring date-time required

ISO 8601 formatted date-time indicating when the new version should become active. Must be a future date-time.

requirement_type_idsstring[] required

List of requirement type UUIDs that apply to the new version. Replaces the existing requirement types for the new version.

Example request

{
  "effective_start_at": "2026-08-01T00:00:00.000Z",
  "requirement_type_ids": [
    "a38c217a-8019-48f8-bff6-0fdd9939075b"
  ]
}

Response

Pending version created successfully

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"
  }
}