{
"code": 400,
"message": "O identificador informado em \"id\" não é válido."
}
{
"code": 401,
"message": "Token de acesso inválido."
}
{
"code": 403,
"message": "Você não tem permissão para acessar este recurso."
}
{
"code": 404,
"message": "Cadastro não encontrado."
}
{
"code": 500,
"message": "Internal server error"
}
Quando usar
Para descobrir de quem pedir documento de sócio, e de onde veio cada pessoa.
A origem importa
source
De onde veio
QSA_OFICIAL
Quadro societário da fonte oficial. O CPF vem mascarado
DOCUMENT_EXTRACTION
Lido de contrato, estatuto, ata ou certidão
MANUAL
Criado por um operador
FORM
Declarado pelo cliente num formulário de solicitação
layer distingue o quadro direto (1) do sócio da sócia pessoa jurídica (2).A resposta vem em persons. Cada pessoa traz editedFields, os campos que alguém da sua equipe corrigiu (a atualização do quadro oficial não passa por cima deles), e contact, o contato guardado que recebe os envios. Para corrigir um sócio ou mexer nos contatos, veja Pessoas, contatos e dados declarados.
De onde a pessoa veio. FORM = declarada pelo cliente num formulario de solicitacao.
Available options:
QSA_OFICIAL,
DOCUMENT_EXTRACTION,
MANUAL,
FORM
persons.sourceDocumentId
string | null
Documento de onde a pessoa foi lida, quando source e DOCUMENT_EXTRACTION.
persons.editedFields
enum<string>[]
Campos que um operador corrigiu. A atualizacao do quadro oficial e a extracao nao passam por cima deles.
Available options:
name,
role,
sharePercent,
document
persons.contact
object | null
Primeiro contato guardado da pessoa (o preferido, senao o mais recente). null sem documento completo ou sem contato.
Hide child attributes
persons.contact.name
string
persons.contact.email
string | null
persons.contact.phone
string | null
persons.contact.source
enum<string>
Available options:
FORM,
OPERATOR,
HISTORY
persons.contact.preferred
boolean
persons.contact.lastUsedAt
string<date-time>
persons.linkedRegistryId
string | null
Cadastro proprio da pessoa, quando ja existe.
{"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-id-persons","slug":"/api-reference/registry/get-registry-id-persons","pageMetadata":{"title":"Árvore Societária","description":"Para descobrir de quem pedir documento de sócio, e de onde veio cada pessoa.","surface":"api","domain":"cadastro","audience":"integrador","lang":"tecnica","openapi":"get /v1/registry/{id}/persons","href":"/api-reference/registry/get-registry-id-persons"},"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 descobrir de quem pedir documento de sócio, e de onde veio cada pessoa.\"\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`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{Heading,Note,Table}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`3`,id:`quando-usar`,children:`Quando usar`}),`\n`,_jsx(_components.p,{children:`Para descobrir de quem pedir documento de sócio, e de onde veio cada pessoa.`}),`\n`,_jsx(Heading,{level:`3`,id:`a-origem-importa`,children:`A origem importa`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:_jsx(_components.code,{children:`source`})}),_jsx(_components.th,{children:`De onde veio`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`QSA_OFICIAL`})}),_jsx(_components.td,{children:`Quadro societário da fonte oficial. O CPF vem mascarado`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`DOCUMENT_EXTRACTION`})}),_jsx(_components.td,{children:`Lido de contrato, estatuto, ata ou certidão`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`MANUAL`})}),_jsx(_components.td,{children:`Criado por um operador`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`FORM`})}),_jsx(_components.td,{children:`Declarado pelo cliente num formulário de solicitação`})]})]})]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`layer`}),` distingue o quadro direto (`,_jsx(_components.code,{children:`1`}),`) do sócio da sócia pessoa jurídica (`,_jsx(_components.code,{children:`2`}),`).`]}),`\n`,_jsxs(_components.p,{children:[`A resposta vem em `,_jsx(_components.code,{children:`persons`}),`. Cada pessoa traz `,_jsx(_components.code,{children:`editedFields`}),`, os campos que alguém da sua equipe corrigiu (a atualização do quadro oficial não passa por cima deles), e `,_jsx(_components.code,{children:`contact`}),`, o contato guardado que recebe os envios. Para corrigir um sócio ou mexer nos contatos, veja `,_jsx(_components.a,{href:`/api-reference/onboarding/pessoas-e-contatos`,children:`Pessoas, contatos e dados declarados`}),`.`]}),`\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":"Árvore Societária","description":"Para descobrir de quem pedir documento de sócio, e de onde veio cada pessoa.","surface":"api","domain":"cadastro","audience":"integrador","lang":"tecnica","openapi":"get /v1/registry/{id}/persons","href":"/api-reference/registry/get-registry-id-persons"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Quando usar","slug":"quando-usar","depth":3,"children":[]},{"title":"A origem importa","slug":"a-origem-importa","depth":3,"children":[]}],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"RegistryController_persons","summary":"Arvore societaria do cadastro","parameters":["1c3af2c0-3584-4c12-84b2-5314f9c0c217"],"responses":{"200":"407b5828-fd6a-4d22-9d92-d26bc76aa7bc","400":"f254049a-a254-4fe7-a94a-3a9a15131519","401":"3a272759-17e0-441a-8788-79bb20f8250c","403":"5bc6a059-d178-4c3a-8713-ae58696eddc4","404":"cd3ae38d-641b-4a83-a3e3-ebbb6200a4c6","500":"dfe85b3a-61c5-4d0d-9e3d-50fddbd62a35"},"tags":["registry"],"security":["d5a3c468-0572-4c14-b32c-ad9e5282b423"],"description":"Para descobrir de quem pedir documento de sócio, e de onde veio cada pessoa.","x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET 'https://gyra-core.gyramais.com.br/v1/registry/6612a7f30000000000000001/persons' \\\n --header 'Authorization: Bearer \u003ctoken>'\n"},{"lang":"JavaScript","label":"Node","source":"const resposta = await fetch(\"https://gyra-core.gyramais.com.br/v1/registry/6612a7f30000000000000001/persons\", {\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/6612a7f30000000000000001/persons\",\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/{id}/persons","baseUrlOptions":["https://gyra-core.gyramais.com.br"],"title":"Arvore societaria do cadastro","codeSamples":[{"label":"cURL","lang":"cURL","source":"curl --request GET 'https://gyra-core.gyramais.com.br/v1/registry/6612a7f30000000000000001/persons' \\\n --header 'Authorization: Bearer \u003ctoken>'\n"},{"label":"Node","lang":"JavaScript","source":"const resposta = await fetch(\"https://gyra-core.gyramais.com.br/v1/registry/6612a7f30000000000000001/persons\", {\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/6612a7f30000000000000001/persons\",\n headers={\"Authorization\": f\"Bearer {token}\"},\n)\n\ndados = resposta.json()\n"}],"requiredOnlyExamples":false,"requestExampleType":"codeSamples","responseExampleType":"generated"},"dependencies":{"parameters":{"1c3af2c0-3584-4c12-84b2-5314f9c0c217":{"name":"id","required":true,"in":"path","schema":{"type":"string","isRequired":true,"description":"Id do cadastro.","uniqueKey":"","typeLabel":"string"},"description":"Id do cadastro."}},"responses":{"407b5828-fd6a-4d22-9d92-d26bc76aa7bc":{"description":"Pessoas com nome, documento, papel, participacao, origem, campos corrigidos e o primeiro contato guardado, dentro de `persons`.","content":{"application/json":{"schema":{"type":"object","properties":{"persons":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","uniqueKey":"persons.items.[INDEX].id","typeLabel":"string"},"registryId":{"type":"string","uniqueKey":"persons.items.[INDEX].registryId","typeLabel":"string"},"entityType":{"type":"string","enum":["COMPANY","PERSON"],"uniqueKey":"persons.items.[INDEX].entityType","typeLabel":"enum\u003cstring>"},"document":{"oneOf":[{"type":"string","uniqueKey":"persons.items.[INDEX].document.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"persons.items.[INDEX].document.oneOf.1","typeLabel":"null"}],"uniqueKey":"persons.items.[INDEX].document","typeLabel":"string | null"},"maskedDocument":{"oneOf":[{"type":"string","description":"O QSA da Receita devolve o CPF de pessoa fisica mascarado.","uniqueKey":"persons.items.[INDEX].maskedDocument.oneOf.0","typeLabel":"string"},{"type":"null","description":"O QSA da Receita devolve o CPF de pessoa fisica mascarado.","uniqueKey":"persons.items.[INDEX].maskedDocument.oneOf.1","typeLabel":"null"}],"uniqueKey":"persons.items.[INDEX].maskedDocument","typeLabel":"string | null"},"name":{"type":"string","uniqueKey":"persons.items.[INDEX].name","typeLabel":"string"},"role":{"oneOf":[{"type":"string","uniqueKey":"persons.items.[INDEX].role.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"persons.items.[INDEX].role.oneOf.1","typeLabel":"null"}],"uniqueKey":"persons.items.[INDEX].role","typeLabel":"string | null"},"sharePercent":{"oneOf":[{"type":"number","uniqueKey":"persons.items.[INDEX].sharePercent.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"persons.items.[INDEX].sharePercent.oneOf.1","typeLabel":"null"}],"uniqueKey":"persons.items.[INDEX].sharePercent","typeLabel":"number | null"},"layer":{"type":"integer","description":"1 = quadro societario direto; 2 = socio da socia pessoa juridica.","uniqueKey":"persons.items.[INDEX].layer","typeLabel":"integer"},"parentPersonId":{"oneOf":[{"type":"string","uniqueKey":"persons.items.[INDEX].parentPersonId.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"persons.items.[INDEX].parentPersonId.oneOf.1","typeLabel":"null"}],"uniqueKey":"persons.items.[INDEX].parentPersonId","typeLabel":"string | null"},"isBeneficialOwner":{"type":"boolean","uniqueKey":"persons.items.[INDEX].isBeneficialOwner","typeLabel":"boolean"},"source":{"type":"string","enum":["QSA_OFICIAL","DOCUMENT_EXTRACTION","MANUAL","FORM"],"description":"De onde a pessoa veio. FORM = declarada pelo cliente num formulario de solicitacao.","uniqueKey":"persons.items.[INDEX].source","typeLabel":"enum\u003cstring>"},"sourceDocumentId":{"oneOf":[{"type":"string","description":"Documento de onde a pessoa foi lida, quando source e DOCUMENT_EXTRACTION.","uniqueKey":"persons.items.[INDEX].sourceDocumentId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Documento de onde a pessoa foi lida, quando source e DOCUMENT_EXTRACTION.","uniqueKey":"persons.items.[INDEX].sourceDocumentId.oneOf.1","typeLabel":"null"}],"uniqueKey":"persons.items.[INDEX].sourceDocumentId","typeLabel":"string | null"},"editedFields":{"type":"array","items":{"type":"string","enum":["name","role","sharePercent","document"],"uniqueKey":"persons.items.[INDEX].editedFields.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"Campos que um operador corrigiu. A atualizacao do quadro oficial e a extracao nao passam por cima deles.","uniqueKey":"persons.items.[INDEX].editedFields","typeLabel":"enum\u003cstring>[]"},"contact":{"oneOf":[{"type":"object","description":"Primeiro contato guardado da pessoa (o preferido, senao o mais recente). null sem documento completo ou sem contato.","properties":{"name":{"type":"string","uniqueKey":"persons.items.[INDEX].contact.oneOf.0.name","typeLabel":"string"},"email":{"oneOf":[{"type":"string","uniqueKey":"persons.items.[INDEX].contact.oneOf.0.email.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"persons.items.[INDEX].contact.oneOf.0.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"persons.items.[INDEX].contact.oneOf.0.email","typeLabel":"string | null"},"phone":{"oneOf":[{"type":"string","uniqueKey":"persons.items.[INDEX].contact.oneOf.0.phone.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"persons.items.[INDEX].contact.oneOf.0.phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"persons.items.[INDEX].contact.oneOf.0.phone","typeLabel":"string | null"},"source":{"type":"string","enum":["FORM","OPERATOR","HISTORY"],"uniqueKey":"persons.items.[INDEX].contact.oneOf.0.source","typeLabel":"enum\u003cstring>"},"preferred":{"type":"boolean","uniqueKey":"persons.items.[INDEX].contact.oneOf.0.preferred","typeLabel":"boolean"},"lastUsedAt":{"type":"string","format":"date-time","uniqueKey":"persons.items.[INDEX].contact.oneOf.0.lastUsedAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"persons.items.[INDEX].contact.oneOf.0","typeLabel":"object"},{"type":"null","description":"Primeiro contato guardado da pessoa (o preferido, senao o mais recente). null sem documento completo ou sem contato.","properties":{"name":{"type":"string"},"email":{"oneOf":[{"type":"string"},{"type":"null"}]},"phone":{"oneOf":[{"type":"string"},{"type":"null"}]},"source":{"type":"string","enum":["FORM","OPERATOR","HISTORY"]},"preferred":{"type":"boolean"},"lastUsedAt":{"type":"string","format":"date-time"}},"uniqueKey":"persons.items.[INDEX].contact.oneOf.1","typeLabel":"null"}],"uniqueKey":"persons.items.[INDEX].contact","typeLabel":"object | null"},"linkedRegistryId":{"oneOf":[{"type":"string","description":"Cadastro proprio da pessoa, quando ja existe.","uniqueKey":"persons.items.[INDEX].linkedRegistryId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Cadastro proprio da pessoa, quando ja existe.","uniqueKey":"persons.items.[INDEX].linkedRegistryId.oneOf.1","typeLabel":"null"}],"uniqueKey":"persons.items.[INDEX].linkedRegistryId","typeLabel":"string | null"}},"uniqueKey":"persons.items.[INDEX]","typeLabel":"object"},"uniqueKey":"persons","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"persons":[{"id":"6612a7f30000000000000021","registryId":"6612a7f30000000000000001","entityType":"PERSON","document":"52998224725","maskedDocument":null,"name":"CARLOS EDUARDO SILVA","role":"Sócio administrador","sharePercent":60,"layer":1,"parentPersonId":null,"isBeneficialOwner":true,"source":"FORM","linkedRegistryId":null,"editedFields":[],"contact":{"name":"CARLOS EDUARDO SILVA","email":"carlos@aurora.com.br","phone":"51999998888","source":"FORM","preferred":false,"lastUsedAt":"2026-09-05T14:20:00.000Z"}},{"id":"6612a7f30000000000000022","registryId":"6612a7f30000000000000001","entityType":"PERSON","document":null,"maskedDocument":"***982247**","name":"MARIA HELENA SOUZA","role":"Sócio","sharePercent":38,"layer":1,"parentPersonId":null,"isBeneficialOwner":true,"source":"QSA_OFICIAL","linkedRegistryId":null,"editedFields":[],"contact":null}]},"examples":{"Example":{"title":"Example","value":{"persons":[{"id":"6612a7f30000000000000021","registryId":"6612a7f30000000000000001","entityType":"PERSON","document":"52998224725","maskedDocument":null,"name":"CARLOS EDUARDO SILVA","role":"Sócio administrador","sharePercent":60,"layer":1,"parentPersonId":null,"isBeneficialOwner":true,"source":"FORM","linkedRegistryId":null,"editedFields":[],"contact":{"name":"CARLOS EDUARDO SILVA","email":"carlos@aurora.com.br","phone":"51999998888","source":"FORM","preferred":false,"lastUsedAt":"2026-09-05T14:20:00.000Z"}},{"id":"6612a7f30000000000000022","registryId":"6612a7f30000000000000001","entityType":"PERSON","document":null,"maskedDocument":"***982247**","name":"MARIA HELENA SOUZA","role":"Sócio","sharePercent":38,"layer":1,"parentPersonId":null,"isBeneficialOwner":true,"source":"QSA_OFICIAL","linkedRegistryId":null,"editedFields":[],"contact":null}]}}},"exampleType":"examples"}},"exampleType":"examples"},"f254049a-a254-4fe7-a94a-3a9a15131519":{"description":"Identificador fora do formato ObjectId (24 caracteres hexadecimais).","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":"O identificador informado em \"id\" não é válido."},"examples":{"Example":{"title":"Example","value":{"code":400,"message":"O identificador informado em \"id\" não é válido."}}},"exampleType":"examples"}},"exampleType":"examples"},"3a272759-17e0-441a-8788-79bb20f8250c":{"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"},"5bc6a059-d178-4c3a-8713-ae58696eddc4":{"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"},"cd3ae38d-641b-4a83-a3e3-ebbb6200a4c6":{"description":"Recurso inexistente OU capacidade nao liberada para a organizacao. As duas coisas respondem 404 de proposito: para quem nao tem o modulo, 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":"Cadastro não encontrado."},"examples":{"Example":{"title":"Example","value":{"code":404,"message":"Cadastro não encontrado."}}},"exampleType":"examples"}},"exampleType":"examples"},"dfe85b3a-61c5-4d0d-9e3d-50fddbd62a35":{"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":{"d5a3c468-0572-4c14-b32c-ad9e5282b423":{"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":"Árvore Societária - GYRA+ Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-05T18:52:01.983Z","originalFileLocation":"api-reference/registry/get-registry-id-persons.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 descobrir de quem pedir documento de sócio, e de onde veio cada pessoa.\">\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=\"Árvore Societária - GYRA+ Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Para descobrir de quem pedir documento de sócio, e de onde veio cada pessoa.\">\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-id-persons\">\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=%C3%81rvore+Societ%C3%A1ria\u0026amp;description=Para+descobrir+de+quem+pedir+documento+de+s%C3%B3cio%2C+e+de+onde+veio+cada+pessoa.\u0026amp;theme=ea306aa6b40007f2fbe241ee\u0026amp;signature=bad4ef1920963afcacf0c2c8e83e49e6de257c4810da4d1e6792179308f1e3f5\">\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=\"Árvore Societária - GYRA+ Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Para descobrir de quem pedir documento de sócio, e de onde veio cada pessoa.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://gyra.mintlify.site/_mintlify/api/og/v2?division=Cadastro\u0026amp;title=%C3%81rvore+Societ%C3%A1ria\u0026amp;description=Para+descobrir+de+quem+pedir+documento+de+s%C3%B3cio%2C+e+de+onde+veio+cada+pessoa.\u0026amp;theme=ea306aa6b40007f2fbe241ee\u0026amp;signature=bad4ef1920963afcacf0c2c8e83e49e6de257c4810da4d1e6792179308f1e3f5\">\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-id-persons\">\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-id-persons.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-id-persons#webpage\",\"url\":\"https://developers.gyramais.com.br/api-reference/registry/get-registry-id-persons\",\"name\":\"Árvore Societária\",\"description\":\"Para descobrir de quem pedir documento de sócio, e de onde veio cada pessoa.\",\"dateModified\":\"2026-10-05T18:52:01.983Z\",\"isPartOf\":{\"@id\":\"https://developers.gyramais.com.br#website\"},\"breadcrumb\":{\"@id\":\"https://developers.gyramais.com.br/api-reference/registry/get-registry-id-persons#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers.gyramais.com.br/api-reference/registry/get-registry-id-persons#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\":\"Árvore Societária\",\"item\":\"https://developers.gyramais.com.br/api-reference/registry/get-registry-id-persons\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developers.gyramais.com.br/api-reference/registry/get-registry-id-persons#apireference\",\"headline\":\"Árvore Societária\",\"name\":\"Árvore Societária\",\"description\":\"Para descobrir de quem pedir documento de sócio, e de onde veio cada pessoa.\",\"url\":\"https://developers.gyramais.com.br/api-reference/registry/get-registry-id-persons\",\"mainEntityOfPage\":{\"@id\":\"https://developers.gyramais.com.br/api-reference/registry/get-registry-id-persons#webpage\"},\"dateModified\":\"2026-10-05T18:52:01.983Z\",\"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-id-persons.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","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","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","description":"Para saber o que o dossiê já tem antes de pedir de novo.","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","description":"Corrija um sócio, guarde e escolha os contatos de cada pessoa e leia o que o cliente respondeu nos formulários do cadastro.","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":"Árvore Societária - 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"]}