For the complete documentation index, see llms.txt. This page is also available as Markdown.

GETlive

Read the current Rules and public procedure metadata

Read the current Rules and public procedure metadata.

/api/rules/currentgetCurrentRulesCanonical

Authentication and authority

No bearer credential is required.

Parameters

This operation has no path, query, or header parameters.

Responses

200

Authorized operation result.

application/json

{
  "$ref": "#/components/schemas/CanonicalGetCurrentRulesCanonicalResponse",
  "type": "object",
  "properties": {
    "data": {
      "$ref": "#/components/schemas/CanonicalCurrentRules",
      "type": "object",
      "properties": {
        "rulesVersion": {
          "type": "string"
        },
        "rulesHash": {
          "type": "string"
        },
        "rulesetId": {
          "type": "string"
        },
        "dynamicRulesetId": {
          "type": "string"
        },
        "apiCompatibilityVersion": {
          "type": "string"
        },
        "application": {
          "const": "prospective_and_case_pinned",
          "type": "string"
        },
        "caseProcedures": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "caseTrack",
              "label",
              "description",
              "appealWaivedDefault",
              "disclosure",
              "appealWaiverDisclosure",
              "terms"
            ],
            "properties": {
              "caseTrack": {
                "type": "string",
                "enum": [
                  "ai_fast",
                  "ai_standard",
                  "ai_assisted_human"
                ]
              },
              "label": {
                "type": "string",
                "minLength": 1
              },
              "description": {
                "type": "string",
                "minLength": 1
              },
              "appealWaivedDefault": {
                "type": "boolean",
                "const": false
              },
              "disclosure": {
                "type": "object",
                "additionalProperties": {
                  "type": "string"
                }
              },
              "appealWaiverDisclosure": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "version",
                  "sha256",
                  "text"
                ],
                "properties": {
                  "version": {
                    "type": "string",
                    "minLength": 1
                  },
                  "sha256": {
                    "type": "string",
                    "pattern": "^[a-f0-9]{64}$"
                  },
                  "text": {
                    "type": "string",
                    "minLength": 1
                  }
                }
              },
              "terms": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "appealRetained",
                  "appealWaived"
                ],
                "properties": {
                  "appealRetained": {
                    "$ref": "#/components/schemas/CaseProcedureTerms",
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "schemaVersion",
                      "track",
                      "appealWaived",
                      "waiverDisclosureVersion",
                      "waiverDisclosureHash",
                      "rulesVersion",
                      "rulesHash",
                      "behaviorVersion",
                      "disclosureVersion",
                      "disclosureHash",
                      "feePolicyVersion",
                      "termsHash"
                    ],
                    "properties": {
                      "schemaVersion": {
                        "type": "string",
                        "const": "case-procedure-v1"
                      },
                      "track": {
                        "type": "string",
                        "enum": [
                          "ai_fast",
                          "ai_standard",
                          "ai_assisted_human"
                        ]
                      },
                      "appealWaived": {
                        "type": "boolean"
                      },
                      "waiverDisclosureVersion": {
                        "type": "string",
                        "minLength": 1
                      },
                      "waiverDisclosureHash": {
                        "type": "string",
                        "pattern": "^[a-f0-9]{64}$"
                      },
                      "rulesVersion": {
                        "type": "string",
                        "minLength": 1
                      },
                      "rulesHash": {
                        "type": "string",
                        "pattern": "^[a-f0-9]{64}$"
                      },
                      "behaviorVersion": {
                        "type": "string",
                        "minLength": 1
                      },
                      "disclosureVersion": {
                        "type": "string",
                        "minLength": 1
                      },
                      "disclosureHash": {
                        "type": "string",
                        "pattern": "^[a-f0-9]{64}$"
                      },
                      "feePolicyVersion": {
                        "type": "string",
                        "minLength": 1
                      },
                      "termsHash": {
                        "type": "string",
                        "pattern": "^[a-f0-9]{64}$"
                      }
                    }
                  },
                  "appealWaived": {
                    "$ref": "#/components/schemas/CaseProcedureTerms",
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "schemaVersion",
                      "track",
                      "appealWaived",
                      "waiverDisclosureVersion",
                      "waiverDisclosureHash",
                      "rulesVersion",
                      "rulesHash",
                      "behaviorVersion",
                      "disclosureVersion",
                      "disclosureHash",
                      "feePolicyVersion",
                      "termsHash"
                    ],
                    "properties": {
                      "schemaVersion": {
                        "type": "string",
                        "const": "case-procedure-v1"
                      },
                      "track": {
                        "type": "string",
                        "enum": [
                          "ai_fast",
                          "ai_standard",
                          "ai_assisted_human"
                        ]
                      },
                      "appealWaived": {
                        "type": "boolean"
                      },
                      "waiverDisclosureVersion": {
                        "type": "string",
                        "minLength": 1
                      },
                      "waiverDisclosureHash": {
                        "type": "string",
                        "pattern": "^[a-f0-9]{64}$"
                      },
                      "rulesVersion": {
                        "type": "string",
                        "minLength": 1
                      },
                      "rulesHash": {
                        "type": "string",
                        "pattern": "^[a-f0-9]{64}$"
                      },
                      "behaviorVersion": {
                        "type": "string",
                        "minLength": 1
                      },
                      "disclosureVersion": {
                        "type": "string",
                        "minLength": 1
                      },
                      "disclosureHash": {
                        "type": "string",
                        "pattern": "^[a-f0-9]{64}$"
                      },
                      "feePolicyVersion": {
                        "type": "string",
                        "minLength": 1
                      },
                      "termsHash": {
                        "type": "string",
                        "pattern": "^[a-f0-9]{64}$"
                      }
                    }
                  }
                }
              }
            }
          },
          "minItems": 3,
          "maxItems": 3
        }
      },
      "required": [
        "rulesVersion",
        "rulesHash",
        "rulesetId",
        "dynamicRulesetId",
        "apiCompatibilityVersion",
        "application",
        "caseProcedures"
      ]
    },
    "requestId": {
      "type": "string"
    }
  },
  "required": [
    "data",
    "requestId"
  ]
}
default

RFC 9457 style problem response.

application/problem+json

{
  "$ref": "#/components/schemas/Problem",
  "type": "object",
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "requestId"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer"
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "requestId": {
      "type": "string"
    },
    "details": {
      "description": "Account-readiness refusals include a value-free checklist and exact account-page link. Other error codes may provide different details.",
      "anyOf": [
        {
          "$ref": "#/components/schemas/AccountReadinessDetails",
          "type": "object",
          "additionalProperties": false,
          "required": [
            "ready",
            "accountSetupUrl",
            "missing"
          ],
          "properties": {
            "ready": {
              "type": "boolean"
            },
            "accountSetupUrl": {
              "type": "string",
              "format": "uri"
            },
            "missing": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/AccountReadinessRequirement",
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "label",
                  "section",
                  "accountUrl"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "label": {
                    "type": "string"
                  },
                  "section": {
                    "type": "string",
                    "enum": [
                      "email",
                      "identity",
                      "legal_documents"
                    ]
                  },
                  "accountUrl": {
                    "type": "string",
                    "format": "uri"
                  }
                }
              }
            }
          }
        },
        {
          "$ref": "#/components/schemas/LegalDocumentsRequiredDetails",
          "type": "object",
          "additionalProperties": false,
          "required": [
            "legalDocumentsUrl"
          ],
          "properties": {
            "legalDocumentsUrl": {
              "type": "string",
              "format": "uri",
              "description": "Absolute account-page URL where the person reviews and accepts the current Terms and Privacy Notice. Uses the configured public application origin. After accepting the documents, retry the original operation."
            },
            "ready": {
              "type": "boolean"
            },
            "accountSetupUrl": {
              "type": "string",
              "format": "uri"
            },
            "missing": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/AccountReadinessRequirement",
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "label",
                  "section",
                  "accountUrl"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "label": {
                    "type": "string"
                  },
                  "section": {
                    "type": "string",
                    "enum": [
                      "email",
                      "identity",
                      "legal_documents"
                    ]
                  },
                  "accountUrl": {
                    "type": "string",
                    "format": "uri"
                  }
                }
              }
            }
          }
        },
        {}
      ]
    }
  }
}

Example response

Successful response

{
  "data": {
    "rulesVersion": "rulesVersion_test",
    "rulesHash": "rulesHash_test",
    "rulesetId": "rulesetId_test",
    "dynamicRulesetId": "dynamicRulesetId_test",
    "apiCompatibilityVersion": "apiCompatibilityVersion_test",
    "application": "prospective_and_case_pinned",
    "caseProcedures": [
      {
        "caseTrack": "ai_standard",
        "label": "label_test",
        "description": "description_test",
        "appealWaivedDefault": false,
        "disclosure": {},
        "appealWaiverDisclosure": {
          "version": "version_test",
          "sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
          "text": "Test-environment procedural message."
        },
        "terms": {
          "appealRetained": {
            "schemaVersion": "case-procedure-v1",
            "track": "ai_fast",
            "appealWaived": false,
            "waiverDisclosureVersion": "waiverDisclosureVersion_test",
            "waiverDisclosureHash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
            "rulesVersion": "rulesVersion_test",
            "rulesHash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
            "behaviorVersion": "behaviorVersion_test",
            "disclosureVersion": "disclosureVersion_test",
            "disclosureHash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
            "feePolicyVersion": "2026-08-test",
            "termsHash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
          },
          "appealWaived": {
            "schemaVersion": "case-procedure-v1",
            "track": "ai_fast",
            "appealWaived": false,
            "waiverDisclosureVersion": "waiverDisclosureVersion_test",
            "waiverDisclosureHash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
            "rulesVersion": "rulesVersion_test",
            "rulesHash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
            "behaviorVersion": "behaviorVersion_test",
            "disclosureVersion": "disclosureVersion_test",
            "disclosureHash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
            "feePolicyVersion": "2026-08-test",
            "termsHash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
          }
        }
      },
      {
        "caseTrack": "ai_standard",
        "label": "label_test",
        "description": "description_test",
        "appealWaivedDefault": false,
        "disclosure": {},
        "appealWaiverDisclosure": {
          "version": "version_test",
          "sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
          "text": "Test-environment procedural message."
        },
        "terms": {
          "appealRetained": {
            "schemaVersion": "case-procedure-v1",
            "track": "ai_fast",
            "appealWaived": false,
            "waiverDisclosureVersion": "waiverDisclosureVersion_test",
            "waiverDisclosureHash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
            "rulesVersion": "rulesVersion_test",
            "rulesHash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
            "behaviorVersion": "behaviorVersion_test",
            "disclosureVersion": "disclosureVersion_test",
            "disclosureHash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
            "feePolicyVersion": "2026-08-test",
            "termsHash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
          },
          "appealWaived": {
            "schemaVersion": "case-procedure-v1",
            "track": "ai_fast",
            "appealWaived": false,
            "waiverDisclosureVersion": "waiverDisclosureVersion_test",
            "waiverDisclosureHash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
            "rulesVersion": "rulesVersion_test",
            "rulesHash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
            "behaviorVersion": "behaviorVersion_test",
            "disclosureVersion": "disclosureVersion_test",
            "disclosureHash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
            "feePolicyVersion": "2026-08-test",
            "termsHash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
          }
        }
      },
      {
        "caseTrack": "ai_standard",
        "label": "label_test",
        "description": "description_test",
        "appealWaivedDefault": false,
        "disclosure": {},
        "appealWaiverDisclosure": {
          "version": "version_test",
          "sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
          "text": "Test-environment procedural message."
        },
        "terms": {
          "appealRetained": {
            "schemaVersion": "case-procedure-v1",
            "track": "ai_fast",
            "appealWaived": false,
            "waiverDisclosureVersion": "waiverDisclosureVersion_test",
            "waiverDisclosureHash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
            "rulesVersion": "rulesVersion_test",
            "rulesHash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
            "behaviorVersion": "behaviorVersion_test",
            "disclosureVersion": "disclosureVersion_test",
            "disclosureHash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
            "feePolicyVersion": "2026-08-test",
            "termsHash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
          },
          "appealWaived": {
            "schemaVersion": "case-procedure-v1",
            "track": "ai_fast",
            "appealWaived": false,
            "waiverDisclosureVersion": "waiverDisclosureVersion_test",
            "waiverDisclosureHash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
            "rulesVersion": "rulesVersion_test",
            "rulesHash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
            "behaviorVersion": "behaviorVersion_test",
            "disclosureVersion": "disclosureVersion_test",
            "disclosureHash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
            "feePolicyVersion": "2026-08-test",
            "termsHash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
          }
        }
      }
    ]
  },
  "requestId": "requestId_test"
}

Errors

Read the response status and stable error code. See errors and rate limits for recovery. Refresh the resource before resolving a state or digest conflict.

Idempotency and retries

  • For throttling, honor Retry-After when present. Back off on retryable server failures.