{
"code": 400,
"message": "each value in kycStatus must be one of the following values: PENDING, PROCESSING, UP_TO_DATE, ATTENTION, EXPIRED, RENEWING"
}
{
"code": 401,
"message": "Token de acesso inválido."
}
{
"code": 403,
"message": "Você não tem permissão para acessar este recurso."
}
{
"code": 404,
"message": "Recurso não encontrado."
}
{
"code": 500,
"message": "Internal server error"
}
Cadastro
Listar Cadastros
Para varrer a carteira por situação: quem está com pendência, quem venceu, quem está em renovação.
GET
/
v1
/
registry
cURL
curl --request GET 'https://gyra-core.gyramais.com.br/v1/registry' \ --header 'Authorization: Bearer <token>'
{
"code": 400,
"message": "each value in kycStatus must be one of the following values: PENDING, PROCESSING, UP_TO_DATE, ATTENTION, EXPIRED, RENEWING"
}
{
"code": 401,
"message": "Token de acesso inválido."
}
{
"code": 403,
"message": "Você não tem permissão para acessar este recurso."
}
{
"code": 404,
"message": "Recurso não encontrado."
}
{
"code": 500,
"message": "Internal server error"
}
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.
Casa por razao social, nome fantasia ou parte do CNPJ/CPF (mascara e ignorada).
entityType
enum<string>
COMPANY (pessoa juridica) ou PERSON (pessoa fisica).
Available options:
COMPANY,
PERSON
kycStatus
enum<string>[]
Uma ou mais situacoes. Repita o parametro para varias.
Available options:
PENDING,
PROCESSING,
UP_TO_DATE,
ATTENTION,
EXPIRED,
RENEWING
skip
integer
Quantos pular. Padrao 0.
Required range: x >= 0
take
integer
Tamanho da pagina. Padrao 20, maximo 50.
Required range: 1 <= x <= 50
Response
Pagina de cadastros com situacao e completude.
items
object[]
Hide child attributes
items.id
string
items.document
string
CNPJ (14) ou CPF (11), so digitos.
items.entityType
enum<string>
Available options:
COMPANY,
PERSON
items.name
string | null
Razao social ou nome.
items.tradeName
string | null
items.legalNature
string | null
items.kycStatus
enum<string>
Available options:
PENDING,
PROCESSING,
UP_TO_DATE,
ATTENTION,
EXPIRED,
RENEWING
items.kycRenewalDue
string<date-time> | null
Quando a renovacao vence.
items.completeness
number
0 a 1.
items.completenessSlots
object[]
A cesta de completude aberta. So no detalhe: na listagem seria N+1.
Hide child attributes
items.completenessSlots.key
string
Primeiro tipo do grupo, usado como rotulo da exigencia.
items.completenessSlots.types
enum<string>[]
Tipos equivalentes que preenchem a mesma exigencia.
Available options:
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
items.completenessSlots.filled
boolean
items.completenessSlots.documentId
string | null
Qual documento cobre a exigencia.
items.signingAuthority
object | null
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.
Hide child attributes
items.signingAuthority.regime
enum<string> | null
Available options:
ISOLADA,
CONJUNTA,
MISTA,
INDETERMINADO,
null
items.signingAuthority.signersRequired
integer | null
Quantas assinaturas a regra geral exige.
items.signingAuthority.anySignerAlone
boolean
true quando ao menos um administrador assina sozinho.
items.signingAuthority.signers
object[]
Hide child attributes
items.signingAuthority.signers.name
string | null
items.signingAuthority.signers.document
string | null
CPF em digitos. null quando o documento societario nao o repete, o que e comum.
Reservado para o relatorio mais recente do mesmo documento. Hoje vem null.
items.crossDocument
object | null
Ultima conferencia cruzada entre os documentos do cadastro. null quando nunca houve o que cruzar, o que e diferente de conferido e consistente.
Hide child attributes
items.crossDocument.status
enum<string>
Available options:
CONSISTENTE,
DIVERGENTE,
NAO_CONFERIDO
items.crossDocument.checks
object[]
items.crossDocument.documentIds
string[]
items.crossDocument.triggeredByDocumentId
string | null
items.crossDocument.ruleSetVersion
string
items.crossDocument.evaluatedAt
string<date-time>
items.basicDataSyncedAt
string<date-time> | null
items.createdAt
string<date-time>
items.updatedAt
string<date-time>
total
integer
Total que casa o filtro, nao o tamanho da pagina.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"GYRA+ Docs","colors":{"primary":"#1a54fa"},"logo":{"light":"https://mintcdn.com/gyra/e0CFjRCELp2Et0mP/logo/light.png?fit=max\u0026auto=format\u0026n=e0CFjRCELp2Et0mP\u0026q=85\u0026s=07c498e8ad046860d4087e2bb3031959","dark":"https://mintcdn.com/gyra/e0CFjRCELp2Et0mP/logo/dark.png?fit=max\u0026auto=format\u0026n=e0CFjRCELp2Et0mP\u0026q=85\u0026s=b619e9921d46fadcfc5ba6797472b83c"},"favicon":"https://mintcdn.com/gyra/NOR5Q9E-wRWiecYr/favicon.svg?fit=max\u0026auto=format\u0026n=NOR5Q9E-wRWiecYr\u0026q=85\u0026s=371669edce3dcdbb9f5774a41b7ff793","api":{"openapi":"openapi.yaml","params":{"expanded":"all"}},"contextual":{"options":["copy","view","chatgpt","claude","cursor","vscode","mcp"],"display":"header"},"markdown":{"schema":true,"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."]},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"gyra","hasAudioNarration":false,"actualSubdomain":"gyra","customDomains":["developers.gyramais.com.br"],"gitSource":{"type":"github","owner":"gyramais","repo":"gyra-mintlify-api-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"agentFeedback":true},"entitlements":{},"buildId":"6ac560c5562cca2062a5e1d5","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"API: Onboarding","count":27},{"language":"default","tag":"Referência da API","count":20},{"language":"default","tag":"Guia do Toolbox","count":19},{"language":"default","tag":"Fontes de Dados","count":15},{"language":"default","tag":"Conceitos Fundamentais","count":13},{"language":"default","tag":"Onboarding","count":12},{"language":"default","tag":"Dicionário de Dados","count":9},{"language":"default","tag":"Solicitação","count":8},{"language":"default","tag":"API: Propostas e Esteiras","count":7},{"language":"default","tag":"Cadastro","count":7}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"mcp-banner.css","content":".mcp-banner{display:flex;align-items:center;gap:10px;margin:0 0 20px;padding:10px 14px;border-radius:12px;border:1px solid #1a54fa;background:rgba(26, 84, 250, 0.06);color:inherit;text-decoration:none!important;transition:background 0.15s ease}.mcp-banner:hover{background:rgba(26, 84, 250, 0.11)}.mcp-banner__badge{flex:none;font-size:10.5px;font-weight:700;letter-spacing:0.04em;text-transform:uppercase;padding:3px 7px;border-radius:999px;background:#1a54fa;color:#fff}.mcp-banner__text{flex:1;min-width:0;font-size:13.5px;line-height:1.45}.mcp-banner__cta{flex:none;font-size:13.5px;font-weight:600;color:#1a54fa;white-space:nowrap}.dark .mcp-banner{border-color:#6b8cff;background:rgba(107, 140, 255, 0.1)}.dark .mcp-banner:hover{background:rgba(107, 140, 255, 0.18)}.dark .mcp-banner__cta{color:#8fa8ff}@media (max-width: 720px){.mcp-banner{flex-wrap:wrap}.mcp-banner__text{flex-basis:100%;order:3}}"}]}
{"page":{"pagePath":"api-reference/registry/get-registry","slug":"/api-reference/registry/get-registry","pageMetadata":{"title":"Listar Cadastros","description":"Para varrer a carteira por situação: quem está com pendência, quem venceu, quem está em renovação.","surface":"api","domain":"cadastro","audience":"integrador","lang":"tecnica","openapi":"get /v1/registry","href":"/api-reference/registry/get-registry"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Para varrer a carteira por situação: quem está com pendência, quem venceu, quem está em renovação.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,..._provideComponents(),...props.components},{Heading,Note}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`3`,id:`quando-usar`,children:`Quando usar`}),`\n`,_jsx(_components.p,{children:`Para varrer a carteira por situação: quem está com pendência, quem venceu, quem está em renovação.`}),`\n`,_jsxs(_components.p,{children:[`Filtre por `,_jsx(_components.code,{children:`kycStatus`}),` (repita o parâmetro para mais de uma situação), por `,_jsx(_components.code,{children:`entityType`}),` ou com `,_jsx(_components.code,{children:`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 `,_jsx(_components.code,{children:`take`}),`.`]}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`Valor de `,_jsx(_components.code,{children:`kycStatus`}),` fora da lista responde `,_jsx(_components.code,{children:`400`}),`. O `,_jsx(_components.code,{children:`reportId`}),` hoje vem sempre `,_jsx(_components.code,{children:`null`}),`.`]})}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`Contexto e vocabulário em `,_jsx(_components.a,{href:`/onboarding/cadastro-documental`,children:`Cadastro documental`}),`. Autenticação, versionamento e capacidades em `,_jsx(_components.a,{href:`/api-reference/onboarding/visao-geral`,children:`Visão geral da API`}),`.`]})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Listar Cadastros","description":"Para varrer a carteira por situação: quem está com pendência, quem venceu, quem está em renovação.","surface":"api","domain":"cadastro","audience":"integrador","lang":"tecnica","openapi":"get /v1/registry","href":"/api-reference/registry/get-registry"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Quando usar","slug":"quando-usar","depth":3,"children":[]}],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"RegistryController_list","summary":"Listar cadastros da organizacao","parameters":["d14361f5-7455-4dae-b201-a60a0ede75b0","ac725337-1a04-4721-8f90-8a5d21b7b84e","e283ee23-c099-4d83-9d95-c3c85b5c748f","0b1fda8d-d11d-45e1-aff8-4c8857c2501e","ebb36930-d543-4400-a6ef-08d152d0ae07"],"responses":{"200":"acb41f9d-501d-4d29-8126-26938be32225","400":"31c9c605-b552-4e47-898f-3807c0b4dd30","401":"3d415ea0-2c6c-4fa9-a384-9384884906b4","403":"6ada1d82-6e38-4151-a0e2-1ac4006e1128","404":"d75e12b2-8fa4-4554-aae1-abf166bd0de9","500":"dfa72d1a-f764-4f07-adf2-e74403792a49"},"tags":["registry"],"security":["fcbd376d-52e9-40c2-b66e-d4e6acd35996"],"description":"Para varrer a carteira por situação: quem está com pendência, quem venceu, quem está em renovação.","x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET 'https://gyra-core.gyramais.com.br/v1/registry' \\\n --header 'Authorization: Bearer \u003ctoken>'\n"},{"lang":"JavaScript","label":"Node","source":"const resposta = await fetch(\"https://gyra-core.gyramais.com.br/v1/registry\", {\n method: \"GET\",\n headers: { Authorization: `Bearer ${token}` },\n});\n\nconst dados = await resposta.json();\n"},{"lang":"Python","label":"Python","source":"import requests\n\nresposta = requests.get(\n \"https://gyra-core.gyramais.com.br/v1/registry\",\n headers={\"Authorization\": f\"Bearer {token}\"},\n)\n\ndados = resposta.json()\n"}],"method":"get","type":"path","servers":["42171238-82dd-4b6d-8980-cce1cc8ba345"],"path":"/v1/registry","baseUrlOptions":["https://gyra-core.gyramais.com.br"],"title":"Listar cadastros da organizacao","codeSamples":[{"label":"cURL","lang":"cURL","source":"curl --request GET 'https://gyra-core.gyramais.com.br/v1/registry' \\\n --header 'Authorization: Bearer \u003ctoken>'\n"},{"label":"Node","lang":"JavaScript","source":"const resposta = await fetch(\"https://gyra-core.gyramais.com.br/v1/registry\", {\n method: \"GET\",\n headers: { Authorization: `Bearer ${token}` },\n});\n\nconst dados = await resposta.json();\n"},{"label":"Python","lang":"Python","source":"import requests\n\nresposta = requests.get(\n \"https://gyra-core.gyramais.com.br/v1/registry\",\n headers={\"Authorization\": f\"Bearer {token}\"},\n)\n\ndados = resposta.json()\n"}],"requiredOnlyExamples":false,"requestExampleType":"codeSamples","responseExampleType":"generated"},"dependencies":{"parameters":{"d14361f5-7455-4dae-b201-a60a0ede75b0":{"name":"search","required":false,"in":"query","schema":{"type":"string","isRequired":false,"description":"Casa por razao social, nome fantasia ou parte do CNPJ/CPF (mascara e ignorada).","uniqueKey":"","typeLabel":"string"},"description":"Casa por razao social, nome fantasia ou parte do CNPJ/CPF (mascara e ignorada)."},"ac725337-1a04-4721-8f90-8a5d21b7b84e":{"name":"entityType","required":false,"in":"query","schema":{"type":"string","enum":["COMPANY","PERSON"],"isRequired":false,"description":"COMPANY (pessoa juridica) ou PERSON (pessoa fisica).","uniqueKey":"","typeLabel":"enum\u003cstring>"},"description":"COMPANY (pessoa juridica) ou PERSON (pessoa fisica)."},"e283ee23-c099-4d83-9d95-c3c85b5c748f":{"name":"kycStatus","required":false,"in":"query","schema":{"type":"array","items":{"type":"string","enum":["PENDING","PROCESSING","UP_TO_DATE","ATTENTION","EXPIRED","RENEWING"],"uniqueKey":"items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":false,"description":"Uma ou mais situacoes. Repita o parametro para varias.","uniqueKey":"","typeLabel":"enum\u003cstring>[]"},"description":"Uma ou mais situacoes. Repita o parametro para varias."},"0b1fda8d-d11d-45e1-aff8-4c8857c2501e":{"name":"skip","required":false,"in":"query","schema":{"type":"integer","minimum":0,"isRequired":false,"description":"Quantos pular. Padrao 0.","uniqueKey":"","typeLabel":"integer"},"description":"Quantos pular. Padrao 0."},"ebb36930-d543-4400-a6ef-08d152d0ae07":{"name":"take","required":false,"in":"query","schema":{"type":"integer","minimum":1,"maximum":50,"isRequired":false,"description":"Tamanho da pagina. Padrao 20, maximo 50.","uniqueKey":"","typeLabel":"integer"},"description":"Tamanho da pagina. Padrao 20, maximo 50."}},"responses":{"acb41f9d-501d-4d29-8126-26938be32225":{"description":"Pagina de cadastros com situacao e completude.","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","description":"O dossie documental de um CNPJ ou CPF.","properties":{"id":{"type":"string","uniqueKey":"\\items.items.[INDEX].id","typeLabel":"string"},"document":{"type":"string","description":"CNPJ (14) ou CPF (11), so digitos.","uniqueKey":"\\items.items.[INDEX].document","typeLabel":"string"},"entityType":{"type":"string","enum":["COMPANY","PERSON"],"uniqueKey":"\\items.items.[INDEX].entityType","typeLabel":"enum\u003cstring>"},"name":{"oneOf":[{"type":"string","description":"Razao social ou nome.","uniqueKey":"\\items.items.[INDEX].name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Razao social ou nome.","uniqueKey":"\\items.items.[INDEX].name.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].name","typeLabel":"string | null"},"tradeName":{"oneOf":[{"type":"string","uniqueKey":"\\items.items.[INDEX].tradeName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"\\items.items.[INDEX].tradeName.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].tradeName","typeLabel":"string | null"},"legalNature":{"oneOf":[{"type":"string","uniqueKey":"\\items.items.[INDEX].legalNature.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"\\items.items.[INDEX].legalNature.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].legalNature","typeLabel":"string | null"},"kycStatus":{"type":"string","enum":["PENDING","PROCESSING","UP_TO_DATE","ATTENTION","EXPIRED","RENEWING"],"uniqueKey":"\\items.items.[INDEX].kycStatus","typeLabel":"enum\u003cstring>"},"kycRenewalDue":{"oneOf":[{"type":"string","format":"date-time","description":"Quando a renovacao vence.","uniqueKey":"\\items.items.[INDEX].kycRenewalDue.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Quando a renovacao vence.","uniqueKey":"\\items.items.[INDEX].kycRenewalDue.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].kycRenewalDue","typeLabel":"string\u003cdate-time> | null"},"completeness":{"type":"number","description":"0 a 1.","uniqueKey":"\\items.items.[INDEX].completeness","typeLabel":"number"},"completenessSlots":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"Primeiro tipo do grupo, usado como rotulo da exigencia.","uniqueKey":"\\items.items.[INDEX].completenessSlots.items.[INDEX].key","typeLabel":"string"},"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"],"uniqueKey":"\\items.items.[INDEX].completenessSlots.items.[INDEX].types.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"Tipos equivalentes que preenchem a mesma exigencia.","uniqueKey":"\\items.items.[INDEX].completenessSlots.items.[INDEX].types","typeLabel":"enum\u003cstring>[]"},"filled":{"type":"boolean","uniqueKey":"\\items.items.[INDEX].completenessSlots.items.[INDEX].filled","typeLabel":"boolean"},"documentId":{"oneOf":[{"type":"string","description":"Qual documento cobre a exigencia.","uniqueKey":"\\items.items.[INDEX].completenessSlots.items.[INDEX].documentId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Qual documento cobre a exigencia.","uniqueKey":"\\items.items.[INDEX].completenessSlots.items.[INDEX].documentId.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].completenessSlots.items.[INDEX].documentId","typeLabel":"string | null"}},"uniqueKey":"\\items.items.[INDEX].completenessSlots.items.[INDEX]","typeLabel":"object"},"description":"A cesta de completude aberta. So no detalhe: na listagem seria N+1.","uniqueKey":"\\items.items.[INDEX].completenessSlots","typeLabel":"object[]"},"signingAuthority":{"oneOf":[{"type":"object","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":{"oneOf":[{"type":"string","enum":["ISOLADA","CONJUNTA","MISTA","INDETERMINADO",null],"uniqueKey":"\\items.items.[INDEX].signingAuthority.oneOf.0.regime.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["ISOLADA","CONJUNTA","MISTA","INDETERMINADO",null],"uniqueKey":"\\items.items.[INDEX].signingAuthority.oneOf.0.regime.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].signingAuthority.oneOf.0.regime","typeLabel":"enum\u003cstring> | null"},"signersRequired":{"oneOf":[{"type":"integer","description":"Quantas assinaturas a regra geral exige.","uniqueKey":"\\items.items.[INDEX].signingAuthority.oneOf.0.signersRequired.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Quantas assinaturas a regra geral exige.","uniqueKey":"\\items.items.[INDEX].signingAuthority.oneOf.0.signersRequired.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].signingAuthority.oneOf.0.signersRequired","typeLabel":"integer | null"},"anySignerAlone":{"type":"boolean","description":"true quando ao menos um administrador assina sozinho.","uniqueKey":"\\items.items.[INDEX].signingAuthority.oneOf.0.anySignerAlone","typeLabel":"boolean"},"signers":{"type":"array","items":{"type":"object","properties":{"name":{"oneOf":[{"type":"string","uniqueKey":"\\items.items.[INDEX].signingAuthority.oneOf.0.signers.items.[INDEX].name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"\\items.items.[INDEX].signingAuthority.oneOf.0.signers.items.[INDEX].name.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].signingAuthority.oneOf.0.signers.items.[INDEX].name","typeLabel":"string | null"},"document":{"oneOf":[{"type":"string","description":"CPF em digitos. null quando o documento societario nao o repete, o que e comum.","uniqueKey":"\\items.items.[INDEX].signingAuthority.oneOf.0.signers.items.[INDEX].document.oneOf.0","typeLabel":"string"},{"type":"null","description":"CPF em digitos. null quando o documento societario nao o repete, o que e comum.","uniqueKey":"\\items.items.[INDEX].signingAuthority.oneOf.0.signers.items.[INDEX].document.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].signingAuthority.oneOf.0.signers.items.[INDEX].document","typeLabel":"string | null"},"role":{"oneOf":[{"type":"string","uniqueKey":"\\items.items.[INDEX].signingAuthority.oneOf.0.signers.items.[INDEX].role.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"\\items.items.[INDEX].signingAuthority.oneOf.0.signers.items.[INDEX].role.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].signingAuthority.oneOf.0.signers.items.[INDEX].role","typeLabel":"string | null"},"signsAlone":{"oneOf":[{"type":"boolean","uniqueKey":"\\items.items.[INDEX].signingAuthority.oneOf.0.signers.items.[INDEX].signsAlone.oneOf.0","typeLabel":"boolean"},{"type":"null","uniqueKey":"\\items.items.[INDEX].signingAuthority.oneOf.0.signers.items.[INDEX].signsAlone.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].signingAuthority.oneOf.0.signers.items.[INDEX].signsAlone","typeLabel":"boolean | null"},"jointSignatureThreshold":{"oneOf":[{"type":"number","uniqueKey":"\\items.items.[INDEX].signingAuthority.oneOf.0.signers.items.[INDEX].jointSignatureThreshold.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"\\items.items.[INDEX].signingAuthority.oneOf.0.signers.items.[INDEX].jointSignatureThreshold.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].signingAuthority.oneOf.0.signers.items.[INDEX].jointSignatureThreshold","typeLabel":"number | null"},"mandateEndDate":{"oneOf":[{"type":"string","description":"YYYY-MM-DD.","uniqueKey":"\\items.items.[INDEX].signingAuthority.oneOf.0.signers.items.[INDEX].mandateEndDate.oneOf.0","typeLabel":"string"},{"type":"null","description":"YYYY-MM-DD.","uniqueKey":"\\items.items.[INDEX].signingAuthority.oneOf.0.signers.items.[INDEX].mandateEndDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].signingAuthority.oneOf.0.signers.items.[INDEX].mandateEndDate","typeLabel":"string | null"},"restrictions":{"oneOf":[{"type":"string","uniqueKey":"\\items.items.[INDEX].signingAuthority.oneOf.0.signers.items.[INDEX].restrictions.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"\\items.items.[INDEX].signingAuthority.oneOf.0.signers.items.[INDEX].restrictions.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].signingAuthority.oneOf.0.signers.items.[INDEX].restrictions","typeLabel":"string | null"}},"uniqueKey":"\\items.items.[INDEX].signingAuthority.oneOf.0.signers.items.[INDEX]","typeLabel":"object"},"uniqueKey":"\\items.items.[INDEX].signingAuthority.oneOf.0.signers","typeLabel":"object[]"},"thresholds":{"type":"array","items":{"type":"object","additionalProperties":true,"description":"Faixa de alcada lida do documento.","uniqueKey":"\\items.items.[INDEX].signingAuthority.oneOf.0.thresholds.items.[INDEX]","typeLabel":"object"},"uniqueKey":"\\items.items.[INDEX].signingAuthority.oneOf.0.thresholds","typeLabel":"object[]"},"prohibitions":{"type":"array","items":{"type":"object","additionalProperties":true,"description":"Vedacao expressa lida do documento.","uniqueKey":"\\items.items.[INDEX].signingAuthority.oneOf.0.prohibitions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"\\items.items.[INDEX].signingAuthority.oneOf.0.prohibitions","typeLabel":"object[]"},"mandate":{"oneOf":[{"type":"object","additionalProperties":true,"uniqueKey":"\\items.items.[INDEX].signingAuthority.oneOf.0.mandate.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":true,"uniqueKey":"\\items.items.[INDEX].signingAuthority.oneOf.0.mandate.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].signingAuthority.oneOf.0.mandate","typeLabel":"object | null"},"source":{"type":"object","description":"De qual documento a leitura saiu.","properties":{"documentId":{"type":"string","uniqueKey":"\\items.items.[INDEX].signingAuthority.oneOf.0.source.documentId","typeLabel":"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"],"uniqueKey":"\\items.items.[INDEX].signingAuthority.oneOf.0.source.documentType","typeLabel":"enum\u003cstring>"},"fileName":{"oneOf":[{"type":"string","uniqueKey":"\\items.items.[INDEX].signingAuthority.oneOf.0.source.fileName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"\\items.items.[INDEX].signingAuthority.oneOf.0.source.fileName.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].signingAuthority.oneOf.0.source.fileName","typeLabel":"string | null"},"version":{"oneOf":[{"type":"integer","uniqueKey":"\\items.items.[INDEX].signingAuthority.oneOf.0.source.version.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"\\items.items.[INDEX].signingAuthority.oneOf.0.source.version.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].signingAuthority.oneOf.0.source.version","typeLabel":"integer | null"},"validatedAt":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"\\items.items.[INDEX].signingAuthority.oneOf.0.source.validatedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"\\items.items.[INDEX].signingAuthority.oneOf.0.source.validatedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].signingAuthority.oneOf.0.source.validatedAt","typeLabel":"string\u003cdate-time> | null"},"clauseNumber":{"oneOf":[{"type":"string","uniqueKey":"\\items.items.[INDEX].signingAuthority.oneOf.0.source.clauseNumber.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"\\items.items.[INDEX].signingAuthority.oneOf.0.source.clauseNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].signingAuthority.oneOf.0.source.clauseNumber","typeLabel":"string | null"},"clauseExcerpt":{"oneOf":[{"type":"string","uniqueKey":"\\items.items.[INDEX].signingAuthority.oneOf.0.source.clauseExcerpt.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"\\items.items.[INDEX].signingAuthority.oneOf.0.source.clauseExcerpt.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].signingAuthority.oneOf.0.source.clauseExcerpt","typeLabel":"string | null"},"confidence":{"oneOf":[{"type":"number","uniqueKey":"\\items.items.[INDEX].signingAuthority.oneOf.0.source.confidence.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"\\items.items.[INDEX].signingAuthority.oneOf.0.source.confidence.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].signingAuthority.oneOf.0.source.confidence","typeLabel":"number | null"}},"uniqueKey":"\\items.items.[INDEX].signingAuthority.oneOf.0.source","typeLabel":"object"}},"uniqueKey":"\\items.items.[INDEX].signingAuthority.oneOf.0","typeLabel":"object"},{"type":"null","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":{"oneOf":[{"type":"string","enum":["ISOLADA","CONJUNTA","MISTA","INDETERMINADO",null]},{"type":"null","enum":["ISOLADA","CONJUNTA","MISTA","INDETERMINADO",null]}]},"signersRequired":{"oneOf":[{"type":"integer","description":"Quantas assinaturas a regra geral exige."},{"type":"null","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":{"oneOf":[{"type":"string"},{"type":"null"}]},"document":{"oneOf":[{"type":"string","description":"CPF em digitos. null quando o documento societario nao o repete, o que e comum."},{"type":"null","description":"CPF em digitos. null quando o documento societario nao o repete, o que e comum."}]},"role":{"oneOf":[{"type":"string"},{"type":"null"}]},"signsAlone":{"oneOf":[{"type":"boolean"},{"type":"null"}]},"jointSignatureThreshold":{"oneOf":[{"type":"number"},{"type":"null"}]},"mandateEndDate":{"oneOf":[{"type":"string","description":"YYYY-MM-DD."},{"type":"null","description":"YYYY-MM-DD."}]},"restrictions":{"oneOf":[{"type":"string"},{"type":"null"}]}}}},"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":{"oneOf":[{"type":"object","additionalProperties":true},{"type":"null","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":{"oneOf":[{"type":"string"},{"type":"null"}]},"version":{"oneOf":[{"type":"integer"},{"type":"null"}]},"validatedAt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"null","format":"date-time"}]},"clauseNumber":{"oneOf":[{"type":"string"},{"type":"null"}]},"clauseExcerpt":{"oneOf":[{"type":"string"},{"type":"null"}]},"confidence":{"oneOf":[{"type":"number"},{"type":"null"}]}}}},"uniqueKey":"\\items.items.[INDEX].signingAuthority.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].signingAuthority","typeLabel":"object | null"},"documentsCount":{"type":"integer","uniqueKey":"\\items.items.[INDEX].documentsCount","typeLabel":"integer"},"pendingCount":{"type":"integer","uniqueKey":"\\items.items.[INDEX].pendingCount","typeLabel":"integer"},"reportId":{"oneOf":[{"type":"string","description":"Reservado para o relatorio mais recente do mesmo documento. Hoje vem null.","uniqueKey":"\\items.items.[INDEX].reportId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Reservado para o relatorio mais recente do mesmo documento. Hoje vem null.","uniqueKey":"\\items.items.[INDEX].reportId.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].reportId","typeLabel":"string | null"},"crossDocument":{"oneOf":[{"type":"object","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"],"uniqueKey":"\\items.items.[INDEX].crossDocument.oneOf.0.status","typeLabel":"enum\u003cstring>"},"checks":{"type":"array","items":{"type":"object","additionalProperties":true,"uniqueKey":"\\items.items.[INDEX].crossDocument.oneOf.0.checks.items.[INDEX]","typeLabel":"object"},"uniqueKey":"\\items.items.[INDEX].crossDocument.oneOf.0.checks","typeLabel":"object[]"},"documentIds":{"type":"array","items":{"type":"string","uniqueKey":"\\items.items.[INDEX].crossDocument.oneOf.0.documentIds.items.[INDEX]","typeLabel":"string"},"uniqueKey":"\\items.items.[INDEX].crossDocument.oneOf.0.documentIds","typeLabel":"string[]"},"triggeredByDocumentId":{"oneOf":[{"type":"string","uniqueKey":"\\items.items.[INDEX].crossDocument.oneOf.0.triggeredByDocumentId.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"\\items.items.[INDEX].crossDocument.oneOf.0.triggeredByDocumentId.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].crossDocument.oneOf.0.triggeredByDocumentId","typeLabel":"string | null"},"ruleSetVersion":{"type":"string","uniqueKey":"\\items.items.[INDEX].crossDocument.oneOf.0.ruleSetVersion","typeLabel":"string"},"evaluatedAt":{"type":"string","format":"date-time","uniqueKey":"\\items.items.[INDEX].crossDocument.oneOf.0.evaluatedAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"\\items.items.[INDEX].crossDocument.oneOf.0","typeLabel":"object"},{"type":"null","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":{"oneOf":[{"type":"string"},{"type":"null"}]},"ruleSetVersion":{"type":"string"},"evaluatedAt":{"type":"string","format":"date-time"}},"uniqueKey":"\\items.items.[INDEX].crossDocument.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].crossDocument","typeLabel":"object | null"},"basicDataSyncedAt":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"\\items.items.[INDEX].basicDataSyncedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"\\items.items.[INDEX].basicDataSyncedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].basicDataSyncedAt","typeLabel":"string\u003cdate-time> | null"},"createdAt":{"type":"string","format":"date-time","uniqueKey":"\\items.items.[INDEX].createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","uniqueKey":"\\items.items.[INDEX].updatedAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"\\items.items.[INDEX]","typeLabel":"object"},"uniqueKey":"\\items","typeLabel":"object[]"},"total":{"type":"integer","description":"Total que casa o filtro, nao o tamanho da pagina.","uniqueKey":"total","typeLabel":"integer"}},"uniqueKey":"","typeLabel":"object"},"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},"examples":{"Example":{"title":"Example","value":{"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}}},"exampleType":"examples"}},"exampleType":"examples"},"31c9c605-b552-4e47-898f-3807c0b4dd30":{"description":"Parametro invalido, inclusive valor de kycStatus fora da lista. A mensagem concatena todas as falhas por virgula.","content":{"application/json":{"schema":{"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.","uniqueKey":"code","typeLabel":"integer"},"message":{"type":"string","description":"Mensagem em portugues. Em erro de validacao, traz TODAS as falhas concatenadas por virgula.","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"code":400,"message":"each value in kycStatus must be one of the following values: PENDING, PROCESSING, UP_TO_DATE, ATTENTION, EXPIRED, RENEWING"},"examples":{"Example":{"title":"Example","value":{"code":400,"message":"each value in kycStatus must be one of the following values: PENDING, PROCESSING, UP_TO_DATE, ATTENTION, EXPIRED, RENEWING"}}},"exampleType":"examples"}},"exampleType":"examples"},"3d415ea0-2c6c-4fa9-a384-9384884906b4":{"description":"Token ausente, expirado ou invalido. Gere outro em POST /auth/authenticate.","content":{"application/json":{"schema":{"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.","uniqueKey":"code","typeLabel":"integer"},"message":{"type":"string","description":"Mensagem em portugues. Em erro de validacao, traz TODAS as falhas concatenadas por virgula.","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"code":401,"message":"Token de acesso inválido."},"examples":{"Example":{"title":"Example","value":{"code":401,"message":"Token de acesso inválido."}}},"exampleType":"examples"}},"exampleType":"examples"},"6ada1d82-6e38-4151-a0e2-1ac4006e1128":{"description":"O usuario autenticado nao tem a permissao exigida pela rota.","content":{"application/json":{"schema":{"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.","uniqueKey":"code","typeLabel":"integer"},"message":{"type":"string","description":"Mensagem em portugues. Em erro de validacao, traz TODAS as falhas concatenadas por virgula.","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"code":403,"message":"Você não tem permissão para acessar este recurso."},"examples":{"Example":{"title":"Example","value":{"code":403,"message":"Você não tem permissão para acessar este recurso."}}},"exampleType":"examples"}},"exampleType":"examples"},"d75e12b2-8fa4-4554-aae1-abf166bd0de9":{"description":"O modulo Onboarding nao esta liberado para a organizacao: para ela, a rota nao existe.","content":{"application/json":{"schema":{"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.","uniqueKey":"code","typeLabel":"integer"},"message":{"type":"string","description":"Mensagem em portugues. Em erro de validacao, traz TODAS as falhas concatenadas por virgula.","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"code":404,"message":"Recurso não encontrado."},"examples":{"Example":{"title":"Example","value":{"code":404,"message":"Recurso não encontrado."}}},"exampleType":"examples"}},"exampleType":"examples"},"dfa72d1a-f764-4f07-adf2-e74403792a49":{"description":"Falha nossa. Tente de novo; se persistir, acione o suporte com o horario da chamada.","content":{"application/json":{"schema":{"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.","uniqueKey":"code","typeLabel":"integer"},"message":{"type":"string","description":"Mensagem em portugues. Em erro de validacao, traz TODAS as falhas concatenadas por virgula.","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"code":500,"message":"Internal server error"},"examples":{"Example":{"title":"Example","value":{"code":500,"message":"Internal server error"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"fcbd376d-52e9-40c2-b66e-d4e6acd35996":{"authorization":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Enter JWT token","scopes":[],"schemeName":"authorization"}}},"servers":{"42171238-82dd-4b6d-8980-cce1cc8ba345":{"url":"https://gyra-core.gyramais.com.br","description":"Producao"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Enter JWT token","scopes":[],"schemeName":"authorization"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Enter JWT token","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"authorization","name":"Authorization"}],"title":"authorization"}]},"originalFileLocation":"openapi.yaml"},"subdomain":"gyra","siteName":"GYRA+ Docs","title":"Listar Cadastros - GYRA+ Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-05T18:52:01.994Z","originalFileLocation":"api-reference/registry/get-registry.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Para varrer a carteira por situação: quem está com pendência, quem venceu, quem está em renovação.\">\u003cmeta data-mint-head name=\"application-name\" content=\"GYRA+ Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/gyra/URB4IAaB0VDk-1wo/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/gyra/URB4IAaB0VDk-1wo/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/gyra/URB4IAaB0VDk-1wo/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/gyra/URB4IAaB0VDk-1wo/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/gyra/URB4IAaB0VDk-1wo/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/gyra/URB4IAaB0VDk-1wo/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/gyra/URB4IAaB0VDk-1wo/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/gyra/URB4IAaB0VDk-1wo/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/gyra/URB4IAaB0VDk-1wo/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Listar Cadastros - GYRA+ Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Para varrer a carteira por situação: quem está com pendência, quem venceu, quem está em renovação.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"GYRA+ Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developers.gyramais.com.br/api-reference/registry/get-registry\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://gyra.mintlify.site/_mintlify/api/og/v2?division=Cadastro\u0026amp;title=Listar+Cadastros\u0026amp;description=Para+varrer+a+carteira+por+situa%C3%A7%C3%A3o%3A+quem+est%C3%A1+com+pend%C3%AAncia%2C+quem+venceu%2C+quem+est%C3%A1+em+renova%C3%A7%C3%A3o.\u0026amp;theme=ea306aa6b40007f2fbe241ee\u0026amp;signature=dd428f8646954a033551f33b17e00df4304da8c47ad8b9250487726d095f92a5\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Listar Cadastros - GYRA+ Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Para varrer a carteira por situação: quem está com pendência, quem venceu, quem está em renovação.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://gyra.mintlify.site/_mintlify/api/og/v2?division=Cadastro\u0026amp;title=Listar+Cadastros\u0026amp;description=Para+varrer+a+carteira+por+situa%C3%A7%C3%A3o%3A+quem+est%C3%A1+com+pend%C3%AAncia%2C+quem+venceu%2C+quem+est%C3%A1+em+renova%C3%A7%C3%A3o.\u0026amp;theme=ea306aa6b40007f2fbe241ee\u0026amp;signature=dd428f8646954a033551f33b17e00df4304da8c47ad8b9250487726d095f92a5\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/gyra/URB4IAaB0VDk-1wo/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"GYRA+ Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1a54fa\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developers.gyramais.com.br/api-reference/registry/get-registry\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/registry/get-registry.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developers.gyramais.com.br/#organization\",\"name\":\"GYRA+ Docs\",\"url\":\"https://developers.gyramais.com.br\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/gyra/e0CFjRCELp2Et0mP/logo/light.png?fit=max\u0026auto=format\u0026n=e0CFjRCELp2Et0mP\u0026q=85\u0026s=07c498e8ad046860d4087e2bb3031959\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developers.gyramais.com.br#website\",\"name\":\"GYRA+ Docs\",\"url\":\"https://developers.gyramais.com.br\",\"publisher\":{\"@id\":\"https://developers.gyramais.com.br/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developers.gyramais.com.br/api-reference/registry/get-registry#webpage\",\"url\":\"https://developers.gyramais.com.br/api-reference/registry/get-registry\",\"name\":\"Listar Cadastros\",\"description\":\"Para varrer a carteira por situação: quem está com pendência, quem venceu, quem está em renovação.\",\"dateModified\":\"2026-10-05T18:52:01.994Z\",\"isPartOf\":{\"@id\":\"https://developers.gyramais.com.br#website\"},\"breadcrumb\":{\"@id\":\"https://developers.gyramais.com.br/api-reference/registry/get-registry#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers.gyramais.com.br/api-reference/registry/get-registry#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API: Onboarding\",\"item\":\"https://developers.gyramais.com.br/api-reference/onboarding/visao-geral\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Cadastro\",\"item\":\"https://developers.gyramais.com.br/api-reference/registry/post-registry\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Listar Cadastros\",\"item\":\"https://developers.gyramais.com.br/api-reference/registry/get-registry\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developers.gyramais.com.br/api-reference/registry/get-registry#apireference\",\"headline\":\"Listar Cadastros\",\"name\":\"Listar Cadastros\",\"description\":\"Para varrer a carteira por situação: quem está com pendência, quem venceu, quem está em renovação.\",\"url\":\"https://developers.gyramais.com.br/api-reference/registry/get-registry\",\"mainEntityOfPage\":{\"@id\":\"https://developers.gyramais.com.br/api-reference/registry/get-registry#webpage\"},\"dateModified\":\"2026-10-05T18:52:01.994Z\",\"publisher\":{\"@id\":\"https://developers.gyramais.com.br/#organization\"},\"isPartOf\":{\"@id\":\"https://developers.gyramais.com.br#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"GYRA+ Docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"GYRA+ Docs\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/registry/get-registry.md","siteName":"GYRA+ Docs","nav":{"global":null,"groups":[{"group":"Primeiros Passos","pages":[{"title":"Introdução","icon":"rocket","href":"/api-reference/introduction"},{"title":"Como Funciona","icon":"chart-network","href":"/api-reference/como-funciona"},{"title":"Chaves de API","icon":"key","href":"/api-reference/api-keys"}]},{"group":"Conceitos Fundamentais","pages":[{"title":"O que é um Relatório","icon":"file-chart-column","href":"/concepts/relatorio"},{"title":"Análise de Crédito","icon":"magnifying-glass-chart","href":"/concepts/analise-de-credito"},{"title":"Política de Crédito","icon":"shield-check","href":"/concepts/politica-de-credito"},{"title":"Templates de Política","icon":"sparkles","href":"/concepts/templates-de-politica"},{"title":"Seções do Relatório","icon":"layout-panel-top","href":"/concepts/secoes"},{"title":"Pareceres GYRA+ IA","icon":"sparkles","href":"/concepts/pareceres-gyra-ia"},{"title":"Comitê de Crédito IA","icon":"users","href":"/concepts/comite-de-credito"},{"title":"Análise Financeira (Balanços e DRE)","icon":"file-invoice-dollar","href":"/concepts/analise-financeira"},{"title":"Arquivos do Relatório","icon":"folder-open","href":"/concepts/arquivos-do-relatorio"},{"title":"Score","icon":"gauge-high","href":"/concepts/score"},{"title":"Decisão Automática","icon":"circle-check","href":"/concepts/decisao-automatica"},{"title":"Precificação","icon":"calculator","href":"/concepts/precificacao"},{"title":"Webhooks e Tempo Real","icon":"webhook","href":"/concepts/webhooks-e-tempo-real"},{"title":"Glossário","icon":"book","href":"/concepts/glossario"}]},{"group":"Onboarding","pages":[{"title":"Onboarding","icon":"folder-open","href":"/onboarding/visao-geral"},{"title":"Cadastro documental","icon":"folder-tree","href":"/onboarding/cadastro-documental"},{"title":"Tipos de documento aceitos","icon":"files","href":"/onboarding/tipos-de-documento"},{"title":"Análise documental","icon":"microscope","href":"/onboarding/analise-documental"},{"title":"Régua de validação","icon":"ruler","href":"/onboarding/regua-de-validacao"},{"title":"Solicitações de coleta","icon":"paper-plane","href":"/onboarding/solicitacoes"},{"title":"Formulários","icon":"rectangle-list","href":"/onboarding/formularios"},{"title":"Formulário público","icon":"globe","href":"/onboarding/formulario-publico"},{"title":"Termos e assinatura","icon":"file-signature","href":"/onboarding/termos-e-assinatura"},{"title":"Verificação de identidade","icon":"user-check","href":"/onboarding/verificacao-de-identidade"},{"title":"Página do destinatário","icon":"link","href":"/onboarding/pagina-do-destinatario"},{"title":"O que é cobrado","icon":"receipt","href":"/onboarding/cobranca"}]},{"group":"Propostas","pages":[{"title":"Propostas","icon":"inbox","href":"/propostas/visao-geral"},{"title":"Produtos e carteiras","icon":"box","href":"/propostas/produtos"},{"title":"Precificação do produto","icon":"calculator","href":"/propostas/precificacao"},{"title":"Pré-aprovação e oferta","icon":"hand-holding-dollar","href":"/propostas/pre-aprovacao-e-oferta"},{"title":"Painel gerencial","icon":"chart-line","href":"/propostas/gerencial"},{"title":"HubSpot","icon":"hubspot","href":"/propostas/hubspot"}]},{"group":"Esteiras","pages":[{"title":"Esteiras","icon":"route","href":"/esteiras/visao-geral"},{"title":"Etapas","icon":"list-ol","href":"/esteiras/etapas"},{"title":"Dados de entrada","icon":"table-list","href":"/esteiras/dados-de-entrada"},{"title":"Camadas e add-ons","icon":"layer-group","href":"/esteiras/camadas-e-add-ons"},{"title":"Chamada de API","icon":"brackets-curly","href":"/esteiras/chamada-de-api"},{"title":"Decisão, alçada e comitê","icon":"gavel","href":"/esteiras/decisao-alcada-e-comite"},{"title":"Execuções","icon":"play","href":"/esteiras/execucoes"}]},{"group":"Formalização","pages":[{"title":"Formalização","icon":"file-contract","href":"/formalizacao/visao-geral"},{"title":"Modelos de contrato","icon":"file-word","href":"/formalizacao/modelos-de-contrato"},{"title":"Variáveis do contrato","icon":"brackets-curly","href":"/formalizacao/variaveis-do-contrato"},{"title":"Partes e assinaturas","icon":"users","href":"/formalizacao/partes-e-assinaturas"},{"title":"Clicksign","icon":"signature","href":"/formalizacao/clicksign"}]},{"group":"BNDES Online","pages":[{"title":"BNDES Online","icon":"building-columns","href":"/bndes-online/visao-geral"}]},{"group":"Plataforma","pages":[{"title":"Módulos e capacidades","icon":"cubes","href":"/plataforma/modulos-e-capacidades"},{"title":"Assistente GYRA+","icon":"sparkles","href":"/plataforma/assistente-gyra"},{"title":"Correspondentes","icon":"handshake","href":"/plataforma/correspondentes"}]},{"group":"Guia do Toolbox","pages":[{"title":"Visão Geral do Toolbox","icon":"compass","href":"/toolbox/visao-geral"},{"title":"Início","icon":"house","href":"/toolbox/inicio"},{"title":"Primeiro Acesso","icon":"door-open","href":"/toolbox/primeiro-acesso"},{"title":"Propostas no toolbox","icon":"table-list","href":"/toolbox/propostas"},{"title":"Produtos no toolbox","icon":"box-open","href":"/toolbox/produtos"},{"title":"Rodar uma Análise","icon":"play","href":"/toolbox/rodar-operacao"},{"title":"Interpretar Resultado do Relatório","icon":"chart-line","href":"/toolbox/interpretar-resultado-operacao"},{"title":"Montar uma esteira","icon":"screwdriver-wrench","href":"/toolbox/montar-esteira"},{"title":"Acompanhar execuções","icon":"list-check","href":"/toolbox/acompanhar-execucoes"},{"title":"Contratos no toolbox","icon":"file-contract","href":"/toolbox/contratos"},{"title":"Clientes no toolbox","icon":"folder-open","href":"/toolbox/cadastros"},{"title":"Solicitações no toolbox","icon":"paper-plane","href":"/toolbox/solicitacoes"},{"title":"Validação de identidade","icon":"id-card","href":"/toolbox/validacao-de-identidade"},{"title":"Criar Política","icon":"wand-magic-sparkles","href":"/toolbox/criar-politica"},{"title":"Editar Política","icon":"pen-to-square","href":"/toolbox/editar-politica"},{"title":"Usar Templates de Política","icon":"sparkles","href":"/toolbox/usar-templates"},{"title":"Integrações no toolbox","icon":"plug","href":"/toolbox/integracoes"},{"title":"Usuários e Permissões","icon":"users-gear","href":"/toolbox/gerenciar-usuarios-permissoes"},{"title":"API \u0026 MCP: chaves e webhooks","icon":"key","href":"/toolbox/webhooks-e-api-keys"}]},{"group":"Fontes de Dados","pages":[{"title":"Visão Geral das Fontes","icon":"layer-group","href":"/sources/visao-geral"},{"title":"Cadastral","icon":"id-card","href":"/sources/cadastral"},{"title":"Bureau de Crédito","icon":"chart-simple","href":"/sources/bureau-credito"},{"title":"Processos Judiciais","icon":"gavel","href":"/sources/processos-judiciais"},{"title":"Protestos","icon":"file-circle-exclamation","href":"/sources/protestos"},{"title":"PEFIN e REFIN","icon":"circle-exclamation","href":"/sources/pefin-refin"},{"title":"SCR e Open Finance","icon":"building-columns","href":"/sources/scr-open-finance"},{"title":"PEP e Sanções","icon":"shield-halved","href":"/sources/pep-sancoes"},{"title":"Vínculos Societários","icon":"diagram-project","href":"/sources/vinculos-societarios"},{"title":"Contatos e Localização","icon":"address-book","href":"/sources/contatos"},{"title":"Financeira","icon":"sack-dollar","href":"/sources/financeira"},{"title":"Inteligência de Pagamentos (Núclea)","icon":"money-bill-transfer","href":"/sources/inteligencia-pagamentos"},{"title":"Certidões","icon":"stamp","href":"/sources/certidoes"},{"title":"Mídia e Reputação","icon":"newspaper","href":"/sources/midia-reputacao"},{"title":"Benefícios Sociais","icon":"hand-holding-heart","href":"/sources/beneficios-sociais"}]},{"group":"Guias","pages":[{"title":"Seu primeiro relatório em 5 minutos","icon":"rocket","href":"/guides/primeiro-relatorio"},{"title":"Integrar o Onboarding","icon":"route","href":"/guides/integrar-cadastro-documental"},{"title":"Configurar Webhook","icon":"webhook","href":"/guides/configurar-webhook"},{"title":"Interpretar uma Decisão de Crédito","icon":"magnifying-glass-chart","href":"/guides/interpretar-decisao"},{"title":"Criar uma Política de Crédito","icon":"sliders","href":"/guides/criar-politica-personalizada"}]},{"group":"Casos de Uso","pages":[{"title":"Fintech de Crédito","icon":"credit-card","href":"/use-cases/fintech-credito"},{"title":"Distribuidora e Crédito B2B","icon":"truck","href":"/use-cases/distribuidora-b2b"},{"title":"Fundo de Crédito e Factoring","icon":"building-columns","href":"/use-cases/fundo-e-factoring"}]},{"group":"MCP Server","pages":[{"title":"O que é o MCP da GYRA+","icon":"plug","href":"/mcp/o-que-e"},{"title":"Instalação do MCP","icon":"download","href":"/mcp/instalacao"},{"title":"Ferramentas Disponíveis","icon":"toolbox","href":"/mcp/ferramentas-disponiveis"},{"title":"Casos de Uso com MCP","icon":"lightbulb","href":"/mcp/casos-de-uso"},{"title":"Troubleshooting MCP","icon":"screwdriver-wrench","href":"/mcp/troubleshooting"}]},{"group":"Referência da API","pages":[{"title":"Gerar Token","openapi":"post /auth/authenticate","href":"/api-reference/auth/post-authauthenticate"},{"title":"Criar Relatório (v2)","openapi":"post /v2/report","href":"/api-reference/report-v2/post-v2report"},{"title":"Consultar Relatório (v2)","openapi":"get /v2/report/{id}","href":"/api-reference/report-v2/get-v2report"},{"title":"Enviar Balanço e DRE","openapi":"post /report/{id}/financial-tab","href":"/api-reference/report/post-report-financial-tab"},{"title":"Enviar Balanço e DRE por upload direto","href":"/api-reference/report/post-report-financial-tab-presign"},{"title":"Consulta Lista de Relatórios","openapi":"get /report/list","href":"/api-reference/report/get-reportlist"},{"title":"Consultar Seção por ID","openapi":"get /report/section/{id}","href":"/api-reference/report/get-reportsection"},{"title":"Consultar Seção por Tipo","openapi":"get /report/{id}/section/{sectionType}","href":"/api-reference/report/get-report-section"},{"title":"Reprocessar seção com falha","href":"/api-reference/report/post-report-section-retry"},{"title":"Consultar Pareceres do Relatório","openapi":"get /report/{id}/insights","href":"/api-reference/report/get-reportinsights"},{"title":"Convocar Comitê de Crédito IA","openapi":"post /report/{id}/committee","href":"/api-reference/report/post-reportcommittee"},{"title":"Consultar Deliberação do Comitê","openapi":"get /committee/deliberations/{reportId}","href":"/api-reference/committee/get-committeedeliberations"},{"title":"Analisar Relatório Manualmente","openapi":"post /report/analyze","href":"/api-reference/report/post-reportanalyze"},{"title":"Refazer Análise Manual","openapi":"post /report/re-analyze","href":"/api-reference/report/post-reportre-analyze"},{"title":"Exportar Relatório (Assíncrono)","openapi":"get /report/export/{id}","href":"/api-reference/report/get-reportexport"},{"title":"Exportar Relatório (Síncrono)","openapi":"get /report/export-sync/{id}","href":"/api-reference/report/get-reportexport-sync"},{"title":"Consultar políticas de decisão","openapi":"get /credit-policy/policy","href":"/api-reference/credit-policypolicy/get-credit-policypolicy"},{"title":"Criar Webhook","openapi":"post /webhook","href":"/api-reference/webhook/post-webhook"},{"title":"Consultar Webhook","openapi":"get /webhook/findBy","href":"/api-reference/webhook/get-webhookfindby"},{"title":"Remover Webhook","openapi":"delete /webhook/{id}","href":"/api-reference/webhook/delete-webhook"}]},{"group":"API: Onboarding","pages":[{"title":"Visão geral da API","href":"/api-reference/onboarding/visao-geral"},{"group":"Documento","pages":[{"title":"Validar Documento","openapi":"post /v1/registry/validate-document","href":"/api-reference/registry/post-registry-validate-document"},{"title":"Status do Documento","openapi":"get /v1/registry/documents/{docId}/status","href":"/api-reference/registry/get-registry-documents-docid-status"},{"title":"Preparar Upload de Documento","openapi":"post /v1/registry/{id}/documents/presign","href":"/api-reference/registry/post-registry-id-documents-presign"},{"title":"Confirmar Upload e Analisar","openapi":"post /v1/registry/{id}/documents","href":"/api-reference/registry/post-registry-id-documents"},{"title":"Resultado do Documento","openapi":"get /v1/registry/{id}/documents/{docId}/result","href":"/api-reference/registry/get-registry-id-documents-docid-result"},{"title":"Reprocessar Documento","openapi":"post /v1/registry/{id}/documents/{docId}/reprocess","href":"/api-reference/registry/post-registry-id-documents-docid-reprocess"}]},{"group":"Cadastro","pages":[{"title":"Criar Cadastro","description":"No início de uma jornada, para garantir que o dossiê daquele CNPJ ou CPF existe.","openapi":"post /v1/registry","href":"/api-reference/registry/post-registry"},{"title":"Listar Cadastros","openapi":"get /v1/registry","href":"/api-reference/registry/get-registry"},{"title":"Consultar Cadastro","description":"Quando você já tem o id e quer o dossiê completo.","openapi":"get /v1/registry/{id}","href":"/api-reference/registry/get-registry-id"},{"title":"Consultar Cadastro por CNPJ ou CPF","openapi":"get /v1/registry/by-document/{document}","href":"/api-reference/registry/get-registry-by-document-document"},{"title":"Listar Documentos do Cadastro","openapi":"get /v1/registry/{id}/documents","href":"/api-reference/registry/get-registry-id-documents"},{"title":"Árvore Societária","openapi":"get /v1/registry/{id}/persons","href":"/api-reference/registry/get-registry-id-persons"},{"title":"Pessoas, contatos e dados declarados","href":"/api-reference/onboarding/pessoas-e-contatos"}]},{"group":"Solicitação","pages":[{"title":"Listar Modelos de Coleta","openapi":"get /v1/collection-templates","href":"/api-reference/collection/get-collection-templates"},{"title":"Criar Solicitação","openapi":"post /v1/collections","href":"/api-reference/collection/post-collections"},{"title":"Listar Solicitações","openapi":"get /v1/collections","href":"/api-reference/collection/get-collections"},{"title":"Consultar Solicitação","openapi":"get /v1/collections/{id}","href":"/api-reference/collection/get-collections-id"},{"title":"Enviar Solicitação","openapi":"post /v1/collections/{id}/send","href":"/api-reference/collection/post-collections-id-send"},{"title":"Cancelar Solicitação","openapi":"post /v1/collections/{id}/cancel","href":"/api-reference/collection/post-collections-id-cancel"},{"title":"Revisar Item","openapi":"post /v1/collections/{id}/items/{itemId}/review","href":"/api-reference/collection/post-collections-id-items-itemid-review"},{"title":"Baixar a via assinada","href":"/api-reference/onboarding/via-assinada"}]},{"group":"Webhook","pages":[{"title":"Catálogo de Eventos","openapi":"get /v1/webhook/events","href":"/api-reference/collection/get-webhook-events"},{"title":"Listar Assinaturas de Webhook","openapi":"get /v1/webhook/endpoints","href":"/api-reference/collection/get-webhook-endpoints"},{"title":"Criar ou Atualizar Assinatura","openapi":"post /v1/webhook/endpoints","href":"/api-reference/collection/post-webhook-endpoints"}]},{"title":"Formatos de retorno por documento","icon":"table-list","href":"/api-reference/onboarding/formatos-de-retorno"},{"title":"Eventos de webhook","icon":"bolt-lightning","href":"/api-reference/onboarding/eventos-de-webhook"}]},{"group":"API: Propostas e Esteiras","pages":[{"title":"Visão geral da API de Propostas","icon":"file-invoice-dollar","href":"/api-reference/propostas/visao-geral"},{"title":"Propostas","icon":"file-lines","href":"/api-reference/propostas/propostas"},{"title":"Ofertas","icon":"hand-holding-dollar","href":"/api-reference/propostas/ofertas"},{"title":"Produtos e precificação","icon":"calculator","href":"/api-reference/propostas/produtos-e-precificacao"},{"title":"Indicadores gerenciais","icon":"chart-line","href":"/api-reference/propostas/gerencial"},{"title":"Dados de entrada","icon":"table-list","href":"/api-reference/propostas/dados-de-entrada"},{"title":"Fechamento externo","icon":"flag-checkered","href":"/api-reference/esteiras/fechamento-externo"}]},{"group":"Dicionário de Dados","pages":[{"title":"Estrutura do Relatório","icon":"database","href":"/data/estrutura-relatorio"},{"title":"Seção, Resumo (SUMMARY)","icon":"chart-bar","href":"/data/secao-resumo"},{"title":"Seção, Informações Básicas (BASIC_INFORMATION)","icon":"address-card","href":"/data/secao-informacoes-basicas"},{"title":"Seção, Processos Judiciais (PROCESSES)","icon":"gavel","href":"/data/secao-processos"},{"title":"Seção, Protestos (PROTESTS)","icon":"stamp","href":"/data/secao-protestos"},{"title":"Seção, PEFIN e REFIN","icon":"triangle-exclamation","href":"/data/secao-pefin-refin"},{"title":"Seção, SCR (Banco Central)","icon":"chart-line","href":"/data/secao-scr"},{"title":"Seção, PEP e Sanções","icon":"landmark","href":"/data/secao-pep-sancoes"},{"title":"Seção, Política de Crédito (CREDIT_POLICY)","icon":"shield-check","href":"/data/secao-politica-credito"}]},{"group":"Integrações","pages":[{"title":"Collections para Postman e Insomnia","icon":"flask-vial","href":"/docs/postman-insomnia"},{"title":"Integração com n8n","icon":"diagram-project","href":"/docs/integracao-n8n"},{"title":"Políticas de Decisão e Tipos de Relatório","icon":"files","href":"/docs/tipos-relatorios"},{"title":"Dados Entregues","icon":"database","href":"/docs/dados-entregues"}]},{"group":"Referência","pages":[{"title":"Referência de Erros","icon":"circle-exclamation","href":"/reference/erros"},{"title":"Changelog","icon":"clock-rotate-left","href":"/reference/changelog"}]}]},"basePath":"","title":"Listar Cadastros - GYRA+ Docs","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","CodeSnippet-D_HwgQO_.js","getApiPlaygroundDisplay-CmCoerhe.js","Page-CVJ-f_k1.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js","Markdown-CX2QY19L.js","AssistantPageLink-CY3bFglh.js","dist-Dl6_zDnT.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}