{ "_type": "export", "__export_format": 4, "__export_source": "axiom-docs-generator", "resources": [ { "_id": "wrk_axiom_api_0_1_1", "_type": "workspace", "name": "Axiom API 0.1.1 - Claims", "description": "Generated from the public Axiom OpenAPI 0.1.1 contract. Use issued credentials and server-minted tenant context for admitted calls.", "scope": "collection" }, { "_id": "env_axiom_api_0_1_1", "_type": "environment", "parentId": "wrk_axiom_api_0_1_1", "name": "Base Environment", "data": { "base_url": "https://api.afr-dev.axiom.express", "access_token": "replace-with-issued-access-token", "tenant_id": "replace-with-admitted-tenant-id-from-list-tenants", "tenant_context": "replace-with-server-minted-tenant-context", "correlation_id": "axiom-example-correlation-id", "example_profile": "canonical-five-acts" } }, { "_id": "fld_claim", "_type": "request_group", "parentId": "wrk_axiom_api_0_1_1", "name": "Claim" }, { "_id": "req_axiom_0", "_type": "request", "parentId": "fld_claim", "name": "Submit a new claim", "description": "Submit an insurance claim against a policy. The claim is created in \"submitted\"\nstatus and enters the claims workflow for assessment.\n\nThe referenced policy must be active (or within its coverage period for the\nevent date). The event must fall within the policy's effective period.\n\nThe system validates coverage eligibility, checks for duplicate claims, and\ntriggers any configured automated rules (e.g. fraud scoring).\n\nSide effects: persists the claim in submitted status; initiates the claims workflow (automated triage and assessment assignment); emits an audit entry recording the submission.", "method": "POST", "url": "{{ _.base_url }}/v1/claims", "headers": [ { "name": "Authorization", "value": "Bearer {{access_token}}" }, { "name": "X-Correlation-ID", "value": "{{correlation_id}}" }, { "name": "X-Tenant-Context", "value": "{{tenant_context}}" }, { "name": "Content-Type", "value": "application/json" } ], "body": { "mimeType": "application/json", "text": "{\n \"attributes\": {\n \"loss_location\": \"Manhattan, New York\",\n \"police_case_number\": \"NYPD-2026-MN-4567\",\n \"third_party_involved\": true\n },\n \"claimed_amount\": {\n \"amount_minor\": 8500000,\n \"currency_code\": \"zar\"\n },\n \"description\": \"Rear-end collision at intersection of 5th Avenue and 42nd Street, New York. Third-party vehicle damage and whiplash injury to driver.\",\n \"event_date\": \"2026-03-01\",\n \"event_id\": \"4cbb0168-4d04-535d-969b-927f53d9c96c\",\n \"metadata\": {\n \"reporter_reference\": \"APP-2026-0042\",\n \"source_system\": \"mobile-app\"\n },\n \"policy_id\": \"41866ac2-9965-5dac-b793-aabd56eadcbd\",\n \"primary_party_id\": \"90ea0de6-41a6-5bff-b66b-7dbbf93ba420\",\n \"priority\": \"medium\"\n}" }, "parameters": [] }, { "_id": "req_axiom_1", "_type": "request", "parentId": "fld_claim", "name": "List claims", "description": "Retrieve a cursor-paginated list of claims for the tenant.\nResults are sorted by created_at descending with id as a stable tie-breaker.\nSort order is not configurable.\n\nReturns claims across all statuses (submitted, under_review, assessed,\npartial_approval, denied, paid, closed).", "method": "GET", "url": "{{ _.base_url }}/v1/claims", "headers": [ { "name": "Authorization", "value": "Bearer {{access_token}}" }, { "name": "X-Correlation-ID", "value": "{{correlation_id}}" }, { "name": "X-Tenant-Context", "value": "{{tenant_context}}" } ], "body": {}, "parameters": [ { "name": "page[size]", "value": "{{page[size]}}", "disabled": true }, { "name": "page[after]", "value": "{{page[after]}}", "disabled": true }, { "name": "policy_id", "value": "{{policy_id}}", "disabled": true }, { "name": "party_id", "value": "{{party_id}}", "disabled": true } ] }, { "_id": "req_axiom_2", "_type": "request", "parentId": "fld_claim", "name": "Get a claim by ID", "description": "Retrieve a single claim with its full details including claim items,\nassessments, payments, and current workflow state.", "method": "GET", "url": "{{ _.base_url }}/v1/claims/{{id}}", "headers": [ { "name": "Authorization", "value": "Bearer {{access_token}}" }, { "name": "X-Correlation-ID", "value": "{{correlation_id}}" }, { "name": "X-Tenant-Context", "value": "{{tenant_context}}" } ], "body": {}, "parameters": [] }, { "_id": "req_axiom_3", "_type": "request", "parentId": "fld_claim", "name": "Assess a claim", "description": "Submit an assessment for a claim. Assessments record the outcome of\ninvestigation and evaluation, including approved amounts and per-item\nassessments.\n\nThe claim must be in \"under_review\" status. After assessment, the claim\ntransitions to \"assessed\" (full approval), \"partial_approval\", or \"denied\".\n\nAutomated rule evaluation results (e.g. fraud scoring) are included in the\nassessment record for audit and explainability.\n\nSide effects: returns the assessment result with the claim status transitioned (under_review to assessed, partial_approval, or denied) without persisting the changes. Emits an audit entry when audit is configured.", "method": "POST", "url": "{{ _.base_url }}/v1/claims/{{id}}/assess", "headers": [ { "name": "Authorization", "value": "Bearer {{access_token}}" }, { "name": "X-Correlation-ID", "value": "{{correlation_id}}" }, { "name": "X-Tenant-Context", "value": "{{tenant_context}}" }, { "name": "Content-Type", "value": "application/json" } ], "body": { "mimeType": "application/json", "text": "{\n \"approved_amount\": {\n \"amount_minor\": 8000000,\n \"currency_code\": \"zar\"\n },\n \"assessed_by\": \"assessor-jvd-001\",\n \"assessment_notes\": \"Site inspection completed. Damage verified against police report and repair quotations from two panel beaters. Approved less R5,000 policy excess.\",\n \"item_assessments\": [\n {\n \"approved_amount\": {\n \"amount_minor\": 5200000,\n \"currency_code\": \"zar\"\n },\n \"item_id\": \"32798e17-3851-562c-b192-f49109f3465d\",\n \"notes\": \"Panel beater quotation verified. Original parts specified.\"\n },\n {\n \"approved_amount\": {\n \"amount_minor\": 2800000,\n \"currency_code\": \"zar\"\n },\n \"item_id\": \"047a5bdd-844c-502f-993a-b05e907ca746\",\n \"notes\": \"Physiotherapy approved per medical protocol for whiplash grade II\"\n }\n ],\n \"metadata\": {\n \"inspection_date\": \"2026-03-06\",\n \"photos_reviewed\": 18\n }\n}" }, "parameters": [] }, { "_id": "req_axiom_4", "_type": "request", "parentId": "fld_claim", "name": "Record a claim authorisation", "description": "Record an governed contract authorisation sub-event against a claim. The row is\nappend-only and carries the authorising actor, authorised scope, budget,\ngoverning-version binding, optional compliance state, decision date, and\nexplanation-node reference.\n\nClaim payments may cite the returned authorisation id. When they do, the\npayment path runs the authorisation compliance gate before disbursement.\n\nSide effects: persists an `authorisation_transitions` row under the\ntenant context and returns the recorded authorisation.", "method": "POST", "url": "{{ _.base_url }}/v1/claims/{{id}}/authorisations", "headers": [ { "name": "Authorization", "value": "Bearer {{access_token}}" }, { "name": "X-Correlation-ID", "value": "{{correlation_id}}" }, { "name": "X-Tenant-Context", "value": "{{tenant_context}}" }, { "name": "Content-Type", "value": "application/json" } ], "body": { "mimeType": "application/json", "text": "{\n \"authorisation_kind\": \"pre-auth\",\n \"authorised_scope\": {\n \"procedure_code\": \"1234\",\n \"visit_limit\": 3\n },\n \"authorising_actor\": \"c6240249-09af-5036-8295-d43ef1b181ea\",\n \"budget_currency_code\": \"zar\",\n \"budget_minor\": 250000,\n \"decision_date\": \"2026-07-06T10:00:00Z\",\n \"explanation_node_id\": \"bef0fb27-f305-55ac-84a3-cf528da03346\",\n \"governing_version_kind\": \"catalogue\",\n \"governing_version_row_id\": \"b1468ab8-97c1-5aa6-aca6-9430e182a5bd\",\n \"transition_kind\": \"authorisation-granted\"\n}" }, "parameters": [] }, { "_id": "req_axiom_5", "_type": "request", "parentId": "fld_claim", "name": "Process a claim payment", "description": "Initiate payment for an assessed claim. The claim must be in \"assessed\"\nor \"partial_approval\" status before payment can be processed.\n\nPayment is recorded against the claim and linked to the billing/payments\nsubsystem. The claim transitions to \"paid\" once the payment is confirmed.\n\nInvalid transitions return HTTP 422 with error code `INVALID_STATE_TRANSITION`.\n\nSide effects: returns the constructed payment record and ledger entries with the claim status transitioned to paid, without persisting the changes. Emits an audit entry when audit is configured.", "method": "POST", "url": "{{ _.base_url }}/v1/claims/{{id}}/pay", "headers": [ { "name": "Authorization", "value": "Bearer {{access_token}}" }, { "name": "X-Correlation-ID", "value": "{{correlation_id}}" }, { "name": "X-Tenant-Context", "value": "{{tenant_context}}" }, { "name": "Content-Type", "value": "application/json" } ], "body": { "mimeType": "application/json", "text": "{\n \"metadata\": {\n \"bank_reference\": \"JPMC-ACH-2026030801\",\n \"beneficiary_account\": \"****4521\",\n \"beneficiary_bank\": \"JPMorgan Chase\"\n },\n \"paid_amount\": {\n \"amount_minor\": 8000000,\n \"currency_code\": \"zar\"\n },\n \"payment_method\": \"bank_transfer\",\n \"payment_notes\": \"Final settlement \\u2014 approved amount less policy excess\",\n \"processed_by\": \"payments-officer-mk-003\"\n}" }, "parameters": [] }, { "_id": "req_axiom_6", "_type": "request", "parentId": "fld_claim", "name": "Close a claim", "description": "Close a claim, marking its lifecycle as complete. Claims can be closed after\npayment has been disbursed, or without payment if denied or withdrawn.\n\nClosing a claim is an irreversible action. Once closed, no further assessments\nor payments can be made against the claim.\n\nThe claim must be in one of: \"paid\", \"denied\", or \"assessed\" status.\n\nInvalid transitions return HTTP 422 with error code `INVALID_STATE_TRANSITION`.\n\nSide effects: persists the claim in closed status; emits an audit entry recording the closure.", "method": "POST", "url": "{{ _.base_url }}/v1/claims/{{id}}/close", "headers": [ { "name": "Authorization", "value": "Bearer {{access_token}}" }, { "name": "X-Correlation-ID", "value": "{{correlation_id}}" }, { "name": "X-Tenant-Context", "value": "{{tenant_context}}" }, { "name": "Content-Type", "value": "application/json" } ], "body": { "mimeType": "application/json", "text": "{\n \"closed_by\": \"claims-manager-001\",\n \"closure_reason\": \"Final settlement disbursed and accepted by claimant\"\n}" }, "parameters": [] }, { "_id": "req_axiom_7", "_type": "request", "parentId": "fld_claim", "name": "Generate a claim PDF report", "description": "Generate a PDF document summarising the claim, including the event details,\nassessment results, payment information, and workflow history.\n\nThe PDF is generated on demand and returned as a binary response. For large\nclaims with extensive documentation, generation may take several seconds.\n\nThe generated PDF includes:\n- Claim header (claim number, policy number, status)\n- Event details and description\n- Claim items with amounts\n- Assessment summary and notes\n- Payment details (if applicable)\n- Workflow timeline\n\nThis endpoint returns binary PDF data (application/pdf), not a JSON envelope.", "method": "GET", "url": "{{ _.base_url }}/v1/claims/{{id}}/pdf", "headers": [ { "name": "Authorization", "value": "Bearer {{access_token}}" }, { "name": "X-Correlation-ID", "value": "{{correlation_id}}" }, { "name": "X-Tenant-Context", "value": "{{tenant_context}}" } ], "body": {}, "parameters": [] }, { "_id": "req_axiom_8", "_type": "request", "parentId": "fld_claim", "name": "Create a claim reserve", "description": "Create a new active reserve for a claim. The amount must be a positive\ninteger in cents. On success the reserve is created with state \"active\",\ncurrent_amount == initial_amount, and released_amount == 0.", "method": "POST", "url": "{{ _.base_url }}/v1/claims/{{id}}/reserves", "headers": [ { "name": "Authorization", "value": "Bearer {{access_token}}" }, { "name": "X-Correlation-ID", "value": "{{correlation_id}}" }, { "name": "X-Tenant-Context", "value": "{{tenant_context}}" }, { "name": "Content-Type", "value": "application/json" } ], "body": { "mimeType": "application/json", "text": "{\n \"amount\": 500000,\n \"reserve_type\": \"case_estimate\"\n}" }, "parameters": [] }, { "_id": "req_axiom_9", "_type": "request", "parentId": "fld_claim", "name": "List reserves for a claim", "description": "Retrieve all reserves for a claim, ordered by established_at descending.\nReturns explanation-ready reserve facts.", "method": "GET", "url": "{{ _.base_url }}/v1/claims/{{id}}/reserves", "headers": [ { "name": "Authorization", "value": "Bearer {{access_token}}" }, { "name": "X-Correlation-ID", "value": "{{correlation_id}}" }, { "name": "X-Tenant-Context", "value": "{{tenant_context}}" } ], "body": {}, "parameters": [] }, { "_id": "req_axiom_10", "_type": "request", "parentId": "fld_claim", "name": "Get a single reserve", "description": "Retrieve a single reserve by ID with explanation-ready facts.", "method": "GET", "url": "{{ _.base_url }}/v1/claims/{{id}}/reserves/{{reserveId}}", "headers": [ { "name": "Authorization", "value": "Bearer {{access_token}}" }, { "name": "X-Correlation-ID", "value": "{{correlation_id}}" }, { "name": "X-Tenant-Context", "value": "{{tenant_context}}" } ], "body": {}, "parameters": [] }, { "_id": "req_axiom_11", "_type": "request", "parentId": "fld_claim", "name": "Update an active reserve", "description": "Only reserves in \"active\" state can be updated.", "method": "PATCH", "url": "{{ _.base_url }}/v1/claims/{{id}}/reserves/{{reserveId}}", "headers": [ { "name": "Authorization", "value": "Bearer {{access_token}}" }, { "name": "X-Correlation-ID", "value": "{{correlation_id}}" }, { "name": "X-Tenant-Context", "value": "{{tenant_context}}" }, { "name": "Content-Type", "value": "application/json" } ], "body": { "mimeType": "application/json", "text": "{\n \"amount\": 600000\n}" }, "parameters": [] }, { "_id": "req_axiom_12", "_type": "request", "parentId": "fld_claim", "name": "Release reserve amount", "description": "Partial release yields \"partially_released\"; full release yields\n\"fully_released\". Over-release returns HTTP 422.", "method": "POST", "url": "{{ _.base_url }}/v1/claims/{{id}}/reserves/{{reserveId}}/release", "headers": [ { "name": "Authorization", "value": "Bearer {{access_token}}" }, { "name": "X-Correlation-ID", "value": "{{correlation_id}}" }, { "name": "X-Tenant-Context", "value": "{{tenant_context}}" }, { "name": "Content-Type", "value": "application/json" } ], "body": { "mimeType": "application/json", "text": "{\n \"amount\": 300000\n}" }, "parameters": [] }, { "_id": "req_axiom_13", "_type": "request", "parentId": "fld_claim", "name": "Cancel an active reserve", "description": "Only reserves in \"active\" state can be cancelled. Returns inactive\nreserve with zero remaining exposure.", "method": "POST", "url": "{{ _.base_url }}/v1/claims/{{id}}/reserves/{{reserveId}}/cancel", "headers": [ { "name": "Authorization", "value": "Bearer {{access_token}}" }, { "name": "X-Correlation-ID", "value": "{{correlation_id}}" }, { "name": "X-Tenant-Context", "value": "{{tenant_context}}" }, { "name": "Content-Type", "value": "application/json" } ], "body": { "mimeType": "application/json", "text": "{\n \"reason\": \"string\"\n}" }, "parameters": [] }, { "_id": "req_axiom_14", "_type": "request", "parentId": "fld_claim", "name": "Re-establish a terminal reserve", "description": "Create a new active reserve linked to a terminal predecessor.\nRe-establishment from \"active\" or \"partially_released\" is rejected.", "method": "POST", "url": "{{ _.base_url }}/v1/claims/{{id}}/reserves/{{reserveId}}/reestablish", "headers": [ { "name": "Authorization", "value": "Bearer {{access_token}}" }, { "name": "X-Correlation-ID", "value": "{{correlation_id}}" }, { "name": "X-Tenant-Context", "value": "{{tenant_context}}" }, { "name": "Content-Type", "value": "application/json" } ], "body": { "mimeType": "application/json", "text": "{\n \"amount\": 750000\n}" }, "parameters": [] }, { "_id": "req_axiom_15", "_type": "request", "parentId": "fld_claim", "name": "List reserves by policy", "description": "policy_id query parameter is required.", "method": "GET", "url": "{{ _.base_url }}/v1/claims/reserves", "headers": [ { "name": "Authorization", "value": "Bearer {{access_token}}" }, { "name": "X-Correlation-ID", "value": "{{correlation_id}}" }, { "name": "X-Tenant-Context", "value": "{{tenant_context}}" } ], "body": {}, "parameters": [ { "name": "policy_id", "value": "{{policy_id}}", "disabled": true }, { "name": "active_only", "value": "{{active_only}}", "disabled": true } ] }, { "_id": "req_axiom_16", "_type": "request", "parentId": "fld_claim", "name": "Create or advance an SIU investigation", "description": "Create a new SIU investigation on a claim, or advance an existing open\ninvestigation by exactly one state. The endpoint uses create-or-advance\nsemantics: the first POST with `target_state=assigned` creates the\ninvestigation (HTTP 201); subsequent POSTs advance the open investigation\n(HTTP 200).\n\nState machine: assigned \u2192 investigating \u2192 findings_submitted \u2192 closed.\nDisposition (substantiated|unsubstantiated|settled) is required only when\n`target_state=closed`.\n\n`settled` closes the SIU investigation only \u2014 it does not change claim\nstatus, create recovery, or affect normal adjudication.\n\nEvery transition persists immutable evidence and an explanation tree in the\nsame transaction (governed contract). Actor provenance is sourced\nfrom the authenticated request context (governed contract).", "method": "POST", "url": "{{ _.base_url }}/v1/claims/{{id}}/investigations", "headers": [ { "name": "Authorization", "value": "Bearer {{access_token}}" }, { "name": "X-Correlation-ID", "value": "{{correlation_id}}" }, { "name": "X-Tenant-Context", "value": "{{tenant_context}}" }, { "name": "Content-Type", "value": "application/json" } ], "body": { "mimeType": "application/json", "text": "{\n \"assigned_party_id\": \"party-siu-001\",\n \"assigned_role_type\": \"siu_investigator\",\n \"evidence_refs\": [\n \"ev-fraud-score-001\"\n ],\n \"fraud_rule_refs\": [\n \"rule-velocity-001\",\n \"rule-amount-002\"\n ],\n \"reason\": \"Fraud score 0.87 exceeded investigation threshold\",\n \"target_state\": \"assigned\",\n \"trigger_source\": \"rule_threshold\"\n}" }, "parameters": [] }, { "_id": "req_axiom_17", "_type": "request", "parentId": "fld_claim", "name": "Record a recovery event for a claim", "description": "Records a subrogation or salvage recovery event with balanced ledger posting,\nexplanation tree, and evidence \u2014 all atomically in a single transaction.\nRequires X-Tenant-Context and Idempotency-Key headers.", "method": "POST", "url": "{{ _.base_url }}/v1/claims/{{claimId}}/recoveries", "headers": [ { "name": "Authorization", "value": "Bearer {{access_token}}" }, { "name": "X-Correlation-ID", "value": "{{correlation_id}}" }, { "name": "X-Tenant-Context", "value": "{{tenant_context}}" }, { "name": "Content-Type", "value": "application/json" } ], "body": { "mimeType": "application/json", "text": "{\n \"amount\": \"5000000\",\n \"currency\": \"USD\",\n \"evidence_refs\": [\n \"ev-settlement-001\",\n \"ev-police-report-042\"\n ],\n \"reason\": \"Third party liability established via settlement agreement\",\n \"received_at\": \"2026-03-15T10:30:00Z\",\n \"recovery_type\": \"subrogation\"\n}" }, "parameters": [] }, { "_id": "req_axiom_18", "_type": "request", "parentId": "fld_claim", "name": "Record a correction for a recovery event", "description": "Creates a correction (full reversal, partial reversal, or write-off) for an\nexisting recovery using compensating ledger entries. Never deletes or updates\noriginal entries (governed contract). Requires X-Tenant-Context and Idempotency-Key headers.", "method": "POST", "url": "{{ _.base_url }}/v1/claims/{{claimId}}/recoveries/{{recoveryId}}/corrections", "headers": [ { "name": "Authorization", "value": "Bearer {{access_token}}" }, { "name": "X-Correlation-ID", "value": "{{correlation_id}}" }, { "name": "X-Tenant-Context", "value": "{{tenant_context}}" }, { "name": "Content-Type", "value": "application/json" } ], "body": { "mimeType": "application/json", "text": "{\n \"correction_type\": \"full_reversal\",\n \"effective_at\": \"2026-03-18T14:00:00Z\",\n \"evidence_refs\": [\n \"ev-rescission-notice-001\"\n ],\n \"reason\": \"Recovery recorded in error \\u2014 settlement rescinded\"\n}" }, "parameters": [] } ] }