Run the permit engine

Safety module

POST/permit-requirements/generatepermitRequirements.generate

Runs the jurisdiction permit engine for a project and writes its permit requirements. An unpopulated jurisdiction returns a 422 `NO_ANSWER` refusal; it never passes. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.

Requires the capability safety.permit.write.
OAuth scopes: safety.
Send an Idempotency-Key header. A replay with the same key returns the original response.
Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.

Request body: PermitEngineRequest

permitRequirements.generate: PermitEngineRequest
Field	Type	Required	Description
project_id	string (uuid)	Yes

{
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Response 200: PermitRequirementPage

permitRequirements.generate: PermitRequirementPage
Field	Type	Required	Description
data	array of PermitRequirement	Yes	Items on this page, in the documented default order.
next_cursor	string \| null	Yes	Opaque cursor for the next page; null on the last page.

{
  "data": [
    {
      "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "created_at": "2026-10-08T14:30:00Z",
      "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "updated_at": "2026-10-08T14:30:00Z",
      "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "rule": "Assembly occupancy",
      "jurisdiction_id": "US-FL",
      "permit": "Certificate of occupancy",
      "ahj": "City Building and Fire",
      "permit_state": "Proposed",
      "lead_time": "4-6 wks",
      "trigger_type": "project",
      "record_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
    }
  ],
  "next_cursor": null
}

Code samples

curl -X POST "$XOS_BASE_URL/permit-requirements/generate" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'

const { data } = await xos.permitRequirements.generate({
    "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
  });

response = xos.permit_requirements.generate({"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"})

xos permit-requirements generate --data '{"project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'