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

# Assurance File

> One document showing everything a named person authorised, and whether
the bounds held.

**Who may call it:** any role. A workspace API key is refused here: this is an act that belongs to a named person.



## OpenAPI

````yaml /api/openapi.json get /v1/assurance-file
openapi: 3.1.0
info:
  title: RotaGrant API
  version: 0.1.0
  description: >-
    The HTTP API of a RotaGrant deployment, made from the product's own route
    definitions at the commit named in `x-rotascale-source`. Nothing here is
    written by hand.


    There is no shared endpoint. RotaGrant runs in your environment, and your
    deployment serves its own copy of this description at `/api/docs`. That copy
    is the authority on what your version has and which features are switched
    on; this one is the reference for one commit of the main line. The version
    is 0.1.0: routes and shapes can still change.


    Every route says who may call it. Most need a bearer token from the identity
    provider your deployment uses, held by a person with the role named. The
    routes an SDK calls also accept a workspace API key. A few are open, and say
    why.
servers:
  - url: https://{deployment}
    description: Your own deployment. There is no shared endpoint.
    variables:
      deployment:
        default: rotagrant.internal.example
        description: The host your deployment answers on.
security: []
paths:
  /v1/assurance-file:
    get:
      tags:
        - Authority
      summary: Assurance File
      description: >-
        One document showing everything a named person authorised, and whether

        the bounds held.


        **Who may call it:** any role. A workspace API key is refused here: this
        is an act that belongs to a named person.
      operationId: assurance_file_v1_assurance_file_get
      parameters:
        - name: subject
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Subject
        - name: days
          in: query
          required: false
          schema:
            type: integer
            default: 90
            title: Days
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssuranceFileOut'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - bearerToken: []
components:
  schemas:
    AssuranceFileOut:
      properties:
        subject:
          type: string
          title: Subject
        period:
          additionalProperties: true
          type: object
          title: Period
        regime:
          anyOf:
            - $ref: '#/components/schemas/RegimeDisclosureOut'
            - type: 'null'
        headline:
          type: string
          title: Headline
        summary:
          additionalProperties:
            type: integer
          type: object
          title: Summary
        authorities:
          items:
            $ref: '#/components/schemas/AuthorityAssuranceOut'
          type: array
          title: Authorities
        disclaimer:
          additionalProperties: true
          type: object
          title: Disclaimer
        assurance_note:
          type: string
          title: Assurance Note
      type: object
      required:
        - subject
        - period
        - headline
        - summary
        - authorities
        - disclaimer
        - assurance_note
      title: AssuranceFileOut
      description: 'One named manager, one period: what they authorised and what held.'
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    RegimeDisclosureOut:
      properties:
        code:
          type: string
          title: Code
        name:
          type: string
          title: Name
        applies:
          items:
            type: string
          type: array
          title: Applies
          default: []
        resolved_from:
          type: string
          title: Resolved From
        requires_second_approver_above_minor:
          anyOf:
            - type: integer
            - type: 'null'
          title: Requires Second Approver Above Minor
        second_approver_currency:
          anyOf:
            - type: string
            - type: 'null'
          title: Second Approver Currency
        forbids:
          additionalProperties:
            type: string
          type: object
          title: Forbids
          default: {}
        assessed_against:
          type: string
          title: Assessed Against
      type: object
      required:
        - code
        - name
        - resolved_from
        - assessed_against
      title: RegimeDisclosureOut
      description: Which law an artefact was produced under, and what it required.
    AuthorityAssuranceOut:
      properties:
        grant_id:
          type: string
          title: Grant Id
        agent_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Agent Id
        signed_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Signed At
        error:
          anyOf:
            - type: string
            - type: 'null'
          title: Error
        authorised:
          anyOf:
            - $ref: '#/components/schemas/AuthorisedBoundsOut'
            - type: 'null'
        attestation:
          anyOf:
            - $ref: '#/components/schemas/AttestationCheckOut'
            - type: 'null'
        held:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Held
        decisions:
          additionalProperties: true
          type: object
          title: Decisions
          default: {}
        findings:
          items:
            $ref: '#/components/schemas/AssuranceFindingOut'
          type: array
          title: Findings
          default: []
      type: object
      required:
        - grant_id
      title: AuthorityAssuranceOut
      description: 'One authority in the assurance file: what was signed, and what held.'
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    AuthorisedBoundsOut:
      properties:
        scope:
          additionalProperties:
            items:
              type: string
            type: array
          type: object
          title: Scope
          default: {}
        budget_amount_minor:
          anyOf:
            - type: integer
            - type: 'null'
          title: Budget Amount Minor
        budget_currency:
          anyOf:
            - type: string
            - type: 'null'
          title: Budget Currency
        budget_count:
          anyOf:
            - type: integer
            - type: 'null'
          title: Budget Count
        not_after:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Not After
        conditions:
          additionalProperties: true
          type: object
          title: Conditions
          default: {}
        enforcement_mode:
          anyOf:
            - type: string
            - type: 'null'
          title: Enforcement Mode
      type: object
      title: AuthorisedBoundsOut
      description: What the manager actually signed for, on one grant.
    AttestationCheckOut:
      properties:
        signature_valid:
          type: boolean
          title: Signature Valid
        matches_grant:
          type: boolean
          title: Matches Grant
        signed_by_platform:
          type: boolean
          title: Signed By Platform
      type: object
      required:
        - signature_valid
        - matches_grant
        - signed_by_platform
      title: AttestationCheckOut
      description: Whether the signature still describes this grant.
    AssuranceFindingOut:
      properties:
        kind:
          type: string
          title: Kind
        severity:
          type: string
          title: Severity
        detail:
          type: string
          title: Detail
      type: object
      required:
        - kind
        - severity
        - detail
      title: AssuranceFindingOut
  securitySchemes:
    bearerToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        A token from the identity provider your deployment federates with. It
        identifies a person; their roles in the workspace decide what they may
        do.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.