> ## Documentation Index
> Fetch the complete documentation index at: https://developers.gyramais.com.br/llms.txt
> Use this file to discover all available pages before exploring further.
> ## Agent Instructions
> A GYRA+ tem um servidor MCP oficial: https://mcp.gyramais.com.br/mcp. A autenticação é o login do próprio usuário na plataforma, não uma credencial separada. Instalação em https://developers.gyramais.com.br/mcp/instalacao.
> Prefira as tools do MCP a montar chamadas HTTP na mão quando o usuário já tem o conector ligado.
> Para analisar crédito de um CNPJ ou CPF, use create_report_v2 e assine um webhook em vez de fazer polling.
> Para ler um documento (contrato social, comprovante de residência, imposto de renda, balanço), use validate_document: a entrada é um arquivo só e a plataforma reconhece o tipo sozinha.
> Para pedir documentos ao cliente final, use create_collection com o slug de um modelo obtido em list_collection_templates.
> Documento (CNPJ/CPF) é dado pessoal: não o repita em log nem o envie a serviços de terceiros.
# Listar Solicitações
> Para responder quem está devendo documento?: filtre por `SENT` e `IN_PROGRESS` e olhe o prazo.
### Quando usar
Para responder "quem está devendo documento?": filtre por `SENT` e `IN_PROGRESS` e olhe o prazo.
`itemsAwaitingOperator` diz quantos itens esperam uma decisão sua, que é a fila que trava a solicitação do lado de dentro.
Contexto e vocabulário em [Solicitações de coleta](/onboarding/solicitacoes). Autenticação, versionamento e capacidades em [Visão geral da API](/api-reference/onboarding/visao-geral).
## OpenAPI
````yaml get /v1/collections
openapi: 3.0.0
info:
title: GYRA+ API - MCP Server
description: >-
API da Gyra+ para analise de credito. Spec curada para uso com agentes AI
via MCP.
version: '1.0'
contact: {}
servers:
- url: https://gyra-core.gyramais.com.br
description: Producao
security: []
paths:
/v1/collections:
get:
tags:
- collections
summary: Listar solicitacoes
description: >
Lista as solicitacoes da organizacao, com filtro por situacao, cadastro,
modelo e periodo.
Situacoes: DRAFT, SENT, IN_PROGRESS, COMPLETED, EXPIRED, CANCELED.
E a tool para responder "quem esta devendo documento?" -- filtre por
SENT e IN_PROGRESS e olhe
o prazo.
operationId: CollectionController_list
parameters:
- name: status
required: false
in: query
schema:
type: array
items:
type: string
enum:
- DRAFT
- SENT
- IN_PROGRESS
- COMPLETED
- EXPIRED
- CANCELED
description: Um ou mais status. Repita o parametro para varios.
- name: registryId
required: false
in: query
schema:
type: string
description: Filtra por cadastro.
- name: document
required: false
in: query
description: Filtra pelo CNPJ/CPF do cadastro.
schema:
type: string
- name: search
required: false
in: query
description: Casa por nome ou documento.
schema:
maxLength: 120
type: string
- name: templateId
required: false
in: query
schema:
type: string
description: Filtra por modelo.
- name: from
required: false
in: query
description: Inicio do periodo de criacao, ISO 8601.
schema:
type: string
- name: to
required: false
in: query
description: Fim do periodo de criacao, ISO 8601.
schema:
type: string
- name: skip
required: false
in: query
schema:
type: number
description: Deslocamento da pagina.
- name: take
required: false
in: query
schema:
maximum: 100
type: number
description: Tamanho da pagina.
responses:
'200':
description: Pagina de solicitacoes com status, cadastro, prazo e progresso.
content:
application/json:
schema:
$ref: '#/components/schemas/CollectionListResponse'
example:
items:
- id: 6612a7f30000000000000051
registryId: 6612a7f30000000000000001
templateId: 6612a7f30000000000000041
templateName: Onboarding PJ
status: IN_PROGRESS
responseMode: REVIEW
channel: BOTH
subjectName: AURORA COMPONENTES INDUSTRIAIS LTDA
subjectDocument: '11444777000161'
itemsTotal: 5
itemsResolved: 3
itemsAwaitingOperator: 1
dueAt: '2026-09-15T23:59:59.000Z'
sentAt: '2026-09-05T14:20:00.000Z'
progress:
total: 5
resolved: 3
validated: 3
awaitingOperator: 1
rejected: 0
pending: 1
hasScrConsent: true
scrConsentItemId: 6612a7f30000000000000073
signingDueAt: null
createdAt: '2026-09-05T14:19:58.000Z'
updatedAt: '2026-09-06T09:11:20.000Z'
total: 1
'400':
description: >-
Parametro invalido (status fora da lista, data fora do ISO 8601,
take acima de 100). A mensagem concatena todas as falhas por
virgula.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
example:
code: 400
message: take must not be greater than 100
'401':
description: >-
Token ausente, expirado ou invalido. Gere outro em POST
/auth/authenticate.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
example:
code: 401
message: Token de acesso inválido.
'403':
description: O usuario autenticado nao tem a permissao exigida pela rota.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
example:
code: 403
message: Você não tem permissão para acessar este recurso.
'500':
description: >-
Falha nossa. Tente de novo; se persistir, acione o suporte com o
horario da chamada.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
example:
code: 500
message: Internal server error
security:
- authorization: []
x-codeSamples:
- lang: cURL
label: cURL
source: >
curl --request GET
'https://gyra-core.gyramais.com.br/v1/collections' \
--header 'Authorization: Bearer '
- lang: JavaScript
label: Node
source: >
const resposta = await
fetch("https://gyra-core.gyramais.com.br/v1/collections", {
method: "GET",
headers: { Authorization: `Bearer ${token}` },
});
const dados = await resposta.json();
- lang: Python
label: Python
source: |
import requests
resposta = requests.get(
"https://gyra-core.gyramais.com.br/v1/collections",
headers={"Authorization": f"Bearer {token}"},
)
dados = resposta.json()
components:
schemas:
CollectionListResponse:
type: object
properties:
items:
type: array
items:
type: object
properties:
id:
type: string
registryId:
type: string
templateId:
type: string
nullable: true
templateName:
type: string
nullable: true
status:
type: string
enum:
- DRAFT
- SENT
- IN_PROGRESS
- COMPLETED
- EXPIRED
- CANCELED
responseMode:
type: string
enum:
- AUTOMATIC
- REVIEW
channel:
type: string
enum:
- WHATSAPP
- EMAIL
- BOTH
- NONE
subjectName:
type: string
nullable: true
subjectDocument:
type: string
nullable: true
itemsTotal:
type: integer
itemsResolved:
type: integer
itemsAwaitingOperator:
type: integer
description: Quantos itens esperam decisao humana.
dueAt:
type: string
nullable: true
format: date-time
sentAt:
type: string
nullable: true
format: date-time
hasScrConsent:
type: boolean
description: A solicitacao tem autorizacao de SCR concedida.
scrConsentItemId:
type: string
nullable: true
description: >-
Item da autorizacao de SCR com via assinada, para baixar em
GET /v1/collections/{id}/items/{itemId}/signed-document. null
quando nao ha PDF.
signingDueAt:
type: string
nullable: true
format: date-time
description: >-
Prazo de assinatura na Clicksign, quando a solicitacao tem
item assinado por ela.
progress:
type: object
additionalProperties:
type: integer
description: >-
Contagem de itens por situacao: total, resolved, validated,
awaitingOperator, rejected, pending.
createdAt:
type: string
format: date-time
updatedAt:
type: string
format: date-time
total:
type: integer
ApiError:
type: object
description: >-
Formato unico de erro da API. Nao faca match exato da mensagem: use o
code.
properties:
code:
type: integer
description: Codigo HTTP.
message:
type: string
description: >-
Mensagem em portugues. Em erro de validacao, traz TODAS as falhas
concatenadas por virgula.
securitySchemes:
authorization:
type: http
scheme: bearer
bearerFormat: JWT
description: Enter JWT token
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.