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

# Listar requisitos



## OpenAPI

````yaml GET /v1/vault/requirements
openapi: 3.1.0
info:
  title: EdTools Client API
  version: 1.0.0
  description: >-
    Stable server-to-server API for tenant-owned EdTools integrations. Public
    docs disable the playground; use your own secure client or Postman workspace
    for real tokens.
servers:
  - url: https://app.edtools.co/api/client
    description: Production
  - url: http://localhost:3000/api/client
    description: Local development
security:
  - bearerAuth: []
tags:
  - name: Client API
    description: Identity and token introspection.
  - name: Students
    description: Student reads, writes and external-id sync.
  - name: Admissions
    description: Admission applications, pipeline statuses and contacts.
  - name: Payments
    description: Payment and obligation reads, writes and external-id sync.
  - name: Programs
    description: Current academic program catalog.
  - name: Courses
    description: Current academic course catalog.
  - name: Forms
    description: Read-only form templates and submissions.
  - name: Vault
    description: Document types, documents, requirements and requests.
paths:
  /v1/vault/requirements:
    get:
      tags:
        - Vault
      parameters:
        - schema:
            type: string
            enum:
              - student
              - admission_application
          required: true
          name: entityKind
          in: query
        - schema:
            type: string
            format: uuid
          required: false
          name: entityId
          in: query
        - schema:
            type: string
          required: false
          name: entityExternalId
          in: query
        - schema:
            type: string
            format: uuid
          required: false
          name: profileId
          in: query
      responses:
        '200':
          description: Vault requirements for an entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      entityKind:
                        type: string
                      entityId:
                        type: string
                      profile:
                        type: object
                        nullable: true
                        properties:
                          id:
                            type: string
                            format: uuid
                          key:
                            type: string
                          name:
                            type: string
                          description:
                            type: string
                            nullable: true
                          active:
                            type: boolean
                          sortOrder:
                            type: number
                          entityKind:
                            type: string
                            enum:
                              - student
                              - admission_application
                          isDefault:
                            type: boolean
                          assignedToEntity:
                            type: boolean
                          groups:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: string
                                  format: uuid
                                key:
                                  type: string
                                label:
                                  type: string
                                subjectRole:
                                  type: string
                                  nullable: true
                                sortOrder:
                                  type: number
                                items:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      id:
                                        type: string
                                        format: uuid
                                      required:
                                        type: boolean
                                      active:
                                        type: boolean
                                      instructions:
                                        type: string
                                        nullable: true
                                      sortOrder:
                                        type: number
                                      documentType:
                                        type: object
                                        properties:
                                          id:
                                            type: string
                                            format: uuid
                                          key:
                                            type: string
                                          name:
                                            type: string
                                          description:
                                            type: string
                                            nullable: true
                                          category:
                                            type: string
                                            nullable: true
                                        required:
                                          - id
                                          - key
                                          - name
                                          - description
                                          - category
                                    required:
                                      - id
                                      - required
                                      - active
                                      - instructions
                                      - sortOrder
                                      - documentType
                              required:
                                - id
                                - key
                                - label
                                - subjectRole
                                - sortOrder
                                - items
                          createdAt:
                            type: string
                          updatedAt:
                            type: string
                        required:
                          - id
                          - key
                          - name
                          - description
                          - active
                          - sortOrder
                          - entityKind
                          - isDefault
                          - groups
                          - createdAt
                          - updatedAt
                      groups:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              format: uuid
                            key:
                              type: string
                            label:
                              type: string
                            subjectRole:
                              type: string
                              nullable: true
                            sortOrder:
                              type: number
                            items:
                              type: array
                              items:
                                type: object
                                properties:
                                  id:
                                    type: string
                                    format: uuid
                                  required:
                                    type: boolean
                                  active:
                                    type: boolean
                                  instructions:
                                    type: string
                                    nullable: true
                                  sortOrder:
                                    type: number
                                  documentType:
                                    type: object
                                    properties:
                                      id:
                                        type: string
                                        format: uuid
                                      key:
                                        type: string
                                      name:
                                        type: string
                                      description:
                                        type: string
                                        nullable: true
                                      category:
                                        type: string
                                        nullable: true
                                    required:
                                      - id
                                      - key
                                      - name
                                      - description
                                      - category
                                required:
                                  - id
                                  - required
                                  - active
                                  - instructions
                                  - sortOrder
                                  - documentType
                          required:
                            - id
                            - key
                            - label
                            - subjectRole
                            - sortOrder
                            - items
                      items:
                        type: array
                        items:
                          nullable: true
                    required:
                      - entityKind
                      - entityId
                      - profile
                      - groups
                      - items
                required:
                  - data
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: EdTools service token

````