> ## Documentation Index > Fetch the complete documentation index at: https://docs.canary.effectiveai.app/llms.txt > Use this file to discover all available pages before exploring further. # List saved loss matters > Read matters in fixed request order, including pending and failed items. Completed items are immutable and remain readable after a run fails. Poll pending pages again for updates. Keep id and limit unchanged when continuing. Free. ## OpenAPI ````yaml /openapi.json get /insurance/loss-reviews/{id}/items openapi: 3.0.3 info: title: Effective API version: 2.0.0 description: The public Effective REST API. Authenticate using an Effective API key. servers: - url: https://api.canary.effectiveai.app/api/v2 description: Canary security: - bearerAuth: [] paths: /insurance/loss-reviews/{id}/items: get: tags: - Loss reviews summary: List saved loss matters description: >- Read matters in fixed request order, including pending and failed items. Completed items are immutable and remain readable after a run fails. Poll pending pages again for updates. Keep id and limit unchanged when continuing. Free. operationId: listLossReviewItems parameters: - schema: type: string description: Loss review UUID returned by createLossReview. required: true description: Loss review UUID returned by createLossReview. name: id in: path - schema: type: integer minimum: 1 maximum: 50 default: 10 required: false name: limit in: query - schema: type: string minLength: 1 maxLength: 8192 description: >- Opaque nextCursor from this operation. Repeat every other query parameter unchanged; a cursor from a different query returns invalid_cursor. required: false description: >- Opaque nextCursor from this operation. Repeat every other query parameter unchanged; a cursor from a different query returns invalid_cursor. name: cursor in: query responses: '200': description: One page of independently saved matters. content: application/json: schema: $ref: '#/components/schemas/V2LossReviewItems' '400': description: invalid_request or invalid_cursor. content: application/json: schema: $ref: '#/components/schemas/V2CodedError' '401': description: 'unauthenticated: credentials required.' content: application/json: schema: $ref: '#/components/schemas/V2CodedError' '403': description: >- feature_not_enabled or forbidden: requires loss reviews and a member credential; app-scoped and delegated credentials cannot access it. content: application/json: schema: $ref: '#/components/schemas/V2CodedError' '404': description: 'not_found: review missing, deleted or inputs inaccessible.' content: application/json: schema: $ref: '#/components/schemas/V2CodedError' '500': description: 'internal_error: unexpected server error.' content: application/json: schema: $ref: '#/components/schemas/V2CodedError' '503': description: 'temporarily_unavailable: retry after Retry-After seconds.' headers: Retry-After: required: true schema: type: integer minimum: 0 description: Seconds to wait before retrying. content: application/json: schema: $ref: '#/components/schemas/V2CodedError' security: - bearerAuth: [] components: schemas: V2LossReviewItems: type: object properties: items: type: array items: $ref: '#/components/schemas/V2LossReviewItem' nextCursor: type: string nullable: true description: Cursor for the next page, or null on the last page. required: - items - nextCursor V2CodedError: allOf: - $ref: '#/components/schemas/V2Error' - type: object properties: code: type: string minLength: 1 description: Stable error code. Clients must tolerate unknown future codes. details: type: array items: type: object properties: location: type: string enum: - path - query - header - body path: type: array items: type: string maxLength: 64 maxItems: 12 code: type: string enum: - required - invalid_type - invalid_value - unknown_field message: type: string minLength: 1 maxLength: 200 required: - location - path - code - message minItems: 1 maxItems: 20 description: Bounded safe validation issues; may omit some invalid fields. requestId: type: string minLength: 1 maxLength: 128 description: >- Existing server correlation for this HTTP attempt, when available. dataset: type: string enum: - naic - osha description: Dataset needed for dataset_not_enabled. businessCode: type: string description: The rater’s own refusal code, for business_rejection. violations: type: array items: type: object properties: code: type: string description: Authored or built-in constraint code message: type: string description: Authored message for the failed constraint path: type: string description: Input path of the offending value; empty for the request value: nullable: true description: Offending input value, size-bounded by the runtime constraint: type: string description: The constraint the value failed, as text cite: type: string nullable: true description: >- Filing citation of the constraint, when the source cites one required: - code - message - path - value - constraint - cite additionalProperties: false maxItems: 256 description: >- Each input constraint the submission failed, for invalid_inputs and business_rejection. violationsTruncated: type: boolean description: >- True when the rater reported more violations than violations holds. accessUrl: type: string nullable: true format: uri description: >- Where to add the product to your account, for product_access_required. required: - code V2LossReviewItem: oneOf: - type: object properties: matterId: type: string label: type: string nullable: true status: type: string enum: - pending required: - matterId - label - status - type: object properties: matterId: type: string label: type: string nullable: true status: type: string enum: - succeeded result: $ref: '#/components/schemas/V2LossReviewItemResult' required: - matterId - label - status - result - type: object properties: matterId: type: string label: type: string nullable: true status: type: string enum: - failed failure: type: object properties: code: type: string error: type: string required: - code - error required: - matterId - label - status - failure V2Error: type: object properties: error: type: string minLength: 1 description: Human-readable explanation of the failure. required: - error V2LossReviewItemResult: type: object properties: matterId: type: string pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]{0,63}$ summary: type: string minLength: 1 maxLength: 8000 identity: type: object properties: status: type: string enum: - resolved - unresolved explanation: type: string minLength: 1 maxLength: 4000 referenceIds: type: array items: type: string pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]{0,63}$ minItems: 1 maxItems: 100 description: >- Supporting reference IDs; incident facts require loss evidence, not knowledge or reviewer notes. required: - status - explanation - referenceIds additionalProperties: false lossAccount: type: object properties: parties: type: array items: type: object properties: id: type: string pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]{0,63}$ role: type: string minLength: 1 maxLength: 200 text: type: string minLength: 1 maxLength: 4000 status: type: string enum: - reported - alleged - inferred referenceIds: type: array items: type: string pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]{0,63}$ minItems: 1 maxItems: 100 description: >- Supporting reference IDs; incident facts require loss evidence, not knowledge or reviewer notes. required: - id - role - text - status - referenceIds additionalProperties: false maxItems: 50 events: type: array items: type: object properties: id: type: string pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]{0,63}$ date: type: string nullable: true format: date partyIds: type: array items: type: string pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]{0,63}$ maxItems: 100 text: type: string minLength: 1 maxLength: 4000 status: type: string enum: - reported - alleged - inferred referenceIds: type: array items: type: string pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]{0,63}$ minItems: 1 maxItems: 100 description: >- Supporting reference IDs; incident facts require loss evidence, not knowledge or reviewer notes. required: - id - date - partyIds - text - status - referenceIds additionalProperties: false maxItems: 100 claims: type: array items: type: object properties: id: type: string pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]{0,63}$ eventIds: type: array items: type: string pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]{0,63}$ minItems: 1 maxItems: 100 claimantIds: type: array items: type: string pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]{0,63}$ maxItems: 100 identifiers: type: array items: type: object properties: system: type: string minLength: 1 maxLength: 200 value: type: string minLength: 1 maxLength: 200 required: - system - value additionalProperties: false maxItems: 20 text: type: string minLength: 1 maxLength: 4000 status: type: string enum: - reported - alleged - inferred referenceIds: type: array items: type: string pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]{0,63}$ minItems: 1 maxItems: 100 description: >- Supporting reference IDs; incident facts require loss evidence, not knowledge or reviewer notes. required: - id - eventIds - claimantIds - identifiers - text - status - referenceIds additionalProperties: false maxItems: 100 financialObservations: type: array items: $ref: '#/components/schemas/V2LossFinancialObservation' maxItems: 200 required: - parties - events - claims - financialObservations additionalProperties: false classifications: type: array items: type: object properties: id: type: string pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]{0,63}$ subjectId: type: string pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]{0,63}$ dimension: type: string minLength: 1 maxLength: 200 originalLabel: type: string nullable: true minLength: 1 maxLength: 300 knowledgeInputId: type: string pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]{0,63}$ conceptId: type: string minLength: 1 maxLength: 200 mapping: type: string enum: - equivalent - broader - narrower - overlapping - unresolved explanation: type: string minLength: 1 maxLength: 4000 referenceIds: type: array items: type: string pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]{0,63}$ minItems: 1 maxItems: 100 description: >- Supporting reference IDs; incident facts require loss evidence, not knowledge or reviewer notes. required: - id - subjectId - dimension - originalLabel - knowledgeInputId - conceptId - mapping - explanation - referenceIds additionalProperties: false maxItems: 200 findings: type: array items: type: object properties: id: type: string pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]{0,63}$ kind: type: string enum: - observation - inference - hypothesis text: type: string minLength: 1 maxLength: 4000 subjectIds: type: array items: type: string pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]{0,63}$ minItems: 1 maxItems: 100 referenceIds: type: array items: type: string pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]{0,63}$ minItems: 1 maxItems: 100 description: >- Supporting reference IDs; incident facts require loss evidence, not knowledge or reviewer notes. implication: type: string nullable: true minLength: 1 maxLength: 4000 required: - id - kind - text - subjectIds - referenceIds - implication additionalProperties: false maxItems: 100 productAssessments: type: array items: type: object properties: id: type: string pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]{0,63}$ proposition: type: string minLength: 1 maxLength: 1000 subjectIds: type: array items: type: string pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]{0,63}$ minItems: 1 maxItems: 100 assessments: type: array items: type: object properties: variant: type: string pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]{0,63}$ status: type: string enum: - supported - not_supported - conditional - undetermined text: type: string minLength: 1 maxLength: 4000 referenceIds: type: array items: type: string pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]{0,63}$ minItems: 1 maxItems: 100 description: >- Supporting reference IDs; incident facts require loss evidence, not knowledge or reviewer notes. gapIds: type: array items: type: string pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]{0,63}$ maxItems: 100 required: - variant - status - text - referenceIds - gapIds additionalProperties: false required: - id - proposition - subjectIds - assessments additionalProperties: false maxItems: 50 questions: type: array items: type: object properties: id: type: string pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]{0,63}$ question: type: string minLength: 1 maxLength: 2000 changes: type: string minLength: 1 maxLength: 2000 evidenceNeeded: type: string minLength: 1 maxLength: 2000 findingIds: type: array items: type: string pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]{0,63}$ maxItems: 100 required: - id - question - changes - evidenceNeeded - findingIds additionalProperties: false maxItems: 50 gaps: type: array items: type: object properties: id: type: string pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]{0,63}$ text: type: string minLength: 1 maxLength: 2000 limits: type: string minLength: 1 maxLength: 2000 needed: type: string minLength: 1 maxLength: 2000 subjectIds: type: array items: type: string pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]{0,63}$ maxItems: 100 required: - id - text - limits - needed - subjectIds additionalProperties: false maxItems: 100 proposedTests: type: array items: type: object properties: id: type: string pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]{0,63}$ hypothetical: type: boolean enum: - true facts: type: string minLength: 1 maxLength: 4000 question: type: string minLength: 1 maxLength: 2000 findingIds: type: array items: type: string pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]{0,63}$ minItems: 1 maxItems: 100 required: - id - hypothetical - facts - question - findingIds additionalProperties: false maxItems: 10 default: [] description: Proposed boundary tests, excluded from observed experience. annotationResponses: type: array items: type: object properties: annotationId: type: string pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]{0,63}$ status: type: string enum: - addressed - needs_context - target_not_found description: >- target_not_found when the annotation target is not in the input. text: type: string minLength: 1 maxLength: 4000 findingIds: type: array items: type: string pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]{0,63}$ maxItems: 50 description: IDs of related findings. referenceIds: type: array items: type: string pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]{0,63}$ maxItems: 50 description: IDs of entries in references that support this text. required: - annotationId - status - text - findingIds - referenceIds additionalProperties: false maxItems: 50 description: One per supplied annotation. references: type: array items: $ref: '#/components/schemas/V2FormComparisonReference' report: type: string required: - matterId - summary - identity - lossAccount - classifications - findings - productAssessments - questions - gaps - annotationResponses - references - report additionalProperties: false V2LossFinancialObservation: type: object properties: id: type: string pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]{0,63}$ subjectId: type: string pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]{0,63}$ description: A claim or event ID, never a party. originalLabel: type: string minLength: 1 maxLength: 300 measure: type: string enum: - indemnity_paid - expense_paid - indemnity_reserve - expense_reserve - indemnity_incurred - expense_incurred - reported_incurred - recoveries - other amountMinor: type: string pattern: ^-?\d{1,15}$ description: >- Integer minor units, e.g. USD 120.00 = "12000". Preserve original label; do not invent a currency. currency: type: string nullable: true pattern: ^[A-Z]{3}$ valuationDate: type: string nullable: true format: date basis: type: string enum: - cumulative - period - unknown grossNet: type: string enum: - gross - net - unknown expenseTreatment: type: string enum: - included - excluded - separate - unknown referenceIds: type: array items: type: string pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]{0,63}$ minItems: 1 maxItems: 100 description: >- Supporting reference IDs; incident facts require loss evidence, not knowledge or reviewer notes. required: - id - subjectId - originalLabel - measure - amountMinor - currency - valuationDate - basis - grossNet - expenseTreatment - referenceIds additionalProperties: false V2FormComparisonReference: oneOf: - $ref: '#/components/schemas/V2FormComparisonDocumentReference' - $ref: '#/components/schemas/V2FormComparisonKnowledgeReference' - $ref: '#/components/schemas/V2FormComparisonAnnotationReference' discriminator: propertyName: type mapping: document: '#/components/schemas/V2FormComparisonDocumentReference' knowledge: '#/components/schemas/V2FormComparisonKnowledgeReference' annotation: '#/components/schemas/V2FormComparisonAnnotationReference' V2FormComparisonDocumentReference: type: object properties: id: type: string type: type: string enum: - document inputId: type: string description: Cited input ID. scope: type: string enum: - passage - document description: >- passage: cites text. document: reports an absence; page is null and quote is empty. fileId: type: string description: Cited file UUID. versionId: anyOf: - type: string format: uuid - type: string maxLength: 8192 pattern: ^lv1\.[A-Za-z0-9_.-]+$ description: 'Pinned file version: UUID or lv1. token.' page: type: integer nullable: true minimum: 1 description: One-based extracted page, or null. quote: type: string description: Matched passage if verified; otherwise a page excerpt or empty. verified: type: boolean description: Whether the quote matches the pinned page text. downloadUrl: type: string description: Authenticated download path for the pinned version. webUrl: type: string format: uri description: Link to the cited page in the file viewer. required: - id - type - inputId - scope - fileId - versionId - page - quote - verified - downloadUrl - webUrl V2FormComparisonKnowledgeReference: type: object properties: id: type: string type: type: string enum: - knowledge inputId: type: string entryId: type: string description: 'Knowledge ID: namespace:local-id.' required: - id - type - inputId - entryId description: Knowledge context, not policy evidence. V2FormComparisonAnnotationReference: type: object properties: id: type: string type: type: string enum: - annotation inputId: type: string annotationId: type: string required: - id - type - inputId - annotationId description: Reviewer claim, not evidence. securitySchemes: bearerAuth: type: http scheme: bearer description: 'Effective API key. Send Authorization: Bearer sk-eai-...' ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.