Por meio deste endpoint o sistema transmite uma chamada na URL definida pelo parceiro e em seguida obtém um retorno onde constará o documento a ser anexado na API de Pessoa.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"BMP","colors":{"primary":"#1A1883","light":"#4A48A8","dark":"#1A1883"},"logo":{"light":"https://raw.githubusercontent.com/docs-petry/imagens/refs/heads/main/bmp-docs/light.png","dark":"https://raw.githubusercontent.com/docs-petry/imagens/refs/heads/main/bmp-docs/dark.png"},"favicon":{"light":"https://raw.githubusercontent.com/docs-petry/imagens/refs/heads/main/bmp-docs/favicon.png","dark":"https://raw.githubusercontent.com/docs-petry/imagens/refs/heads/main/bmp-docs/favicon.png"},"api":{"playground":{"display":"none"}},"appearance":{"default":"light","strict":false},"navbar":{"primary":{"type":"button","label":"Suporte","href":"https://bmp.heflo.com/"}},"search":{"prompt":" "},"styling":{"latex":false},"navigation":{"languages":[{"language":"pt-BR","href":"homepage/quem-somos"},{"language":"en","href":"homepage/english-homepage/about-us"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"bmpmoneyplus-sandbox","hasAudioNarration":false,"actualSubdomain":"bmpmoneyplus-sandbox","customDomains":[],"gitSource":{"type":"github","owner":"bmp-docs","repo":"documentation-sandbox","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae23450ca08729418cc032e","collectionId":"9a850dcc-39a8-415c-8df9-0277ddeba2e4","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae23450ca08729418cc032e"},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae23450ca08729418cc032e","clientVersion":"0.0.4054","searchFilterCounts":[{"language":"pt-BR","tag":"Documentação","count":316},{"language":"en","tag":"Documentation","count":196},{"language":"pt-BR","tag":"Referências de API","count":167},{"language":"pt-BR","tag":"BaaS","count":108},{"language":"en","tag":"BaaS","count":88},{"language":"en","tag":"API References","count":82},{"language":"pt-BR","tag":"CaaS","count":61},{"language":"en","tag":"APIs Reference","count":55},{"language":"en","tag":"CaaS","count":54},{"language":"pt-BR","tag":"Bureaus","count":51},{"language":"pt-BR","tag":"Referencias de API","count":44},{"language":"pt-BR","tag":"Guia do Desenvolvedor","count":43},{"language":"pt-BR","tag":"PIX","count":40},{"language":"pt-BR","tag":"Guia de Integração Via API","count":32},{"language":"pt-BR","tag":"E-Consignado","count":30},{"language":"en","tag":"FGTS","count":26},{"language":"en","tag":"Pix","count":24},{"language":"en","tag":"Onboarding","count":21},{"language":"en","tag":"Developer's Guide","count":21},{"language":"en","tag":"API Integration Guide","count":16}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","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":"llms-txt-v2","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":"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":"vite-origin","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":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"caas/referencias-de-api/onboarding/12-consultar-documento","slug":"/caas/referencias-de-api/onboarding/12-consultar-documento","pageMetadata":{"title":"12 - Consultar Documento","openapi":"post /Pessoa/ConsultarDocumento","version":"Português","description":null,"href":"/caas/referencias-de-api/onboarding/12-consultar-documento"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={p:`p`,..._provideComponents(),...props.components};return _jsx(_components.p,{children:`Por meio deste endpoint o sistema transmite uma chamada na URL definida pelo parceiro e em seguida obtém um retorno onde constará o documento a ser anexado na API de Pessoa.`})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"12 - Consultar Documento","openapi":"post /Pessoa/ConsultarDocumento","version":"Português","description":null,"href":"/caas/referencias-de-api/onboarding/12-consultar-documento"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Pessoa"],"parameters":["98efe639-f8c1-40e5-b735-1108f74ae831"],"requestBody":"e3f07762-1377-4dc5-9c36-e15425e02c8a","responses":{"200":"41eaf2c7-aca1-4599-838c-1d411a44ff4f","400":"76f78f19-85ca-4a7b-ba1a-ad5fe714d48c"},"method":"post","type":"path","servers":["78eb12ed-a3ba-4385-8013-656fdd44c524"],"security":["50061105-00dd-46fa-b46e-5a0cf1dc9c9e"],"path":"/Pessoa/ConsultarDocumento","baseUrlOptions":["https://api.bmpdigital.moneyp.dev.br/"],"title":"","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"98efe639-f8c1-40e5-b735-1108f74ae831":{"name":"IdempotencyKey","in":"header","required":true,"schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"dto":{"required":["documentoCliente"],"type":"object","properties":{"documentoCliente":{"oneOf":[{"maxLength":20,"minLength":0,"type":"string","description":"Documento federal do cliente","isRequired":true,"uniqueKey":"dto.documentoCliente.oneOf.0","typeLabel":"string"},{"maxLength":20,"minLength":0,"type":"null","description":"Documento federal do cliente","isRequired":true,"uniqueKey":"dto.documentoCliente.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"dto.documentoCliente","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"dto","typeLabel":"object"},"busca":{"type":"object","properties":{"authHeaderName":{"oneOf":[{"type":"string","description":"Parâmetro para autenticação na URL do parceiro","uniqueKey":"busca.authHeaderName.oneOf.0","typeLabel":"string"},{"type":"null","description":"Parâmetro para autenticação na URL do parceiro","uniqueKey":"busca.authHeaderName.oneOf.1","typeLabel":"null"}],"uniqueKey":"busca.authHeaderName","typeLabel":"string | null"},"authHeaderValue":{"oneOf":[{"type":"string","description":"Valor do parâmetro para autenticação na URL do parceiro","uniqueKey":"busca.authHeaderValue.oneOf.0","typeLabel":"string"},{"type":"null","description":"Valor do parâmetro para autenticação na URL do parceiro","uniqueKey":"busca.authHeaderValue.oneOf.1","typeLabel":"null"}],"uniqueKey":"busca.authHeaderValue","typeLabel":"string | null"},"method":{"oneOf":[{"type":"string","description":"GET/POST/PUT","uniqueKey":"busca.method.oneOf.0","typeLabel":"string"},{"type":"null","description":"GET/POST/PUT","uniqueKey":"busca.method.oneOf.1","typeLabel":"null"}],"uniqueKey":"busca.method","typeLabel":"string | null"},"contentType":{"oneOf":[{"type":"string","description":"Indica o formato desejado pela URL, Exemplo: text/plain, application/json","uniqueKey":"busca.contentType.oneOf.0","typeLabel":"string"},{"type":"null","description":"Indica o formato desejado pela URL, Exemplo: text/plain, application/json","uniqueKey":"busca.contentType.oneOf.1","typeLabel":"null"}],"uniqueKey":"busca.contentType","typeLabel":"string | null"},"url":{"oneOf":[{"type":"string","description":"Url definida pelo parceiro que deverá devolver como resposta o DTO","uniqueKey":"busca.url.oneOf.0","typeLabel":"string"},{"type":"null","description":"Url definida pelo parceiro que deverá devolver como resposta o DTO","uniqueKey":"busca.url.oneOf.1","typeLabel":"null"}],"uniqueKey":"busca.url","typeLabel":"string | null"},"body":{"oneOf":[{"type":"string","description":"Corpo da mensagem que a URL deve receber. Exemplo: Parâmetros para que localize o documento na base do parceiro.","uniqueKey":"busca.body.oneOf.0","typeLabel":"string"},{"type":"null","description":"Corpo da mensagem que a URL deve receber. Exemplo: Parâmetros para que localize o documento na base do parceiro.","uniqueKey":"busca.body.oneOf.1","typeLabel":"null"}],"uniqueKey":"busca.body","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"busca","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"busca":{"authHeaderName":"\u003cstring>","authHeaderValue":"\u003cstring>","method":"\u003cstring>","contentType":"\u003cstring>","url":"\u003cstring>","body":"\u003cstring>"}}}},"exampleType":"generated"},"text/json":{"schema":{"type":"object","properties":{"dto":{"required":["documentoCliente"],"type":"object","properties":{"documentoCliente":{"oneOf":[{"maxLength":20,"minLength":0,"type":"string","description":"Documento federal do cliente","isRequired":true,"uniqueKey":"dto.documentoCliente.oneOf.0","typeLabel":"string"},{"maxLength":20,"minLength":0,"type":"null","description":"Documento federal do cliente","isRequired":true,"uniqueKey":"dto.documentoCliente.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"dto.documentoCliente","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"dto","typeLabel":"object"},"busca":{"type":"object","properties":{"authHeaderName":{"oneOf":[{"type":"string","description":"Parâmetro para autenticação na URL do parceiro","uniqueKey":"busca.authHeaderName.oneOf.0","typeLabel":"string"},{"type":"null","description":"Parâmetro para autenticação na URL do parceiro","uniqueKey":"busca.authHeaderName.oneOf.1","typeLabel":"null"}],"uniqueKey":"busca.authHeaderName","typeLabel":"string | null"},"authHeaderValue":{"oneOf":[{"type":"string","description":"Valor do parâmetro para autenticação na URL do parceiro","uniqueKey":"busca.authHeaderValue.oneOf.0","typeLabel":"string"},{"type":"null","description":"Valor do parâmetro para autenticação na URL do parceiro","uniqueKey":"busca.authHeaderValue.oneOf.1","typeLabel":"null"}],"uniqueKey":"busca.authHeaderValue","typeLabel":"string | null"},"method":{"oneOf":[{"type":"string","description":"GET/POST/PUT","uniqueKey":"busca.method.oneOf.0","typeLabel":"string"},{"type":"null","description":"GET/POST/PUT","uniqueKey":"busca.method.oneOf.1","typeLabel":"null"}],"uniqueKey":"busca.method","typeLabel":"string | null"},"contentType":{"oneOf":[{"type":"string","description":"Indica o formato desejado pela URL, Exemplo: text/plain, application/json","uniqueKey":"busca.contentType.oneOf.0","typeLabel":"string"},{"type":"null","description":"Indica o formato desejado pela URL, Exemplo: text/plain, application/json","uniqueKey":"busca.contentType.oneOf.1","typeLabel":"null"}],"uniqueKey":"busca.contentType","typeLabel":"string | null"},"url":{"oneOf":[{"type":"string","description":"Url definida pelo parceiro que deverá devolver como resposta o DTO","uniqueKey":"busca.url.oneOf.0","typeLabel":"string"},{"type":"null","description":"Url definida pelo parceiro que deverá devolver como resposta o DTO","uniqueKey":"busca.url.oneOf.1","typeLabel":"null"}],"uniqueKey":"busca.url","typeLabel":"string | null"},"body":{"oneOf":[{"type":"string","description":"Corpo da mensagem que a URL deve receber. Exemplo: Parâmetros para que localize o documento na base do parceiro.","uniqueKey":"busca.body.oneOf.0","typeLabel":"string"},{"type":"null","description":"Corpo da mensagem que a URL deve receber. Exemplo: Parâmetros para que localize o documento na base do parceiro.","uniqueKey":"busca.body.oneOf.1","typeLabel":"null"}],"uniqueKey":"busca.body","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"busca","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"busca":{"authHeaderName":"\u003cstring>","authHeaderValue":"\u003cstring>","method":"\u003cstring>","contentType":"\u003cstring>","url":"\u003cstring>","body":"\u003cstring>"}}}},"exampleType":"generated"},"application/*+json":{"schema":{"type":"object","properties":{"dto":{"required":["documentoCliente"],"type":"object","properties":{"documentoCliente":{"oneOf":[{"maxLength":20,"minLength":0,"type":"string","description":"Documento federal do cliente","isRequired":true,"uniqueKey":"dto.documentoCliente.oneOf.0","typeLabel":"string"},{"maxLength":20,"minLength":0,"type":"null","description":"Documento federal do cliente","isRequired":true,"uniqueKey":"dto.documentoCliente.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"dto.documentoCliente","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"dto","typeLabel":"object"},"busca":{"type":"object","properties":{"authHeaderName":{"oneOf":[{"type":"string","description":"Parâmetro para autenticação na URL do parceiro","uniqueKey":"busca.authHeaderName.oneOf.0","typeLabel":"string"},{"type":"null","description":"Parâmetro para autenticação na URL do parceiro","uniqueKey":"busca.authHeaderName.oneOf.1","typeLabel":"null"}],"uniqueKey":"busca.authHeaderName","typeLabel":"string | null"},"authHeaderValue":{"oneOf":[{"type":"string","description":"Valor do parâmetro para autenticação na URL do parceiro","uniqueKey":"busca.authHeaderValue.oneOf.0","typeLabel":"string"},{"type":"null","description":"Valor do parâmetro para autenticação na URL do parceiro","uniqueKey":"busca.authHeaderValue.oneOf.1","typeLabel":"null"}],"uniqueKey":"busca.authHeaderValue","typeLabel":"string | null"},"method":{"oneOf":[{"type":"string","description":"GET/POST/PUT","uniqueKey":"busca.method.oneOf.0","typeLabel":"string"},{"type":"null","description":"GET/POST/PUT","uniqueKey":"busca.method.oneOf.1","typeLabel":"null"}],"uniqueKey":"busca.method","typeLabel":"string | null"},"contentType":{"oneOf":[{"type":"string","description":"Indica o formato desejado pela URL, Exemplo: text/plain, application/json","uniqueKey":"busca.contentType.oneOf.0","typeLabel":"string"},{"type":"null","description":"Indica o formato desejado pela URL, Exemplo: text/plain, application/json","uniqueKey":"busca.contentType.oneOf.1","typeLabel":"null"}],"uniqueKey":"busca.contentType","typeLabel":"string | null"},"url":{"oneOf":[{"type":"string","description":"Url definida pelo parceiro que deverá devolver como resposta o DTO","uniqueKey":"busca.url.oneOf.0","typeLabel":"string"},{"type":"null","description":"Url definida pelo parceiro que deverá devolver como resposta o DTO","uniqueKey":"busca.url.oneOf.1","typeLabel":"null"}],"uniqueKey":"busca.url","typeLabel":"string | null"},"body":{"oneOf":[{"type":"string","description":"Corpo da mensagem que a URL deve receber. Exemplo: Parâmetros para que localize o documento na base do parceiro.","uniqueKey":"busca.body.oneOf.0","typeLabel":"string"},{"type":"null","description":"Corpo da mensagem que a URL deve receber. Exemplo: Parâmetros para que localize o documento na base do parceiro.","uniqueKey":"busca.body.oneOf.1","typeLabel":"null"}],"uniqueKey":"busca.body","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"busca","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"busca":{"authHeaderName":"\u003cstring>","authHeaderValue":"\u003cstring>","method":"\u003cstring>","contentType":"\u003cstring>","url":"\u003cstring>","body":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"41eaf2c7-aca1-4599-838c-1d411a44ff4f":{"description":"OK","content":{"text/plain":{"schema":{"type":"object","properties":{"msg":{"oneOf":[{"type":"string","uniqueKey":"msg.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"msg.oneOf.1","typeLabel":"null"}],"uniqueKey":"msg","typeLabel":"string | null"},"hasError":{"type":"boolean","uniqueKey":"hasError","typeLabel":"boolean"},"messages":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"messageType":{"enum":[1,2,3],"type":"integer","format":"int32","uniqueKey":"messages.oneOf.0.items.[INDEX].messageType","typeLabel":"enum\u003cinteger>"},"code":{"oneOf":[{"type":"string","uniqueKey":"messages.oneOf.0.items.[INDEX].code.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"messages.oneOf.0.items.[INDEX].code.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.oneOf.0.items.[INDEX].code","typeLabel":"string | null"},"context":{"oneOf":[{"type":"string","uniqueKey":"messages.oneOf.0.items.[INDEX].context.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"messages.oneOf.0.items.[INDEX].context.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.oneOf.0.items.[INDEX].context","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","uniqueKey":"messages.oneOf.0.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"messages.oneOf.0.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.oneOf.0.items.[INDEX].description","typeLabel":"string | null"},"field":{"oneOf":[{"type":"string","uniqueKey":"messages.oneOf.0.items.[INDEX].field.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"messages.oneOf.0.items.[INDEX].field.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.oneOf.0.items.[INDEX].field","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"messages.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"messages.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"messageType":{"enum":[1,2,3],"type":"integer","format":"int32"},"code":{"oneOf":[{"type":"string"},{"type":"null"}]},"context":{"oneOf":[{"type":"string"},{"type":"null"}]},"description":{"oneOf":[{"type":"string"},{"type":"null"}]},"field":{"oneOf":[{"type":"string"},{"type":"null"}]}},"additionalProperties":false},"uniqueKey":"messages.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages","typeLabel":"object[] | null"},"codigo":{"oneOf":[{"type":"string","format":"uuid","uniqueKey":"codigo.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","uniqueKey":"codigo.oneOf.1","typeLabel":"null"}],"uniqueKey":"codigo","typeLabel":"string\u003cuuid> | null"},"tipoDocumento":{"type":"integer","format":"int32","uniqueKey":"tipoDocumento","typeLabel":"integer\u003cint32>"},"nomeArquivo":{"oneOf":[{"type":"string","uniqueKey":"nomeArquivo.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"nomeArquivo.oneOf.1","typeLabel":"null"}],"uniqueKey":"nomeArquivo","typeLabel":"string | null"},"extensao":{"oneOf":[{"type":"string","uniqueKey":"extensao.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"extensao.oneOf.1","typeLabel":"null"}],"uniqueKey":"extensao","typeLabel":"string | null"},"dtValidade":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"dtValidade.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"dtValidade.oneOf.1","typeLabel":"null"}],"uniqueKey":"dtValidade","typeLabel":"string\u003cdate-time> | null"},"arquivo":{"oneOf":[{"type":"string","format":"byte","uniqueKey":"arquivo.oneOf.0","typeLabel":"string\u003cbyte>"},{"type":"null","format":"byte","uniqueKey":"arquivo.oneOf.1","typeLabel":"null"}],"uniqueKey":"arquivo","typeLabel":"string\u003cbyte> | null"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"msg":"\u003cstring>","hasError":true,"messages":[{"messageType":1,"code":"\u003cstring>","context":"\u003cstring>","description":"\u003cstring>","field":"\u003cstring>"}],"codigo":"3c90c3cc-0d44-4b50-8888-8dd25736052a","tipoDocumento":123,"nomeArquivo":"\u003cstring>","extensao":"\u003cstring>","dtValidade":"2023-11-07T05:31:56Z","arquivo":"aSDinaTvuI8gbWludGxpZnk="}}},"exampleType":"generated"},"application/json":{"schema":{"type":"object","properties":{"msg":{"oneOf":[{"type":"string","uniqueKey":"msg.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"msg.oneOf.1","typeLabel":"null"}],"uniqueKey":"msg","typeLabel":"string | null"},"hasError":{"type":"boolean","uniqueKey":"hasError","typeLabel":"boolean"},"messages":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"messageType":{"enum":[1,2,3],"type":"integer","format":"int32","uniqueKey":"messages.oneOf.0.items.[INDEX].messageType","typeLabel":"enum\u003cinteger>"},"code":{"oneOf":[{"type":"string","uniqueKey":"messages.oneOf.0.items.[INDEX].code.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"messages.oneOf.0.items.[INDEX].code.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.oneOf.0.items.[INDEX].code","typeLabel":"string | null"},"context":{"oneOf":[{"type":"string","uniqueKey":"messages.oneOf.0.items.[INDEX].context.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"messages.oneOf.0.items.[INDEX].context.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.oneOf.0.items.[INDEX].context","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","uniqueKey":"messages.oneOf.0.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"messages.oneOf.0.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.oneOf.0.items.[INDEX].description","typeLabel":"string | null"},"field":{"oneOf":[{"type":"string","uniqueKey":"messages.oneOf.0.items.[INDEX].field.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"messages.oneOf.0.items.[INDEX].field.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.oneOf.0.items.[INDEX].field","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"messages.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"messages.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"messageType":{"enum":[1,2,3],"type":"integer","format":"int32"},"code":{"oneOf":[{"type":"string"},{"type":"null"}]},"context":{"oneOf":[{"type":"string"},{"type":"null"}]},"description":{"oneOf":[{"type":"string"},{"type":"null"}]},"field":{"oneOf":[{"type":"string"},{"type":"null"}]}},"additionalProperties":false},"uniqueKey":"messages.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages","typeLabel":"object[] | null"},"codigo":{"oneOf":[{"type":"string","format":"uuid","uniqueKey":"codigo.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","uniqueKey":"codigo.oneOf.1","typeLabel":"null"}],"uniqueKey":"codigo","typeLabel":"string\u003cuuid> | null"},"tipoDocumento":{"type":"integer","format":"int32","uniqueKey":"tipoDocumento","typeLabel":"integer\u003cint32>"},"nomeArquivo":{"oneOf":[{"type":"string","uniqueKey":"nomeArquivo.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"nomeArquivo.oneOf.1","typeLabel":"null"}],"uniqueKey":"nomeArquivo","typeLabel":"string | null"},"extensao":{"oneOf":[{"type":"string","uniqueKey":"extensao.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"extensao.oneOf.1","typeLabel":"null"}],"uniqueKey":"extensao","typeLabel":"string | null"},"dtValidade":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"dtValidade.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"dtValidade.oneOf.1","typeLabel":"null"}],"uniqueKey":"dtValidade","typeLabel":"string\u003cdate-time> | null"},"arquivo":{"oneOf":[{"type":"string","format":"byte","uniqueKey":"arquivo.oneOf.0","typeLabel":"string\u003cbyte>"},{"type":"null","format":"byte","uniqueKey":"arquivo.oneOf.1","typeLabel":"null"}],"uniqueKey":"arquivo","typeLabel":"string\u003cbyte> | null"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"msg":"\u003cstring>","hasError":true,"messages":[{"messageType":1,"code":"\u003cstring>","context":"\u003cstring>","description":"\u003cstring>","field":"\u003cstring>"}],"codigo":"3c90c3cc-0d44-4b50-8888-8dd25736052a","tipoDocumento":123,"nomeArquivo":"\u003cstring>","extensao":"\u003cstring>","dtValidade":"2023-11-07T05:31:56Z","arquivo":"aSDinaTvuI8gbWludGxpZnk="}}},"exampleType":"generated"},"text/json":{"schema":{"type":"object","properties":{"msg":{"oneOf":[{"type":"string","uniqueKey":"msg.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"msg.oneOf.1","typeLabel":"null"}],"uniqueKey":"msg","typeLabel":"string | null"},"hasError":{"type":"boolean","uniqueKey":"hasError","typeLabel":"boolean"},"messages":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"messageType":{"enum":[1,2,3],"type":"integer","format":"int32","uniqueKey":"messages.oneOf.0.items.[INDEX].messageType","typeLabel":"enum\u003cinteger>"},"code":{"oneOf":[{"type":"string","uniqueKey":"messages.oneOf.0.items.[INDEX].code.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"messages.oneOf.0.items.[INDEX].code.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.oneOf.0.items.[INDEX].code","typeLabel":"string | null"},"context":{"oneOf":[{"type":"string","uniqueKey":"messages.oneOf.0.items.[INDEX].context.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"messages.oneOf.0.items.[INDEX].context.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.oneOf.0.items.[INDEX].context","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","uniqueKey":"messages.oneOf.0.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"messages.oneOf.0.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.oneOf.0.items.[INDEX].description","typeLabel":"string | null"},"field":{"oneOf":[{"type":"string","uniqueKey":"messages.oneOf.0.items.[INDEX].field.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"messages.oneOf.0.items.[INDEX].field.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.oneOf.0.items.[INDEX].field","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"messages.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"messages.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"messageType":{"enum":[1,2,3],"type":"integer","format":"int32"},"code":{"oneOf":[{"type":"string"},{"type":"null"}]},"context":{"oneOf":[{"type":"string"},{"type":"null"}]},"description":{"oneOf":[{"type":"string"},{"type":"null"}]},"field":{"oneOf":[{"type":"string"},{"type":"null"}]}},"additionalProperties":false},"uniqueKey":"messages.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages","typeLabel":"object[] | null"},"codigo":{"oneOf":[{"type":"string","format":"uuid","uniqueKey":"codigo.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","uniqueKey":"codigo.oneOf.1","typeLabel":"null"}],"uniqueKey":"codigo","typeLabel":"string\u003cuuid> | null"},"tipoDocumento":{"type":"integer","format":"int32","uniqueKey":"tipoDocumento","typeLabel":"integer\u003cint32>"},"nomeArquivo":{"oneOf":[{"type":"string","uniqueKey":"nomeArquivo.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"nomeArquivo.oneOf.1","typeLabel":"null"}],"uniqueKey":"nomeArquivo","typeLabel":"string | null"},"extensao":{"oneOf":[{"type":"string","uniqueKey":"extensao.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"extensao.oneOf.1","typeLabel":"null"}],"uniqueKey":"extensao","typeLabel":"string | null"},"dtValidade":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"dtValidade.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"dtValidade.oneOf.1","typeLabel":"null"}],"uniqueKey":"dtValidade","typeLabel":"string\u003cdate-time> | null"},"arquivo":{"oneOf":[{"type":"string","format":"byte","uniqueKey":"arquivo.oneOf.0","typeLabel":"string\u003cbyte>"},{"type":"null","format":"byte","uniqueKey":"arquivo.oneOf.1","typeLabel":"null"}],"uniqueKey":"arquivo","typeLabel":"string\u003cbyte> | null"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"msg":"\u003cstring>","hasError":true,"messages":[{"messageType":1,"code":"\u003cstring>","context":"\u003cstring>","description":"\u003cstring>","field":"\u003cstring>"}],"codigo":"3c90c3cc-0d44-4b50-8888-8dd25736052a","tipoDocumento":123,"nomeArquivo":"\u003cstring>","extensao":"\u003cstring>","dtValidade":"2023-11-07T05:31:56Z","arquivo":"aSDinaTvuI8gbWludGxpZnk="}}},"exampleType":"generated"}},"exampleType":"generated"},"76f78f19-85ca-4a7b-ba1a-ad5fe714d48c":{"description":"Bad Request","content":{"text/plain":{"schema":{"type":"object","properties":{"msg":{"oneOf":[{"type":"string","uniqueKey":"msg.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"msg.oneOf.1","typeLabel":"null"}],"uniqueKey":"msg","typeLabel":"string | null"},"hasError":{"type":"boolean","uniqueKey":"hasError","typeLabel":"boolean"},"messages":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"messageType":{"enum":[1,2,3],"type":"integer","format":"int32","uniqueKey":"messages.oneOf.0.items.[INDEX].messageType","typeLabel":"enum\u003cinteger>"},"code":{"oneOf":[{"type":"string","uniqueKey":"messages.oneOf.0.items.[INDEX].code.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"messages.oneOf.0.items.[INDEX].code.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.oneOf.0.items.[INDEX].code","typeLabel":"string | null"},"context":{"oneOf":[{"type":"string","uniqueKey":"messages.oneOf.0.items.[INDEX].context.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"messages.oneOf.0.items.[INDEX].context.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.oneOf.0.items.[INDEX].context","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","uniqueKey":"messages.oneOf.0.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"messages.oneOf.0.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.oneOf.0.items.[INDEX].description","typeLabel":"string | null"},"field":{"oneOf":[{"type":"string","uniqueKey":"messages.oneOf.0.items.[INDEX].field.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"messages.oneOf.0.items.[INDEX].field.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.oneOf.0.items.[INDEX].field","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"messages.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"messages.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"messageType":{"enum":[1,2,3],"type":"integer","format":"int32"},"code":{"oneOf":[{"type":"string"},{"type":"null"}]},"context":{"oneOf":[{"type":"string"},{"type":"null"}]},"description":{"oneOf":[{"type":"string"},{"type":"null"}]},"field":{"oneOf":[{"type":"string"},{"type":"null"}]}},"additionalProperties":false},"uniqueKey":"messages.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages","typeLabel":"object[] | null"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"msg":"\u003cstring>","hasError":true,"messages":[{"messageType":1,"code":"\u003cstring>","context":"\u003cstring>","description":"\u003cstring>","field":"\u003cstring>"}]}}},"exampleType":"generated"},"application/json":{"schema":{"type":"object","properties":{"msg":{"oneOf":[{"type":"string","uniqueKey":"msg.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"msg.oneOf.1","typeLabel":"null"}],"uniqueKey":"msg","typeLabel":"string | null"},"hasError":{"type":"boolean","uniqueKey":"hasError","typeLabel":"boolean"},"messages":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"messageType":{"enum":[1,2,3],"type":"integer","format":"int32","uniqueKey":"messages.oneOf.0.items.[INDEX].messageType","typeLabel":"enum\u003cinteger>"},"code":{"oneOf":[{"type":"string","uniqueKey":"messages.oneOf.0.items.[INDEX].code.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"messages.oneOf.0.items.[INDEX].code.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.oneOf.0.items.[INDEX].code","typeLabel":"string | null"},"context":{"oneOf":[{"type":"string","uniqueKey":"messages.oneOf.0.items.[INDEX].context.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"messages.oneOf.0.items.[INDEX].context.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.oneOf.0.items.[INDEX].context","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","uniqueKey":"messages.oneOf.0.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"messages.oneOf.0.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.oneOf.0.items.[INDEX].description","typeLabel":"string | null"},"field":{"oneOf":[{"type":"string","uniqueKey":"messages.oneOf.0.items.[INDEX].field.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"messages.oneOf.0.items.[INDEX].field.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.oneOf.0.items.[INDEX].field","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"messages.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"messages.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"messageType":{"enum":[1,2,3],"type":"integer","format":"int32"},"code":{"oneOf":[{"type":"string"},{"type":"null"}]},"context":{"oneOf":[{"type":"string"},{"type":"null"}]},"description":{"oneOf":[{"type":"string"},{"type":"null"}]},"field":{"oneOf":[{"type":"string"},{"type":"null"}]}},"additionalProperties":false},"uniqueKey":"messages.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages","typeLabel":"object[] | null"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"msg":"\u003cstring>","hasError":true,"messages":[{"messageType":1,"code":"\u003cstring>","context":"\u003cstring>","description":"\u003cstring>","field":"\u003cstring>"}]}}},"exampleType":"generated"},"text/json":{"schema":{"type":"object","properties":{"msg":{"oneOf":[{"type":"string","uniqueKey":"msg.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"msg.oneOf.1","typeLabel":"null"}],"uniqueKey":"msg","typeLabel":"string | null"},"hasError":{"type":"boolean","uniqueKey":"hasError","typeLabel":"boolean"},"messages":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"messageType":{"enum":[1,2,3],"type":"integer","format":"int32","uniqueKey":"messages.oneOf.0.items.[INDEX].messageType","typeLabel":"enum\u003cinteger>"},"code":{"oneOf":[{"type":"string","uniqueKey":"messages.oneOf.0.items.[INDEX].code.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"messages.oneOf.0.items.[INDEX].code.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.oneOf.0.items.[INDEX].code","typeLabel":"string | null"},"context":{"oneOf":[{"type":"string","uniqueKey":"messages.oneOf.0.items.[INDEX].context.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"messages.oneOf.0.items.[INDEX].context.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.oneOf.0.items.[INDEX].context","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","uniqueKey":"messages.oneOf.0.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"messages.oneOf.0.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.oneOf.0.items.[INDEX].description","typeLabel":"string | null"},"field":{"oneOf":[{"type":"string","uniqueKey":"messages.oneOf.0.items.[INDEX].field.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"messages.oneOf.0.items.[INDEX].field.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.oneOf.0.items.[INDEX].field","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"messages.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"messages.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"messageType":{"enum":[1,2,3],"type":"integer","format":"int32"},"code":{"oneOf":[{"type":"string"},{"type":"null"}]},"context":{"oneOf":[{"type":"string"},{"type":"null"}]},"description":{"oneOf":[{"type":"string"},{"type":"null"}]},"field":{"oneOf":[{"type":"string"},{"type":"null"}]}},"additionalProperties":false},"uniqueKey":"messages.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages","typeLabel":"object[] | null"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"msg":"\u003cstring>","hasError":true,"messages":[{"messageType":1,"code":"\u003cstring>","context":"\u003cstring>","description":"\u003cstring>","field":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"50061105-00dd-46fa-b46e-5a0cf1dc9c9e":{"Bearer":{"type":"apiKey","description":"Informe o token","name":"Authorization","in":"header","scopes":[]}}},"servers":{"78eb12ed-a3ba-4385-8013-656fdd44c524":{"url":"https://api.bmpdigital.moneyp.dev.br/","description":"Localhost"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","description":"Informe o token","name":"Authorization","in":"header","scopes":[]},"schema":{"title":"Authorization","type":"string","description":"Informe o token","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"Bearer","name":"Authorization"}],"title":"Bearer"}]},"originalFileLocation":"specs/pessoa.json"},"subdomain":"bmpmoneyplus-sandbox","siteName":"BMP","title":"12 - Consultar Documento - BMP","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"pt-BR":{"href":"/caas/referencias-de-api/onboarding/12-consultar-documento","matchLevel":0},"en":{"href":"/homepage/english-homepage/about-us","matchLevel":4}}},"lastModified":"2026-10-28T17:46:05.136Z","originalFileLocation":"caas/referencias-de-api/onboarding/12-consultar-documento.mdx","locale":"pt-BR"},"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=\"light\"}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=\"application-name\" content=\"BMP\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"https://raw.githubusercontent.com/docs-petry/imagens/refs/heads/main/bmp-docs/favicon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"https://raw.githubusercontent.com/docs-petry/imagens/refs/heads/main/bmp-docs/favicon.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"https://raw.githubusercontent.com/docs-petry/imagens/refs/heads/main/bmp-docs/favicon.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/png\" href=\"https://raw.githubusercontent.com/docs-petry/imagens/refs/heads/main/bmp-docs/favicon.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"https://raw.githubusercontent.com/docs-petry/imagens/refs/heads/main/bmp-docs/favicon.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"https://raw.githubusercontent.com/docs-petry/imagens/refs/heads/main/bmp-docs/favicon.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/png\" href=\"https://raw.githubusercontent.com/docs-petry/imagens/refs/heads/main/bmp-docs/favicon.png\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"12 - Consultar Documento - BMP\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"BMP\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://bmpmoneyplus-sandbox.mintlify.app/caas/referencias-de-api/onboarding/12-consultar-documento\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://bmpmoneyplus-sandbox.mintlify.app/_mintlify/api/og/v2?division=Onboarding\u0026amp;title=12+-+Consultar+Documento\u0026amp;theme=e1418ef4c4ce228a24d581f0\u0026amp;signature=f52ae27e16fa9ca95c5fcb81ef5848e5ec4ce6f44b5d9b46dff37956fb70f2f0\">\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=\"12 - Consultar Documento - BMP\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://bmpmoneyplus-sandbox.mintlify.app/_mintlify/api/og/v2?division=Onboarding\u0026amp;title=12+-+Consultar+Documento\u0026amp;theme=e1418ef4c4ce228a24d581f0\u0026amp;signature=f52ae27e16fa9ca95c5fcb81ef5848e5ec4ce6f44b5d9b46dff37956fb70f2f0\">\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=\"https://mintlify.s3.us-west-1.amazonaws.com/bmpmoneyplus-sandbox/_generated/favicon/browserconfig.xml?v=3\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"BMP\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1A1883\">\u003clink data-mint-head rel=\"canonical\" href=\"https://bmpmoneyplus-sandbox.mintlify.app/caas/referencias-de-api/onboarding/12-consultar-documento\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/caas/referencias-de-api/onboarding/12-consultar-documento.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://bmpmoneyplus-sandbox.mintlify.app/#organization\",\"name\":\"BMP\",\"url\":\"https://bmpmoneyplus-sandbox.mintlify.app\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://raw.githubusercontent.com/docs-petry/imagens/refs/heads/main/bmp-docs/light.png\"}},{\"@type\":\"WebSite\",\"@id\":\"https://bmpmoneyplus-sandbox.mintlify.app#website\",\"name\":\"BMP\",\"url\":\"https://bmpmoneyplus-sandbox.mintlify.app\",\"publisher\":{\"@id\":\"https://bmpmoneyplus-sandbox.mintlify.app/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://bmpmoneyplus-sandbox.mintlify.app/caas/referencias-de-api/onboarding/12-consultar-documento#webpage\",\"url\":\"https://bmpmoneyplus-sandbox.mintlify.app/caas/referencias-de-api/onboarding/12-consultar-documento\",\"name\":\"12 - Consultar Documento\",\"dateModified\":\"2026-10-28T17:46:05.136Z\",\"isPartOf\":{\"@id\":\"https://bmpmoneyplus-sandbox.mintlify.app#website\"},\"breadcrumb\":{\"@id\":\"https://bmpmoneyplus-sandbox.mintlify.app/caas/referencias-de-api/onboarding/12-consultar-documento#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://bmpmoneyplus-sandbox.mintlify.app/caas/referencias-de-api/onboarding/12-consultar-documento#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Referencias de API\",\"item\":\"https://bmpmoneyplus-sandbox.mintlify.app/caas/referencias-de-api/solicitacao-de-limite-de-credito/1-consultar-saldo\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Onboarding\",\"item\":\"https://bmpmoneyplus-sandbox.mintlify.app/caas/referencias-de-api/onboarding/10-cadastro-do-cliente\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"12 - Consultar Documento\",\"item\":\"https://bmpmoneyplus-sandbox.mintlify.app/caas/referencias-de-api/onboarding/12-consultar-documento\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://bmpmoneyplus-sandbox.mintlify.app/caas/referencias-de-api/onboarding/12-consultar-documento#apireference\",\"headline\":\"12 - Consultar Documento\",\"name\":\"12 - Consultar Documento\",\"url\":\"https://bmpmoneyplus-sandbox.mintlify.app/caas/referencias-de-api/onboarding/12-consultar-documento\",\"mainEntityOfPage\":{\"@id\":\"https://bmpmoneyplus-sandbox.mintlify.app/caas/referencias-de-api/onboarding/12-consultar-documento#webpage\"},\"dateModified\":\"2026-10-28T17:46:05.136Z\",\"publisher\":{\"@id\":\"https://bmpmoneyplus-sandbox.mintlify.app/#organization\"},\"isPartOf\":{\"@id\":\"https://bmpmoneyplus-sandbox.mintlify.app#website\"}}]}\u003c/script>","siteName":"BMP","nav":{"global":null,"languages":[{"language":"pt-BR","anchors":[{"anchor":"Documentação","icon":"book-open","tabs":[{"tab":"Página Iniciall","pages":[{"title":"Página Iniciall","href":"/homepage/quem-somos"}]},{"tab":"BaaS","pages":[{"title":"BaaS","href":"/baas/guia-inicial/sobre-o-digital-banking-as-a-service"}]},{"tab":"CaaS","groups":[{"group":"Guia Inicial","pages":[{"title":"Sobre o Credit as a Service (CaaS)","href":"/caas/sobre-o-caas"},{"group":"Operações de crédito","pages":[{"title":"Pessoa Física","href":"/caas/pessoa-fisica"},{"title":"Pessoa Jurídica","version":"Português","href":"/caas/pessoa-juridica"}]}]},{"group":"Métodos de Assinaturas","pages":[{"title":"Conheça Nossas Assinaturas","version":"Português","href":"/caas/assinaturas"}]},{"group":"Guia do Desenvolvedor","pages":[{"group":"Guia de Integração Via API","pages":[{"title":"Introdução","version":"Português","href":"/caas/primeiros-passos/introducao"},{"title":"Autenticação","version":"Português","href":"/caas/primeiros-passos/autenticacao"},{"title":"Ambientes","version":"Português","href":"/caas/primeiros-passos/ambiente"},{"group":"Procedimento Técnico de Callback","pages":[{"title":"Introdução","version":"Português","href":"/caas/procedimento-tecnico-de-callback/introducao"},{"title":"Configuração","version":"Português","href":"/caas/procedimento-tecnico-de-callback/configuracao"},{"title":"Eventos","version":"Português","href":"/caas/procedimento-tecnico-de-callback/eventos"}]}]}]},{"group":"Referencias de API","pages":[{"group":"Solicitação de Limite de Crédito","pages":[{"title":" 1 - Consultar Saldo","openapi":"post /SolicitacaoAnalise/ConsultarSaldo","href":"/caas/referencias-de-api/solicitacao-de-limite-de-credito/1-consultar-saldo"},{"title":"2 - Consultar Situação","openapi":"post /SolicitacaoAnalise/ConsultarSituacao","href":"/caas/referencias-de-api/solicitacao-de-limite-de-credito/2-consultar-situacao"},{"title":"3 - Consultar Solicitações","openapi":"post /SolicitacaoAnalise/ConsultarSolicitacoes","href":"/caas/referencias-de-api/solicitacao-de-limite-de-credito/3-consultar-solicitacoes"},{"title":"4 - Incluir Solicitação de Análise de Crédito","openapi":"post /SolicitacaoAnalise/IncluirSolicitacaoAnaliseCredito","href":"/caas/referencias-de-api/solicitacao-de-limite-de-credito/4-incluir-solicitacao-de-analise-de-credito"}]},{"group":"Simulações","pages":[{"title":"5 - Simulação Multiparcelamento","openapi":"post /Proposta/CalcularGridParcelasSimplificado","href":"/caas/referencias-de-api/simulacoes/5-simulacao-multiparcelamento"},{"title":"6 - Simulação Detalhada","openapi":"post /Proposta/CalcularGridParcelasSimplificadoPrice","href":"/caas/referencias-de-api/simulacoes/6-simulacao-detalhada"},{"title":"7 - Calcular","openapi":"post /Proposta/Calcular","href":"/caas/referencias-de-api/simulacoes/7-calcular"},{"title":"9 - Calcular Valores Proposta","openapi":"post /Proposta/CalcularValoresProposta","href":"/caas/referencias-de-api/simulacoes/9-calcular-valores-proposta"}]},{"group":"Onboarding","pages":[{"title":"10 - Cadastro do Cliente","openapi":"post /Pessoa/Salvar","href":"/caas/referencias-de-api/onboarding/10-cadastro-do-cliente"},{"title":"11 - Cadastro do Endereço","openapi":"post /Pessoa/SalvarEndereco","description":null,"href":"/caas/referencias-de-api/onboarding/11-cadastro-do-endereco"},{"title":"12 - Consultar Documento","openapi":"post /Pessoa/ConsultarDocumento","version":"Português","href":"/caas/referencias-de-api/onboarding/12-consultar-documento"},{"title":"13 - Consultar Pessoa","openapi":"post /Pessoa/ConsultarPessoa","version":"Português","description":null,"href":"/caas/referencias-de-api/onboarding/13-consultar-pessoa"},{"title":"14 - Consultar Situação Onboarding","openapi":"post /Pessoa/ConsultarSituacaoOnBoarding","version":"Português","href":"/caas/referencias-de-api/onboarding/14-consultar-situacao-onboarding"},{"title":"15 - Incluir Documento","openapi":"post /Pessoa/IncluirDocumento","version":"Português","href":"/caas/referencias-de-api/onboarding/15-incluir-documento"},{"title":"16 - Incluir Pessoa Onboarding","openapi":"post /Pessoa/IncluirPessoaOnBoarding","version":"Português","href":"/caas/referencias-de-api/onboarding/16-incluir-pessoa-onboarding"},{"title":"17 - Salvar Endereços","openapi":"post /Pessoa/SalvarEnderecos","version":"Português","href":"/caas/referencias-de-api/onboarding/17-salvar-enderecos"},{"title":"18 - Salvar Sócio","openapi":"post /Pessoa/SalvarSocio","version":"Português","href":"/caas/referencias-de-api/onboarding/18-salvar-socio"},{"title":"19 - Salvar Sócios","openapi":"post /Pessoa/SalvarSocios","version":"Português","href":"/caas/referencias-de-api/onboarding/19-salvar-socios"},{"title":"20 - Incluir Avalista","openapi":"post /Proposta/IncluirAvalista","href":"/caas/referencias-de-api/onboarding/20-incluir-avalista"},{"title":"21 - Incluir Avalistas","openapi":"post /Proposta/IncluirAvalistas","href":"/caas/referencias-de-api/onboarding/21-incluir-avalistas"}]},{"group":"Contratação","pages":[{"title":"22 - Inclusão com Análise BMP","openapi":"post /Proposta/IncluirManual","href":"/caas/referencias-de-api/contratacao/22-inclusao-com-analise-bmp"},{"title":"24 - Incluir Manual Simplificado Price","openapi":"post /Proposta/IncluirManualSimplificadoPrice","href":"/caas/referencias-de-api/contratacao/24-incluir-manual-simplificado-price"},{"title":"25 - Reservar Número do Contrato","openapi":"post /Proposta/ReservarNumero","href":"/caas/referencias-de-api/contratacao/25-reservar-numero-contrato"}]},{"group":"Gestão de Propostas","pages":[{"title":"26 - Aprovar","openapi":"post /Proposta/Aprovar","href":"/caas/referencias-de-api/gestao-de-propostas/26-aprovar"},{"title":"27 - Conferir","openapi":"post /Proposta/Conferir","href":"/caas/referencias-de-api/gestao-de-propostas/27-conferir"},{"title":"28 - Consultar","openapi":"post /Proposta/Consultar","href":"/caas/referencias-de-api/gestao-de-propostas/28-consultar"},{"title":"29 - Consultar Estendida","openapi":"post /Proposta/ConsultarEstendida","href":"/caas/referencias-de-api/gestao-de-propostas/29-consultar-estendida"},{"title":"30 - Consultar Parcelas","openapi":"post /Proposta/ConsultarParcelas","href":"/caas/referencias-de-api/gestao-de-propostas/30-consultar-parcelas"},{"title":"31 - Incluir Campo Extra","openapi":"post /Proposta/IncluirCampoExtra","href":"/caas/referencias-de-api/gestao-de-propostas/31-incluir-campo-extra"},{"title":"32 - Recusar","openapi":"post /Proposta/Recusar","href":"/caas/referencias-de-api/gestao-de-propostas/32-recusar"},{"title":"33 - Cancelamento de Contrato","openapi":"post /Proposta/Cancelar","href":"/caas/referencias-de-api/gestao-de-propostas/33-cancelamento-de-contrato"}]},{"group":"Garantias","pages":[{"title":"34 - Registro de Veículo","openapi":"post /Proposta/IncluirDadosVeiculo","href":"/caas/referencias-de-api/garantias/34-registro-de-veiculo"},{"title":"35 - Salvar Proposta Garantia Bem Documento","openapi":"post /Proposta/SalvarPropostaGarantiaBemDocumento","href":"/caas/referencias-de-api/garantias/35-salvar-proposta-garantia-bem-documento"},{"title":"36 - Salvar Proposta Garantia Bem","openapi":"post /Proposta/SalvarPropostaGarantiaBem","href":"/caas/referencias-de-api/garantias/36-salvar-proposta-garantia-bem"}]},{"group":"Impressão de Documentos","pages":[{"title":"37 - Impressão de CCB","openapi":"get /api/","href":"/caas/referencias-de-api/impressao-documentos/37-impressao-ccb"},{"title":"38 - Comprovante de Pagamento","openapi":"get /api/","href":"/caas/referencias-de-api/impressao-documentos/38-comprovante-de-pagamento"}]},{"group":"Assinaturas","pages":[{"title":"39 - Eletrônica","openapi":"post /Proposta/IncluirAssinaturaCCB","href":"/caas/referencias-de-api/assinaturas/39-eletronica"},{"title":"40 - Relogon","openapi":"post /Proposta/IncluirAssinaturaCCBFinalizada","href":"/caas/referencias-de-api/assinaturas/40-relogon"},{"title":"41 - Certificadora","openapi":"post /Proposta/IncluirDocumento","href":"/caas/referencias-de-api/assinaturas/41-certificadora"},{"title":"42 - Finalização de Proposta","openapi":"post /Proposta/Finalizar","href":"/caas/referencias-de-api/assinaturas/42-finalizacao-de-proposta"}]},{"group":"Desembolso","pages":[{"title":"43 - Liberação de Proposta","openapi":"post /Proposta/Liberar","href":"/caas/referencias-de-api/desembolso/43-liberacao-de-proposta"},{"title":"44 - Atualização de Conta Bancária","openapi":"post /Proposta/AtualizarContaPagamento","href":"/caas/referencias-de-api/desembolso/44-atualizacao-de-conta-bancaria"},{"title":"45 - Pagar","openapi":"post /Proposta/Pagar","href":"/caas/referencias-de-api/desembolso/45-pagar"},{"title":"46 - Atualização de Split","openapi":"post /Proposta/SalvarLancamento","href":"/caas/referencias-de-api/desembolso/46-atualizacao-de-split"}]}]},{"group":"Guias e Casos de Uso","pages":[{"title":"Capital de Giro com/sem Garantia","version":"Português","href":"/caas/casos-uso/capital-de-giro"},{"title":"Capital de Giro com/sem Garantia (Cessão BTG)","version":"Português","href":"/caas/casos-uso/capital-de-giro-btg"},{"title":"Crédito Direto ao Consumidor (CDC)","version":"Português","href":"/caas/casos-uso/cdc"},{"title":"Home Equity","version":"Português","href":"/caas/casos-uso/home-equity"},{"title":"Empréstimo Pessoal","version":"Português","href":"/caas/casos-uso/emprestimo-pessoal"},{"title":"Financiamento de Veículos","version":"Português","href":"/caas/casos-uso/financiamento-veiculo"},{"title":"Consignado","version":"Português","href":"/caas/casos-uso/consignado-legacy"}]}]},{"tab":"Bureaus","pages":[{"title":"Bureaus","href":"/bureau/sobre-o-Bureau"}]},{"tab":"FGTS","pages":[{"title":"FGTS","href":"/fgts/sobre-o-fgts"}]},{"tab":"Gestão de Contratos","pages":[{"title":"Gestão de Contratos","href":"/gestao-contratos/sobre-gestao-contratos"}]},{"tab":"E-Consignado","pages":[{"title":"E-Consignado","href":"/e-consignado/sobre-o-e-consignado-trabalhador"}]},{"tab":"Banco do Futuro","pages":[{"title":"Banco do Futuro","href":"/banco-do-futuro/sobre-o-banco-do-futuro"}]},{"tab":"Portais BMP","pages":[{"title":"Portais BMP","href":"/portais-bmp/sobre-os-portais-bmp"}]},{"tab":"Materiais Complementares","pages":[{"title":"Materiais Complementares","href":"/materiais-complementares/materiais-complementares"}]},{"tab":"Atualizações","pages":[{"title":"Atualizações","href":"/atualizacoes/comunicados"}]}]},{"anchor":"Entre em contato","icon":"envelope","href":"https://moneyp.com.br/contato"},{"anchor":"Coleção do Postman","icon":"code","href":"https://www.postman.com/bmp-docs/bmp-docs"}]},{"language":"en","pages":[{"title":"en","href":"/homepage/english-homepage/about-us"}]}]},"basePath":"","title":"12 - Consultar Documento - BMP","buildId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","deploymentId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C8RPHPxo.js","utils-0BK-9q6z.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DfjzsUJT.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B4v9psJ4.js","snippetPresets-CpTQv-Ez.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-BNP-Fvr0.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BSgu6h1D.js","shallow-Biv1i9Gs.js","getApiPlaygroundDisplay-BoGOXhtF.js","CodeSnippet-DvQoT18_.js","CodeSnippets-Dnpa15xT.js","Page-Buji1S4J.js","getPastedJson-xAIyhUFE.js","icon-S6FBih11.js","MethodPill-SaYeUZyk.js","DuplicateIcon-Cs-p3v2Q.js","createIcon-DjCFEoHq.js","DynamicMarkdown-BcnBltEQ.js","SectionHeading-BUBl0eEF.js","axios-vUo_bRtp.js","Markdown-h4cOoD8d.js","clsx-B2v50t8t.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DJnKvr0g.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BHrrjR1K.js"]}