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

# Candidate

> Everything known about this agent, and what it would take to clear it.

**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/agents/{agent_id}/certification
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/agents/{agent_id}/certification:
    get:
      tags:
        - Certification
      summary: Candidate
      description: >-
        Everything known about this agent, and what it would take to clear it.


        **Who may call it:** any role. A workspace API key is refused here: this
        is an act that belongs to a named person.
      operationId: candidate_v1_agents__agent_id__certification_get
      parameters:
        - name: agent_id
          in: path
          required: true
          schema:
            type: string
            title: Agent Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CandidateOut'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - bearerToken: []
components:
  schemas:
    CandidateOut:
      properties:
        agent_id:
          type: string
          title: Agent Id
        agent_name:
          type: string
          title: Agent Name
        environment:
          type: string
          title: Environment
        certification_required:
          type: boolean
          title: Certification Required
        standing:
          $ref: '#/components/schemas/StandingOut'
        findings:
          items:
            $ref: '#/components/schemas/ClearanceCheckOut'
          type: array
          title: Findings
        unknowns:
          items:
            type: string
          type: array
          title: Unknowns
        binds_to_manifest:
          anyOf:
            - type: string
            - type: 'null'
          title: Binds To Manifest
        binds_to_content:
          anyOf:
            - type: string
            - type: 'null'
          title: Binds To Content
        market_profile:
          anyOf:
            - type: string
            - type: 'null'
          title: Market Profile
      type: object
      required:
        - agent_id
        - agent_name
        - environment
        - certification_required
        - standing
        - findings
        - unknowns
      title: CandidateOut
      description: What a signer is agreeing to, before they agree to it.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    StandingOut:
      properties:
        state:
          type: string
          title: State
        detail:
          type: string
          title: Detail
        cleared:
          type: boolean
          title: Cleared
        certificate_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Certificate Id
        issued_by:
          anyOf:
            - type: string
            - type: 'null'
          title: Issued By
        issued_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Issued At
      type: object
      required:
        - state
        - detail
        - cleared
      title: StandingOut
      description: Whether the clearance still says what it said, computed now.
    ClearanceCheckOut:
      properties:
        key:
          type: string
          title: Key
        title:
          type: string
          title: Title
        state:
          type: string
          title: State
        detail:
          type: string
          title: Detail
        bears_on:
          type: string
          title: Bears On
        count:
          anyOf:
            - type: integer
            - type: 'null'
          title: Count
      type: object
      required:
        - key
        - title
        - state
        - detail
        - bears_on
      title: ClearanceCheckOut
    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
  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.