> ## Documentation Index
> Fetch the complete documentation index at: https://docs.heyrafiki.space/llms.txt
> Use this file to discover all available pages before exploring further.

# Submit Claim evidence

> Fulfils an open information request and resubmits the Claim. Requires `claims:write`.



## OpenAPI

````yaml /openapi/heyrafiki.openapi.yaml post /claims/{claim_id}/evidence
openapi: 3.1.0
info:
  title: Heyrafiki API
  version: 1.0.0
  description: Build Care, Cover and Payment workflows on Heyrafiki.
  contact:
    name: Heyrafiki
    url: https://heyrafiki.space
    email: developers@heyrafiki.space
  license:
    name: All rights reserved
    identifier: LicenseRef-Heyrafiki-Proprietary
servers:
  - url: https://api.heyrafiki.space/v1
security:
  - bearerAuth: []
  - apiKeyAuth: []
paths:
  /claims/{claim_id}/evidence:
    post:
      summary: Submit Claim evidence
      description: >-
        Fulfils an open information request and resubmits the Claim. Requires
        `claims:write`.
      operationId: submitClaimEvidence
      parameters:
        - $ref: '#/components/parameters/ClaimId'
        - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClaimEvidenceInput'
      responses:
        '200':
          description: The Claim was resubmitted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Claim'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
components:
  parameters:
    ClaimId:
      name: claim_id
      in: path
      required: true
      description: A public Claim identifier.
      schema:
        type: string
        maxLength: 100
        pattern: ^clm_[A-Za-z0-9_-]+$
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      required: true
      description: A caller-owned key for safely retrying one write.
      schema:
        type: string
        minLength: 8
        maxLength: 255
  schemas:
    ClaimEvidenceInput:
      type: object
      additionalProperties: false
      required:
        - information_request_id
        - evidence_refs
      properties:
        information_request_id:
          type: string
          pattern: ^cir_[A-Za-z0-9_-]+$
        evidence_refs:
          allOf:
            - $ref: '#/components/schemas/EvidenceReferences'
            - minItems: 1
    Claim:
      type: object
      additionalProperties: false
      required:
        - id
        - object
        - status
        - provider_claim_reference
        - submission_version
        - amount
        - service_period
        - lines
        - information_requests
        - adjudication
        - submitted_at
        - updated_at
      properties:
        id:
          type: string
          maxLength: 100
          pattern: ^clm_[A-Za-z0-9_-]+$
        object:
          type: string
          const: claim
        status:
          type: string
          enum:
            - draft
            - submitted
            - queried
            - approved
            - partially_approved
            - denied
            - settled
            - reversed
            - cancelled
        provider_claim_reference:
          type:
            - string
            - 'null'
        submission_version:
          type: integer
          minimum: 1
        amount:
          type: object
          additionalProperties: false
          required:
            - currency
            - billed
            - approved
            - settled
          properties:
            currency:
              type: string
              pattern: ^[A-Z]{3}$
            billed:
              type: integer
              minimum: 0
            approved:
              type:
                - integer
                - 'null'
              minimum: 0
            settled:
              type:
                - integer
                - 'null'
              minimum: 0
        service_period:
          type: object
          additionalProperties: false
          required:
            - starts_at
            - ends_at
          properties:
            starts_at:
              type: string
              format: date-time
            ends_at:
              type: string
              format: date-time
        lines:
          type: array
          items:
            $ref: '#/components/schemas/ClaimLine'
        information_requests:
          type: array
          items:
            $ref: '#/components/schemas/ClaimInformationRequest'
        adjudication:
          oneOf:
            - $ref: '#/components/schemas/ClaimAdjudication'
            - type: 'null'
        submitted_at:
          type:
            - string
            - 'null'
          format: date-time
        updated_at:
          type: string
          format: date-time
    EvidenceReferences:
      type: array
      maxItems: 32
      items:
        type: string
        minLength: 3
        maxLength: 200
        pattern: ^[A-Za-z][A-Za-z0-9:_-]+$
    ClaimLine:
      type: object
      additionalProperties: false
      required:
        - line_number
        - code_system
        - code_system_version
        - service_code
        - units
        - amount
      properties:
        line_number:
          type: integer
          minimum: 1
        code_system:
          type: string
        code_system_version:
          type:
            - string
            - 'null'
        service_code:
          type: string
        units:
          type: number
          exclusiveMinimum: 0
        amount:
          type: integer
          minimum: 1
    ClaimInformationRequest:
      type: object
      additionalProperties: false
      required:
        - id
        - object
        - reason_code
        - requested_evidence_types
        - status
        - due_at
        - created_at
        - resolved_at
      properties:
        id:
          type: string
          pattern: ^cir_[A-Za-z0-9_-]+$
        object:
          type: string
          const: claim_information_request
        reason_code:
          type: string
        requested_evidence_types:
          type: array
          items:
            type: string
        status:
          type: string
          enum:
            - open
            - fulfilled
            - cancelled
        due_at:
          type:
            - string
            - 'null'
          format: date-time
        created_at:
          type: string
          format: date-time
        resolved_at:
          type:
            - string
            - 'null'
          format: date-time
    ClaimAdjudication:
      type: object
      additionalProperties: false
      required:
        - id
        - object
        - version
        - decision
        - amount
        - reason_codes
        - policy
        - lines
        - decided_at
      properties:
        id:
          type: string
          pattern: ^adj_[A-Za-z0-9_-]+$
        object:
          type: string
          const: claim_adjudication
        version:
          type: integer
          minimum: 1
        decision:
          type: string
          enum:
            - approved
            - partially_approved
            - denied
        amount:
          type: object
          additionalProperties: false
          required:
            - currency
            - billed
            - payer
            - patient_responsibility
            - adjustment
          properties:
            currency:
              type: string
              pattern: ^[A-Z]{3}$
            billed:
              type: integer
              minimum: 1
            payer:
              type: integer
              minimum: 0
            patient_responsibility:
              type: integer
              minimum: 0
            adjustment:
              type: integer
              minimum: 0
        reason_codes:
          type: array
          items:
            type: string
        policy:
          type: object
          additionalProperties: false
          required:
            - reference
            - version
          properties:
            reference:
              type: string
            version:
              type: string
        lines:
          type: array
          items:
            $ref: '#/components/schemas/ClaimAdjudicationLine'
        decided_at:
          type: string
          format: date-time
    ErrorEnvelope:
      type: object
      additionalProperties: false
      required:
        - error
      properties:
        error:
          type: object
          additionalProperties: false
          required:
            - code
            - message
            - docs
          properties:
            code:
              type: string
            message:
              type: string
            docs:
              type: string
              format: uri
    ClaimAdjudicationLine:
      type: object
      additionalProperties: false
      required:
        - line_number
        - amount
        - reason_codes
      properties:
        line_number:
          type: integer
          minimum: 1
        amount:
          type: object
          additionalProperties: false
          required:
            - billed
            - allowed
            - payer
            - patient_responsibility
            - adjustment
          properties:
            billed:
              type: integer
              minimum: 1
            allowed:
              type: integer
              minimum: 0
            payer:
              type: integer
              minimum: 0
            patient_responsibility:
              type: integer
              minimum: 0
            adjustment:
              type: integer
              minimum: 0
        reason_codes:
          type: array
          minItems: 1
          maxItems: 16
          items:
            type: string
            pattern: ^[a-z0-9_]+$
  responses:
    BadRequest:
      description: The request failed validation.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    Unauthorized:
      description: The API key is missing or invalid.
      headers:
        WWW-Authenticate:
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    Forbidden:
      description: The API key does not permit this operation.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    NotFound:
      description: The requested resource does not exist or is not visible to this project.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    Conflict:
      description: The request conflicts with current state.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    TooManyRequests:
      description: The project exceeded its request limit.
      headers:
        Retry-After:
          description: Seconds until another request should be attempted.
          schema:
            type: integer
        X-RateLimit-Limit:
          $ref: '#/components/headers/RateLimitLimit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/RateLimitRemaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/RateLimitReset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    ServiceUnavailable:
      description: The service is temporarily unavailable.
      headers:
        Retry-After:
          schema:
            type: integer
            example: 5
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
  headers:
    RateLimitLimit:
      description: Maximum requests allowed in the current minute.
      schema:
        type: integer
    RateLimitRemaining:
      description: Requests remaining in the current minute.
      schema:
        type: integer
    RateLimitReset:
      description: Unix timestamp when the current limit resets.
      schema:
        type: integer
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: A sandbox or production secret key.
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: An alternative for clients that cannot set Authorization.

````