{
"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": "Solicitação não encontrada."
}
{
"code": 500,
"message": "Internal server error"
}
Quando usar
Para acompanhar item a item e ver o estado de entrega de cada destinatário.
O estado que mais importa
recipients[].status em FAILED quer dizer que a mensagem não chegou. É o caso de ligar para o cliente, e é por isso que vale assinar collection.message.failed.items[].files[] traz o parecer de cada arquivo, quando o item aceita mais de um. Item com signedDocumentAvailable: true tem via assinada para baixar.O link de cada destinatário não volta aqui: ele só existe na resposta de criação e na de envio.
Solicitacao com itens, destinatarios, links e trilha.
Uma solicitacao de coleta com itens, destinatarios e trilha.
id
string
registryId
string
templateId
string | null
templateSlug
string | null
templateName
string | null
templateVersion
integer | null
status
enum<string>
Available options:
DRAFT,
SENT,
IN_PROGRESS,
COMPLETED,
EXPIRED,
CANCELED
responseMode
enum<string>
Available options:
AUTOMATIC,
REVIEW
channel
enum<string>
NONE: a plataforma nao avisou ninguem e quem entrega o link e voce.
Available options:
WHATSAPP,
EMAIL,
BOTH,
NONE
reminders
integer[]
Dias apos o envio.
behavior
object
O comportamento herdado do modelo.
message
string | null
Recado do operador ao destinatario.
dueAt
string<date-time> | null
sentAt
string<date-time> | null
completedAt
string<date-time> | null
canceledAt
string<date-time> | null
subjectName
string | null
Resumo do cadastro alvo, para evitar uma segunda chamada.
subjectDocument
string | null
items
object[]
Hide child attributes
items.id
string
items.collectionId
string
items.recipientId
string | null
items.order
integer
items.kind
enum<string>
Available options:
DOCUMENT,
IDENTITY,
CONSENT,
SIGNATURE,
FORM,
CUSTOM
items.documentType
enum<string> | null
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,
null
items.label
string
O que o destinatario le.
items.instructions
string | null
items.required
boolean
items.rules
object
Regras da coleta para este item (recencia, formatos, metodos de identidade).
items.status
enum<string>
Available options:
PENDING,
ALREADY_ON_FILE,
SUBMITTED,
PROCESSING,
VALIDATED,
REJECTED,
MANUAL_REVIEW,
AWAITING_OPERATOR,
WAIVED,
EXPIRED
items.registryDocumentId
string | null
O documento que este item gerou no cadastro.
items.attempt
integer | null
items.verdict
enum<string> | null
Available options:
VALIDO,
INVALIDO,
INCONCLUSIVO,
ANALISE_MANUAL,
null
items.score
number | null
items.rejectionReason
string | null
Motivo tecnico, para o operador.
items.submittedAt
string<date-time> | null
items.resendRequestedAt
string<date-time> | null
items.resendCount
integer
items.files
object[]
Um por arquivo enviado, com o parecer de cada um. Vazio no item que ainda nao recebeu nada.
Hide child attributes
items.files.id
string
items.files.order
integer
items.files.registryDocumentId
string | null
items.files.status
enum<string>
Available options:
PENDING,
ALREADY_ON_FILE,
SUBMITTED,
PROCESSING,
VALIDATED,
REJECTED,
MANUAL_REVIEW,
AWAITING_OPERATOR,
WAIVED,
EXPIRED
items.files.verdict
enum<string> | null
Available options:
VALIDO,
INVALIDO,
INCONCLUSIVO,
ANALISE_MANUAL,
null
items.files.score
number | null
items.files.attempt
integer | null
items.files.rejectionReason
string | null
items.files.fileName
string | null
items.files.mimeType
string | null
items.files.sizeBytes
integer | null
items.files.submittedAt
string<date-time> | null
items.files.resolvedAt
string<date-time> | null
items.consentType
enum<string> | null
Available options:
SCR,
null
items.consentTemplateId
string | null
items.consentTemplateVersion
integer | null
items.optinId
string | null
items.consentAcceptedAt
string<date-time> | null
items.formSpec
object | null
O formulario pedido.
items.formPrefill
object | null
O que a extracao sugeriu.
items.formAnswer
object | null
O que a pessoa respondeu.
items.identityProvider
string | null
items.identityStatus
string | null
items.identityEvaluation
object | null
A avaliacao da verificacao em portugues (veredito, similaridade, prova de vida, sinais de antifraude). O payload cru do provedor NAO vem aqui.
items.identityMediaCount
integer | null
Quantas imagens estao guardadas. Os enderecos saem por acao explicita, que fica na trilha.
items.identityStartedAt
string<date-time> | null
items.signedDocumentId
string | null
items.signatureMode
enum<string>
Available options:
INDIVIDUAL,
JOINT
items.signaturePackage
enum<string> | null
Available options:
SIGNATURE,
SIGNATURE_AND_IDENTITY,
null
items.signatureProgress
object | null
"2 de 4 assinaram", ja pronto.
Hide child attributes
items.signatureProgress.total
integer
items.signatureProgress.signed
integer
items.signatureProgress.missing
string[]
Nome das partes obrigatorias que faltam.
items.signatureProgress.awaitingIdentity
string[]
Assinaram o texto e esperam a verificacao de identidade.
items.signatureProgress.awaitingContact
string[]
Partes sem contato para receber o link.
items.signatureProgress.complete
boolean
true quando a via em PDF pode nascer.
items.signatureProgress.label
string
items.signatories
object[]
items.reviewDecision
enum<string> | null
Available options:
APPROVED,
RESEND_REQUESTED,
WAIVED,
null
items.reviewComment
string | null
items.reviewedAt
string<date-time> | null
items.reviewedByUserId
string | null
items.alreadyOnFileReason
string | null
Por que o item nasceu ALREADY_ON_FILE, em portugues.
items.resolvedAt
string<date-time> | null
items.signedDocumentAvailable
boolean
true quando ha via assinada para baixar em GET /v1/collections/{id}/items/{itemId}/signed-document.
items.identityEmailCandidateCount
integer
Quantos e-mails foram oferecidos para a verificacao por e-mail (nunca quais).
recipients
object[]
Hide child attributes
recipients.id
string
recipients.collectionId
string
recipients.name
string
recipients.document
string | null
recipients.email
string | null
recipients.phone
string | null
E.164.
recipients.role
string | null
recipients.registryPersonId
string | null
recipients.status
enum<string>
FAILED quer dizer que a MENSAGEM nao chegou. NO_ITEMS: nao sobrou item para essa pessoa.
Available options:
PENDING,
DELIVERED,
OPENED,
IN_PROGRESS,
COMPLETED,
FAILED,
NO_ITEMS
recipients.emailDelivery
enum<string>
Available options:
PENDING,
SENT,
DELIVERED,
FAILED
recipients.whatsappDelivery
enum<string>
Available options:
PENDING,
SENT,
DELIVERED,
FAILED
recipients.deliveryError
string | null
recipients.tokenExpiresAt
string<date-time> | null
recipients.lastSentAt
string<date-time> | null
recipients.openedAt
string<date-time> | null
recipients.completedAt
string<date-time> | null
recipients.remindersSent
integer
recipients.lastReminderAt
string<date-time> | null
recipients.revoked
boolean
recipients.link
string | null
So volta na criacao e na reemissao. O token cru nunca e persistido.
events
object[]
A trilha, append-only. O detalhe traz os 100 eventos mais recentes.
Hide child attributes
events.id
string
events.action
string
events.actorType
enum<string>
Available options:
USER,
API_USER,
RECIPIENT,
SYSTEM
events.itemId
string | null
events.recipientId
string | null
events.payload
object | null
events.createdAt
string<date-time>
registry
object | null
O cadastro alvo: id, document, name e entityType.
Hide child attributes
registry.id
string
registry.document
string
registry.name
string | null
registry.entityType
enum<string>
Available options:
COMPANY,
PERSON
itemsTotal
integer
itemsResolved
integer
itemsAwaitingOperator
integer
Itens esperando decisao humana (AWAITING_OPERATOR ou MANUAL_REVIEW).
progress
object
Contagem de itens (total, resolved, validated, awaitingOperator, rejected, pending) e de destinatarios (recipientsTotal, recipientsExpected, recipientsCompleted, recipientsWithoutItems).
Hide child attributes
progress.{key}
integer
createdAt
string<date-time>
updatedAt
string<date-time>
{"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/collection/get-collections-id","slug":"/api-reference/collection/get-collections-id","pageMetadata":{"title":"Consultar Solicitação","description":"Para acompanhar item a item e ver o estado de entrega de cada destinatário.","surface":"api","domain":"cadastro","audience":"integrador","lang":"tecnica","openapi":"get /v1/collections/{id}","href":"/api-reference/collection/get-collections-id"},"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 acompanhar item a item e ver o estado de entrega de cada destinatário.\"\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`,strong:`strong`,..._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 acompanhar item a item e ver o estado de entrega de cada destinatário.`}),`\n`,_jsx(Heading,{level:`3`,id:`o-estado-que-mais-importa`,children:`O estado que mais importa`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`recipients[].status`}),` em `,_jsx(_components.strong,{children:_jsx(_components.code,{children:`FAILED`})}),` quer dizer que a mensagem `,_jsx(_components.strong,{children:`não chegou`}),`. É o caso de ligar para o cliente, e é por isso que vale assinar `,_jsx(_components.code,{children:`collection.message.failed`}),`.`]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`items[].files[]`}),` traz o parecer de cada arquivo, quando o item aceita mais de um. Item com `,_jsx(_components.code,{children:`signedDocumentAvailable: true`}),` tem via assinada para `,_jsx(_components.a,{href:`/api-reference/onboarding/via-assinada`,children:`baixar`}),`.`]}),`\n`,_jsxs(_components.p,{children:[`O link de cada destinatário `,_jsx(_components.strong,{children:`não`}),` volta aqui: ele só existe na resposta de criação e na de `,_jsx(_components.a,{href:`/api-reference/collection/post-collections-id-send`,children:`envio`}),`.`]}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`Contexto e vocabulário em `,_jsx(_components.a,{href:`/onboarding/solicitacoes`,children:`Solicitações de coleta`}),`. 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":"Consultar Solicitação","description":"Para acompanhar item a item e ver o estado de entrega de cada destinatário.","surface":"api","domain":"cadastro","audience":"integrador","lang":"tecnica","openapi":"get /v1/collections/{id}","href":"/api-reference/collection/get-collections-id"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Quando usar","slug":"quando-usar","depth":3,"children":[]},{"title":"O estado que mais importa","slug":"o-estado-que-mais-importa","depth":3,"children":[]}],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"CollectionController_findOne","summary":"Detalhe de uma solicitacao","parameters":["e2bcb881-4a9f-45eb-a1f7-6bf5bc3f0718"],"responses":{"200":"a233d6b4-79e1-4f69-8666-8e0696c4da30","400":"65edf42e-dab4-4d7a-a99a-4d684e6b0985","401":"0050b8bb-d417-4f4f-8ca7-661536d128ab","403":"830ddb50-564a-4cca-ac35-cb86ea292df7","404":"2a2d30eb-b8c3-421f-a7c0-746957867a1a","500":"da65544c-d72d-4336-bce5-0d8fb64774e0"},"tags":["collections"],"security":["06efe164-d12c-46d1-9bd9-e56f2b12568f"],"description":"Para acompanhar item a item e ver o estado de entrega de cada destinatário.","x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET 'https://gyra-core.gyramais.com.br/v1/collections/6612a7f30000000000000001' \\\n --header 'Authorization: Bearer \u003ctoken>'\n"},{"lang":"JavaScript","label":"Node","source":"const resposta = await fetch(\"https://gyra-core.gyramais.com.br/v1/collections/6612a7f30000000000000001\", {\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/collections/6612a7f30000000000000001\",\n headers={\"Authorization\": f\"Bearer {token}\"},\n)\n\ndados = resposta.json()\n"}],"method":"get","type":"path","servers":["42171238-82dd-4b6d-8980-cce1cc8ba345"],"path":"/v1/collections/{id}","baseUrlOptions":["https://gyra-core.gyramais.com.br"],"title":"Detalhe de uma solicitacao","codeSamples":[{"label":"cURL","lang":"cURL","source":"curl --request GET 'https://gyra-core.gyramais.com.br/v1/collections/6612a7f30000000000000001' \\\n --header 'Authorization: Bearer \u003ctoken>'\n"},{"label":"Node","lang":"JavaScript","source":"const resposta = await fetch(\"https://gyra-core.gyramais.com.br/v1/collections/6612a7f30000000000000001\", {\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/collections/6612a7f30000000000000001\",\n headers={\"Authorization\": f\"Bearer {token}\"},\n)\n\ndados = resposta.json()\n"}],"requiredOnlyExamples":false,"requestExampleType":"codeSamples","responseExampleType":"generated"},"dependencies":{"parameters":{"e2bcb881-4a9f-45eb-a1f7-6bf5bc3f0718":{"name":"id","required":true,"in":"path","schema":{"type":"string","isRequired":true,"description":"Id da solicitacao.","uniqueKey":"","typeLabel":"string"},"description":"Id da solicitacao."}},"responses":{"a233d6b4-79e1-4f69-8666-8e0696c4da30":{"description":"Solicitacao com itens, destinatarios, links e trilha.","content":{"application/json":{"schema":{"type":"object","description":"Uma solicitacao de coleta com itens, destinatarios e trilha.","properties":{"id":{"type":"string","uniqueKey":"id","typeLabel":"string"},"registryId":{"type":"string","uniqueKey":"registryId","typeLabel":"string"},"templateId":{"oneOf":[{"type":"string","uniqueKey":"templateId.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"templateId.oneOf.1","typeLabel":"null"}],"uniqueKey":"templateId","typeLabel":"string | null"},"templateSlug":{"oneOf":[{"type":"string","uniqueKey":"templateSlug.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"templateSlug.oneOf.1","typeLabel":"null"}],"uniqueKey":"templateSlug","typeLabel":"string | null"},"templateName":{"oneOf":[{"type":"string","uniqueKey":"templateName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"templateName.oneOf.1","typeLabel":"null"}],"uniqueKey":"templateName","typeLabel":"string | null"},"templateVersion":{"oneOf":[{"type":"integer","uniqueKey":"templateVersion.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"templateVersion.oneOf.1","typeLabel":"null"}],"uniqueKey":"templateVersion","typeLabel":"integer | null"},"status":{"type":"string","enum":["DRAFT","SENT","IN_PROGRESS","COMPLETED","EXPIRED","CANCELED"],"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"responseMode":{"type":"string","enum":["AUTOMATIC","REVIEW"],"uniqueKey":"responseMode","typeLabel":"enum\u003cstring>"},"channel":{"type":"string","enum":["WHATSAPP","EMAIL","BOTH","NONE"],"description":"NONE: a plataforma nao avisou ninguem e quem entrega o link e voce.","uniqueKey":"channel","typeLabel":"enum\u003cstring>"},"reminders":{"type":"array","items":{"type":"integer","uniqueKey":"reminders.items.[INDEX]","typeLabel":"integer"},"description":"Dias apos o envio.","uniqueKey":"reminders","typeLabel":"integer[]"},"behavior":{"type":"object","additionalProperties":true,"description":"O comportamento herdado do modelo.","uniqueKey":"behavior","typeLabel":"object"},"message":{"oneOf":[{"type":"string","description":"Recado do operador ao destinatario.","uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","description":"Recado do operador ao destinatario.","uniqueKey":"message.oneOf.1","typeLabel":"null"}],"uniqueKey":"message","typeLabel":"string | null"},"dueAt":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"dueAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"dueAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"dueAt","typeLabel":"string\u003cdate-time> | null"},"sentAt":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"sentAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"sentAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"sentAt","typeLabel":"string\u003cdate-time> | null"},"completedAt":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"completedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"completedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"completedAt","typeLabel":"string\u003cdate-time> | null"},"canceledAt":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"canceledAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"canceledAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"canceledAt","typeLabel":"string\u003cdate-time> | null"},"subjectName":{"oneOf":[{"type":"string","description":"Resumo do cadastro alvo, para evitar uma segunda chamada.","uniqueKey":"subjectName.oneOf.0","typeLabel":"string"},{"type":"null","description":"Resumo do cadastro alvo, para evitar uma segunda chamada.","uniqueKey":"subjectName.oneOf.1","typeLabel":"null"}],"uniqueKey":"subjectName","typeLabel":"string | null"},"subjectDocument":{"oneOf":[{"type":"string","uniqueKey":"subjectDocument.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"subjectDocument.oneOf.1","typeLabel":"null"}],"uniqueKey":"subjectDocument","typeLabel":"string | null"},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","uniqueKey":"\\items.items.[INDEX].id","typeLabel":"string"},"collectionId":{"type":"string","uniqueKey":"\\items.items.[INDEX].collectionId","typeLabel":"string"},"recipientId":{"oneOf":[{"type":"string","uniqueKey":"\\items.items.[INDEX].recipientId.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"\\items.items.[INDEX].recipientId.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].recipientId","typeLabel":"string | null"},"order":{"type":"integer","uniqueKey":"\\items.items.[INDEX].order","typeLabel":"integer"},"kind":{"type":"string","enum":["DOCUMENT","IDENTITY","CONSENT","SIGNATURE","FORM","CUSTOM"],"uniqueKey":"\\items.items.[INDEX].kind","typeLabel":"enum\u003cstring>"},"documentType":{"oneOf":[{"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",null],"uniqueKey":"\\items.items.[INDEX].documentType.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","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",null],"uniqueKey":"\\items.items.[INDEX].documentType.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].documentType","typeLabel":"enum\u003cstring> | null"},"label":{"type":"string","description":"O que o destinatario le.","uniqueKey":"\\items.items.[INDEX].label","typeLabel":"string"},"instructions":{"oneOf":[{"type":"string","uniqueKey":"\\items.items.[INDEX].instructions.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"\\items.items.[INDEX].instructions.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].instructions","typeLabel":"string | null"},"required":{"type":"boolean","uniqueKey":"\\items.items.[INDEX].required","typeLabel":"boolean"},"rules":{"type":"object","additionalProperties":true,"description":"Regras da coleta para este item (recencia, formatos, metodos de identidade).","uniqueKey":"\\items.items.[INDEX].rules","typeLabel":"object"},"status":{"type":"string","enum":["PENDING","ALREADY_ON_FILE","SUBMITTED","PROCESSING","VALIDATED","REJECTED","MANUAL_REVIEW","AWAITING_OPERATOR","WAIVED","EXPIRED"],"uniqueKey":"\\items.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"registryDocumentId":{"oneOf":[{"type":"string","description":"O documento que este item gerou no cadastro.","uniqueKey":"\\items.items.[INDEX].registryDocumentId.oneOf.0","typeLabel":"string"},{"type":"null","description":"O documento que este item gerou no cadastro.","uniqueKey":"\\items.items.[INDEX].registryDocumentId.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].registryDocumentId","typeLabel":"string | null"},"attempt":{"oneOf":[{"type":"integer","uniqueKey":"\\items.items.[INDEX].attempt.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"\\items.items.[INDEX].attempt.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].attempt","typeLabel":"integer | null"},"verdict":{"oneOf":[{"type":"string","enum":["VALIDO","INVALIDO","INCONCLUSIVO","ANALISE_MANUAL",null],"uniqueKey":"\\items.items.[INDEX].verdict.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["VALIDO","INVALIDO","INCONCLUSIVO","ANALISE_MANUAL",null],"uniqueKey":"\\items.items.[INDEX].verdict.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].verdict","typeLabel":"enum\u003cstring> | null"},"score":{"oneOf":[{"type":"number","uniqueKey":"\\items.items.[INDEX].score.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"\\items.items.[INDEX].score.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].score","typeLabel":"number | null"},"rejectionReason":{"oneOf":[{"type":"string","description":"Motivo tecnico, para o operador.","uniqueKey":"\\items.items.[INDEX].rejectionReason.oneOf.0","typeLabel":"string"},{"type":"null","description":"Motivo tecnico, para o operador.","uniqueKey":"\\items.items.[INDEX].rejectionReason.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].rejectionReason","typeLabel":"string | null"},"submittedAt":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"\\items.items.[INDEX].submittedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"\\items.items.[INDEX].submittedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].submittedAt","typeLabel":"string\u003cdate-time> | null"},"resendRequestedAt":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"\\items.items.[INDEX].resendRequestedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"\\items.items.[INDEX].resendRequestedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].resendRequestedAt","typeLabel":"string\u003cdate-time> | null"},"resendCount":{"type":"integer","uniqueKey":"\\items.items.[INDEX].resendCount","typeLabel":"integer"},"files":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","uniqueKey":"\\items.items.[INDEX].files.items.[INDEX].id","typeLabel":"string"},"order":{"type":"integer","uniqueKey":"\\items.items.[INDEX].files.items.[INDEX].order","typeLabel":"integer"},"registryDocumentId":{"oneOf":[{"type":"string","uniqueKey":"\\items.items.[INDEX].files.items.[INDEX].registryDocumentId.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"\\items.items.[INDEX].files.items.[INDEX].registryDocumentId.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].files.items.[INDEX].registryDocumentId","typeLabel":"string | null"},"status":{"type":"string","enum":["PENDING","ALREADY_ON_FILE","SUBMITTED","PROCESSING","VALIDATED","REJECTED","MANUAL_REVIEW","AWAITING_OPERATOR","WAIVED","EXPIRED"],"uniqueKey":"\\items.items.[INDEX].files.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"verdict":{"oneOf":[{"type":"string","enum":["VALIDO","INVALIDO","INCONCLUSIVO","ANALISE_MANUAL",null],"uniqueKey":"\\items.items.[INDEX].files.items.[INDEX].verdict.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["VALIDO","INVALIDO","INCONCLUSIVO","ANALISE_MANUAL",null],"uniqueKey":"\\items.items.[INDEX].files.items.[INDEX].verdict.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].files.items.[INDEX].verdict","typeLabel":"enum\u003cstring> | null"},"score":{"oneOf":[{"type":"number","uniqueKey":"\\items.items.[INDEX].files.items.[INDEX].score.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"\\items.items.[INDEX].files.items.[INDEX].score.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].files.items.[INDEX].score","typeLabel":"number | null"},"attempt":{"oneOf":[{"type":"integer","uniqueKey":"\\items.items.[INDEX].files.items.[INDEX].attempt.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"\\items.items.[INDEX].files.items.[INDEX].attempt.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].files.items.[INDEX].attempt","typeLabel":"integer | null"},"rejectionReason":{"oneOf":[{"type":"string","uniqueKey":"\\items.items.[INDEX].files.items.[INDEX].rejectionReason.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"\\items.items.[INDEX].files.items.[INDEX].rejectionReason.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].files.items.[INDEX].rejectionReason","typeLabel":"string | null"},"fileName":{"oneOf":[{"type":"string","uniqueKey":"\\items.items.[INDEX].files.items.[INDEX].fileName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"\\items.items.[INDEX].files.items.[INDEX].fileName.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].files.items.[INDEX].fileName","typeLabel":"string | null"},"mimeType":{"oneOf":[{"type":"string","uniqueKey":"\\items.items.[INDEX].files.items.[INDEX].mimeType.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"\\items.items.[INDEX].files.items.[INDEX].mimeType.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].files.items.[INDEX].mimeType","typeLabel":"string | null"},"sizeBytes":{"oneOf":[{"type":"integer","uniqueKey":"\\items.items.[INDEX].files.items.[INDEX].sizeBytes.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"\\items.items.[INDEX].files.items.[INDEX].sizeBytes.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].files.items.[INDEX].sizeBytes","typeLabel":"integer | null"},"submittedAt":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"\\items.items.[INDEX].files.items.[INDEX].submittedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"\\items.items.[INDEX].files.items.[INDEX].submittedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].files.items.[INDEX].submittedAt","typeLabel":"string\u003cdate-time> | null"},"resolvedAt":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"\\items.items.[INDEX].files.items.[INDEX].resolvedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"\\items.items.[INDEX].files.items.[INDEX].resolvedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].files.items.[INDEX].resolvedAt","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"\\items.items.[INDEX].files.items.[INDEX]","typeLabel":"object"},"description":"Um por arquivo enviado, com o parecer de cada um. Vazio no item que ainda nao recebeu nada.","uniqueKey":"\\items.items.[INDEX].files","typeLabel":"object[]"},"consentType":{"oneOf":[{"type":"string","enum":["SCR",null],"uniqueKey":"\\items.items.[INDEX].consentType.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["SCR",null],"uniqueKey":"\\items.items.[INDEX].consentType.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].consentType","typeLabel":"enum\u003cstring> | null"},"consentTemplateId":{"oneOf":[{"type":"string","uniqueKey":"\\items.items.[INDEX].consentTemplateId.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"\\items.items.[INDEX].consentTemplateId.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].consentTemplateId","typeLabel":"string | null"},"consentTemplateVersion":{"oneOf":[{"type":"integer","uniqueKey":"\\items.items.[INDEX].consentTemplateVersion.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"\\items.items.[INDEX].consentTemplateVersion.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].consentTemplateVersion","typeLabel":"integer | null"},"optinId":{"oneOf":[{"type":"string","uniqueKey":"\\items.items.[INDEX].optinId.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"\\items.items.[INDEX].optinId.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].optinId","typeLabel":"string | null"},"consentAcceptedAt":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"\\items.items.[INDEX].consentAcceptedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"\\items.items.[INDEX].consentAcceptedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].consentAcceptedAt","typeLabel":"string\u003cdate-time> | null"},"formSpec":{"oneOf":[{"type":"object","additionalProperties":true,"description":"O formulario pedido.","uniqueKey":"\\items.items.[INDEX].formSpec.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":true,"description":"O formulario pedido.","uniqueKey":"\\items.items.[INDEX].formSpec.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].formSpec","typeLabel":"object | null"},"formPrefill":{"oneOf":[{"type":"object","additionalProperties":true,"description":"O que a extracao sugeriu.","uniqueKey":"\\items.items.[INDEX].formPrefill.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":true,"description":"O que a extracao sugeriu.","uniqueKey":"\\items.items.[INDEX].formPrefill.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].formPrefill","typeLabel":"object | null"},"formAnswer":{"oneOf":[{"type":"object","additionalProperties":true,"description":"O que a pessoa respondeu.","uniqueKey":"\\items.items.[INDEX].formAnswer.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":true,"description":"O que a pessoa respondeu.","uniqueKey":"\\items.items.[INDEX].formAnswer.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].formAnswer","typeLabel":"object | null"},"identityProvider":{"oneOf":[{"type":"string","uniqueKey":"\\items.items.[INDEX].identityProvider.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"\\items.items.[INDEX].identityProvider.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].identityProvider","typeLabel":"string | null"},"identityStatus":{"oneOf":[{"type":"string","uniqueKey":"\\items.items.[INDEX].identityStatus.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"\\items.items.[INDEX].identityStatus.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].identityStatus","typeLabel":"string | null"},"identityEvaluation":{"oneOf":[{"type":"object","additionalProperties":true,"description":"A avaliacao da verificacao em portugues (veredito, similaridade, prova de vida, sinais de antifraude). O payload cru do provedor NAO vem aqui.","uniqueKey":"\\items.items.[INDEX].identityEvaluation.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":true,"description":"A avaliacao da verificacao em portugues (veredito, similaridade, prova de vida, sinais de antifraude). O payload cru do provedor NAO vem aqui.","uniqueKey":"\\items.items.[INDEX].identityEvaluation.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].identityEvaluation","typeLabel":"object | null"},"identityMediaCount":{"oneOf":[{"type":"integer","description":"Quantas imagens estao guardadas. Os enderecos saem por acao explicita, que fica na trilha.","uniqueKey":"\\items.items.[INDEX].identityMediaCount.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Quantas imagens estao guardadas. Os enderecos saem por acao explicita, que fica na trilha.","uniqueKey":"\\items.items.[INDEX].identityMediaCount.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].identityMediaCount","typeLabel":"integer | null"},"identityStartedAt":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"\\items.items.[INDEX].identityStartedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"\\items.items.[INDEX].identityStartedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].identityStartedAt","typeLabel":"string\u003cdate-time> | null"},"signedDocumentId":{"oneOf":[{"type":"string","uniqueKey":"\\items.items.[INDEX].signedDocumentId.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"\\items.items.[INDEX].signedDocumentId.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].signedDocumentId","typeLabel":"string | null"},"signatureMode":{"type":"string","enum":["INDIVIDUAL","JOINT"],"uniqueKey":"\\items.items.[INDEX].signatureMode","typeLabel":"enum\u003cstring>"},"signaturePackage":{"oneOf":[{"type":"string","enum":["SIGNATURE","SIGNATURE_AND_IDENTITY",null],"uniqueKey":"\\items.items.[INDEX].signaturePackage.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["SIGNATURE","SIGNATURE_AND_IDENTITY",null],"uniqueKey":"\\items.items.[INDEX].signaturePackage.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].signaturePackage","typeLabel":"enum\u003cstring> | null"},"signatureProgress":{"oneOf":[{"type":"object","description":"\"2 de 4 assinaram\", ja pronto.","properties":{"total":{"type":"integer","uniqueKey":"\\items.items.[INDEX].signatureProgress.oneOf.0.total","typeLabel":"integer"},"signed":{"type":"integer","uniqueKey":"\\items.items.[INDEX].signatureProgress.oneOf.0.signed","typeLabel":"integer"},"missing":{"type":"array","items":{"type":"string","uniqueKey":"\\items.items.[INDEX].signatureProgress.oneOf.0.missing.items.[INDEX]","typeLabel":"string"},"description":"Nome das partes obrigatorias que faltam.","uniqueKey":"\\items.items.[INDEX].signatureProgress.oneOf.0.missing","typeLabel":"string[]"},"awaitingIdentity":{"type":"array","items":{"type":"string","uniqueKey":"\\items.items.[INDEX].signatureProgress.oneOf.0.awaitingIdentity.items.[INDEX]","typeLabel":"string"},"description":"Assinaram o texto e esperam a verificacao de identidade.","uniqueKey":"\\items.items.[INDEX].signatureProgress.oneOf.0.awaitingIdentity","typeLabel":"string[]"},"awaitingContact":{"type":"array","items":{"type":"string","uniqueKey":"\\items.items.[INDEX].signatureProgress.oneOf.0.awaitingContact.items.[INDEX]","typeLabel":"string"},"description":"Partes sem contato para receber o link.","uniqueKey":"\\items.items.[INDEX].signatureProgress.oneOf.0.awaitingContact","typeLabel":"string[]"},"complete":{"type":"boolean","description":"true quando a via em PDF pode nascer.","uniqueKey":"\\items.items.[INDEX].signatureProgress.oneOf.0.complete","typeLabel":"boolean"},"label":{"type":"string","uniqueKey":"\\items.items.[INDEX].signatureProgress.oneOf.0.label","typeLabel":"string"}},"uniqueKey":"\\items.items.[INDEX].signatureProgress.oneOf.0","typeLabel":"object"},{"type":"null","description":"\"2 de 4 assinaram\", ja pronto.","properties":{"total":{"type":"integer"},"signed":{"type":"integer"},"missing":{"type":"array","items":{"type":"string"},"description":"Nome das partes obrigatorias que faltam."},"awaitingIdentity":{"type":"array","items":{"type":"string"},"description":"Assinaram o texto e esperam a verificacao de identidade."},"awaitingContact":{"type":"array","items":{"type":"string"},"description":"Partes sem contato para receber o link."},"complete":{"type":"boolean","description":"true quando a via em PDF pode nascer."},"label":{"type":"string"}},"uniqueKey":"\\items.items.[INDEX].signatureProgress.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].signatureProgress","typeLabel":"object | null"},"signatories":{"type":"array","items":{"type":"object","additionalProperties":true,"description":"Uma parte do documento conjunto. O documento vem mascarado.","uniqueKey":"\\items.items.[INDEX].signatories.items.[INDEX]","typeLabel":"object"},"uniqueKey":"\\items.items.[INDEX].signatories","typeLabel":"object[]"},"reviewDecision":{"oneOf":[{"type":"string","enum":["APPROVED","RESEND_REQUESTED","WAIVED",null],"uniqueKey":"\\items.items.[INDEX].reviewDecision.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["APPROVED","RESEND_REQUESTED","WAIVED",null],"uniqueKey":"\\items.items.[INDEX].reviewDecision.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].reviewDecision","typeLabel":"enum\u003cstring> | null"},"reviewComment":{"oneOf":[{"type":"string","uniqueKey":"\\items.items.[INDEX].reviewComment.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"\\items.items.[INDEX].reviewComment.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].reviewComment","typeLabel":"string | null"},"reviewedAt":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"\\items.items.[INDEX].reviewedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"\\items.items.[INDEX].reviewedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].reviewedAt","typeLabel":"string\u003cdate-time> | null"},"reviewedByUserId":{"oneOf":[{"type":"string","uniqueKey":"\\items.items.[INDEX].reviewedByUserId.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"\\items.items.[INDEX].reviewedByUserId.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].reviewedByUserId","typeLabel":"string | null"},"alreadyOnFileReason":{"oneOf":[{"type":"string","description":"Por que o item nasceu ALREADY_ON_FILE, em portugues.","uniqueKey":"\\items.items.[INDEX].alreadyOnFileReason.oneOf.0","typeLabel":"string"},{"type":"null","description":"Por que o item nasceu ALREADY_ON_FILE, em portugues.","uniqueKey":"\\items.items.[INDEX].alreadyOnFileReason.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].alreadyOnFileReason","typeLabel":"string | null"},"resolvedAt":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"\\items.items.[INDEX].resolvedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"\\items.items.[INDEX].resolvedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].resolvedAt","typeLabel":"string\u003cdate-time> | null"},"signedDocumentAvailable":{"type":"boolean","description":"true quando ha via assinada para baixar em GET /v1/collections/{id}/items/{itemId}/signed-document.","uniqueKey":"\\items.items.[INDEX].signedDocumentAvailable","typeLabel":"boolean"},"identityEmailCandidateCount":{"type":"integer","description":"Quantos e-mails foram oferecidos para a verificacao por e-mail (nunca quais).","uniqueKey":"\\items.items.[INDEX].identityEmailCandidateCount","typeLabel":"integer"}},"uniqueKey":"\\items.items.[INDEX]","typeLabel":"object"},"uniqueKey":"\\items","typeLabel":"object[]"},"recipients":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","uniqueKey":"recipients.items.[INDEX].id","typeLabel":"string"},"collectionId":{"type":"string","uniqueKey":"recipients.items.[INDEX].collectionId","typeLabel":"string"},"name":{"type":"string","uniqueKey":"recipients.items.[INDEX].name","typeLabel":"string"},"document":{"oneOf":[{"type":"string","uniqueKey":"recipients.items.[INDEX].document.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"recipients.items.[INDEX].document.oneOf.1","typeLabel":"null"}],"uniqueKey":"recipients.items.[INDEX].document","typeLabel":"string | null"},"email":{"oneOf":[{"type":"string","uniqueKey":"recipients.items.[INDEX].email.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"recipients.items.[INDEX].email.oneOf.1","typeLabel":"null"}],"uniqueKey":"recipients.items.[INDEX].email","typeLabel":"string | null"},"phone":{"oneOf":[{"type":"string","description":"E.164.","uniqueKey":"recipients.items.[INDEX].phone.oneOf.0","typeLabel":"string"},{"type":"null","description":"E.164.","uniqueKey":"recipients.items.[INDEX].phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"recipients.items.[INDEX].phone","typeLabel":"string | null"},"role":{"oneOf":[{"type":"string","uniqueKey":"recipients.items.[INDEX].role.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"recipients.items.[INDEX].role.oneOf.1","typeLabel":"null"}],"uniqueKey":"recipients.items.[INDEX].role","typeLabel":"string | null"},"registryPersonId":{"oneOf":[{"type":"string","uniqueKey":"recipients.items.[INDEX].registryPersonId.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"recipients.items.[INDEX].registryPersonId.oneOf.1","typeLabel":"null"}],"uniqueKey":"recipients.items.[INDEX].registryPersonId","typeLabel":"string | null"},"status":{"type":"string","enum":["PENDING","DELIVERED","OPENED","IN_PROGRESS","COMPLETED","FAILED","NO_ITEMS"],"description":"FAILED quer dizer que a MENSAGEM nao chegou. NO_ITEMS: nao sobrou item para essa pessoa.","uniqueKey":"recipients.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"emailDelivery":{"type":"string","enum":["PENDING","SENT","DELIVERED","FAILED"],"uniqueKey":"recipients.items.[INDEX].emailDelivery","typeLabel":"enum\u003cstring>"},"whatsappDelivery":{"type":"string","enum":["PENDING","SENT","DELIVERED","FAILED"],"uniqueKey":"recipients.items.[INDEX].whatsappDelivery","typeLabel":"enum\u003cstring>"},"deliveryError":{"oneOf":[{"type":"string","uniqueKey":"recipients.items.[INDEX].deliveryError.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"recipients.items.[INDEX].deliveryError.oneOf.1","typeLabel":"null"}],"uniqueKey":"recipients.items.[INDEX].deliveryError","typeLabel":"string | null"},"tokenExpiresAt":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"recipients.items.[INDEX].tokenExpiresAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"recipients.items.[INDEX].tokenExpiresAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"recipients.items.[INDEX].tokenExpiresAt","typeLabel":"string\u003cdate-time> | null"},"lastSentAt":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"recipients.items.[INDEX].lastSentAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"recipients.items.[INDEX].lastSentAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"recipients.items.[INDEX].lastSentAt","typeLabel":"string\u003cdate-time> | null"},"openedAt":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"recipients.items.[INDEX].openedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"recipients.items.[INDEX].openedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"recipients.items.[INDEX].openedAt","typeLabel":"string\u003cdate-time> | null"},"completedAt":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"recipients.items.[INDEX].completedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"recipients.items.[INDEX].completedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"recipients.items.[INDEX].completedAt","typeLabel":"string\u003cdate-time> | null"},"remindersSent":{"type":"integer","uniqueKey":"recipients.items.[INDEX].remindersSent","typeLabel":"integer"},"lastReminderAt":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"recipients.items.[INDEX].lastReminderAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"recipients.items.[INDEX].lastReminderAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"recipients.items.[INDEX].lastReminderAt","typeLabel":"string\u003cdate-time> | null"},"revoked":{"type":"boolean","uniqueKey":"recipients.items.[INDEX].revoked","typeLabel":"boolean"},"link":{"oneOf":[{"type":"string","description":"So volta na criacao e na reemissao. O token cru nunca e persistido.","uniqueKey":"recipients.items.[INDEX].link.oneOf.0","typeLabel":"string"},{"type":"null","description":"So volta na criacao e na reemissao. O token cru nunca e persistido.","uniqueKey":"recipients.items.[INDEX].link.oneOf.1","typeLabel":"null"}],"uniqueKey":"recipients.items.[INDEX].link","typeLabel":"string | null"}},"uniqueKey":"recipients.items.[INDEX]","typeLabel":"object"},"uniqueKey":"recipients","typeLabel":"object[]"},"events":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","uniqueKey":"events.items.[INDEX].id","typeLabel":"string"},"action":{"type":"string","uniqueKey":"events.items.[INDEX].action","typeLabel":"string"},"actorType":{"type":"string","enum":["USER","API_USER","RECIPIENT","SYSTEM"],"uniqueKey":"events.items.[INDEX].actorType","typeLabel":"enum\u003cstring>"},"itemId":{"oneOf":[{"type":"string","uniqueKey":"events.items.[INDEX].itemId.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"events.items.[INDEX].itemId.oneOf.1","typeLabel":"null"}],"uniqueKey":"events.items.[INDEX].itemId","typeLabel":"string | null"},"recipientId":{"oneOf":[{"type":"string","uniqueKey":"events.items.[INDEX].recipientId.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"events.items.[INDEX].recipientId.oneOf.1","typeLabel":"null"}],"uniqueKey":"events.items.[INDEX].recipientId","typeLabel":"string | null"},"payload":{"oneOf":[{"type":"object","additionalProperties":true,"uniqueKey":"events.items.[INDEX].payload.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":true,"uniqueKey":"events.items.[INDEX].payload.oneOf.1","typeLabel":"null"}],"uniqueKey":"events.items.[INDEX].payload","typeLabel":"object | null"},"createdAt":{"type":"string","format":"date-time","uniqueKey":"events.items.[INDEX].createdAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"events.items.[INDEX]","typeLabel":"object"},"description":"A trilha, append-only. O detalhe traz os 100 eventos mais recentes.","uniqueKey":"events","typeLabel":"object[]"},"registry":{"oneOf":[{"type":"object","description":"O cadastro alvo: id, document, name e entityType.","properties":{"id":{"type":"string","uniqueKey":"registry.oneOf.0.id","typeLabel":"string"},"document":{"type":"string","uniqueKey":"registry.oneOf.0.document","typeLabel":"string"},"name":{"oneOf":[{"type":"string","uniqueKey":"registry.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"registry.oneOf.0.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"registry.oneOf.0.name","typeLabel":"string | null"},"entityType":{"type":"string","enum":["COMPANY","PERSON"],"uniqueKey":"registry.oneOf.0.entityType","typeLabel":"enum\u003cstring>"}},"uniqueKey":"registry.oneOf.0","typeLabel":"object"},{"type":"null","description":"O cadastro alvo: id, document, name e entityType.","properties":{"id":{"type":"string"},"document":{"type":"string"},"name":{"oneOf":[{"type":"string"},{"type":"null"}]},"entityType":{"type":"string","enum":["COMPANY","PERSON"]}},"uniqueKey":"registry.oneOf.1","typeLabel":"null"}],"uniqueKey":"registry","typeLabel":"object | null"},"itemsTotal":{"type":"integer","uniqueKey":"itemsTotal","typeLabel":"integer"},"itemsResolved":{"type":"integer","uniqueKey":"itemsResolved","typeLabel":"integer"},"itemsAwaitingOperator":{"type":"integer","description":"Itens esperando decisao humana (AWAITING_OPERATOR ou MANUAL_REVIEW).","uniqueKey":"itemsAwaitingOperator","typeLabel":"integer"},"progress":{"type":"object","additionalProperties":{"type":"integer","uniqueKey":"progress.additionalProperties","typeLabel":"integer"},"description":"Contagem de itens (total, resolved, validated, awaitingOperator, rejected, pending) e de destinatarios (recipientsTotal, recipientsExpected, recipientsCompleted, recipientsWithoutItems).","uniqueKey":"progress","typeLabel":"object"},"createdAt":{"type":"string","format":"date-time","uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","uniqueKey":"updatedAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"","typeLabel":"object"},"example":{"id":"6612a7f30000000000000051","registryId":"6612a7f30000000000000001","templateId":"6612a7f30000000000000041","templateSlug":"onboarding-pj","templateName":"Onboarding PJ","templateVersion":3,"status":"SENT","responseMode":"REVIEW","channel":"BOTH","reminders":[2,5],"behavior":{"acceptPartial":false,"requestResendOnReject":true,"notifyOnComplete":true,"skipItemsAlreadyOnFile":true},"message":"Precisamos destes documentos para liberar seu limite.","dueAt":"2026-09-15T23:59:59.000Z","sentAt":"2026-09-05T14:20:00.000Z","completedAt":null,"canceledAt":null,"subjectName":"AURORA COMPONENTES INDUSTRIAIS LTDA","subjectDocument":"11444777000161","items":[{"id":"6612a7f30000000000000071","collectionId":"6612a7f30000000000000051","recipientId":"6612a7f30000000000000061","order":1,"kind":"DOCUMENT","documentType":"CONTRATO_SOCIAL","label":"Contrato social consolidado","instructions":"Envie a última alteração consolidada, com a chancela da Junta.","required":true,"rules":{"maxAgeDays":365,"allowMultipleFiles":true,"maxFiles":5},"status":"PENDING","registryDocumentId":null,"attempt":null,"verdict":null,"score":null,"rejectionReason":null,"submittedAt":null,"resendCount":0,"files":[],"signatureMode":"INDIVIDUAL","signaturePackage":null,"resolvedAt":null}],"recipients":[{"id":"6612a7f30000000000000061","collectionId":"6612a7f30000000000000051","name":"Ana Souza","document":"52998224725","email":"ana@exemplo.com.br","phone":5551999998888,"role":"Sócia administradora · 60%","registryPersonId":"6612a7f30000000000000021","status":"DELIVERED","emailDelivery":"DELIVERED","whatsappDelivery":"SENT","deliveryError":null,"tokenExpiresAt":"2026-09-15T23:59:59.000Z","lastSentAt":"2026-09-05T14:20:03.000Z","openedAt":null,"completedAt":null,"remindersSent":0,"lastReminderAt":null,"revoked":false}],"createdAt":"2026-09-05T14:19:58.000Z","updatedAt":"2026-09-05T14:20:03.000Z"},"examples":{"Example":{"title":"Example","value":{"id":"6612a7f30000000000000051","registryId":"6612a7f30000000000000001","templateId":"6612a7f30000000000000041","templateSlug":"onboarding-pj","templateName":"Onboarding PJ","templateVersion":3,"status":"SENT","responseMode":"REVIEW","channel":"BOTH","reminders":[2,5],"behavior":{"acceptPartial":false,"requestResendOnReject":true,"notifyOnComplete":true,"skipItemsAlreadyOnFile":true},"message":"Precisamos destes documentos para liberar seu limite.","dueAt":"2026-09-15T23:59:59.000Z","sentAt":"2026-09-05T14:20:00.000Z","completedAt":null,"canceledAt":null,"subjectName":"AURORA COMPONENTES INDUSTRIAIS LTDA","subjectDocument":"11444777000161","items":[{"id":"6612a7f30000000000000071","collectionId":"6612a7f30000000000000051","recipientId":"6612a7f30000000000000061","order":1,"kind":"DOCUMENT","documentType":"CONTRATO_SOCIAL","label":"Contrato social consolidado","instructions":"Envie a última alteração consolidada, com a chancela da Junta.","required":true,"rules":{"maxAgeDays":365,"allowMultipleFiles":true,"maxFiles":5},"status":"PENDING","registryDocumentId":null,"attempt":null,"verdict":null,"score":null,"rejectionReason":null,"submittedAt":null,"resendCount":0,"files":[],"signatureMode":"INDIVIDUAL","signaturePackage":null,"resolvedAt":null}],"recipients":[{"id":"6612a7f30000000000000061","collectionId":"6612a7f30000000000000051","name":"Ana Souza","document":"52998224725","email":"ana@exemplo.com.br","phone":5551999998888,"role":"Sócia administradora · 60%","registryPersonId":"6612a7f30000000000000021","status":"DELIVERED","emailDelivery":"DELIVERED","whatsappDelivery":"SENT","deliveryError":null,"tokenExpiresAt":"2026-09-15T23:59:59.000Z","lastSentAt":"2026-09-05T14:20:03.000Z","openedAt":null,"completedAt":null,"remindersSent":0,"lastReminderAt":null,"revoked":false}],"createdAt":"2026-09-05T14:19:58.000Z","updatedAt":"2026-09-05T14:20:03.000Z"}}},"exampleType":"examples"}},"exampleType":"examples"},"65edf42e-dab4-4d7a-a99a-4d684e6b0985":{"description":"Corpo ou parametro invalido. A mensagem aponta o campo, e 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":"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"},"0050b8bb-d417-4f4f-8ca7-661536d128ab":{"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"},"830ddb50-564a-4cca-ac35-cb86ea292df7":{"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"},"2a2d30eb-b8c3-421f-a7c0-746957867a1a":{"description":"Solicitacao inexistente na organizacao, ou modulo nao liberado (\"Recurso não encontrado.\").","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":"Solicitação não encontrada."},"examples":{"Example":{"title":"Example","value":{"code":404,"message":"Solicitação não encontrada."}}},"exampleType":"examples"}},"exampleType":"examples"},"da65544c-d72d-4336-bce5-0d8fb64774e0":{"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":{"06efe164-d12c-46d1-9bd9-e56f2b12568f":{"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":"Consultar Solicitação - GYRA+ Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-05T18:52:05.496Z","originalFileLocation":"api-reference/collection/get-collections-id.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 acompanhar item a item e ver o estado de entrega de cada destinatário.\">\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=\"Consultar Solicitação - GYRA+ Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Para acompanhar item a item e ver o estado de entrega de cada destinatário.\">\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/collection/get-collections-id\">\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=Solicita%C3%A7%C3%A3o\u0026amp;title=Consultar+Solicita%C3%A7%C3%A3o\u0026amp;description=Para+acompanhar+item+a+item+e+ver+o+estado+de+entrega+de+cada+destinat%C3%A1rio.\u0026amp;theme=ea306aa6b40007f2fbe241ee\u0026amp;signature=fa70ddd7b25608591ab2530eb81625a726fd562fabd22419ad20a8ca1775f276\">\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=\"Consultar Solicitação - GYRA+ Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Para acompanhar item a item e ver o estado de entrega de cada destinatário.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://gyra.mintlify.site/_mintlify/api/og/v2?division=Solicita%C3%A7%C3%A3o\u0026amp;title=Consultar+Solicita%C3%A7%C3%A3o\u0026amp;description=Para+acompanhar+item+a+item+e+ver+o+estado+de+entrega+de+cada+destinat%C3%A1rio.\u0026amp;theme=ea306aa6b40007f2fbe241ee\u0026amp;signature=fa70ddd7b25608591ab2530eb81625a726fd562fabd22419ad20a8ca1775f276\">\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/collection/get-collections-id\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/collection/get-collections-id.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/collection/get-collections-id#webpage\",\"url\":\"https://developers.gyramais.com.br/api-reference/collection/get-collections-id\",\"name\":\"Consultar Solicitação\",\"description\":\"Para acompanhar item a item e ver o estado de entrega de cada destinatário.\",\"dateModified\":\"2026-10-05T18:52:05.496Z\",\"isPartOf\":{\"@id\":\"https://developers.gyramais.com.br#website\"},\"breadcrumb\":{\"@id\":\"https://developers.gyramais.com.br/api-reference/collection/get-collections-id#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers.gyramais.com.br/api-reference/collection/get-collections-id#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\":\"Solicitação\",\"item\":\"https://developers.gyramais.com.br/api-reference/collection/get-collection-templates\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Consultar Solicitação\",\"item\":\"https://developers.gyramais.com.br/api-reference/collection/get-collections-id\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developers.gyramais.com.br/api-reference/collection/get-collections-id#apireference\",\"headline\":\"Consultar Solicitação\",\"name\":\"Consultar Solicitação\",\"description\":\"Para acompanhar item a item e ver o estado de entrega de cada destinatário.\",\"url\":\"https://developers.gyramais.com.br/api-reference/collection/get-collections-id\",\"mainEntityOfPage\":{\"@id\":\"https://developers.gyramais.com.br/api-reference/collection/get-collections-id#webpage\"},\"dateModified\":\"2026-10-05T18:52:05.496Z\",\"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/collection/get-collections-id.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","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","description":"Para responder quem está devendo documento?: filtre por `SENT` e `IN_PROGRESS` e olhe o prazo.","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","description":"Primeiro envio de um rascunho, ou reenvio de um pedido que o cliente não respondeu.","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":"Consultar Solicitação - 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"]}