{ "openapi": "3.0.0", "info": { "title": "API de Integração Dynadok", "version": "2026-11-05", "description": "Contrato da API de integração da Dynadok, autenticada por chave de API (header `x-api-key`). Toda resposta vem em envelope `{ code, message, timestamp, data }`. Guias em https://doc.dynadok.com/docs/api/autenticacao." }, "servers": [ { "url": "https://api.dynadok.com" } ], "paths": { "/v1/api/projects/{projectId}/competencies": { "post": { "operationId": "createProjectCompetencyUsingApi", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "pattern": "[^\\/#\\?]+?", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateProjectCompetencyInputDto" } } }, "description": "CreateProjectCompetencyInputDto", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CreateProjectCompetencyOutputDto" }, "message": { "type": "string", "example": "Success" }, "timestamp": { "type": "string", "example": 1793891111576 } }, "required": [ "data", "message", "timestamp" ] } } }, "description": "" } }, "summary": "Create a new competency for the project using API", "tags": [ "Api Project" ], "security": [ { "ApiKeyAuth": [] } ] }, "get": { "operationId": "paginateProjectCompetenciesUsingApi", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "pattern": "[^\\/#\\?]+?", "type": "string" } }, { "in": "query", "name": "competency", "schema": { "type": "string" } }, { "in": "query", "name": "page", "schema": { "minimum": 1, "type": "number" } }, { "in": "query", "name": "perPage", "schema": { "minimum": 1, "type": "number" } }, { "in": "query", "name": "query", "schema": { "type": "string" } }, { "in": "query", "name": "orderByColumn", "schema": { "type": "string" } }, { "in": "query", "name": "orderByDirection", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PaginateProjectCompetencyUsingApiOutputDto" } }, "message": { "type": "string", "example": "Success" }, "timestamp": { "type": "string", "example": 1793891111576 }, "meta": { "$ref": "#/components/schemas/PaginationMetaOutputDto" } }, "required": [ "data", "message", "timestamp", "meta" ] } } }, "description": "" } }, "summary": "Paginate project competencies using API", "tags": [ "Api Project" ], "security": [ { "ApiKeyAuth": [] } ] } }, "/v1/api/competencies/{competencyId}/participant": { "post": { "operationId": "createCompetencyParticipantUsingApi", "parameters": [ { "in": "path", "name": "competencyId", "required": true, "schema": { "pattern": "[^\\/#\\?]+?", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCompetencyParticipantInputDto" } } }, "description": "CreateCompetencyParticipantInputDto", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CreateCompetencyParticipantOutputDto" }, "message": { "type": "string", "example": "Success" }, "timestamp": { "type": "string", "example": 1793891111577 } }, "required": [ "data", "message", "timestamp" ] } } }, "description": "" } }, "summary": "Create participant using API", "tags": [ "Api Competency" ], "security": [ { "ApiKeyAuth": [] } ], "description": "Create participant for the project competency using API" } }, "/v1/api/competencies/{competencyId}/participants/search": { "post": { "operationId": "searchCompetencyParticipantsUsingApi", "parameters": [ { "in": "path", "name": "competencyId", "required": true, "schema": { "pattern": "[^\\/#\\?]+?", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginateCompetencyParticipantsUsingApiInputDto" } } }, "description": "PaginateCompetencyParticipantsUsingApiInputDto", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PaginateCompetencyParticipantsUsingApiOutputDto" } }, "message": { "type": "string", "example": "Success" }, "timestamp": { "type": "string", "example": 1793891111580 }, "meta": { "$ref": "#/components/schemas/PaginationMetaOutputDto" } }, "required": [ "data", "message", "timestamp", "meta" ] } } }, "description": "" } }, "summary": "Search participants using API", "tags": [ "Api Participant" ], "security": [ { "ApiKeyAuth": [] } ], "description": "Search participants for the project competency using API" } }, "/v1/api/participants/search": { "post": { "operationId": "searchParticipantsUsingApi", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchParticipantsUsingApiInputDto" } } }, "description": "SearchParticipantsUsingApiInputDto", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SearchParticipantsUsingApiOutputDto" } }, "message": { "type": "string", "example": "Success" }, "timestamp": { "type": "string", "example": 1793891111581 }, "meta": { "$ref": "#/components/schemas/PaginationMetaOutputDto" } }, "required": [ "data", "message", "timestamp", "meta" ] } } }, "description": "" } }, "summary": "Search participations by CPF using API", "tags": [ "Api Participant" ], "security": [ { "ApiKeyAuth": [] } ], "description": "Lists the participations (participant in a competency) of a CPF in the company of the API key, across all its projects. Each item `_id` is the participantId used by GET /v1/api/participants/{participantId}/document-requests and the input-documents route. The CPF goes in the body, never in the URL. Accepts the CPF with or without mask; invalid CPF answers 400; no participation answers an empty list." } }, "/v1/api/competencies/{competencyId}/participants/{participantId}/documents": { "post": { "operationId": "createDocumentUsingApi", "parameters": [ { "in": "path", "name": "competencyId", "required": true, "schema": { "pattern": "[^\\/#\\?]+?", "type": "string" } }, { "in": "path", "name": "participantId", "required": true, "schema": { "pattern": "[^\\/#\\?]+?", "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateParticipantDocumentUsingApiDto" }, { "properties": { "files": { "type": "array", "items": { "type": "string", "format": "binary" } } }, "required": [ "files" ], "type": "object" } ] } } }, "description": "CreateParticipantDocumentUsingApiDto", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CreateApiDocumentOutputDto" }, "message": { "type": "string", "example": "Success" }, "timestamp": { "type": "string", "example": 1793891111582 } }, "required": [ "data", "message", "timestamp" ] } } }, "description": "" } }, "summary": "Create participant document", "tags": [ "Api Participant" ], "security": [ { "ApiKeyAuth": [] } ], "description": "Upload a new document for a participant of a project competency using API" } }, "/v1/api/competencies/{competencyId}/participants/{participantId}/input-documents": { "post": { "operationId": "createParticipantInputDocumentUsingApi", "parameters": [ { "in": "path", "name": "competencyId", "required": true, "schema": { "pattern": "[^\\/#\\?]+?", "type": "string" } }, { "in": "path", "name": "participantId", "required": true, "schema": { "pattern": "[^\\/#\\?]+?", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateParticipantInputDocumentUsingApiInputDto" } } }, "description": "CreateParticipantInputDocumentUsingApiInputDto", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CreateParticipantInputDocumentUsingApiOutputDto" }, "message": { "type": "string", "example": "Success" }, "timestamp": { "type": "string", "example": 1793891111582 } }, "required": [ "data", "message", "timestamp" ] } } }, "description": "" } }, "summary": "Answer an input field for a participant using API", "tags": [ "Api Participant" ], "security": [ { "ApiKeyAuth": [] } ], "description": "Answers a form field (INPUT slot) of a participant or of one of their dependents. `value` is always text. For SELECTION_OPTION_INPUT slots the value must be one of the options listed in `rules[].inputValue` of the slot returned by GET /v1/api/participants/{participantId}/document-requests. DATE_INPUT values use the YYYY-MM-DD format. File slots (DOCUMENT) answer 400: use the documents route." } }, "/v1/api/participant-documents/{participantDocumentId}": { "get": { "operationId": "fetchParticipantDocumentById", "parameters": [ { "in": "path", "name": "participantDocumentId", "required": true, "schema": { "pattern": "[^\\/#\\?]+?", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/FetchCompetencyDocumentIdOutputDto" }, "message": { "type": "string", "example": "Success" }, "timestamp": { "type": "string", "example": 1793891111583 } }, "required": [ "data", "message", "timestamp" ] } } }, "description": "" } }, "summary": "Fetch an document by id", "tags": [ "Api Participant" ], "security": [ { "ApiKeyAuth": [] } ] } }, "/v1/api/participants/{participantId}/documents": { "get": { "operationId": "fetchCompetencyParticipantDocuments", "parameters": [ { "in": "path", "name": "participantId", "required": true, "schema": { "pattern": "[^\\/#\\?]+?", "type": "string" } }, { "in": "query", "name": "categories", "schema": { "items": { "type": "string", "example": "DOCUMENT", "examples": [ "DOCUMENT", "INPUT" ] }, "type": "array", "description": "Filtra por categoria. Aceita CSV (?categories=DOCUMENT,INPUT) ou repetição. Default: DOCUMENT.", "default": [ "DOCUMENT" ] } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/FetchCompetencyParticipantDocumentsOutputDto" } }, "message": { "type": "string", "example": "Success" }, "timestamp": { "type": "string", "example": 1793891111584 }, "meta": { "$ref": "#/components/schemas/PaginationMetaOutputDto" } }, "required": [ "data", "message", "timestamp", "meta" ] } } }, "description": "" } }, "summary": "Fetch competency documents for a participant", "tags": [ "Api Participant" ], "security": [ { "ApiKeyAuth": [] } ], "description": "Fetch competency documents for a participant. Filters by category via the `categories` query param (accepts CSV or repeated values). Defaults to DOCUMENT only." } }, "/v1/api/participants/{participantId}": { "get": { "operationId": "fetchCompetencyParticipant", "parameters": [ { "in": "path", "name": "participantId", "required": true, "schema": { "pattern": "[^\\/#\\?]+?", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/FetchCompetencyParticipantOutputDto" }, "message": { "type": "string", "example": "Success" }, "timestamp": { "type": "string", "example": 1793891111584 } }, "required": [ "data", "message", "timestamp" ] } } }, "description": "" } }, "summary": "Fetch competency participant", "tags": [ "Api Participant" ], "security": [ { "ApiKeyAuth": [] } ] }, "patch": { "operationId": "updateCompetencyParticipantWithApi", "parameters": [ { "in": "path", "name": "participantId", "required": true, "schema": { "pattern": "[^\\/#\\?]+?", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCompetencyParticipantWithApiInputDto" } } }, "description": "UpdateCompetencyParticipantWithApiInputDto", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/UpdateCompetencyParticipantWithApiOutputDto" }, "message": { "type": "string", "example": "Success" }, "timestamp": { "type": "string", "example": 1793891111584 } }, "required": [ "data", "message", "timestamp" ] } } }, "description": "" } }, "summary": "Update participant using API", "tags": [ "Api Participant" ], "security": [ { "ApiKeyAuth": [] } ], "description": "Update participant basic information (name, email, dateOfBirth, gender) using API. `dateOfBirth` is a calendar day in `YYYY-MM-DD`; an ISO datetime is also accepted and its date part is used as written (no timezone conversion). The response returns it as `YYYY-MM-DD`." } }, "/v1/api/participants/{participantId}/documents-data": { "get": { "operationId": "fetchCompetencyParticipantDocumentsData", "parameters": [ { "in": "path", "name": "participantId", "required": true, "schema": { "pattern": "[^\\/#\\?]+?", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/FetchCompetencyParticipantDocumentsDataOutputDto" }, "message": { "type": "string", "example": "Success" }, "timestamp": { "type": "string", "example": 1793891111587 } }, "required": [ "data", "message", "timestamp" ] } } }, "description": "" } }, "summary": "Get all documents data for a participant", "tags": [ "Api Participant" ], "security": [ { "ApiKeyAuth": [] } ] } }, "/v1/api/participant-documents/{participantDocumentId}/file-url": { "get": { "operationId": "fetchParticipantDocumentFileUrl", "parameters": [ { "in": "path", "name": "participantDocumentId", "required": true, "schema": { "pattern": "[^\\/#\\?]+?", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/FetchParticipantDocumentFileUrlOutputDto" }, "message": { "type": "string", "example": "Success" }, "timestamp": { "type": "string", "example": 1793891111588 } }, "required": [ "data", "message", "timestamp" ] } } }, "description": "" } }, "summary": "Get the file url of a participant document", "tags": [ "Api Participant" ], "security": [ { "ApiKeyAuth": [] } ], "description": "Devolve URLs assinadas e temporárias dos arquivos de um documento. `fileUrl` é o arquivo enviado e `justificationFileUrl` é o anexo da justificativa; são independentes e cada um pode vir `null` — um documento pode ter os dois. As URLs expiram, não armazenar. Documento sem nenhum arquivo responde 404." } }, "/v1/api/participants/{participantId}/document-requests": { "get": { "operationId": "fetchParticipantDocumentRequests", "parameters": [ { "in": "path", "name": "participantId", "required": true, "schema": { "pattern": "[^\\/#\\?]+?", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/FetchParticipantDocumentRequestsOutputDto" } }, "message": { "type": "string", "example": "Success" }, "timestamp": { "type": "string", "example": 1793891111589 }, "meta": { "$ref": "#/components/schemas/PaginationMetaOutputDto" } }, "required": [ "data", "message", "timestamp", "meta" ] } } }, "description": "" } }, "summary": "List document requests for a participant", "tags": [ "Api Participant" ], "security": [ { "ApiKeyAuth": [] } ], "description": "Retorna os documentos solicitados ao participante, agrupados como no portal, com o estado de cada envio e a lista de documentos aceitos no conteúdo do arquivo (principal, substitutos, declarações e tipos customizados). No upload, o documento solicitado é identificado pelo `competencyDocumentId` de cada item." } }, "/v1/api/participant-documents/{participantDocumentId}/status": { "patch": { "operationId": "updateParticipantDocumentStatus", "parameters": [ { "in": "path", "name": "participantDocumentId", "required": true, "schema": { "pattern": "[^\\/#\\?]+?", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchParticipantDocumentStatusInputDto" } } }, "description": "PatchParticipantDocumentStatusInputDto", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": {}, "message": { "type": "string", "example": "Success" }, "timestamp": { "type": "string", "example": 1793891111589 } }, "required": [ "data", "message", "timestamp" ] } } }, "description": "Successful response" } }, "summary": "Update participant document status", "tags": [ "Api Participant" ], "security": [ { "ApiKeyAuth": [] } ] } }, "/v1/api/participants/{participantId}/custom-fields": { "get": { "operationId": "getCustomFieldsByParticipantId", "parameters": [ { "in": "path", "name": "participantId", "required": true, "schema": { "pattern": "[^\\/#\\?]+?", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/GetCustomFieldsByParticipantIdOutputDto" }, "message": { "type": "string", "example": "Success" }, "timestamp": { "type": "string", "example": 1793891111590 } }, "required": [ "data", "message", "timestamp" ] } } }, "description": "" } }, "summary": "Buscar campos customizados de um participante com base no id do participante", "tags": [ "Api Participant" ], "security": [ { "ApiKeyAuth": [] } ], "description": "Buscar campos customizados de um participante com base no id do participante" }, "patch": { "operationId": "updateCustomFieldsByParticipantId", "parameters": [ { "in": "path", "name": "participantId", "required": true, "schema": { "pattern": "[^\\/#\\?]+?", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCustomFieldsByParticipantIdInputDto" } } }, "description": "UpdateCustomFieldsByParticipantIdInputDto", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/UpdateCustomFieldsByParticipantIdOutputDto" }, "message": { "type": "string", "example": "Success" }, "timestamp": { "type": "string", "example": 1793891111590 } }, "required": [ "data", "message", "timestamp" ] } } }, "description": "" } }, "summary": "Atualizar campos customizados de um participante com base no id do participante", "tags": [ "Api Participant" ], "security": [ { "ApiKeyAuth": [] } ], "description": "Atualizar campos customizados de um participante com base no id do participante" } }, "/v1/api/competencies/{competencyId}/participants/{competencyParticipantId}/status": { "patch": { "operationId": "updateParticipantStatus", "parameters": [ { "in": "path", "name": "competencyId", "required": true, "schema": { "pattern": "[^\\/#\\?]+?", "type": "string" } }, { "in": "path", "name": "competencyParticipantId", "required": true, "schema": { "pattern": "[^\\/#\\?]+?", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiDocumentUpdateParticipantStatusInputDto" } } }, "description": "ApiDocumentUpdateParticipantStatusInputDto", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ApiDocumentUpdateParticipantStatusOutputDto" }, "message": { "type": "string", "example": "Success" }, "timestamp": { "type": "string", "example": 1793891111593 } }, "required": [ "data", "message", "timestamp" ] } } }, "description": "" } }, "summary": "Update participant status", "tags": [ "Api Participant" ], "security": [ { "ApiKeyAuth": [] } ] } }, "/v1/api/participants/{participantId}/dependents": { "post": { "operationId": "addParticipantDependentsWithApi", "parameters": [ { "in": "path", "name": "participantId", "required": true, "schema": { "pattern": "[^\\/#\\?]+?", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddParticipantDependentsWithApiInputDto" } } }, "description": "AddParticipantDependentsWithApiInputDto", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AddParticipantDependentsWithApiOutputDto" } }, "message": { "type": "string", "example": "Success" }, "timestamp": { "type": "string", "example": 1793891111594 }, "meta": { "$ref": "#/components/schemas/PaginationMetaOutputDto" } }, "required": [ "data", "message", "timestamp", "meta" ] } } }, "description": "" } }, "summary": "Add dependents to participant using API", "tags": [ "Api Participant" ], "security": [ { "ApiKeyAuth": [] } ], "description": "Add or update dependents for a participant using API" } }, "/v1/api/competencies/{competencyId}/participants/{participantId}/submission/status": { "get": { "operationId": "getSubmissionConclusionStatusUsingApi", "parameters": [ { "in": "path", "name": "competencyId", "required": true, "schema": { "pattern": "[^\\/#\\?]+?", "type": "string" } }, { "in": "path", "name": "participantId", "required": true, "schema": { "pattern": "[^\\/#\\?]+?", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/GetSubmissionConclusionStatusOutputDto" }, "message": { "type": "string", "example": "Success" }, "timestamp": { "type": "string", "example": 1793891111595 } }, "required": [ "data", "message", "timestamp" ] } } }, "description": "" } }, "summary": "Get the submission conclusion status of a participant using API", "tags": [ "Api Participant" ], "security": [ { "ApiKeyAuth": [] } ], "description": "Same state the participant sees on the \"Conclude submission\" button of the portal: whether the button is enabled in the competency, whether the submission is completed, whether it can be concluded now, and the issues of the last attempt." } }, "/v1/api/competencies/{competencyId}/participants/{participantId}/submission/conclude": { "post": { "operationId": "concludeSubmissionUsingApi", "parameters": [ { "in": "path", "name": "competencyId", "required": true, "schema": { "pattern": "[^\\/#\\?]+?", "type": "string" } }, { "in": "path", "name": "participantId", "required": true, "schema": { "pattern": "[^\\/#\\?]+?", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ConcludeSubmissionOutputDto" }, "message": { "type": "string", "example": "Success" }, "timestamp": { "type": "string", "example": 1793891111596 } }, "required": [ "data", "message", "timestamp" ] } } }, "description": "" } }, "summary": "Conclude the submission of a participant using API", "tags": [ "Api Participant" ], "security": [ { "ApiKeyAuth": [] } ], "description": "Concludes the submission on behalf of the participant with the same rules as the portal button: the button must be enabled in the competency, required documents must be sent and processed, and the competency validation formula must report no issues. When the formula reports issues the answer is 200 with status BLOCKED and the issues. Concluding an already concluded submission answers ALREADY_COMPLETED without side effects." } }, "/v1/api/competencies/{competencyId}/participants/{participantId}/dependents/{dependentId}": { "delete": { "operationId": "removeParticipantDependentUsingApi", "parameters": [ { "in": "path", "name": "competencyId", "required": true, "schema": { "pattern": "[^\\/#\\?]+?", "type": "string" } }, { "in": "path", "name": "participantId", "required": true, "schema": { "pattern": "[^\\/#\\?]+?", "type": "string" } }, { "in": "path", "name": "dependentId", "required": true, "schema": { "pattern": "[^\\/#\\?]+?", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/RemoveParticipantDependentUsingApiOutputDto" }, "message": { "type": "string", "example": "Success" }, "timestamp": { "type": "string", "example": 1793891111596 } }, "required": [ "data", "message", "timestamp" ] } } }, "description": "" } }, "summary": "Remove a dependent of a participant using API", "tags": [ "Api Participant" ], "security": [ { "ApiKeyAuth": [] } ], "description": "Removes the dependent the same way the participant does in the portal. DESTRUCTIVE: every document sent for the dependent is deleted together with it; `deletedDocumentsCount` tells how many. Repeating the call for a dependent already removed answers 200 with `deletedDocumentsCount` 0; an unknown dependent answers 404." } }, "/v1/api/competencies/{competencyId}/participants/{participantId}": { "delete": { "operationId": "removeParticipantUsingApi", "parameters": [ { "in": "path", "name": "competencyId", "required": true, "schema": { "pattern": "[^\\/#\\?]+?", "type": "string" } }, { "in": "path", "name": "participantId", "required": true, "schema": { "pattern": "[^\\/#\\?]+?", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/RemoveParticipantUsingApiOutputDto" }, "message": { "type": "string", "example": "Success" }, "timestamp": { "type": "string", "example": 1793891111597 } }, "required": [ "data", "message", "timestamp" ] } } }, "description": "" } }, "summary": "Remove a participant using API", "tags": [ "Api Participant" ], "security": [ { "ApiKeyAuth": [] } ], "description": "Removes the participant of the project competency together with its dependents and every document sent for them. DESTRUCTIVE: `deletedDocumentsCount` tells how many documents were deleted. To register the same person again, call POST /v1/api/competencies/{competencyId}/participant afterwards. Repeating the call for a participant already removed answers 200 with `deletedDocumentsCount` 0; an unknown participant, or one from another company or competency, answers 404." } }, "/v1/api/competencies/{competencyId}/participants/{participantId}/documents/justification": { "post": { "operationId": "createDocumentJustificationUsingApi", "parameters": [ { "in": "path", "name": "competencyId", "required": true, "schema": { "pattern": "[^\\/#\\?]+?", "type": "string" } }, { "in": "path", "name": "participantId", "required": true, "schema": { "pattern": "[^\\/#\\?]+?", "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateDocumentJustificationUsingApiInputDto" }, { "properties": { "files": { "type": "array", "items": { "type": "string", "format": "binary" } } }, "required": [ "files" ], "type": "object" } ] } } }, "description": "CreateDocumentJustificationUsingApiInputDto", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ParticipantDocumentDto" }, "message": { "type": "string", "example": "Success" }, "timestamp": { "type": "string", "example": 1793891111598 } }, "required": [ "data", "message", "timestamp" ] } } }, "description": "" } }, "summary": "Justify a participant document using API", "tags": [ "Api Participant" ], "security": [ { "ApiKeyAuth": [] } ], "description": "Justifies an existing participant document on behalf of the participant, as in the portal. The document request must accept justification (otherwise 422). As in the portal, `files` is required and is stored as the justification attachment. The document becomes JUSTIFIED and the action is recorded as made by the integration." } }, "/v1/api/competencies/{competencyId}/participants/{participantId}/participant-documents/{participantDocumentId}/request-review": { "post": { "operationId": "requestParticipantDocumentReviewUsingApi", "parameters": [ { "in": "path", "name": "competencyId", "required": true, "schema": { "pattern": "[^\\/#\\?]+?", "type": "string" } }, { "in": "path", "name": "participantId", "required": true, "schema": { "pattern": "[^\\/#\\?]+?", "type": "string" } }, { "in": "path", "name": "participantDocumentId", "required": true, "schema": { "pattern": "[^\\/#\\?]+?", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestParticipantDocumentReviewUsingApiInputDto" } } }, "description": "RequestParticipantDocumentReviewUsingApiInputDto", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/RequestParticipantDocumentReviewOutputDto" }, "message": { "type": "string", "example": "Success" }, "timestamp": { "type": "string", "example": 1793891111601 } }, "required": [ "data", "message", "timestamp" ] } } }, "description": "" } }, "summary": "Request review of a rejected participant document using API", "tags": [ "Api Participant" ], "security": [ { "ApiKeyAuth": [] } ], "description": "Third level of the automatic review, requested on behalf of the participant as in the portal. Available only after the automatic reviewer rejected an identical resubmission (reviewStage REVIEWER_REJECTED); otherwise 422 with the reason. Requires a reason of 10 to 500 characters and re-runs the reviewer with a stronger model; if it rejects again, the document goes to human review automatically." } }, "/v1/api/documents": { "post": { "operationId": "processExternalDocument", "requestBody": { "content": { "multipart/form-data": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateApiDocumentInputDto" }, { "properties": { "files": { "type": "array", "items": { "type": "string", "format": "binary" } } }, "required": [ "files" ], "type": "object" } ] } } }, "description": "CreateApiDocumentInputDto", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CreateApiDocumentOutputDto" }, "message": { "type": "string", "example": "Success" }, "timestamp": { "type": "string", "example": 1793891111610 } }, "required": [ "data", "message", "timestamp" ] } } }, "description": "" } }, "summary": "Create a new document using API", "tags": [ "Api Document" ], "security": [ { "ApiKeyAuth": [] } ] } }, "/v1/api/documents/{_id}": { "get": { "operationId": "fetchExternalDocumentById", "parameters": [ { "in": "path", "name": "_id", "required": true, "schema": { "pattern": "[^\\/#\\?]+?", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/FetchApiDocumentByIdOutpuDto" }, "message": { "type": "string", "example": "Success" }, "timestamp": { "type": "string", "example": 1793891111611 } }, "required": [ "data", "message", "timestamp" ] } } }, "description": "" } }, "summary": "Fetch a document uploaded by company in API", "tags": [ "Api Document" ], "security": [ { "ApiKeyAuth": [] } ] } }, "/v1/api/documents/{participantDocumentId}/computed-fields": { "patch": { "operationId": "updateParticipantDocumentComputedFields", "parameters": [ { "in": "path", "name": "participantDocumentId", "required": true, "schema": { "pattern": "[^\\/#\\?]+?", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateParticipantDocumentComputedFieldsInputDto" } } }, "description": "UpdateParticipantDocumentComputedFieldsInputDto", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/UpdateParticipantDocumentComputedFieldsOutputDto" }, "message": { "type": "string", "example": "Success" }, "timestamp": { "type": "string", "example": 1793891111612 } }, "required": [ "data", "message", "timestamp" ] } } }, "description": "" } }, "summary": "Update computed fields of a participant document (legacy path)", "tags": [ "Api Document" ], "security": [ { "ApiKeyAuth": [] } ] } }, "/v1/api/participant-documents/{participantDocumentId}/computed-fields": { "patch": { "operationId": "patchParticipantDocumentComputedFields", "parameters": [ { "in": "path", "name": "participantDocumentId", "required": true, "schema": { "pattern": "[^\\/#\\?]+?", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateParticipantDocumentComputedFieldsInputDto" } } }, "description": "UpdateParticipantDocumentComputedFieldsInputDto", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/UpdateParticipantDocumentComputedFieldsOutputDto" }, "message": { "type": "string", "example": "Success" }, "timestamp": { "type": "string", "example": 1793891111613 } }, "required": [ "data", "message", "timestamp" ] } } }, "description": "" } }, "summary": "Update computed fields of a participant document", "tags": [ "Api Document" ], "security": [ { "ApiKeyAuth": [] } ] } }, "/v1/api/datasets": { "get": { "operationId": "apiListDatasets", "parameters": [ { "in": "query", "name": "page", "schema": { "minimum": 1, "type": "number" } }, { "in": "query", "name": "perPage", "schema": { "minimum": 1, "type": "number" } }, { "in": "query", "name": "query", "schema": { "type": "string" } }, { "in": "query", "name": "orderByColumn", "schema": { "type": "string" } }, { "in": "query", "name": "orderByDirection", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DatasetOutputDto" } }, "message": { "type": "string", "example": "Success" }, "timestamp": { "type": "string", "example": 1793891111615 }, "meta": { "$ref": "#/components/schemas/PaginationMetaOutputDto" } }, "required": [ "data", "message", "timestamp", "meta" ] } } }, "description": "" } }, "summary": "Listar tabelas de dados (API)", "tags": [ "Api Dataset" ], "security": [ { "ApiKeyAuth": [] } ] } }, "/v1/api/datasets/{datasetId}": { "get": { "operationId": "apiGetDataset", "parameters": [ { "in": "path", "name": "datasetId", "required": true, "schema": { "pattern": "[^\\/#\\?]+?", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DatasetOutputDto" }, "message": { "type": "string", "example": "Success" }, "timestamp": { "type": "string", "example": 1793891111616 } }, "required": [ "data", "message", "timestamp" ] } } }, "description": "" } }, "summary": "Detalhar tabela de dados / schema (API)", "tags": [ "Api Dataset" ], "security": [ { "ApiKeyAuth": [] } ] } }, "/v1/api/datasets/{datasetId}/rows": { "get": { "operationId": "apiListDatasetRows", "parameters": [ { "in": "path", "name": "datasetId", "required": true, "schema": { "pattern": "[^\\/#\\?]+?", "type": "string" } }, { "in": "query", "name": "page", "schema": { "minimum": 1, "type": "number" } }, { "in": "query", "name": "perPage", "schema": { "maximum": 200, "type": "number", "minimum": 1 } }, { "in": "query", "name": "filters", "schema": { "type": "string" } }, { "in": "query", "name": "query", "schema": { "type": "string" } }, { "in": "query", "name": "orderByColumn", "schema": { "type": "string" } }, { "in": "query", "name": "orderByDirection", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": {}, "message": { "type": "string", "example": "Success" }, "timestamp": { "type": "string", "example": 1793891111617 } }, "required": [ "data", "message", "timestamp" ] } } }, "description": "Successful response" } }, "summary": "Listar linhas da tabela (API)", "tags": [ "Api Dataset" ], "security": [ { "ApiKeyAuth": [] } ] }, "post": { "operationId": "apiCreateDatasetRow", "parameters": [ { "in": "path", "name": "datasetId", "required": true, "schema": { "pattern": "[^\\/#\\?]+?", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDatasetRowInputDto" } } }, "description": "CreateDatasetRowInputDto", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": {}, "message": { "type": "string", "example": "Success" }, "timestamp": { "type": "string", "example": 1793891111617 } }, "required": [ "data", "message", "timestamp" ] } } }, "description": "Successful response" } }, "summary": "Adicionar linha na tabela (API)", "tags": [ "Api Dataset" ], "security": [ { "ApiKeyAuth": [] } ] }, "delete": { "operationId": "apiDeleteDatasetRows", "parameters": [ { "in": "path", "name": "datasetId", "required": true, "schema": { "pattern": "[^\\/#\\?]+?", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteDatasetRowsInputDto" } } }, "description": "DeleteDatasetRowsInputDto", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": {}, "message": { "type": "string", "example": "Success" }, "timestamp": { "type": "string", "example": 1793891111617 } }, "required": [ "data", "message", "timestamp" ] } } }, "description": "Successful response" } }, "summary": "Excluir linhas da tabela (API)", "tags": [ "Api Dataset" ], "security": [ { "ApiKeyAuth": [] } ] } }, "/v1/api/datasets/{datasetId}/rows/{rowId}": { "patch": { "operationId": "apiUpdateDatasetRow", "parameters": [ { "in": "path", "name": "datasetId", "required": true, "schema": { "pattern": "[^\\/#\\?]+?", "type": "string" } }, { "in": "path", "name": "rowId", "required": true, "schema": { "pattern": "[^\\/#\\?]+?", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDatasetRowInputDto" } } }, "description": "UpdateDatasetRowInputDto", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": {}, "message": { "type": "string", "example": "Success" }, "timestamp": { "type": "string", "example": 1793891111618 } }, "required": [ "data", "message", "timestamp" ] } } }, "description": "Successful response" } }, "summary": "Editar linha da tabela (API)", "tags": [ "Api Dataset" ], "security": [ { "ApiKeyAuth": [] } ] } }, "/v1/api/credit-transfer-analyses": { "post": { "operationId": "apiCreditTransferAnalysisStartStandalone", "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": false, "schema": { "type": "string", "maxLength": 255 } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "roles": { "type": "array", "items": { "type": "string", "enum": [ "HISTORIC", "ORIGIN_SYLLABUS", "DESTINATION_SYLLABUS" ] } }, "parameters": { "type": "string", "description": "JSON: { minScore?: 0-100 (default 75), creditHoursTolerance?: 0-100 | null (default 60), complexity?: NORMAL | HIGH (default NORMAL), allowCombination?: boolean (default false), minScoreToDisplay?: 0-100 (default 50) }" }, "externalId": { "type": "string", "description": "Your identifier for this analysis; filterable in the listing." }, "files": { "type": "array", "items": { "type": "string", "format": "binary" } } }, "required": [ "files", "roles" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CreditTransferAnalysisOutputDto" }, "message": { "type": "string", "example": "Success" }, "timestamp": { "type": "string", "example": 1793891111619 } }, "required": [ "data", "message", "timestamp" ] } } }, "description": "" } }, "summary": "Start a credit transfer analysis from uploaded files", "tags": [ "Api Credit Transfer Analysis" ], "security": [ { "ApiKeyAuth": [] } ], "description": "Send the student documents in `files` and, in the same order, the role of each one in `roles`: at least one HISTORIC and one ORIGIN_SYLLABUS, and exactly one DESTINATION_SYLLABUS. PDF or image, up to 30 files. `parameters` is an optional JSON object; omitted fields take the defaults and `creditHoursTolerance: null` turns the workload rule off. Repeating a request with the same `Idempotency-Key` header returns the analysis it created. Follow the analysis by GET or webhook." }, "get": { "operationId": "apiCreditTransferAnalysisList", "parameters": [ { "in": "query", "name": "externalId", "schema": { "maxLength": 200, "type": "string" } }, { "in": "query", "name": "status", "schema": { "type": "string", "example": "PENDING_DOCUMENTS", "examples": [ "PENDING_DOCUMENTS", "QUEUED", "PROCESSING", "COMPLETED", "FAILED" ] } }, { "in": "query", "name": "competencyParticipantId", "schema": { "pattern": "^[0-9a-fA-F]{24}$", "type": "string" } }, { "in": "query", "name": "page", "schema": { "minimum": 1, "type": "number" } }, { "in": "query", "name": "perPage", "schema": { "minimum": 1, "type": "number" } }, { "in": "query", "name": "query", "schema": { "type": "string" } }, { "in": "query", "name": "orderByColumn", "schema": { "type": "string" } }, { "in": "query", "name": "orderByDirection", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CreditTransferAnalysisListItemOutputDto" } }, "message": { "type": "string", "example": "Success" }, "timestamp": { "type": "string", "example": 1793891111619 }, "meta": { "$ref": "#/components/schemas/PaginationMetaOutputDto" } }, "required": [ "data", "message", "timestamp", "meta" ] } } }, "description": "" } }, "summary": "List credit transfer analyses", "tags": [ "Api Credit Transfer Analysis" ], "security": [ { "ApiKeyAuth": [] } ], "description": "Newest first, filterable by externalId, status and competencyParticipantId. Items carry the summary; get an analysis by id for its subjects." } }, "/v1/api/competencies/{competencyId}/participants/{participantId}/credit-transfer-analyses": { "post": { "operationId": "apiCreditTransferAnalysisStartForParticipant", "parameters": [ { "in": "path", "name": "competencyId", "required": true, "schema": { "pattern": "[^\\/#\\?]+?", "type": "string" } }, { "in": "path", "name": "participantId", "required": true, "schema": { "pattern": "[^\\/#\\?]+?", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "competencyDocumentId": { "type": "string" } }, "required": [], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CreditTransferAnalysisOutputDto" }, "message": { "type": "string", "example": "Success" }, "timestamp": { "type": "string", "example": 1793891111622 } }, "required": [ "data", "message", "timestamp" ] } } }, "description": "" } }, "summary": "Start a credit transfer analysis for a project participant", "tags": [ "Api Credit Transfer Analysis" ], "security": [ { "ApiKeyAuth": [] } ], "description": "Uses the documents already uploaded to the participant slots configured with the credit transfer rule, and the parameters of the destination slot. Responds with the analysis; follow it by GET or webhook." } }, "/v1/api/credit-transfer-analyses/{creditTransferAnalysisId}": { "get": { "operationId": "apiCreditTransferAnalysisGetById", "parameters": [ { "in": "path", "name": "creditTransferAnalysisId", "required": true, "schema": { "pattern": "[^\\/#\\?]+?", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CreditTransferAnalysisOutputDto" }, "message": { "type": "string", "example": "Success" }, "timestamp": { "type": "string", "example": 1793891111622 } }, "required": [ "data", "message", "timestamp" ] } } }, "description": "" } }, "summary": "Get a credit transfer analysis", "tags": [ "Api Credit Transfer Analysis" ], "security": [ { "ApiKeyAuth": [] } ], "description": "Status and, once completed, the clean result of the analysis." } }, "/v1/api/credit-transfer-analyses/{creditTransferAnalysisId}/spreadsheet": { "get": { "operationId": "apiCreditTransferAnalysisGetSpreadsheet", "parameters": [ { "in": "path", "name": "creditTransferAnalysisId", "required": true, "schema": { "pattern": "[^\\/#\\?]+?", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/GetCreditTransferAnalysisSpreadsheetOutputDto" }, "message": { "type": "string", "example": "Success" }, "timestamp": { "type": "string", "example": 1793891111623 } }, "required": [ "data", "message", "timestamp" ] } } }, "description": "" } }, "summary": "Get the spreadsheet of a credit transfer analysis", "tags": [ "Api Credit Transfer Analysis" ], "security": [ { "ApiKeyAuth": [] } ], "description": "Generated on the first call; returns a signed URL valid for 7 days." } }, "/v1/api/competencies/execute-validation-code-for-split/{splitId}": { "get": { "operationId": "executeCompetencyValidationCodeForSplit", "parameters": [ { "in": "path", "name": "splitId", "required": true, "schema": { "pattern": "[^\\/#\\?]+?", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ExecuteCompetencyValidationCodeForSplitOutputDto" } }, "message": { "type": "string", "example": "Success" }, "timestamp": { "type": "string", "example": 1793891111624 }, "meta": { "$ref": "#/components/schemas/PaginationMetaOutputDto" } }, "required": [ "data", "message", "timestamp", "meta" ] } } }, "description": "" } }, "summary": "Execute competency validation code for split", "tags": [ "Api Competency" ], "security": [ { "ApiKeyAuth": [] } ] } }, "/v1/api/competencies/{competencyId}/participants/{participantId}/document-group/{documentGroupId}/split-and-redistribute": { "post": { "operationId": "handleGfdSingleDocumentApi", "parameters": [ { "in": "path", "name": "competencyId", "required": true, "schema": { "pattern": "[^\\/#\\?]+?", "type": "string" } }, { "in": "path", "name": "participantId", "required": true, "schema": { "pattern": "[^\\/#\\?]+?", "type": "string" } }, { "in": "path", "name": "documentGroupId", "required": true, "schema": { "pattern": "[^\\/#\\?]+?", "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SplitAndRedistributeDocumentApiInputDto" }, { "properties": { "files": { "type": "array", "items": { "type": "string", "format": "binary" } } }, "required": [ "files" ], "type": "object" } ] } } }, "description": "SplitAndRedistributeDocumentApiInputDto", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SplitAndRedistributeDocumentApiOutputDto" }, "message": { "type": "string", "example": "Success" }, "timestamp": { "type": "string", "example": 1793891111625 } }, "required": [ "data", "message", "timestamp" ] } } }, "description": "" } }, "summary": "Split and redistribute document api", "tags": [ "Api Competency" ], "security": [ { "ApiKeyAuth": [] } ], "description": "Handle single document split into category" } }, "/v1/api/competencies/participants/search": { "post": { "operationId": "searchCompetencyParticipants", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchCompetencyParticipantInputDto" } } }, "description": "SearchCompetencyParticipantInputDto", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SearchCompetencyParticipantOutputDto" } }, "message": { "type": "string", "example": "Success" }, "timestamp": { "type": "string", "example": 1793891111629 }, "meta": { "$ref": "#/components/schemas/PaginationMetaOutputDto" } }, "required": [ "data", "message", "timestamp", "meta" ] } } }, "description": "" } }, "summary": "Search participants in a competency", "tags": [ "Api Competency" ], "security": [ { "ApiKeyAuth": [] } ], "description": "Search participants in a competency" } }, "/v1/api/competencies/{competencyId}/send-invite": { "post": { "operationId": "sendParticipantInvite", "parameters": [ { "in": "path", "name": "competencyId", "required": true, "schema": { "pattern": "[^\\/#\\?]+?", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendParticipantInviteInputDto" } } }, "description": "SendParticipantInviteInputDto", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SendParticipantInviteOutputDto" }, "message": { "type": "string", "example": "Success" }, "timestamp": { "type": "string", "example": 1793891111630 } }, "required": [ "data", "message", "timestamp" ] } } }, "description": "" } }, "summary": "Enviar convite para participante", "tags": [ "Api Competency" ], "security": [ { "ApiKeyAuth": [] } ], "description": "Enviar convite por email para um participante específico usando API" } }, "/v1/api/competencies/{competencyId}/participants/{participantId}/authenticated-link": { "post": { "operationId": "generateParticipantAuthenticatedLink", "parameters": [ { "in": "path", "name": "competencyId", "required": true, "schema": { "pattern": "[^\\/#\\?]+?", "type": "string" } }, { "in": "path", "name": "participantId", "required": true, "schema": { "pattern": "[^\\/#\\?]+?", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/GenerateParticipantAuthenticatedLinkOutputDto" }, "message": { "type": "string", "example": "Success" }, "timestamp": { "type": "string", "example": 1793891111631 } }, "required": [ "data", "message", "timestamp" ] } } }, "description": "" } }, "summary": "Gerar link autenticado para envio de documentação do participante", "tags": [ "Api Competency" ], "security": [ { "ApiKeyAuth": [] } ], "description": "Gera um link autenticado via SSO para um participante acessar diretamente a tela de envio de documentos sem precisar de login" } }, "/v1/api/catalog/documents": { "get": { "operationId": "paginateCatalogDocumentsUsingApi", "parameters": [ { "in": "query", "name": "juridicNature", "schema": { "type": "string" } }, { "in": "query", "name": "page", "schema": { "minimum": 1, "type": "number" } }, { "in": "query", "name": "perPage", "schema": { "minimum": 1, "type": "number" } }, { "in": "query", "name": "query", "schema": { "type": "string" } }, { "in": "query", "name": "orderByColumn", "schema": { "type": "string" } }, { "in": "query", "name": "orderByDirection", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogItemOutputDto" } }, "message": { "type": "string", "example": "Success" }, "timestamp": { "type": "string", "example": 1793891111632 }, "meta": { "$ref": "#/components/schemas/PaginationMetaOutputDto" } }, "required": [ "data", "message", "timestamp", "meta" ] } } }, "description": "" } }, "summary": "List the document types released to the company", "tags": [ "Api Catalog" ], "security": [ { "ApiKeyAuth": [] } ] } }, "/v1/api/catalog/declarations": { "get": { "operationId": "paginateCatalogDeclarationsUsingApi", "parameters": [ { "in": "query", "name": "page", "schema": { "minimum": 1, "type": "number" } }, { "in": "query", "name": "perPage", "schema": { "minimum": 1, "type": "number" } }, { "in": "query", "name": "query", "schema": { "type": "string" } }, { "in": "query", "name": "orderByColumn", "schema": { "type": "string" } }, { "in": "query", "name": "orderByDirection", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogItemOutputDto" } }, "message": { "type": "string", "example": "Success" }, "timestamp": { "type": "string", "example": 1793891111632 }, "meta": { "$ref": "#/components/schemas/PaginationMetaOutputDto" } }, "required": [ "data", "message", "timestamp", "meta" ] } } }, "description": "" } }, "summary": "List the declarations of the company", "tags": [ "Api Catalog" ], "security": [ { "ApiKeyAuth": [] } ] } }, "/v1/api/catalog/custom-document-types": { "get": { "operationId": "paginateCatalogCustomDocumentTypesUsingApi", "parameters": [ { "in": "query", "name": "page", "schema": { "minimum": 1, "type": "number" } }, { "in": "query", "name": "perPage", "schema": { "minimum": 1, "type": "number" } }, { "in": "query", "name": "query", "schema": { "type": "string" } }, { "in": "query", "name": "orderByColumn", "schema": { "type": "string" } }, { "in": "query", "name": "orderByDirection", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogItemOutputDto" } }, "message": { "type": "string", "example": "Success" }, "timestamp": { "type": "string", "example": 1793891111633 }, "meta": { "$ref": "#/components/schemas/PaginationMetaOutputDto" } }, "required": [ "data", "message", "timestamp", "meta" ] } } }, "description": "" } }, "summary": "List the custom document types of the company", "tags": [ "Api Catalog" ], "security": [ { "ApiKeyAuth": [] } ] } } }, "components": { "schemas": { "AddParticipantDependentsWithApiInputDto": { "properties": { "dependents": { "items": { "properties": { "name": { "type": "string" }, "cpf": { "type": "string" }, "cnpj": { "type": "string" }, "dateOfBirth": { "type": "string", "format": "date", "example": "2026-09-01", "nullable": true }, "competencyDocumentGroupId": { "not": { "type": "null" }, "type": "string" }, "gender": { "type": "string", "example": "MALE", "examples": [ "MALE", "FEMALE" ] }, "type": { "type": "string", "example": "CHILD", "examples": [ "CHILD", "GRANDPARENT", "PARTNER", "SPOUSE", "STEPCHILD", "SIBLING", "STEPMOTHER", "MOTHER", "STEPFATHER", "FATHER", "OTHER", "NOT_REQUIRED" ] }, "customFields": { "type": "object" } }, "type": "object", "required": [ "name", "competencyDocumentGroupId" ] }, "type": "array" } }, "type": "object", "required": [ "dependents" ] }, "AddParticipantDependentsWithApiOutputDto": { "properties": { "_id": { "type": "string" }, "name": { "type": "string" }, "cnpj": { "type": "string" }, "cpf": { "type": "string" }, "dateOfBirth": { "type": "string", "format": "date", "example": "2026-09-01", "nullable": true }, "gender": { "type": "string" }, "competencyDocumentGroupId": { "type": "string" }, "type": { "type": "string" }, "customFields": { "type": "array", "items": { "type": "object" } } }, "type": "object", "required": [ "_id", "name", "cnpj", "cpf", "dateOfBirth", "gender", "competencyDocumentGroupId", "type", "customFields" ] }, "ApiDocumentUpdateParticipantStatusInputDto": { "properties": { "status": { "type": "string", "example": "PENDING", "examples": [ "PENDING", "STARTED", "APPROVED_BY_AI", "IN_ANALYSIS", "APPROVED", "DISAPPROVED" ] }, "reason": { "type": "string" } }, "type": "object", "required": [ "status" ] }, "ApiDocumentUpdateParticipantStatusOutputDto": { "properties": { "_id": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "cpf": { "type": "string" }, "cnpj": { "type": "string" }, "dateOfBirth": { "type": "string", "format": "date", "example": "2026-09-01", "nullable": true }, "type": { "type": "string" }, "gender": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "projectId": { "type": "string" }, "competencyId": { "type": "string" }, "status": { "type": "string", "examples": [] } }, "type": "object", "required": [ "_id", "name", "email", "cpf", "cnpj", "dateOfBirth", "type", "gender", "createdAt", "updatedAt", "projectId", "competencyId", "status" ] }, "CatalogItemOutputDto": { "properties": { "documentId": { "type": "string" }, "declarationId": { "type": "string", "nullable": true }, "customDocumentTypeId": { "type": "string", "nullable": true }, "type": { "type": "string" }, "title": { "type": "string" } }, "type": "object", "required": [ "documentId", "declarationId", "customDocumentTypeId", "type", "title" ] }, "CompetencyDocumentRuleInputDto": { "properties": { "type": { "type": "string" }, "inputName": { "type": "string" }, "inputValue": { "items": { "type": "string" }, "type": "array" } }, "type": "object", "required": [ "type", "inputName", "inputValue" ] }, "ConcludeSubmissionOutputDto": { "properties": { "status": { "type": "string" }, "submissionCompleted": { "type": "boolean", "nullable": false }, "submissionCompletedAt": { "type": "string", "format": "date-time", "nullable": true }, "issues": { "items": { "properties": { "message": { "type": "string" }, "participantDocumentId": { "type": "string", "nullable": true } }, "type": "object", "required": [ "message", "participantDocumentId" ] }, "type": "array" } }, "type": "object", "required": [ "status", "submissionCompleted", "submissionCompletedAt", "issues" ] }, "CreateApiDocumentInputDto": { "properties": { "type": { "type": "string", "example": "RG", "description": "Tipo do documento. A lista completa não é publicada aqui porque os tipos que uma empresa pode usar dependem do que foi liberado para ela. Consulte `GET /v1/api/catalog/documents` para o catálogo da sua empresa." }, "customDocumentTypeId": { "not": { "type": "null" }, "type": "string" }, "files": { "type": "array", "items": { "type": "string", "format": "binary" } }, "rules": { "type": "array", "items": { "$ref": "#/components/schemas/CompetencyDocumentRuleInputDto" } }, "ownerData": { "properties": { "name": { "type": "string" }, "cpf": { "type": "string" }, "cnpj": { "type": "string" }, "dateOfBirth": { "type": "string", "format": "date", "example": "2026-09-01", "nullable": true } }, "type": "object" }, "maxPages": { "minimum": 1, "type": "integer" } }, "type": "object", "required": [ "files" ] }, "CreateApiDocumentOutputDto": { "properties": { "_id": { "type": "string" }, "status": { "type": "string", "examples": [] }, "pagesCount": { "type": "number" }, "type": { "type": "string", "nullable": true }, "ownerData": { "properties": { "name": { "type": "string", "nullable": true }, "cpf": { "type": "string", "nullable": true }, "cnpj": { "type": "string", "nullable": true }, "dateOfBirth": { "type": "string", "format": "date", "example": "2026-09-01", "nullable": true } }, "type": "object", "required": [ "name", "cpf", "cnpj", "dateOfBirth" ] }, "createdAt": { "type": "string", "format": "date-time" } }, "type": "object", "required": [ "_id", "status", "pagesCount", "type", "ownerData", "createdAt" ] }, "CreateCompetencyParticipantInputDto": { "properties": { "name": { "type": "string" }, "email": { "format": "email", "type": "string" }, "cpf": { "type": "string" }, "cnpj": { "type": "string" }, "phone": { "type": "string", "nullable": true }, "dateOfBirth": { "type": "string", "format": "date", "example": "2026-09-01", "nullable": true }, "documentSubmissionDeadline": { "type": "string", "format": "date", "example": "2026-09-01", "nullable": true }, "gender": { "type": "string", "example": "MALE", "examples": [ "MALE", "FEMALE" ] }, "type": { "type": "string", "example": "PF", "examples": [ "PF", "PJ" ] }, "customFields": { "type": "object" }, "companyTagsIds": { "not": { "type": "null" }, "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "email", "type" ] }, "CreateCompetencyParticipantOutputDto": { "properties": { "_id": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "cpf": { "type": "string" }, "cnpj": { "type": "string" }, "dateOfBirth": { "type": "string", "format": "date", "example": "2026-09-01", "nullable": true }, "documentSubmissionDeadline": { "type": "string", "format": "date", "example": "2026-09-01", "nullable": true }, "type": { "type": "string" }, "gender": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "projectId": { "type": "string" }, "competencyId": { "type": "string" }, "status": { "type": "string", "examples": [] } }, "type": "object", "required": [ "_id", "name", "email", "cpf", "cnpj", "dateOfBirth", "documentSubmissionDeadline", "type", "gender", "createdAt", "updatedAt", "projectId", "competencyId", "status" ] }, "CreateDatasetRowInputDto": { "properties": { "data": { "type": "object" } }, "type": "object", "required": [ "data" ] }, "CreateDocumentJustificationUsingApiInputDto": { "properties": { "justification": { "not": { "type": "null" }, "type": "string" }, "files": { "type": "array", "items": { "type": "string", "format": "binary" } }, "participantDocumentId": { "not": { "type": "null" }, "type": "string" } }, "type": "object", "required": [ "justification", "files", "participantDocumentId" ] }, "CreateParticipantDocumentUsingApiDto": { "properties": { "files": { "type": "array", "items": { "type": "string", "format": "binary" } }, "rules": { "type": "array", "items": { "$ref": "#/components/schemas/CompetencyDocumentRuleInputDto" } }, "dependentId": { "not": { "type": "null" }, "type": "string" }, "competencyDocumentId": { "not": { "type": "null" }, "type": "string" }, "extraData": { "type": "object" } }, "type": "object", "required": [ "files", "competencyDocumentId" ] }, "CreateParticipantInputDocumentUsingApiInputDto": { "properties": { "competencyDocumentId": { "not": { "type": "null" }, "type": "string" }, "dependentId": { "not": { "type": "null" }, "type": "string" }, "value": { "type": "string", "not": { "type": "null" } } }, "type": "object", "required": [ "competencyDocumentId", "value" ] }, "CreateParticipantInputDocumentUsingApiOutputDto": { "properties": { "_id": { "type": "string" }, "type": { "type": "string" }, "documentStatus": { "type": "string" } }, "type": "object", "required": [ "_id", "type", "documentStatus" ] }, "CreateProjectCompetencyInputDto": { "properties": { "projectId": { "not": { "type": "null" }, "type": "string" }, "publicTitle": { "maxLength": 270, "type": "string" }, "allowParticipantRegister": { "type": "boolean" }, "enableSubmissionConclusion": { "type": "boolean" }, "allowAiDocumentSplit": { "type": "boolean" }, "aiDocumentSplitMaxPages": { "minimum": 1, "type": "integer" }, "competency": { "type": "string" }, "startAt": { "type": "string", "format": "date", "example": "2026-09-01", "nullable": true }, "endAt": { "type": "string", "format": "date", "example": "2026-09-01", "nullable": true }, "competencyIdToCopy": { "not": { "type": "null" }, "type": "string" }, "isToCopyDocuments": { "type": "boolean" }, "isToCopyFormula": { "type": "boolean" }, "isToCopyParticipants": { "type": "boolean" }, "customFields": { "type": "object" } }, "type": "object", "required": [ "projectId", "publicTitle", "allowParticipantRegister", "enableSubmissionConclusion", "allowAiDocumentSplit", "competency" ] }, "CreateProjectCompetencyOutputDto": { "properties": { "_id": { "not": { "type": "null" }, "type": "string" }, "projectId": { "type": "string" }, "documentGroups": { "items": { "properties": { "_id": { "type": "string" }, "title": { "type": "string" }, "instructions": { "type": "string", "nullable": true }, "type": { "type": "string" }, "order": { "type": "number" }, "cpfRequiredCondition": { "type": "string" }, "cpfRequiredForAge": { "type": "number" }, "juridicNature": { "type": "string" }, "requiresRelationship": { "type": "boolean", "nullable": true } }, "type": "object", "required": [ "_id", "title", "instructions", "type", "order", "cpfRequiredCondition", "cpfRequiredForAge", "juridicNature", "requiresRelationship" ] }, "type": "array" }, "documents": { "items": { "properties": { "_id": { "type": "string" }, "documentId": { "type": "string" }, "competencyId": { "type": "string" }, "documentGroupId": { "type": "string" }, "declarationId": { "type": "string", "nullable": true }, "customDocumentTypeId": { "type": "string", "nullable": true }, "competencyDocumentGroupId": { "type": "string" }, "isRequired": { "type": "boolean", "nullable": false }, "isHiddenFromParticipant": { "type": "boolean", "nullable": false }, "showWarningWhenRejectedByAI": { "type": "boolean", "nullable": false }, "rules": { "items": { "properties": { "type": { "type": "string" }, "inputName": { "type": "string" }, "inputValue": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "type", "inputName", "inputValue" ] }, "type": "array" }, "document": { "properties": { "_id": { "type": "string" }, "type": { "type": "string" }, "title": { "type": "string" }, "rules": { "items": { "properties": { "type": { "type": "string" }, "properties": { "items": { "properties": { "inputType": { "type": "string" }, "inputName": { "type": "string" }, "conditions": { "items": { "properties": { "source": { "type": "string", "nullable": true }, "inputName": { "type": "string" }, "condition": { "type": "string" }, "value": { "type": "string" } }, "type": "object", "required": [ "source", "inputName", "condition", "value" ] }, "type": "array" }, "options": { "items": { "properties": { "label": { "type": "string" }, "value": { "type": "string" } }, "type": "object", "required": [ "label", "value" ] }, "type": "array" }, "resourceRef": { "type": "string", "nullable": true }, "inputLabel": { "type": "string" }, "inputDefaultValue": { "type": "string", "nullable": true }, "isMultiple": { "type": "boolean", "nullable": false }, "isMultiline": { "type": "boolean", "nullable": false } }, "type": "object", "required": [ "inputType", "inputName", "conditions", "options", "resourceRef", "inputLabel", "inputDefaultValue", "isMultiple", "isMultiline" ] }, "type": "array" }, "helperText": { "type": "string" }, "title": { "type": "string" }, "requiredCompanyFeature": { "type": "string", "nullable": true } }, "type": "object", "required": [ "type", "properties", "helperText", "title", "requiredCompanyFeature" ] }, "type": "array" } }, "type": "object", "required": [ "_id", "type", "title", "rules" ] }, "acceptJustification": { "type": "boolean", "nullable": false }, "allowMultipleUploads": { "type": "boolean", "nullable": true }, "minMultipleUploads": { "type": "number", "nullable": true }, "maxMultipleUploads": { "type": "number", "nullable": true }, "requiredForGender": { "type": "string" }, "requiredForAge": { "properties": { "condition": { "type": "string" }, "value": { "type": "string", "nullable": true } }, "type": "object", "required": [ "condition" ] }, "alternativeName": { "type": "string" }, "description": { "type": "string" }, "order": { "type": "number" }, "descriptionLink": { "type": "string" }, "type": { "type": "string" }, "maxPages": { "type": "number", "nullable": true }, "minPages": { "type": "number", "nullable": true }, "supportsAutoEmission": { "type": "boolean", "nullable": true }, "supportsForensicAnalysis": { "type": "boolean", "nullable": true }, "autoEmissionPortals": { "items": { "properties": { "name": { "type": "string" }, "url": { "type": "string" } }, "type": "object", "required": [ "name", "url" ] }, "type": "array" }, "autoEmission": { "type": "boolean", "nullable": true }, "category": { "type": "string", "nullable": true }, "joinOperator": { "type": "string", "nullable": true }, "conditions": { "items": { "properties": { "sourceType": { "type": "string", "nullable": true }, "referencedCompetencyDocumentId": { "type": "string", "nullable": true }, "documentProperty": { "type": "string", "nullable": true }, "customFieldName": { "type": "string", "nullable": true }, "customFieldType": { "type": "string", "nullable": true }, "operator": { "type": "string" }, "value": { "type": "string" } }, "type": "object", "required": [ "sourceType", "referencedCompetencyDocumentId", "documentProperty", "customFieldName", "customFieldType", "operator", "value" ] }, "type": "array" } }, "type": "object", "required": [ "_id", "documentId", "competencyId", "documentGroupId", "declarationId", "customDocumentTypeId", "competencyDocumentGroupId", "isRequired", "isHiddenFromParticipant", "showWarningWhenRejectedByAI", "rules", "document", "acceptJustification", "minMultipleUploads", "maxMultipleUploads", "requiredForGender", "requiredForAge", "alternativeName", "description", "order", "descriptionLink", "type", "maxPages", "minPages", "supportsAutoEmission", "supportsForensicAnalysis", "autoEmissionPortals", "autoEmission", "category", "joinOperator", "conditions" ] }, "type": "array" }, "allowParticipantRegister": { "type": "boolean", "nullable": false }, "competency": { "type": "string" }, "companyId": { "type": "string" }, "startAt": { "type": "string", "format": "date", "example": "2026-09-01", "nullable": true }, "endAt": { "type": "string", "format": "date", "example": "2026-09-01", "nullable": true }, "publicTitle": { "type": "string" }, "customFields": { "items": { "properties": { "value": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "name": { "type": "string" }, "label": { "type": "string" } }, "type": "object", "required": [ "value", "name", "label" ] }, "type": "array" }, "enableSubmissionConclusion": { "type": "boolean", "nullable": false }, "allowAiDocumentSplit": { "type": "boolean", "nullable": false }, "aiDocumentSplitMaxPages": { "type": "number", "nullable": true } }, "type": "object", "required": [ "_id", "projectId", "documentGroups", "documents", "allowParticipantRegister", "competency", "companyId", "startAt", "endAt", "publicTitle", "customFields", "enableSubmissionConclusion", "allowAiDocumentSplit", "aiDocumentSplitMaxPages" ] }, "CreditTransferAnalysisListItemOutputDto": { "properties": { "_id": { "not": { "type": "null" }, "type": "string" }, "status": { "type": "string" }, "source": { "type": "string" }, "trigger": { "type": "string" }, "externalId": { "type": "string", "nullable": true }, "competencyParticipantId": { "not": { "type": "null" }, "type": "string" }, "destinationCompetencyDocumentId": { "not": { "type": "null" }, "type": "string" }, "parameters": { "properties": { "minScore": { "type": "number" }, "creditHoursTolerance": { "type": "number", "nullable": true }, "complexity": { "type": "string" }, "allowCombination": { "type": "boolean", "nullable": false }, "minScoreToDisplay": { "type": "number" } }, "type": "object", "required": [ "minScore", "creditHoursTolerance", "complexity", "allowCombination", "minScoreToDisplay" ] }, "summary": { "properties": { "destinationSubjects": { "type": "number" }, "exempted": { "type": "number" }, "exemptedByCombination": { "type": "number" } }, "type": "object", "required": [ "destinationSubjects", "exempted", "exemptedByCombination" ], "nullable": true }, "failure": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "type": "object", "required": [ "code", "message" ], "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "startedAt": { "type": "string", "format": "date-time", "nullable": true }, "completedAt": { "type": "string", "format": "date-time", "nullable": true }, "outdatedAt": { "type": "string", "format": "date-time", "nullable": true } }, "type": "object", "required": [ "_id", "status", "source", "trigger", "externalId", "competencyParticipantId", "destinationCompetencyDocumentId", "parameters", "summary", "failure", "createdAt", "updatedAt", "startedAt", "completedAt", "outdatedAt" ] }, "CreditTransferAnalysisOutputDto": { "properties": { "subjects": { "items": { "properties": { "name": { "type": "string", "nullable": true }, "period": { "type": "number", "nullable": true }, "workloadHours": { "type": "number", "nullable": true }, "mandatoryPractice": { "type": "boolean", "nullable": false }, "exempted": { "type": "boolean", "nullable": false }, "exemptedBy": { "type": "string", "nullable": true }, "equivalences": { "items": { "properties": { "originSubject": { "properties": { "name": { "type": "string", "nullable": true }, "period": { "type": "number", "nullable": true }, "workloadHours": { "type": "number", "nullable": true }, "institution": { "type": "string", "nullable": true }, "course": { "type": "string", "nullable": true } }, "type": "object", "required": [ "name", "period", "workloadHours", "institution", "course" ] }, "score": { "type": "number", "nullable": true }, "approved": { "type": "boolean", "nullable": false }, "rejectionReason": { "type": "string", "nullable": true }, "justification": { "type": "string", "nullable": true } }, "type": "object", "required": [ "originSubject", "score", "approved", "rejectionReason", "justification" ] }, "type": "array" }, "combination": { "properties": { "approved": { "type": "boolean", "nullable": false }, "score": { "type": "number", "nullable": true }, "justification": { "type": "string", "nullable": true }, "rejectionReason": { "type": "string", "nullable": true }, "originSubjects": { "items": { "properties": { "name": { "type": "string", "nullable": true }, "period": { "type": "number", "nullable": true }, "workloadHours": { "type": "number", "nullable": true }, "institution": { "type": "string", "nullable": true }, "course": { "type": "string", "nullable": true } }, "type": "object", "required": [ "name", "period", "workloadHours", "institution", "course" ] }, "type": "array" } }, "type": "object", "required": [ "approved", "score", "justification", "rejectionReason", "originSubjects" ], "nullable": true } }, "type": "object", "required": [ "name", "period", "workloadHours", "mandatoryPractice", "exempted", "exemptedBy", "equivalences", "combination" ] }, "type": "array", "nullable": true }, "_id": { "not": { "type": "null" }, "type": "string" }, "status": { "type": "string" }, "source": { "type": "string" }, "trigger": { "type": "string" }, "externalId": { "type": "string", "nullable": true }, "competencyParticipantId": { "not": { "type": "null" }, "type": "string" }, "destinationCompetencyDocumentId": { "not": { "type": "null" }, "type": "string" }, "parameters": { "properties": { "minScore": { "type": "number" }, "creditHoursTolerance": { "type": "number", "nullable": true }, "complexity": { "type": "string" }, "allowCombination": { "type": "boolean", "nullable": false }, "minScoreToDisplay": { "type": "number" } }, "type": "object", "required": [ "minScore", "creditHoursTolerance", "complexity", "allowCombination", "minScoreToDisplay" ] }, "summary": { "properties": { "destinationSubjects": { "type": "number" }, "exempted": { "type": "number" }, "exemptedByCombination": { "type": "number" } }, "type": "object", "required": [ "destinationSubjects", "exempted", "exemptedByCombination" ], "nullable": true }, "failure": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "type": "object", "required": [ "code", "message" ], "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "startedAt": { "type": "string", "format": "date-time", "nullable": true }, "completedAt": { "type": "string", "format": "date-time", "nullable": true }, "outdatedAt": { "type": "string", "format": "date-time", "nullable": true } }, "type": "object", "required": [ "subjects", "_id", "status", "source", "trigger", "externalId", "competencyParticipantId", "destinationCompetencyDocumentId", "parameters", "summary", "failure", "createdAt", "updatedAt", "startedAt", "completedAt", "outdatedAt" ] }, "DatasetOutputDto": { "properties": { "_id": { "type": "string" }, "name": { "type": "string" }, "columns": { "items": { "properties": { "name": { "type": "string" }, "type": { "type": "string", "examples": [] }, "key": { "type": "string" }, "options": { "type": "object" } }, "type": "object", "required": [ "name", "type", "key", "options" ] }, "type": "array" }, "rowCount": { "type": "number" }, "structured": { "type": "boolean", "nullable": false }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "type": "object", "required": [ "_id", "name", "columns", "rowCount", "structured", "createdAt", "updatedAt" ] }, "DeleteDatasetRowsInputDto": { "properties": { "ids": { "not": { "type": "null" }, "items": { "type": "string" }, "minItems": 1, "type": "array" } }, "type": "object", "required": [ "ids" ] }, "ExecuteCompetencyValidationCodeForSplitOutputDto": { "properties": { "status": { "type": "string" }, "documents": { "items": { "properties": { "_id": { "type": "string" }, "status": { "type": "string", "examples": [] }, "pagesCount": { "type": "number" }, "type": { "type": "string", "nullable": true }, "uploadedDocumentType": { "type": "string" }, "parsedContent": { "type": "object", "nullable": true }, "validationErrors": { "items": { "properties": { "message": { "type": "string" }, "path": { "type": "array", "items": { "type": "string" } }, "group": { "type": "string" } }, "type": "object", "required": [ "message", "path", "group" ] }, "type": "array" }, "createdAt": { "type": "string", "format": "date-time" }, "ownerData": { "properties": { "name": { "type": "string", "nullable": true }, "cpf": { "type": "string", "nullable": true }, "cnpj": { "type": "string", "nullable": true }, "dateOfBirth": { "type": "string", "format": "date", "example": "2026-09-01", "nullable": true } }, "type": "object", "required": [ "name", "cpf", "cnpj", "dateOfBirth" ] }, "computedFields": { "items": { "properties": { "_id": { "not": { "type": "null" }, "type": "string" }, "label": { "type": "string" }, "value": { "type": "string" }, "type": { "type": "string", "example": "CHECKBOX", "examples": [ "CHECKBOX", "TEXT", "TEXT_AREA", "MARKDOWN" ] }, "subgroup": { "type": "string" } }, "type": "object", "required": [ "label", "value", "type" ] }, "type": "array" }, "validationCheckpoints": { "items": { "properties": { "_id": { "type": "string", "nullable": true }, "status": { "type": "string" }, "description": { "type": "string" }, "index": { "type": "number", "nullable": true }, "origin": { "type": "string", "nullable": true }, "steps": { "items": { "properties": { "status": { "type": "string" }, "description": { "type": "string" }, "details": { "type": "string", "nullable": true }, "timestamp": { "type": "string", "format": "date-time", "nullable": true } }, "type": "object", "required": [ "status", "description", "details", "timestamp" ] }, "type": "array" }, "timestamp": { "type": "string", "format": "date-time", "nullable": true } }, "type": "object", "required": [ "_id", "status", "description", "index", "origin", "steps", "timestamp" ] }, "type": "array" }, "documentExtraData": { "properties": { "competencyParticipantId": { "type": "string" }, "projectCompetencyId": { "type": "string" } }, "type": "object", "required": [ "competencyParticipantId", "projectCompetencyId" ], "nullable": true } }, "type": "object", "required": [ "_id", "status", "pagesCount", "type", "uploadedDocumentType", "parsedContent", "validationErrors", "createdAt", "ownerData", "computedFields", "validationCheckpoints", "documentExtraData" ] }, "type": "array" } }, "type": "object", "required": [ "status", "documents" ] }, "FetchApiDocumentByIdOutpuDto": { "properties": { "_id": { "type": "string" }, "status": { "type": "string", "examples": [] }, "pagesCount": { "type": "number" }, "type": { "type": "string", "nullable": true }, "uploadedDocumentType": { "type": "string" }, "parsedContent": { "type": "object", "nullable": true }, "validationErrors": { "items": { "properties": { "message": { "type": "string" }, "path": { "type": "array", "items": { "type": "string" } }, "group": { "type": "string" } }, "type": "object", "required": [ "message", "path", "group" ] }, "type": "array" }, "createdAt": { "type": "string", "format": "date-time" }, "ownerData": { "properties": { "name": { "type": "string", "nullable": true }, "cpf": { "type": "string", "nullable": true }, "cnpj": { "type": "string", "nullable": true }, "dateOfBirth": { "type": "string", "format": "date", "example": "2026-09-01", "nullable": true } }, "type": "object", "required": [ "name", "cpf", "cnpj", "dateOfBirth" ] }, "computedFields": { "items": { "properties": { "_id": { "not": { "type": "null" }, "type": "string" }, "label": { "type": "string" }, "value": { "type": "string" }, "type": { "type": "string", "example": "CHECKBOX", "examples": [ "CHECKBOX", "TEXT", "TEXT_AREA", "MARKDOWN" ] }, "subgroup": { "type": "string" } }, "type": "object", "required": [ "label", "value", "type" ] }, "type": "array" }, "validationCheckpoints": { "items": { "properties": { "_id": { "type": "string", "nullable": true }, "status": { "type": "string" }, "description": { "type": "string" }, "index": { "type": "number", "nullable": true }, "origin": { "type": "string", "nullable": true }, "steps": { "items": { "properties": { "status": { "type": "string" }, "description": { "type": "string" }, "details": { "type": "string", "nullable": true }, "timestamp": { "type": "string", "format": "date-time", "nullable": true } }, "type": "object", "required": [ "status", "description", "details", "timestamp" ] }, "type": "array" }, "timestamp": { "type": "string", "format": "date-time", "nullable": true } }, "type": "object", "required": [ "_id", "status", "description", "index", "origin", "steps", "timestamp" ] }, "type": "array" }, "documentExtraData": { "properties": { "competencyParticipantId": { "type": "string" }, "projectCompetencyId": { "type": "string" } }, "type": "object", "required": [ "competencyParticipantId", "projectCompetencyId" ], "nullable": true } }, "type": "object", "required": [ "_id", "status", "pagesCount", "type", "uploadedDocumentType", "parsedContent", "validationErrors", "createdAt", "ownerData", "computedFields", "validationCheckpoints", "documentExtraData" ] }, "FetchCompetencyDocumentIdOutputDto": { "properties": { "_id": { "type": "string" }, "competencyParticipantId": { "type": "string", "nullable": true }, "participantDependentId": { "type": "string", "nullable": true }, "documentUrl": { "type": "string", "nullable": true }, "competencyDocumentTitle": { "type": "string" }, "justification": { "type": "string", "nullable": true }, "justificationUrl": { "type": "string", "nullable": true }, "status": { "type": "string", "examples": [] }, "pagesCount": { "type": "number" }, "type": { "type": "string", "nullable": true }, "uploadedDocumentType": { "type": "string" }, "parsedContent": { "type": "object", "nullable": true }, "validationErrors": { "items": { "properties": { "message": { "type": "string" }, "path": { "type": "array", "items": { "type": "string" } }, "group": { "type": "string" } }, "type": "object", "required": [ "message", "path", "group" ] }, "type": "array" }, "createdAt": { "type": "string", "format": "date-time" }, "ownerData": { "properties": { "name": { "type": "string", "nullable": true }, "cpf": { "type": "string", "nullable": true }, "cnpj": { "type": "string", "nullable": true }, "dateOfBirth": { "type": "string", "format": "date", "example": "2026-09-01", "nullable": true } }, "type": "object", "required": [ "name", "cpf", "cnpj", "dateOfBirth" ] }, "computedFields": { "items": { "properties": { "_id": { "not": { "type": "null" }, "type": "string" }, "label": { "type": "string" }, "value": { "type": "string" }, "type": { "type": "string", "example": "CHECKBOX", "examples": [ "CHECKBOX", "TEXT", "TEXT_AREA", "MARKDOWN" ] }, "subgroup": { "type": "string" } }, "type": "object", "required": [ "label", "value", "type" ] }, "type": "array" }, "validationCheckpoints": { "items": { "properties": { "_id": { "type": "string", "nullable": true }, "status": { "type": "string" }, "description": { "type": "string" }, "index": { "type": "number", "nullable": true }, "origin": { "type": "string", "nullable": true }, "steps": { "items": { "properties": { "status": { "type": "string" }, "description": { "type": "string" }, "details": { "type": "string", "nullable": true }, "timestamp": { "type": "string", "format": "date-time", "nullable": true } }, "type": "object", "required": [ "status", "description", "details", "timestamp" ] }, "type": "array" }, "timestamp": { "type": "string", "format": "date-time", "nullable": true } }, "type": "object", "required": [ "_id", "status", "description", "index", "origin", "steps", "timestamp" ] }, "type": "array" }, "documentExtraData": { "properties": { "competencyParticipantId": { "type": "string" }, "projectCompetencyId": { "type": "string" } }, "type": "object", "required": [ "competencyParticipantId", "projectCompetencyId" ], "nullable": true } }, "type": "object", "required": [ "_id", "competencyParticipantId", "participantDependentId", "documentUrl", "competencyDocumentTitle", "justification", "justificationUrl", "status", "pagesCount", "type", "uploadedDocumentType", "parsedContent", "validationErrors", "createdAt", "ownerData", "computedFields", "validationCheckpoints", "documentExtraData" ] }, "FetchCompetencyParticipantDocumentsDataOutputDto": { "properties": { "documents": { "items": { "properties": { "_id": { "type": "string" }, "status": { "type": "string", "examples": [] }, "pagesCount": { "type": "number" }, "type": { "type": "string", "nullable": true }, "uploadedDocumentType": { "type": "string" }, "parsedContent": { "type": "object", "nullable": true }, "validationErrors": { "items": { "properties": { "message": { "type": "string" }, "path": { "type": "array", "items": { "type": "string" } }, "group": { "type": "string" } }, "type": "object", "required": [ "message", "path", "group" ] }, "type": "array" }, "createdAt": { "type": "string", "format": "date-time" }, "ownerData": { "properties": { "name": { "type": "string", "nullable": true }, "cpf": { "type": "string", "nullable": true }, "cnpj": { "type": "string", "nullable": true }, "dateOfBirth": { "type": "string", "format": "date", "example": "2026-09-01", "nullable": true } }, "type": "object", "required": [ "name", "cpf", "cnpj", "dateOfBirth" ] }, "computedFields": { "items": { "properties": { "_id": { "not": { "type": "null" }, "type": "string" }, "label": { "type": "string" }, "value": { "type": "string" }, "type": { "type": "string", "example": "CHECKBOX", "examples": [ "CHECKBOX", "TEXT", "TEXT_AREA", "MARKDOWN" ] }, "subgroup": { "type": "string" } }, "type": "object", "required": [ "label", "value", "type" ] }, "type": "array" }, "validationCheckpoints": { "items": { "properties": { "_id": { "type": "string", "nullable": true }, "status": { "type": "string" }, "description": { "type": "string" }, "index": { "type": "number", "nullable": true }, "origin": { "type": "string", "nullable": true }, "steps": { "items": { "properties": { "status": { "type": "string" }, "description": { "type": "string" }, "details": { "type": "string", "nullable": true }, "timestamp": { "type": "string", "format": "date-time", "nullable": true } }, "type": "object", "required": [ "status", "description", "details", "timestamp" ] }, "type": "array" }, "timestamp": { "type": "string", "format": "date-time", "nullable": true } }, "type": "object", "required": [ "_id", "status", "description", "index", "origin", "steps", "timestamp" ] }, "type": "array" }, "documentExtraData": { "properties": { "competencyParticipantId": { "type": "string" }, "projectCompetencyId": { "type": "string" } }, "type": "object", "required": [ "competencyParticipantId", "projectCompetencyId" ], "nullable": true } }, "type": "object", "required": [ "_id", "status", "pagesCount", "type", "uploadedDocumentType", "parsedContent", "validationErrors", "createdAt", "ownerData", "computedFields", "validationCheckpoints", "documentExtraData" ] }, "type": "array" } }, "type": "object", "required": [ "documents" ] }, "FetchCompetencyParticipantDocumentsOutputDto": { "properties": { "_id": { "type": "string" }, "competencyDocumentId": { "type": "string" }, "competencyParticipantId": { "type": "string" }, "participantDependentId": { "type": "string", "nullable": true }, "documentGroupId": { "type": "string" }, "type": { "type": "string" }, "status": { "type": "string", "examples": [] }, "createdAt": { "type": "string", "format": "date-time" }, "competencyDocumentTitle": { "type": "string" } }, "type": "object", "required": [ "_id", "competencyDocumentId", "competencyParticipantId", "participantDependentId", "documentGroupId", "type", "status", "createdAt", "competencyDocumentTitle" ] }, "FetchCompetencyParticipantOutputDto": { "properties": { "_id": { "type": "string" }, "name": { "type": "string" }, "cpf": { "type": "string", "nullable": true }, "cnpj": { "type": "string", "nullable": true }, "dateOfBirth": { "type": "string", "format": "date", "example": "2026-09-01", "nullable": true }, "gender": { "type": "string", "nullable": true }, "customFields": { "items": { "properties": { "name": { "type": "string" }, "value": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } }, "type": "object", "required": [ "name", "value" ] }, "type": "array" }, "status": { "type": "string", "examples": [] }, "dependents": { "items": { "properties": { "_id": { "type": "string" }, "name": { "type": "string" }, "cpf": { "type": "string", "nullable": true }, "cnpj": { "type": "string", "nullable": true }, "type": { "type": "string" }, "dateOfBirth": { "type": "string", "format": "date", "example": "2026-09-01", "nullable": true }, "gender": { "type": "string", "nullable": true }, "customFields": { "items": { "properties": { "name": { "type": "string" }, "value": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } }, "type": "object", "required": [ "name", "value" ] }, "type": "array" }, "documentGroup": { "items": { "properties": { "_id": { "type": "string" }, "title": { "type": "string" } }, "type": "object", "required": [ "_id", "title" ] }, "type": "array", "nullable": true } }, "type": "object", "required": [ "_id", "name", "cpf", "cnpj", "type", "dateOfBirth", "gender", "customFields", "documentGroup" ] }, "type": "array" } }, "type": "object", "required": [ "_id", "name", "cpf", "cnpj", "dateOfBirth", "gender", "customFields", "status", "dependents" ] }, "FetchParticipantDocumentFileUrlOutputDto": { "properties": { "fileUrl": { "type": "string", "nullable": true }, "justificationFileUrl": { "type": "string", "nullable": true } }, "type": "object", "required": [ "fileUrl", "justificationFileUrl" ] }, "FetchParticipantDocumentRequestsOutputDto": { "properties": { "_id": { "type": "string" }, "title": { "type": "string" }, "instructions": { "type": "string", "nullable": true }, "type": { "type": "string" }, "juridicNature": { "type": "string" }, "order": { "type": "number" }, "requiresRelationship": { "type": "boolean", "nullable": true }, "cpfRequiredCondition": { "type": "string" }, "cpfRequiredForAge": { "type": "number", "nullable": true }, "isAgeRequired": { "type": "boolean", "nullable": false }, "isGenderRequired": { "type": "boolean", "nullable": false }, "documentRequests": { "items": { "properties": { "competencyDocumentId": { "type": "string" }, "name": { "type": "string" }, "alternativeName": { "type": "string" }, "type": { "type": "string" }, "category": { "type": "string", "nullable": true }, "order": { "type": "number" }, "isRequired": { "type": "boolean", "nullable": false }, "description": { "type": "string" }, "descriptionLink": { "type": "string" }, "allowMultipleUploads": { "type": "boolean", "nullable": false }, "minMultipleUploads": { "type": "number", "nullable": true }, "maxMultipleUploads": { "type": "number", "nullable": true }, "acceptJustification": { "type": "boolean", "nullable": false }, "autoEmission": { "type": "boolean", "nullable": true }, "allowedFileExtensions": { "type": "array", "items": { "type": "string" } }, "substituteDocumentTitles": { "type": "array", "items": { "type": "string" } }, "acceptedDocuments": { "items": { "properties": { "role": { "type": "string" }, "type": { "type": "string" }, "title": { "type": "string" }, "declarationId": { "type": "string", "nullable": true }, "customDocumentTypeId": { "type": "string", "nullable": true } }, "type": "object", "required": [ "role", "type", "title", "declarationId", "customDocumentTypeId" ] }, "type": "array" }, "rules": { "items": { "properties": { "inputName": { "type": "string" }, "inputValue": { "type": "array", "items": { "type": "string" } }, "type": { "type": "string" } }, "type": "object", "required": [ "inputName", "inputValue", "type" ] }, "type": "array" }, "uploadedDocuments": { "items": { "properties": { "_id": { "type": "string" }, "documentStatus": { "type": "string" }, "infoPreview": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "value": { "type": "string", "nullable": true }, "valueJSON": { "type": "string", "nullable": true }, "uploadGroupId": { "type": "string", "nullable": true }, "aiDocumentSplitId": { "type": "string", "nullable": true } }, "type": "object", "required": [ "_id", "documentStatus", "infoPreview", "createdAt", "value", "valueJSON", "uploadGroupId", "aiDocumentSplitId" ] }, "type": "array" } }, "type": "object", "required": [ "competencyDocumentId", "name", "alternativeName", "type", "category", "order", "isRequired", "description", "descriptionLink", "allowMultipleUploads", "minMultipleUploads", "maxMultipleUploads", "acceptJustification", "autoEmission", "allowedFileExtensions", "substituteDocumentTitles", "acceptedDocuments", "rules", "uploadedDocuments" ] }, "type": "array" }, "dependents": { "items": { "properties": { "_id": { "type": "string" }, "name": { "type": "string" }, "cpf": { "type": "string", "nullable": true }, "cnpj": { "type": "string", "nullable": true }, "dateOfBirth": { "type": "string", "format": "date", "example": "2026-09-01", "nullable": true }, "type": { "type": "string" }, "gender": { "type": "string", "nullable": true }, "competencyDocumentGroupId": { "type": "string" }, "cpfRequired": { "type": "boolean", "nullable": false }, "documentRequests": { "items": { "properties": { "competencyDocumentId": { "type": "string" }, "name": { "type": "string" }, "alternativeName": { "type": "string" }, "type": { "type": "string" }, "category": { "type": "string", "nullable": true }, "order": { "type": "number" }, "isRequired": { "type": "boolean", "nullable": false }, "description": { "type": "string" }, "descriptionLink": { "type": "string" }, "allowMultipleUploads": { "type": "boolean", "nullable": false }, "minMultipleUploads": { "type": "number", "nullable": true }, "maxMultipleUploads": { "type": "number", "nullable": true }, "acceptJustification": { "type": "boolean", "nullable": false }, "autoEmission": { "type": "boolean", "nullable": true }, "allowedFileExtensions": { "type": "array", "items": { "type": "string" } }, "substituteDocumentTitles": { "type": "array", "items": { "type": "string" } }, "acceptedDocuments": { "items": { "properties": { "role": { "type": "string" }, "type": { "type": "string" }, "title": { "type": "string" }, "declarationId": { "type": "string", "nullable": true }, "customDocumentTypeId": { "type": "string", "nullable": true } }, "type": "object", "required": [ "role", "type", "title", "declarationId", "customDocumentTypeId" ] }, "type": "array" }, "rules": { "items": { "properties": { "inputName": { "type": "string" }, "inputValue": { "type": "array", "items": { "type": "string" } }, "type": { "type": "string" } }, "type": "object", "required": [ "inputName", "inputValue", "type" ] }, "type": "array" }, "uploadedDocuments": { "items": { "properties": { "_id": { "type": "string" }, "documentStatus": { "type": "string" }, "infoPreview": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "value": { "type": "string", "nullable": true }, "valueJSON": { "type": "string", "nullable": true }, "uploadGroupId": { "type": "string", "nullable": true }, "aiDocumentSplitId": { "type": "string", "nullable": true } }, "type": "object", "required": [ "_id", "documentStatus", "infoPreview", "createdAt", "value", "valueJSON", "uploadGroupId", "aiDocumentSplitId" ] }, "type": "array" } }, "type": "object", "required": [ "competencyDocumentId", "name", "alternativeName", "type", "category", "order", "isRequired", "description", "descriptionLink", "allowMultipleUploads", "minMultipleUploads", "maxMultipleUploads", "acceptJustification", "autoEmission", "allowedFileExtensions", "substituteDocumentTitles", "acceptedDocuments", "rules", "uploadedDocuments" ] }, "type": "array" } }, "type": "object", "required": [ "_id", "name", "cpf", "cnpj", "dateOfBirth", "type", "gender", "competencyDocumentGroupId", "cpfRequired", "documentRequests" ] }, "type": "array" } }, "type": "object", "required": [ "_id", "title", "instructions", "type", "juridicNature", "order", "requiresRelationship", "cpfRequiredCondition", "cpfRequiredForAge", "isAgeRequired", "isGenderRequired", "documentRequests", "dependents" ] }, "GenerateParticipantAuthenticatedLinkOutputDto": { "properties": { "participantId": { "not": { "type": "null" }, "type": "string" }, "competencyId": { "not": { "type": "null" }, "type": "string" }, "authenticatedLink": { "format": "url", "type": "string" } }, "type": "object", "required": [ "participantId", "competencyId", "authenticatedLink" ] }, "GetCreditTransferAnalysisSpreadsheetOutputDto": { "properties": { "url": { "type": "string" }, "expiresAt": { "type": "string", "format": "date-time" } }, "type": "object", "required": [ "url", "expiresAt" ] }, "GetCustomFieldsByParticipantIdOutputDto": { "properties": { "customFields": { "items": { "properties": { "value": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "name": { "type": "string" }, "label": { "type": "string" } }, "type": "object", "required": [ "value", "name", "label" ] }, "type": "array" } }, "type": "object", "required": [ "customFields" ] }, "GetSubmissionConclusionStatusOutputDto": { "properties": { "enabled": { "type": "boolean", "nullable": false }, "submissionCompleted": { "type": "boolean", "nullable": false }, "submissionCompletedAt": { "type": "string", "format": "date-time", "nullable": true }, "canConclude": { "type": "boolean", "nullable": false }, "pendingRequiredCount": { "type": "number" }, "pendingRequiredDocumentIds": { "type": "array", "items": { "type": "string" } }, "issues": { "items": { "properties": { "message": { "type": "string" }, "participantDocumentId": { "type": "string", "nullable": true } }, "type": "object", "required": [ "message", "participantDocumentId" ] }, "type": "array" } }, "type": "object", "required": [ "enabled", "submissionCompleted", "submissionCompletedAt", "canConclude", "pendingRequiredCount", "pendingRequiredDocumentIds", "issues" ] }, "PaginateCompetencyParticipantsUsingApiInputDto": { "properties": { "cnpj": { "type": "string" }, "cpf": { "type": "string" }, "page": { "minimum": 1, "type": "number" }, "perPage": { "minimum": 1, "type": "number" }, "query": { "type": "string" }, "orderByColumn": { "type": "string" }, "orderByDirection": { "type": "string" } }, "type": "object" }, "PaginateCompetencyParticipantsUsingApiOutputDto": { "properties": { "_id": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "cpf": { "type": "string", "nullable": true }, "cnpj": { "type": "string", "nullable": true }, "gender": { "type": "string" }, "dateOfBirth": { "type": "string", "format": "date", "example": "2026-09-01", "nullable": true }, "type": { "type": "string" }, "phone": { "type": "string" }, "customFields": { "type": "object" }, "status": { "type": "string", "examples": [] } }, "type": "object", "required": [ "_id", "name", "email", "cpf", "cnpj", "gender", "dateOfBirth", "type", "phone", "customFields", "status" ] }, "PaginateProjectCompetencyUsingApiOutputDto": { "properties": { "_id": { "type": "string" }, "publicTitle": { "type": "string" }, "competency": { "type": "string" }, "startAt": { "type": "string", "format": "date", "example": "2026-09-01", "nullable": true }, "endAt": { "type": "string", "format": "date", "example": "2026-09-01", "nullable": true } }, "type": "object", "required": [ "_id", "publicTitle", "competency", "startAt", "endAt" ] }, "PaginationMetaOutputDto": { "properties": { "page": { "type": "number" }, "perPage": { "type": "number" }, "total": { "type": "number" }, "lastPage": { "type": "number" } }, "type": "object", "required": [ "page", "perPage", "total", "lastPage" ] }, "ParticipantDocumentDto": { "properties": { "_id": { "not": { "type": "null" }, "type": "string" }, "type": { "type": "string", "example": "RG", "description": "Tipo do documento. A lista completa não é publicada aqui porque os tipos que uma empresa pode usar dependem do que foi liberado para ela. Consulte `GET /v1/api/catalog/documents` para o catálogo da sua empresa." } }, "type": "object", "required": [ "_id", "type" ] }, "PatchParticipantDocumentStatusInputDto": { "properties": { "status": { "type": "string", "example": "ACTION_REQUIRED", "examples": [ "ACTION_REQUIRED" ] }, "reason": { "type": "string" } }, "type": "object", "required": [ "status" ] }, "RemoveParticipantDependentUsingApiOutputDto": { "properties": { "dependentId": { "type": "string" }, "deletedDocumentsCount": { "type": "number" } }, "type": "object", "required": [ "dependentId", "deletedDocumentsCount" ] }, "RemoveParticipantUsingApiOutputDto": { "properties": { "participantId": { "type": "string" }, "deletedDocumentsCount": { "type": "number" } }, "type": "object", "required": [ "participantId", "deletedDocumentsCount" ] }, "RequestParticipantDocumentReviewOutputDto": { "properties": { "_id": { "type": "string" }, "status": { "type": "string" }, "documentStatus": { "type": "string" }, "selfReviewAttempts": { "type": "number" }, "canAutoReprocess": { "type": "boolean", "nullable": false } }, "type": "object", "required": [ "_id", "status", "documentStatus", "selfReviewAttempts", "canAutoReprocess" ] }, "RequestParticipantDocumentReviewUsingApiInputDto": { "properties": { "reason": { "maxLength": 500, "type": "string", "minLength": 10 } }, "type": "object", "required": [ "reason" ] }, "SearchCompetencyParticipantInputDto": { "properties": { "phone": { "type": "string" }, "page": { "minimum": 1, "type": "number" }, "perPage": { "minimum": 1, "type": "number" }, "query": { "type": "string" }, "orderByColumn": { "type": "string" }, "orderByDirection": { "type": "string" } }, "type": "object" }, "SearchCompetencyParticipantOutputDto": { "properties": { "_id": { "type": "string" }, "name": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "status": { "type": "string" }, "project": { "properties": { "_id": { "type": "string" } }, "type": "object", "required": [ "_id" ] }, "competency": { "properties": { "_id": { "type": "string" }, "publicTitle": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" } }, "type": "object", "required": [ "_id", "publicTitle", "createdAt" ] } }, "type": "object", "required": [ "_id", "name", "createdAt", "status", "project", "competency" ] }, "SearchParticipantsUsingApiInputDto": { "properties": { "cpf": { "type": "string" } }, "type": "object", "required": [ "cpf" ] }, "SearchParticipantsUsingApiOutputDto": { "properties": { "_id": { "type": "string" }, "name": { "type": "string" }, "cpf": { "type": "string", "nullable": true }, "status": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "project": { "properties": { "_id": { "type": "string" }, "status": { "type": "string" } }, "type": "object", "required": [ "_id", "status" ] }, "competency": { "properties": { "_id": { "type": "string" }, "publicTitle": { "type": "string" } }, "type": "object", "required": [ "_id", "publicTitle" ] } }, "type": "object", "required": [ "_id", "name", "cpf", "status", "createdAt", "project", "competency" ] }, "SendParticipantInviteInputDto": { "properties": { "participantId": { "not": { "type": "null" }, "type": "string" } }, "type": "object", "required": [ "participantId" ] }, "SendParticipantInviteOutputDto": { "properties": { "participantId": { "type": "string" }, "success": { "type": "boolean", "nullable": false }, "message": { "type": "string" }, "inviteSentAt": { "type": "string", "format": "date-time", "nullable": true } }, "type": "object", "required": [ "participantId", "success", "message", "inviteSentAt" ] }, "SplitAndRedistributeDocumentApiInputDto": { "properties": { "files": { "type": "array", "items": { "type": "string", "format": "binary" } }, "documentRules": { "items": {}, "type": "array" }, "allowProcessingOnNewVersion": { "type": "boolean" }, "rejectOnMissingRequiredTypesInGroup": { "type": "boolean" }, "maxPages": { "minimum": 1, "type": "integer" } }, "type": "object", "required": [ "files" ] }, "SplitAndRedistributeDocumentApiOutputDto": { "properties": { "_id": { "type": "string" }, "fileHash": { "type": "string" }, "results": { "items": { "properties": { "_id": { "not": { "type": "null" }, "type": "string" }, "validationErrors": { "items": { "properties": { "message": { "type": "string" }, "path": { "type": "array", "items": { "type": "string" } }, "group": { "type": "string" } }, "type": "object", "required": [ "message", "path", "group" ] }, "type": "array" }, "documentStatus": { "type": "string" }, "uploadGroupId": { "type": "string", "nullable": true }, "aiDocumentSplitId": { "type": "string", "nullable": true } }, "type": "object", "required": [ "_id", "validationErrors", "documentStatus", "uploadGroupId", "aiDocumentSplitId" ] }, "type": "array" }, "pendingDocuments": { "items": { "properties": { "type": { "type": "string" }, "alternativeName": { "type": "string" } }, "type": "object", "required": [ "type", "alternativeName" ] }, "type": "array" } }, "type": "object", "required": [ "_id", "fileHash", "results", "pendingDocuments" ] }, "UpdateCompetencyParticipantWithApiInputDto": { "properties": { "name": { "type": "string" }, "email": { "format": "email", "type": "string" }, "dateOfBirth": { "type": "string", "format": "date", "example": "2026-09-01", "nullable": true }, "gender": { "type": "string", "example": "MALE", "examples": [ "MALE", "FEMALE" ] }, "phone": { "type": "string" }, "cpf": { "type": "string" }, "cnpj": { "type": "string" } }, "type": "object" }, "UpdateCompetencyParticipantWithApiOutputDto": { "properties": { "_id": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "dateOfBirth": { "type": "string", "format": "date", "example": "2026-09-01", "nullable": true }, "gender": { "type": "string" }, "cpf": { "type": "string" }, "cnpj": { "type": "string" }, "type": { "type": "string" }, "phone": { "type": "string" } }, "type": "object", "required": [ "_id", "name", "email", "dateOfBirth", "gender", "cpf", "cnpj", "type", "phone" ] }, "UpdateCustomFieldsByParticipantIdInputDto": { "properties": { "customFields": { "items": { "properties": { "name": { "type": "string" }, "value": {} }, "type": "object", "required": [ "name" ] }, "type": "array" } }, "type": "object", "required": [ "customFields" ] }, "UpdateCustomFieldsByParticipantIdOutputDto": { "properties": { "_id": { "type": "string" } }, "type": "object", "required": [ "_id" ] }, "UpdateDatasetRowInputDto": { "properties": { "data": { "type": "object" } }, "type": "object", "required": [ "data" ] }, "UpdateParticipantDocumentComputedFieldsInputDto": { "properties": { "computedFields": { "items": { "properties": { "_id": { "not": { "type": "null" }, "type": "string" }, "label": { "type": "string" }, "value": { "type": "string" }, "type": { "type": "string", "example": "CHECKBOX", "examples": [ "CHECKBOX", "TEXT", "TEXT_AREA", "MARKDOWN" ] }, "subgroup": { "type": "string" } }, "type": "object", "required": [ "label", "value", "type" ] }, "type": "array" } }, "type": "object", "required": [ "computedFields" ] }, "UpdateParticipantDocumentComputedFieldsOutputDto": { "properties": { "_id": { "type": "string" }, "computedFields": { "items": { "properties": { "_id": { "not": { "type": "null" }, "type": "string" }, "label": { "type": "string" }, "value": { "type": "string" }, "type": { "type": "string", "example": "CHECKBOX", "examples": [ "CHECKBOX", "TEXT", "TEXT_AREA", "MARKDOWN" ] }, "subgroup": { "type": "string" } }, "type": "object", "required": [ "label", "value", "type" ] }, "type": "array" } }, "type": "object", "required": [ "_id", "computedFields" ] } }, "securitySchemes": { "ApiKeyAuth": { "type": "apiKey", "in": "header", "name": "x-api-key" } } } }