> ## 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 Cadastros
> Para varrer a carteira por situação: quem está com pendência, quem venceu, quem está em renovação.
### Quando usar
Para varrer a carteira por situação: quem está com pendência, quem venceu, quem está em renovação.
Filtre por `kycStatus` (repita o parâmetro para mais de uma situação), por `entityType` ou com `search`, que casa razão social, nome fantasia ou parte do CNPJ/CPF. A página tem 20 cadastros por padrão e até 50 com `take`.
Valor de `kycStatus` fora da lista responde `400`. O `reportId` hoje vem sempre `null`.
Contexto e vocabulário em [Cadastro documental](/onboarding/cadastro-documental). Autenticação, versionamento e capacidades em [Visão geral da API](/api-reference/onboarding/visao-geral).
## OpenAPI
````yaml get /v1/registry
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/registry:
get:
tags:
- registry
summary: Listar cadastros da organizacao
description: >
Lista os cadastros, com busca e filtro por situacao, do atualizado mais
recentemente para o
mais antigo. Cadastro removido nao aparece.
Situacoes: PENDING (sem documento validado), PROCESSING (documento em
analise),
UP_TO_DATE (tudo validado), ATTENTION (divergencia, vencimento proximo
ou ressalva),
EXPIRED (renovacao vencida), RENEWING (renovacao em curso).
Valor de kycStatus fora dessa lista e recusado com 400.
`completenessSlots` e `signingAuthority` so vem no detalhe do cadastro.
operationId: RegistryController_list
parameters:
- name: search
required: false
in: query
schema:
type: string
description: >-
Casa por razao social, nome fantasia ou parte do CNPJ/CPF (mascara e
ignorada).
- name: entityType
required: false
in: query
schema:
type: string
enum:
- COMPANY
- PERSON
description: COMPANY (pessoa juridica) ou PERSON (pessoa fisica).
- name: kycStatus
required: false
in: query
schema:
type: array
items:
type: string
enum:
- PENDING
- PROCESSING
- UP_TO_DATE
- ATTENTION
- EXPIRED
- RENEWING
description: Uma ou mais situacoes. Repita o parametro para varias.
- name: skip
required: false
in: query
schema:
type: integer
minimum: 0
description: Quantos pular. Padrao 0.
- name: take
required: false
in: query
schema:
type: integer
minimum: 1
maximum: 50
description: Tamanho da pagina. Padrao 20, maximo 50.
responses:
'200':
description: Pagina de cadastros com situacao e completude.
content:
application/json:
schema:
$ref: '#/components/schemas/RegistryListResponse'
example:
items:
- id: 6612a7f30000000000000001
document: '11444777000161'
entityType: COMPANY
name: AURORA COMPONENTES INDUSTRIAIS LTDA
tradeName: AURORA
legalNature: Sociedade Empresária Limitada
kycStatus: ATTENTION
kycRenewalDue: '2027-03-31T00:00:00.000Z'
completeness: 0.66
documentsCount: 4
pendingCount: 1
reportId: null
basicDataSyncedAt: '2026-09-05T12:58:10.000Z'
crossDocument: null
createdAt: '2026-09-05T12:58:10.000Z'
updatedAt: '2026-09-05T13:07:44.000Z'
total: 1
'400':
description: >-
Parametro invalido, inclusive valor de kycStatus fora da lista. A
mensagem concatena todas as falhas por virgula.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
example:
code: 400
message: >-
each value in kycStatus must be one of the following values:
PENDING, PROCESSING, UP_TO_DATE, ATTENTION, EXPIRED, RENEWING
'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.
'404':
description: >-
O modulo Onboarding nao esta liberado para a organizacao: para ela,
a rota nao existe.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
example:
code: 404
message: Recurso não encontrado.
'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/registry' \
--header 'Authorization: Bearer '
- lang: JavaScript
label: Node
source: >
const resposta = await
fetch("https://gyra-core.gyramais.com.br/v1/registry", {
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/registry",
headers={"Authorization": f"Bearer {token}"},
)
dados = resposta.json()
components:
schemas:
RegistryListResponse:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/Registry'
total:
type: integer
description: Total que casa o filtro, nao o tamanho da pagina.
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.
Registry:
type: object
description: O dossie documental de um CNPJ ou CPF.
properties:
id:
type: string
document:
type: string
description: CNPJ (14) ou CPF (11), so digitos.
entityType:
type: string
enum:
- COMPANY
- PERSON
name:
type: string
nullable: true
description: Razao social ou nome.
tradeName:
type: string
nullable: true
legalNature:
type: string
nullable: true
kycStatus:
type: string
enum:
- PENDING
- PROCESSING
- UP_TO_DATE
- ATTENTION
- EXPIRED
- RENEWING
kycRenewalDue:
type: string
nullable: true
format: date-time
description: Quando a renovacao vence.
completeness:
type: number
description: 0 a 1.
completenessSlots:
type: array
items:
type: object
properties:
key:
type: string
description: Primeiro tipo do grupo, usado como rotulo da exigencia.
types:
type: array
items:
type: string
enum:
- CONTRATO_SOCIAL
- ALTERACAO_CONTRATUAL
- ESTATUTO_SOCIAL
- REQUERIMENTO_EMPRESARIO
- ATA_ASSEMBLEIA
- PROCURACAO_PJ
- CERTIDAO_JUNTA
- CERTIDAO_QSA
- IRPJ_ECF
- DECLARACAO_FATURAMENTO
- CERTIFICADO_SIMPLES_NACIONAL
- DEMONSTRACOES_FINANCEIRAS
- EXTRATO_BANCARIO
- CERTIDAO_PGFN_PJ
- CERTIDAO_FGTS
- CADIN_FEDERAL
- CADIN_ESTADUAL
- ESOCIAL_PJ
- DOC_IDENTIDADE
- COMPROVANTE_RESIDENCIA
- DIRPF
- COMPROVANTE_RENDA
- CERTIDAO_PF
- PROCURACAO_PF
- COMPROVACAO_ESTADO_CIVIL
- FORA_DE_ESCOPO
- NAO_IDENTIFICADO
description: Tipos equivalentes que preenchem a mesma exigencia.
filled:
type: boolean
documentId:
type: string
nullable: true
description: Qual documento cobre a exigencia.
description: 'A cesta de completude aberta. So no detalhe: na listagem seria N+1.'
signingAuthority:
type: object
nullable: true
description: >-
Quem pode assinar pela empresa, ja achatado (sem a tripla
value/confidence/page). null quando o cadastro nao tem documento
societario validado com clausula de administracao legivel. So vem no
DETALHE do cadastro.
properties:
regime:
type: string
nullable: true
enum:
- ISOLADA
- CONJUNTA
- MISTA
- INDETERMINADO
- null
signersRequired:
type: integer
nullable: true
description: Quantas assinaturas a regra geral exige.
anySignerAlone:
type: boolean
description: true quando ao menos um administrador assina sozinho.
signers:
type: array
items:
type: object
properties:
name:
type: string
nullable: true
document:
type: string
nullable: true
description: >-
CPF em digitos. null quando o documento societario nao o
repete, o que e comum.
role:
type: string
nullable: true
signsAlone:
type: boolean
nullable: true
jointSignatureThreshold:
type: number
nullable: true
mandateEndDate:
type: string
nullable: true
description: YYYY-MM-DD.
restrictions:
type: string
nullable: true
thresholds:
type: array
items:
type: object
additionalProperties: true
description: Faixa de alcada lida do documento.
prohibitions:
type: array
items:
type: object
additionalProperties: true
description: Vedacao expressa lida do documento.
mandate:
type: object
nullable: true
additionalProperties: true
source:
type: object
description: De qual documento a leitura saiu.
properties:
documentId:
type: string
documentType:
type: string
enum:
- CONTRATO_SOCIAL
- ALTERACAO_CONTRATUAL
- ESTATUTO_SOCIAL
- REQUERIMENTO_EMPRESARIO
- ATA_ASSEMBLEIA
- PROCURACAO_PJ
- CERTIDAO_JUNTA
- CERTIDAO_QSA
- IRPJ_ECF
- DECLARACAO_FATURAMENTO
- CERTIFICADO_SIMPLES_NACIONAL
- DEMONSTRACOES_FINANCEIRAS
- EXTRATO_BANCARIO
- CERTIDAO_PGFN_PJ
- CERTIDAO_FGTS
- CADIN_FEDERAL
- CADIN_ESTADUAL
- ESOCIAL_PJ
- DOC_IDENTIDADE
- COMPROVANTE_RESIDENCIA
- DIRPF
- COMPROVANTE_RENDA
- CERTIDAO_PF
- PROCURACAO_PF
- COMPROVACAO_ESTADO_CIVIL
- FORA_DE_ESCOPO
- NAO_IDENTIFICADO
fileName:
type: string
nullable: true
version:
type: integer
nullable: true
validatedAt:
type: string
nullable: true
format: date-time
clauseNumber:
type: string
nullable: true
clauseExcerpt:
type: string
nullable: true
confidence:
type: number
nullable: true
documentsCount:
type: integer
pendingCount:
type: integer
reportId:
type: string
nullable: true
description: >-
Reservado para o relatorio mais recente do mesmo documento. Hoje vem
null.
crossDocument:
type: object
nullable: true
description: >-
Ultima conferencia cruzada entre os documentos do cadastro. null
quando nunca houve o que cruzar, o que e diferente de conferido e
consistente.
properties:
status:
type: string
enum:
- CONSISTENTE
- DIVERGENTE
- NAO_CONFERIDO
checks:
type: array
items:
type: object
additionalProperties: true
documentIds:
type: array
items:
type: string
triggeredByDocumentId:
type: string
nullable: true
ruleSetVersion:
type: string
evaluatedAt:
type: string
format: date-time
basicDataSyncedAt:
type: string
nullable: true
format: date-time
createdAt:
type: string
format: date-time
updatedAt:
type: string
format: date-time
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.