> ## 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.

# Clause Maps

> **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/clause-maps
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/clause-maps:
    get:
      tags:
        - Regulatory
      summary: Clause Maps
      description: >-
        **Who may call it:** any role. A workspace API key is refused here: this
        is an act that belongs to a named person.
      operationId: clause_maps_v1_clause_maps_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClauseMapsOut'
      security:
        - bearerToken: []
components:
  schemas:
    ClauseMapsOut:
      properties:
        clause_maps:
          items:
            $ref: '#/components/schemas/ClauseMapOut'
          type: array
          title: Clause Maps
      type: object
      required:
        - clause_maps
      title: ClauseMapsOut
    ClauseMapOut:
      properties:
        key:
          type: string
          title: Key
        jurisdiction:
          type: string
          title: Jurisdiction
        regulator:
          type: string
          title: Regulator
        instrument:
          type: string
          title: Instrument
        instrument_ref:
          anyOf:
            - type: string
            - type: 'null'
          title: Instrument Ref
        version:
          type: string
          title: Version
        status:
          type: string
          title: Status
        source_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Source Url
        accepted_by_customer:
          type: boolean
          title: Accepted By Customer
        accepted_by:
          anyOf:
            - type: string
            - type: 'null'
          title: Accepted By
        accepted_on:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Accepted On
        caveat:
          anyOf:
            - type: string
            - type: 'null'
          title: Caveat
        clauses:
          type: integer
          title: Clauses
        by_provenance:
          additionalProperties:
            type: integer
          type: object
          title: By Provenance
      type: object
      required:
        - key
        - jurisdiction
        - regulator
        - instrument
        - version
        - status
        - accepted_by_customer
        - clauses
        - by_provenance
      title: ClauseMapOut
      description: >-
        One regulatory instrument we claim to map, and how far we stand behind
        it.
  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.