Por meio deste endpoint o parceiro inclui ou atualiza registros de endereços de um cliente específico.
Para que ocorra uma atualização, é necessário o envio do campo código, preenchido com o código do registro na base da BMP, ou então a busca será através do campo CEP
A tabela abaixo representa as mensagens de erro que podem ser retornadas ao tentar realizar uma requisição.
Mostrar Mensagens de requisições com erro
O retorno de uma requisição com status HTTP 400 (Bad Request) pode incluir as seguintes mensagens de erro:
No exemplo de retorno ao lado, o campo code representa a coluna Código desta tabela; o campo context representa a coluna Código Detalhado; e o campo message representa a coluna Mensagem.
Categoria
Operação
Ação
Código
Código Detalhado
Mensagem
Pessoa
CreateUpdatePessoaEnderecos
SalvarEnderecos
C0108
V0001
Documento Federal deve ser informado
Pessoa
CreateUpdatePessoaEnderecos
SalvarEnderecos
C0108
V0002
Cliente não encontrado com o documento {documentoCliente}
Pessoa
CreateUpdatePessoaEnderecos
SalvarEnderecos
C0108
V0003
Cliente não cadastrado pelo parceiro de integração
{"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/17-salvar-enderecos","slug":"/caas/referencias-de-api/onboarding/17-salvar-enderecos","pageMetadata":{"title":"17 - Salvar Endereços","openapi":"post /Pessoa/SalvarEnderecos","version":"Português","description":null,"href":"/caas/referencias-de-api/onboarding/17-salvar-enderecos"},"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={code:`code`,p:`p`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{Expandable,Heading,Note,Table}=_components;if(!Expandable)_missingMdxReference(`Expandable`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Por meio deste endpoint o parceiro inclui ou atualiza registros de endereços de um cliente específico.\nPara que ocorra uma atualização, é necessário o envio do campo código, preenchido com o código do registro na base da BMP, ou então a busca será através do campo CEP`}),`\n`,_jsx(Heading,{level:`1`,id:`tabela-de-códigos-auxiliares`,children:`Tabela de códigos auxiliares`}),`\n`,_jsx(Expandable,{title:`Tabela TipoEndereco`,children:_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`ID`}),_jsx(_components.th,{children:`Descrição`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`1`}),_jsx(_components.td,{children:`Residencial`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`2`}),_jsx(_components.td,{children:`Comercial`})]})]})]})}),`\n`,_jsx(Expandable,{title:` Tabela TipoResidencia`,children:_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`ID`}),_jsx(_components.th,{children:`Descrição`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`1`}),_jsx(_components.td,{children:`Alugado`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`2`}),_jsx(_components.td,{children:`Próprio`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`3`}),_jsx(_components.td,{children:`Financiado`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`4`}),_jsx(_components.td,{children:`Casa Funcional`})]})]})]})}),`\n`,_jsx(Heading,{level:`2`,id:`mensagens-de-erro`,children:`Mensagens de erro`}),`\n`,_jsx(_components.p,{children:`A tabela abaixo representa as mensagens de erro que podem ser retornadas ao tentar realizar uma requisição.`}),`\n`,_jsxs(Expandable,{title:`Mensagens de requisições com erro`,children:[_jsx(_components.p,{children:`O retorno de uma requisição com status HTTP 400 (Bad Request) pode incluir as seguintes mensagens de erro:`}),_jsxs(Note,{children:[`No exemplo de retorno ao lado, o campo `,_jsx(_components.code,{children:`code`}),` representa a coluna `,_jsx(_components.strong,{children:`Código`}),` desta tabela; o campo `,_jsx(_components.code,{children:`context`}),` representa a coluna `,_jsx(_components.strong,{children:`Código Detalhado`}),`; e o campo `,_jsx(_components.code,{children:`message`}),` representa a coluna `,_jsx(_components.strong,{children:`Mensagem`}),`.`]}),_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Categoria`}),_jsx(_components.th,{children:`Operação`}),_jsx(_components.th,{children:`Ação`}),_jsx(_components.th,{children:`Código`}),_jsx(_components.th,{children:`Código Detalhado`}),_jsx(_components.th,{children:`Mensagem`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Pessoa`}),_jsx(_components.td,{children:`CreateUpdatePessoaEnderecos`}),_jsx(_components.td,{children:`SalvarEnderecos`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`C0108`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`V0001`}),_jsx(_components.td,{children:`Documento Federal deve ser informado`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Pessoa`}),_jsx(_components.td,{children:`CreateUpdatePessoaEnderecos`}),_jsx(_components.td,{children:`SalvarEnderecos`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`C0108`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`V0002`}),_jsxs(_components.td,{children:[`Cliente não encontrado com o documento `,_jsx(_components.code,{children:`{documentoCliente}`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Pessoa`}),_jsx(_components.td,{children:`CreateUpdatePessoaEnderecos`}),_jsx(_components.td,{children:`SalvarEnderecos`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`C0108`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`V0003`}),_jsx(_components.td,{children:`Cliente não cadastrado pelo parceiro de integração`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Pessoa`}),_jsx(_components.td,{children:`CreateUpdatePessoaEnderecos`}),_jsx(_components.td,{children:`SalvarEnderecos`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`T0608`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`D0001`}),_jsx(_components.td,{children:`Informe o CEP`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Pessoa`}),_jsx(_components.td,{children:`CreateUpdatePessoaEnderecos`}),_jsx(_components.td,{children:`SalvarEnderecos`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`T0608`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`D0002`}),_jsx(_components.td,{children:`CEP inválido`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Pessoa`}),_jsx(_components.td,{children:`CreateUpdatePessoaEnderecos`}),_jsx(_components.td,{children:`SalvarEnderecos`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`T0608`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`D0003`}),_jsx(_components.td,{children:`Informe o Logradouro`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Pessoa`}),_jsx(_components.td,{children:`CreateUpdatePessoaEnderecos`}),_jsx(_components.td,{children:`SalvarEnderecos`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`T0608`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`D0004`}),_jsx(_components.td,{children:`Informe a Cidade`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Pessoa`}),_jsx(_components.td,{children:`CreateUpdatePessoaEnderecos`}),_jsx(_components.td,{children:`SalvarEnderecos`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`T0608`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`D0005`}),_jsx(_components.td,{children:`Informe o Estado`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Pessoa`}),_jsx(_components.td,{children:`CreateUpdatePessoaEnderecos`}),_jsx(_components.td,{children:`SalvarEnderecos`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`T0608`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`D0006`}),_jsx(_components.td,{children:`Informe o Tipo de Imóvel`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Pessoa`}),_jsx(_components.td,{children:`CreateUpdatePessoaEnderecos`}),_jsx(_components.td,{children:`SalvarEnderecos`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`T0608`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`D0007`}),_jsx(_components.td,{children:`Informe o Tipo de Endereço`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Pessoa`}),_jsx(_components.td,{children:`CreateUpdatePessoaEnderecos`}),_jsx(_components.td,{children:`SalvarEnderecos`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`T0608`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`D0008`}),_jsx(_components.td,{children:`Informe o tempo em que está situado no endereço`})]})]})]})]})]})}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":"17 - Salvar Endereços","openapi":"post /Pessoa/SalvarEnderecos","version":"Português","description":null,"href":"/caas/referencias-de-api/onboarding/17-salvar-enderecos"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Tabela de códigos auxiliares","slug":"tabela-de-códigos-auxiliares","depth":1,"children":[]},{"title":"Mensagens de erro","slug":"mensagens-de-erro","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Pessoa"],"parameters":["b8e6ebd4-bd17-41a7-93a1-30459b95b482"],"requestBody":"08d2b112-2aab-439a-87b6-337b83bf4698","responses":{"200":"bb0f0bf9-86fd-475a-930c-3a702376f69a","400":"fca24a77-40dd-4517-96a6-da1fb63e07c1"},"method":"post","type":"path","servers":["78eb12ed-a3ba-4385-8013-656fdd44c524"],"security":["50061105-00dd-46fa-b46e-5a0cf1dc9c9e"],"path":"/Pessoa/SalvarEnderecos","baseUrlOptions":["https://api.bmpdigital.moneyp.dev.br/"],"title":"","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"b8e6ebd4-bd17-41a7-93a1-30459b95b482":{"name":"IdempotencyKey","in":"header","required":true,"schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"param":{"required":["documentoCliente"],"type":"object","properties":{"documentoCliente":{"oneOf":[{"maxLength":20,"minLength":0,"type":"string","description":"Documento federal do cliente","isRequired":true,"uniqueKey":"param.documentoCliente.oneOf.0","typeLabel":"string"},{"maxLength":20,"minLength":0,"type":"null","description":"Documento federal do cliente","isRequired":true,"uniqueKey":"param.documentoCliente.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"param.documentoCliente","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"param","typeLabel":"object"},"dtos":{"oneOf":[{"type":"array","items":{"required":["cep","cidade","logradouro","tipoEndereco","tipoResidencia","uf"],"type":"object","properties":{"cep":{"oneOf":[{"maximum":8,"minimum":0,"type":"string","description":"Código de endereçamento postal (CEP)","isRequired":true,"uniqueKey":"dtos.oneOf.0.items.[INDEX].cep.oneOf.0","typeLabel":"string"},{"maximum":8,"minimum":0,"type":"null","description":"Código de endereçamento postal (CEP)","isRequired":true,"uniqueKey":"dtos.oneOf.0.items.[INDEX].cep.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"dtos.oneOf.0.items.[INDEX].cep","typeLabel":"string | null"},"logradouro":{"oneOf":[{"type":"string","description":"Logradouro","isRequired":true,"uniqueKey":"dtos.oneOf.0.items.[INDEX].logradouro.oneOf.0","typeLabel":"string"},{"type":"null","description":"Logradouro","isRequired":true,"uniqueKey":"dtos.oneOf.0.items.[INDEX].logradouro.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"dtos.oneOf.0.items.[INDEX].logradouro","typeLabel":"string | null"},"cidade":{"oneOf":[{"type":"string","description":"Cidade","isRequired":true,"uniqueKey":"dtos.oneOf.0.items.[INDEX].cidade.oneOf.0","typeLabel":"string"},{"type":"null","description":"Cidade","isRequired":true,"uniqueKey":"dtos.oneOf.0.items.[INDEX].cidade.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"dtos.oneOf.0.items.[INDEX].cidade","typeLabel":"string | null"},"uf":{"oneOf":[{"type":"string","description":"Unidade Federal (UF). Exemplo: SC (Sigla de Santa Catarina)","isRequired":true,"uniqueKey":"dtos.oneOf.0.items.[INDEX].uf.oneOf.0","typeLabel":"string"},{"type":"null","description":"Unidade Federal (UF). Exemplo: SC (Sigla de Santa Catarina)","isRequired":true,"uniqueKey":"dtos.oneOf.0.items.[INDEX].uf.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"dtos.oneOf.0.items.[INDEX].uf","typeLabel":"string | null"},"tipoEndereco":{"oneOf":[{"type":"integer","description":"Consultar tabela Tipo de Endereço","format":"int32","isRequired":true,"uniqueKey":"dtos.oneOf.0.items.[INDEX].tipoEndereco.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","description":"Consultar tabela Tipo de Endereço","format":"int32","isRequired":true,"uniqueKey":"dtos.oneOf.0.items.[INDEX].tipoEndereco.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"dtos.oneOf.0.items.[INDEX].tipoEndereco","typeLabel":"integer\u003cint32> | null"},"tipoResidencia":{"oneOf":[{"type":"integer","description":"Consultar tabela Tipo de residência","format":"int32","isRequired":true,"uniqueKey":"dtos.oneOf.0.items.[INDEX].tipoResidencia.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","description":"Consultar tabela Tipo de residência","format":"int32","isRequired":true,"uniqueKey":"dtos.oneOf.0.items.[INDEX].tipoResidencia.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"dtos.oneOf.0.items.[INDEX].tipoResidencia","typeLabel":"integer\u003cint32> | null"},"codigo":{"oneOf":[{"type":"string","description":"Será preenchido apenas pelo método SelectPessoa","uniqueKey":"dtos.oneOf.0.items.[INDEX].codigo.oneOf.0","typeLabel":"string"},{"type":"null","description":"Será preenchido apenas pelo método SelectPessoa","uniqueKey":"dtos.oneOf.0.items.[INDEX].codigo.oneOf.1","typeLabel":"null"}],"uniqueKey":"dtos.oneOf.0.items.[INDEX].codigo","typeLabel":"string | null"},"nroLogradouro":{"oneOf":[{"type":"string","description":"Número do Logradouro","uniqueKey":"dtos.oneOf.0.items.[INDEX].nroLogradouro.oneOf.0","typeLabel":"string"},{"type":"null","description":"Número do Logradouro","uniqueKey":"dtos.oneOf.0.items.[INDEX].nroLogradouro.oneOf.1","typeLabel":"null"}],"uniqueKey":"dtos.oneOf.0.items.[INDEX].nroLogradouro","typeLabel":"string | null"},"bairro":{"oneOf":[{"type":"string","description":"Bairro","uniqueKey":"dtos.oneOf.0.items.[INDEX].bairro.oneOf.0","typeLabel":"string"},{"type":"null","description":"Bairro","uniqueKey":"dtos.oneOf.0.items.[INDEX].bairro.oneOf.1","typeLabel":"null"}],"uniqueKey":"dtos.oneOf.0.items.[INDEX].bairro","typeLabel":"string | null"},"complemento":{"oneOf":[{"type":"string","description":"Complemento","uniqueKey":"dtos.oneOf.0.items.[INDEX].complemento.oneOf.0","typeLabel":"string"},{"type":"null","description":"Complemento","uniqueKey":"dtos.oneOf.0.items.[INDEX].complemento.oneOf.1","typeLabel":"null"}],"uniqueKey":"dtos.oneOf.0.items.[INDEX].complemento","typeLabel":"string | null"},"enderecoDesde":{"oneOf":[{"type":"string","description":"Data de início no endereço","format":"date-time","uniqueKey":"dtos.oneOf.0.items.[INDEX].enderecoDesde.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"Data de início no endereço","format":"date-time","uniqueKey":"dtos.oneOf.0.items.[INDEX].enderecoDesde.oneOf.1","typeLabel":"null"}],"uniqueKey":"dtos.oneOf.0.items.[INDEX].enderecoDesde","typeLabel":"string\u003cdate-time> | null"},"enderecoPrincipal":{"oneOf":[{"type":"boolean","description":"Indica se é o endereço principal","uniqueKey":"dtos.oneOf.0.items.[INDEX].enderecoPrincipal.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Indica se é o endereço principal","uniqueKey":"dtos.oneOf.0.items.[INDEX].enderecoPrincipal.oneOf.1","typeLabel":"null"}],"uniqueKey":"dtos.oneOf.0.items.[INDEX].enderecoPrincipal","typeLabel":"boolean | null"},"enderecoCorrespondencia":{"oneOf":[{"type":"boolean","description":"Indica se é o endereço que recebe correspondências","uniqueKey":"dtos.oneOf.0.items.[INDEX].enderecoCorrespondencia.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Indica se é o endereço que recebe correspondências","uniqueKey":"dtos.oneOf.0.items.[INDEX].enderecoCorrespondencia.oneOf.1","typeLabel":"null"}],"uniqueKey":"dtos.oneOf.0.items.[INDEX].enderecoCorrespondencia","typeLabel":"boolean | null"}},"additionalProperties":false,"uniqueKey":"dtos.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"dtos.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"required":["cep","cidade","logradouro","tipoEndereco","tipoResidencia","uf"],"type":"object","properties":{"codigo":{"oneOf":[{"type":"string","description":"Será preenchido apenas pelo método SelectPessoa"},{"type":"null","description":"Será preenchido apenas pelo método SelectPessoa"}]},"cep":{"oneOf":[{"maximum":8,"minimum":0,"type":"string","description":"Código de endereçamento postal (CEP)"},{"maximum":8,"minimum":0,"type":"null","description":"Código de endereçamento postal (CEP)"}]},"logradouro":{"oneOf":[{"type":"string","description":"Logradouro"},{"type":"null","description":"Logradouro"}]},"nroLogradouro":{"oneOf":[{"type":"string","description":"Número do Logradouro"},{"type":"null","description":"Número do Logradouro"}]},"bairro":{"oneOf":[{"type":"string","description":"Bairro"},{"type":"null","description":"Bairro"}]},"complemento":{"oneOf":[{"type":"string","description":"Complemento"},{"type":"null","description":"Complemento"}]},"cidade":{"oneOf":[{"type":"string","description":"Cidade"},{"type":"null","description":"Cidade"}]},"uf":{"oneOf":[{"type":"string","description":"Unidade Federal (UF). Exemplo: SC (Sigla de Santa Catarina)"},{"type":"null","description":"Unidade Federal (UF). Exemplo: SC (Sigla de Santa Catarina)"}]},"tipoEndereco":{"oneOf":[{"type":"integer","description":"Consultar tabela Tipo de Endereço","format":"int32"},{"type":"null","description":"Consultar tabela Tipo de Endereço","format":"int32"}]},"tipoResidencia":{"oneOf":[{"type":"integer","description":"Consultar tabela Tipo de residência","format":"int32"},{"type":"null","description":"Consultar tabela Tipo de residência","format":"int32"}]},"enderecoDesde":{"oneOf":[{"type":"string","description":"Data de início no endereço","format":"date-time"},{"type":"null","description":"Data de início no endereço","format":"date-time"}]},"enderecoPrincipal":{"oneOf":[{"type":"boolean","description":"Indica se é o endereço principal"},{"type":"null","description":"Indica se é o endereço principal"}]},"enderecoCorrespondencia":{"oneOf":[{"type":"boolean","description":"Indica se é o endereço que recebe correspondências"},{"type":"null","description":"Indica se é o endereço que recebe correspondências"}]}},"additionalProperties":false},"uniqueKey":"dtos.oneOf.1","typeLabel":"null"}],"uniqueKey":"dtos","typeLabel":"object[] | null"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"dtos":[{"cep":"\u003cstring>","logradouro":"\u003cstring>","cidade":"\u003cstring>","uf":"\u003cstring>","tipoEndereco":123,"tipoResidencia":123,"codigo":"\u003cstring>","nroLogradouro":"\u003cstring>","bairro":"\u003cstring>","complemento":"\u003cstring>","enderecoDesde":"2023-11-07T05:31:56Z","enderecoPrincipal":true,"enderecoCorrespondencia":true}]}}},"exampleType":"generated"},"text/json":{"schema":{"type":"object","properties":{"param":{"required":["documentoCliente"],"type":"object","properties":{"documentoCliente":{"oneOf":[{"maxLength":20,"minLength":0,"type":"string","description":"Documento federal do cliente","isRequired":true,"uniqueKey":"param.documentoCliente.oneOf.0","typeLabel":"string"},{"maxLength":20,"minLength":0,"type":"null","description":"Documento federal do cliente","isRequired":true,"uniqueKey":"param.documentoCliente.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"param.documentoCliente","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"param","typeLabel":"object"},"dtos":{"oneOf":[{"type":"array","items":{"required":["cep","cidade","logradouro","tipoEndereco","tipoResidencia","uf"],"type":"object","properties":{"cep":{"oneOf":[{"maximum":8,"minimum":0,"type":"string","description":"Código de endereçamento postal (CEP)","isRequired":true,"uniqueKey":"dtos.oneOf.0.items.[INDEX].cep.oneOf.0","typeLabel":"string"},{"maximum":8,"minimum":0,"type":"null","description":"Código de endereçamento postal (CEP)","isRequired":true,"uniqueKey":"dtos.oneOf.0.items.[INDEX].cep.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"dtos.oneOf.0.items.[INDEX].cep","typeLabel":"string | null"},"logradouro":{"oneOf":[{"type":"string","description":"Logradouro","isRequired":true,"uniqueKey":"dtos.oneOf.0.items.[INDEX].logradouro.oneOf.0","typeLabel":"string"},{"type":"null","description":"Logradouro","isRequired":true,"uniqueKey":"dtos.oneOf.0.items.[INDEX].logradouro.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"dtos.oneOf.0.items.[INDEX].logradouro","typeLabel":"string | null"},"cidade":{"oneOf":[{"type":"string","description":"Cidade","isRequired":true,"uniqueKey":"dtos.oneOf.0.items.[INDEX].cidade.oneOf.0","typeLabel":"string"},{"type":"null","description":"Cidade","isRequired":true,"uniqueKey":"dtos.oneOf.0.items.[INDEX].cidade.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"dtos.oneOf.0.items.[INDEX].cidade","typeLabel":"string | null"},"uf":{"oneOf":[{"type":"string","description":"Unidade Federal (UF). Exemplo: SC (Sigla de Santa Catarina)","isRequired":true,"uniqueKey":"dtos.oneOf.0.items.[INDEX].uf.oneOf.0","typeLabel":"string"},{"type":"null","description":"Unidade Federal (UF). Exemplo: SC (Sigla de Santa Catarina)","isRequired":true,"uniqueKey":"dtos.oneOf.0.items.[INDEX].uf.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"dtos.oneOf.0.items.[INDEX].uf","typeLabel":"string | null"},"tipoEndereco":{"oneOf":[{"type":"integer","description":"Consultar tabela Tipo de Endereço","format":"int32","isRequired":true,"uniqueKey":"dtos.oneOf.0.items.[INDEX].tipoEndereco.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","description":"Consultar tabela Tipo de Endereço","format":"int32","isRequired":true,"uniqueKey":"dtos.oneOf.0.items.[INDEX].tipoEndereco.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"dtos.oneOf.0.items.[INDEX].tipoEndereco","typeLabel":"integer\u003cint32> | null"},"tipoResidencia":{"oneOf":[{"type":"integer","description":"Consultar tabela Tipo de residência","format":"int32","isRequired":true,"uniqueKey":"dtos.oneOf.0.items.[INDEX].tipoResidencia.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","description":"Consultar tabela Tipo de residência","format":"int32","isRequired":true,"uniqueKey":"dtos.oneOf.0.items.[INDEX].tipoResidencia.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"dtos.oneOf.0.items.[INDEX].tipoResidencia","typeLabel":"integer\u003cint32> | null"},"codigo":{"oneOf":[{"type":"string","description":"Será preenchido apenas pelo método SelectPessoa","uniqueKey":"dtos.oneOf.0.items.[INDEX].codigo.oneOf.0","typeLabel":"string"},{"type":"null","description":"Será preenchido apenas pelo método SelectPessoa","uniqueKey":"dtos.oneOf.0.items.[INDEX].codigo.oneOf.1","typeLabel":"null"}],"uniqueKey":"dtos.oneOf.0.items.[INDEX].codigo","typeLabel":"string | null"},"nroLogradouro":{"oneOf":[{"type":"string","description":"Número do Logradouro","uniqueKey":"dtos.oneOf.0.items.[INDEX].nroLogradouro.oneOf.0","typeLabel":"string"},{"type":"null","description":"Número do Logradouro","uniqueKey":"dtos.oneOf.0.items.[INDEX].nroLogradouro.oneOf.1","typeLabel":"null"}],"uniqueKey":"dtos.oneOf.0.items.[INDEX].nroLogradouro","typeLabel":"string | null"},"bairro":{"oneOf":[{"type":"string","description":"Bairro","uniqueKey":"dtos.oneOf.0.items.[INDEX].bairro.oneOf.0","typeLabel":"string"},{"type":"null","description":"Bairro","uniqueKey":"dtos.oneOf.0.items.[INDEX].bairro.oneOf.1","typeLabel":"null"}],"uniqueKey":"dtos.oneOf.0.items.[INDEX].bairro","typeLabel":"string | null"},"complemento":{"oneOf":[{"type":"string","description":"Complemento","uniqueKey":"dtos.oneOf.0.items.[INDEX].complemento.oneOf.0","typeLabel":"string"},{"type":"null","description":"Complemento","uniqueKey":"dtos.oneOf.0.items.[INDEX].complemento.oneOf.1","typeLabel":"null"}],"uniqueKey":"dtos.oneOf.0.items.[INDEX].complemento","typeLabel":"string | null"},"enderecoDesde":{"oneOf":[{"type":"string","description":"Data de início no endereço","format":"date-time","uniqueKey":"dtos.oneOf.0.items.[INDEX].enderecoDesde.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"Data de início no endereço","format":"date-time","uniqueKey":"dtos.oneOf.0.items.[INDEX].enderecoDesde.oneOf.1","typeLabel":"null"}],"uniqueKey":"dtos.oneOf.0.items.[INDEX].enderecoDesde","typeLabel":"string\u003cdate-time> | null"},"enderecoPrincipal":{"oneOf":[{"type":"boolean","description":"Indica se é o endereço principal","uniqueKey":"dtos.oneOf.0.items.[INDEX].enderecoPrincipal.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Indica se é o endereço principal","uniqueKey":"dtos.oneOf.0.items.[INDEX].enderecoPrincipal.oneOf.1","typeLabel":"null"}],"uniqueKey":"dtos.oneOf.0.items.[INDEX].enderecoPrincipal","typeLabel":"boolean | null"},"enderecoCorrespondencia":{"oneOf":[{"type":"boolean","description":"Indica se é o endereço que recebe correspondências","uniqueKey":"dtos.oneOf.0.items.[INDEX].enderecoCorrespondencia.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Indica se é o endereço que recebe correspondências","uniqueKey":"dtos.oneOf.0.items.[INDEX].enderecoCorrespondencia.oneOf.1","typeLabel":"null"}],"uniqueKey":"dtos.oneOf.0.items.[INDEX].enderecoCorrespondencia","typeLabel":"boolean | null"}},"additionalProperties":false,"uniqueKey":"dtos.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"dtos.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"required":["cep","cidade","logradouro","tipoEndereco","tipoResidencia","uf"],"type":"object","properties":{"codigo":{"oneOf":[{"type":"string","description":"Será preenchido apenas pelo método SelectPessoa"},{"type":"null","description":"Será preenchido apenas pelo método SelectPessoa"}]},"cep":{"oneOf":[{"maximum":8,"minimum":0,"type":"string","description":"Código de endereçamento postal (CEP)"},{"maximum":8,"minimum":0,"type":"null","description":"Código de endereçamento postal (CEP)"}]},"logradouro":{"oneOf":[{"type":"string","description":"Logradouro"},{"type":"null","description":"Logradouro"}]},"nroLogradouro":{"oneOf":[{"type":"string","description":"Número do Logradouro"},{"type":"null","description":"Número do Logradouro"}]},"bairro":{"oneOf":[{"type":"string","description":"Bairro"},{"type":"null","description":"Bairro"}]},"complemento":{"oneOf":[{"type":"string","description":"Complemento"},{"type":"null","description":"Complemento"}]},"cidade":{"oneOf":[{"type":"string","description":"Cidade"},{"type":"null","description":"Cidade"}]},"uf":{"oneOf":[{"type":"string","description":"Unidade Federal (UF). Exemplo: SC (Sigla de Santa Catarina)"},{"type":"null","description":"Unidade Federal (UF). Exemplo: SC (Sigla de Santa Catarina)"}]},"tipoEndereco":{"oneOf":[{"type":"integer","description":"Consultar tabela Tipo de Endereço","format":"int32"},{"type":"null","description":"Consultar tabela Tipo de Endereço","format":"int32"}]},"tipoResidencia":{"oneOf":[{"type":"integer","description":"Consultar tabela Tipo de residência","format":"int32"},{"type":"null","description":"Consultar tabela Tipo de residência","format":"int32"}]},"enderecoDesde":{"oneOf":[{"type":"string","description":"Data de início no endereço","format":"date-time"},{"type":"null","description":"Data de início no endereço","format":"date-time"}]},"enderecoPrincipal":{"oneOf":[{"type":"boolean","description":"Indica se é o endereço principal"},{"type":"null","description":"Indica se é o endereço principal"}]},"enderecoCorrespondencia":{"oneOf":[{"type":"boolean","description":"Indica se é o endereço que recebe correspondências"},{"type":"null","description":"Indica se é o endereço que recebe correspondências"}]}},"additionalProperties":false},"uniqueKey":"dtos.oneOf.1","typeLabel":"null"}],"uniqueKey":"dtos","typeLabel":"object[] | null"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"dtos":[{"cep":"\u003cstring>","logradouro":"\u003cstring>","cidade":"\u003cstring>","uf":"\u003cstring>","tipoEndereco":123,"tipoResidencia":123,"codigo":"\u003cstring>","nroLogradouro":"\u003cstring>","bairro":"\u003cstring>","complemento":"\u003cstring>","enderecoDesde":"2023-11-07T05:31:56Z","enderecoPrincipal":true,"enderecoCorrespondencia":true}]}}},"exampleType":"generated"},"application/*+json":{"schema":{"type":"object","properties":{"param":{"required":["documentoCliente"],"type":"object","properties":{"documentoCliente":{"oneOf":[{"maxLength":20,"minLength":0,"type":"string","description":"Documento federal do cliente","isRequired":true,"uniqueKey":"param.documentoCliente.oneOf.0","typeLabel":"string"},{"maxLength":20,"minLength":0,"type":"null","description":"Documento federal do cliente","isRequired":true,"uniqueKey":"param.documentoCliente.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"param.documentoCliente","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"param","typeLabel":"object"},"dtos":{"oneOf":[{"type":"array","items":{"required":["cep","cidade","logradouro","tipoEndereco","tipoResidencia","uf"],"type":"object","properties":{"cep":{"oneOf":[{"maximum":8,"minimum":0,"type":"string","description":"Código de endereçamento postal (CEP)","isRequired":true,"uniqueKey":"dtos.oneOf.0.items.[INDEX].cep.oneOf.0","typeLabel":"string"},{"maximum":8,"minimum":0,"type":"null","description":"Código de endereçamento postal (CEP)","isRequired":true,"uniqueKey":"dtos.oneOf.0.items.[INDEX].cep.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"dtos.oneOf.0.items.[INDEX].cep","typeLabel":"string | null"},"logradouro":{"oneOf":[{"type":"string","description":"Logradouro","isRequired":true,"uniqueKey":"dtos.oneOf.0.items.[INDEX].logradouro.oneOf.0","typeLabel":"string"},{"type":"null","description":"Logradouro","isRequired":true,"uniqueKey":"dtos.oneOf.0.items.[INDEX].logradouro.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"dtos.oneOf.0.items.[INDEX].logradouro","typeLabel":"string | null"},"cidade":{"oneOf":[{"type":"string","description":"Cidade","isRequired":true,"uniqueKey":"dtos.oneOf.0.items.[INDEX].cidade.oneOf.0","typeLabel":"string"},{"type":"null","description":"Cidade","isRequired":true,"uniqueKey":"dtos.oneOf.0.items.[INDEX].cidade.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"dtos.oneOf.0.items.[INDEX].cidade","typeLabel":"string | null"},"uf":{"oneOf":[{"type":"string","description":"Unidade Federal (UF). Exemplo: SC (Sigla de Santa Catarina)","isRequired":true,"uniqueKey":"dtos.oneOf.0.items.[INDEX].uf.oneOf.0","typeLabel":"string"},{"type":"null","description":"Unidade Federal (UF). Exemplo: SC (Sigla de Santa Catarina)","isRequired":true,"uniqueKey":"dtos.oneOf.0.items.[INDEX].uf.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"dtos.oneOf.0.items.[INDEX].uf","typeLabel":"string | null"},"tipoEndereco":{"oneOf":[{"type":"integer","description":"Consultar tabela Tipo de Endereço","format":"int32","isRequired":true,"uniqueKey":"dtos.oneOf.0.items.[INDEX].tipoEndereco.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","description":"Consultar tabela Tipo de Endereço","format":"int32","isRequired":true,"uniqueKey":"dtos.oneOf.0.items.[INDEX].tipoEndereco.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"dtos.oneOf.0.items.[INDEX].tipoEndereco","typeLabel":"integer\u003cint32> | null"},"tipoResidencia":{"oneOf":[{"type":"integer","description":"Consultar tabela Tipo de residência","format":"int32","isRequired":true,"uniqueKey":"dtos.oneOf.0.items.[INDEX].tipoResidencia.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","description":"Consultar tabela Tipo de residência","format":"int32","isRequired":true,"uniqueKey":"dtos.oneOf.0.items.[INDEX].tipoResidencia.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"dtos.oneOf.0.items.[INDEX].tipoResidencia","typeLabel":"integer\u003cint32> | null"},"codigo":{"oneOf":[{"type":"string","description":"Será preenchido apenas pelo método SelectPessoa","uniqueKey":"dtos.oneOf.0.items.[INDEX].codigo.oneOf.0","typeLabel":"string"},{"type":"null","description":"Será preenchido apenas pelo método SelectPessoa","uniqueKey":"dtos.oneOf.0.items.[INDEX].codigo.oneOf.1","typeLabel":"null"}],"uniqueKey":"dtos.oneOf.0.items.[INDEX].codigo","typeLabel":"string | null"},"nroLogradouro":{"oneOf":[{"type":"string","description":"Número do Logradouro","uniqueKey":"dtos.oneOf.0.items.[INDEX].nroLogradouro.oneOf.0","typeLabel":"string"},{"type":"null","description":"Número do Logradouro","uniqueKey":"dtos.oneOf.0.items.[INDEX].nroLogradouro.oneOf.1","typeLabel":"null"}],"uniqueKey":"dtos.oneOf.0.items.[INDEX].nroLogradouro","typeLabel":"string | null"},"bairro":{"oneOf":[{"type":"string","description":"Bairro","uniqueKey":"dtos.oneOf.0.items.[INDEX].bairro.oneOf.0","typeLabel":"string"},{"type":"null","description":"Bairro","uniqueKey":"dtos.oneOf.0.items.[INDEX].bairro.oneOf.1","typeLabel":"null"}],"uniqueKey":"dtos.oneOf.0.items.[INDEX].bairro","typeLabel":"string | null"},"complemento":{"oneOf":[{"type":"string","description":"Complemento","uniqueKey":"dtos.oneOf.0.items.[INDEX].complemento.oneOf.0","typeLabel":"string"},{"type":"null","description":"Complemento","uniqueKey":"dtos.oneOf.0.items.[INDEX].complemento.oneOf.1","typeLabel":"null"}],"uniqueKey":"dtos.oneOf.0.items.[INDEX].complemento","typeLabel":"string | null"},"enderecoDesde":{"oneOf":[{"type":"string","description":"Data de início no endereço","format":"date-time","uniqueKey":"dtos.oneOf.0.items.[INDEX].enderecoDesde.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"Data de início no endereço","format":"date-time","uniqueKey":"dtos.oneOf.0.items.[INDEX].enderecoDesde.oneOf.1","typeLabel":"null"}],"uniqueKey":"dtos.oneOf.0.items.[INDEX].enderecoDesde","typeLabel":"string\u003cdate-time> | null"},"enderecoPrincipal":{"oneOf":[{"type":"boolean","description":"Indica se é o endereço principal","uniqueKey":"dtos.oneOf.0.items.[INDEX].enderecoPrincipal.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Indica se é o endereço principal","uniqueKey":"dtos.oneOf.0.items.[INDEX].enderecoPrincipal.oneOf.1","typeLabel":"null"}],"uniqueKey":"dtos.oneOf.0.items.[INDEX].enderecoPrincipal","typeLabel":"boolean | null"},"enderecoCorrespondencia":{"oneOf":[{"type":"boolean","description":"Indica se é o endereço que recebe correspondências","uniqueKey":"dtos.oneOf.0.items.[INDEX].enderecoCorrespondencia.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Indica se é o endereço que recebe correspondências","uniqueKey":"dtos.oneOf.0.items.[INDEX].enderecoCorrespondencia.oneOf.1","typeLabel":"null"}],"uniqueKey":"dtos.oneOf.0.items.[INDEX].enderecoCorrespondencia","typeLabel":"boolean | null"}},"additionalProperties":false,"uniqueKey":"dtos.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"dtos.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"required":["cep","cidade","logradouro","tipoEndereco","tipoResidencia","uf"],"type":"object","properties":{"codigo":{"oneOf":[{"type":"string","description":"Será preenchido apenas pelo método SelectPessoa"},{"type":"null","description":"Será preenchido apenas pelo método SelectPessoa"}]},"cep":{"oneOf":[{"maximum":8,"minimum":0,"type":"string","description":"Código de endereçamento postal (CEP)"},{"maximum":8,"minimum":0,"type":"null","description":"Código de endereçamento postal (CEP)"}]},"logradouro":{"oneOf":[{"type":"string","description":"Logradouro"},{"type":"null","description":"Logradouro"}]},"nroLogradouro":{"oneOf":[{"type":"string","description":"Número do Logradouro"},{"type":"null","description":"Número do Logradouro"}]},"bairro":{"oneOf":[{"type":"string","description":"Bairro"},{"type":"null","description":"Bairro"}]},"complemento":{"oneOf":[{"type":"string","description":"Complemento"},{"type":"null","description":"Complemento"}]},"cidade":{"oneOf":[{"type":"string","description":"Cidade"},{"type":"null","description":"Cidade"}]},"uf":{"oneOf":[{"type":"string","description":"Unidade Federal (UF). Exemplo: SC (Sigla de Santa Catarina)"},{"type":"null","description":"Unidade Federal (UF). Exemplo: SC (Sigla de Santa Catarina)"}]},"tipoEndereco":{"oneOf":[{"type":"integer","description":"Consultar tabela Tipo de Endereço","format":"int32"},{"type":"null","description":"Consultar tabela Tipo de Endereço","format":"int32"}]},"tipoResidencia":{"oneOf":[{"type":"integer","description":"Consultar tabela Tipo de residência","format":"int32"},{"type":"null","description":"Consultar tabela Tipo de residência","format":"int32"}]},"enderecoDesde":{"oneOf":[{"type":"string","description":"Data de início no endereço","format":"date-time"},{"type":"null","description":"Data de início no endereço","format":"date-time"}]},"enderecoPrincipal":{"oneOf":[{"type":"boolean","description":"Indica se é o endereço principal"},{"type":"null","description":"Indica se é o endereço principal"}]},"enderecoCorrespondencia":{"oneOf":[{"type":"boolean","description":"Indica se é o endereço que recebe correspondências"},{"type":"null","description":"Indica se é o endereço que recebe correspondências"}]}},"additionalProperties":false},"uniqueKey":"dtos.oneOf.1","typeLabel":"null"}],"uniqueKey":"dtos","typeLabel":"object[] | null"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"dtos":[{"cep":"\u003cstring>","logradouro":"\u003cstring>","cidade":"\u003cstring>","uf":"\u003cstring>","tipoEndereco":123,"tipoResidencia":123,"codigo":"\u003cstring>","nroLogradouro":"\u003cstring>","bairro":"\u003cstring>","complemento":"\u003cstring>","enderecoDesde":"2023-11-07T05:31:56Z","enderecoPrincipal":true,"enderecoCorrespondencia":true}]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"bb0f0bf9-86fd-475a-930c-3a702376f69a":{"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"},"results":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"msg":{"oneOf":[{"type":"string","uniqueKey":"results.oneOf.0.items.[INDEX].msg.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"results.oneOf.0.items.[INDEX].msg.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.oneOf.0.items.[INDEX].msg","typeLabel":"string | null"},"hasError":{"type":"boolean","uniqueKey":"results.oneOf.0.items.[INDEX].hasError","typeLabel":"boolean"},"messages":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"messageType":{"enum":[1,2,3],"type":"integer","format":"int32","uniqueKey":"results.oneOf.0.items.[INDEX].messages.oneOf.0.items.[INDEX].messageType","typeLabel":"enum\u003cinteger>"},"code":{"oneOf":[{"type":"string","uniqueKey":"results.oneOf.0.items.[INDEX].messages.oneOf.0.items.[INDEX].code.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"results.oneOf.0.items.[INDEX].messages.oneOf.0.items.[INDEX].code.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.oneOf.0.items.[INDEX].messages.oneOf.0.items.[INDEX].code","typeLabel":"string | null"},"context":{"oneOf":[{"type":"string","uniqueKey":"results.oneOf.0.items.[INDEX].messages.oneOf.0.items.[INDEX].context.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"results.oneOf.0.items.[INDEX].messages.oneOf.0.items.[INDEX].context.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.oneOf.0.items.[INDEX].messages.oneOf.0.items.[INDEX].context","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","uniqueKey":"results.oneOf.0.items.[INDEX].messages.oneOf.0.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"results.oneOf.0.items.[INDEX].messages.oneOf.0.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.oneOf.0.items.[INDEX].messages.oneOf.0.items.[INDEX].description","typeLabel":"string | null"},"field":{"oneOf":[{"type":"string","uniqueKey":"results.oneOf.0.items.[INDEX].messages.oneOf.0.items.[INDEX].field.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"results.oneOf.0.items.[INDEX].messages.oneOf.0.items.[INDEX].field.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.oneOf.0.items.[INDEX].messages.oneOf.0.items.[INDEX].field","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"results.oneOf.0.items.[INDEX].messages.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"results.oneOf.0.items.[INDEX].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":"results.oneOf.0.items.[INDEX].messages.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.oneOf.0.items.[INDEX].messages","typeLabel":"object[] | null"},"codigo":{"type":"string","format":"uuid","uniqueKey":"results.oneOf.0.items.[INDEX].codigo","typeLabel":"string\u003cuuid>"}},"additionalProperties":false,"uniqueKey":"results.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"results.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"msg":{"oneOf":[{"type":"string"},{"type":"null"}]},"hasError":{"type":"boolean"},"messages":{"oneOf":[{"type":"array","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}},{"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}}]},"codigo":{"type":"string","format":"uuid"}},"additionalProperties":false},"uniqueKey":"results.oneOf.1","typeLabel":"null"}],"uniqueKey":"results","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>"}],"results":[{"msg":"\u003cstring>","hasError":true,"messages":[{"messageType":1,"code":"\u003cstring>","context":"\u003cstring>","description":"\u003cstring>","field":"\u003cstring>"}],"codigo":"3c90c3cc-0d44-4b50-8888-8dd25736052a"}]}}},"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"},"results":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"msg":{"oneOf":[{"type":"string","uniqueKey":"results.oneOf.0.items.[INDEX].msg.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"results.oneOf.0.items.[INDEX].msg.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.oneOf.0.items.[INDEX].msg","typeLabel":"string | null"},"hasError":{"type":"boolean","uniqueKey":"results.oneOf.0.items.[INDEX].hasError","typeLabel":"boolean"},"messages":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"messageType":{"enum":[1,2,3],"type":"integer","format":"int32","uniqueKey":"results.oneOf.0.items.[INDEX].messages.oneOf.0.items.[INDEX].messageType","typeLabel":"enum\u003cinteger>"},"code":{"oneOf":[{"type":"string","uniqueKey":"results.oneOf.0.items.[INDEX].messages.oneOf.0.items.[INDEX].code.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"results.oneOf.0.items.[INDEX].messages.oneOf.0.items.[INDEX].code.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.oneOf.0.items.[INDEX].messages.oneOf.0.items.[INDEX].code","typeLabel":"string | null"},"context":{"oneOf":[{"type":"string","uniqueKey":"results.oneOf.0.items.[INDEX].messages.oneOf.0.items.[INDEX].context.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"results.oneOf.0.items.[INDEX].messages.oneOf.0.items.[INDEX].context.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.oneOf.0.items.[INDEX].messages.oneOf.0.items.[INDEX].context","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","uniqueKey":"results.oneOf.0.items.[INDEX].messages.oneOf.0.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"results.oneOf.0.items.[INDEX].messages.oneOf.0.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.oneOf.0.items.[INDEX].messages.oneOf.0.items.[INDEX].description","typeLabel":"string | null"},"field":{"oneOf":[{"type":"string","uniqueKey":"results.oneOf.0.items.[INDEX].messages.oneOf.0.items.[INDEX].field.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"results.oneOf.0.items.[INDEX].messages.oneOf.0.items.[INDEX].field.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.oneOf.0.items.[INDEX].messages.oneOf.0.items.[INDEX].field","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"results.oneOf.0.items.[INDEX].messages.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"results.oneOf.0.items.[INDEX].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":"results.oneOf.0.items.[INDEX].messages.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.oneOf.0.items.[INDEX].messages","typeLabel":"object[] | null"},"codigo":{"type":"string","format":"uuid","uniqueKey":"results.oneOf.0.items.[INDEX].codigo","typeLabel":"string\u003cuuid>"}},"additionalProperties":false,"uniqueKey":"results.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"results.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"msg":{"oneOf":[{"type":"string"},{"type":"null"}]},"hasError":{"type":"boolean"},"messages":{"oneOf":[{"type":"array","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}},{"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}}]},"codigo":{"type":"string","format":"uuid"}},"additionalProperties":false},"uniqueKey":"results.oneOf.1","typeLabel":"null"}],"uniqueKey":"results","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>"}],"results":[{"msg":"\u003cstring>","hasError":true,"messages":[{"messageType":1,"code":"\u003cstring>","context":"\u003cstring>","description":"\u003cstring>","field":"\u003cstring>"}],"codigo":"3c90c3cc-0d44-4b50-8888-8dd25736052a"}]}}},"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"},"results":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"msg":{"oneOf":[{"type":"string","uniqueKey":"results.oneOf.0.items.[INDEX].msg.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"results.oneOf.0.items.[INDEX].msg.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.oneOf.0.items.[INDEX].msg","typeLabel":"string | null"},"hasError":{"type":"boolean","uniqueKey":"results.oneOf.0.items.[INDEX].hasError","typeLabel":"boolean"},"messages":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"messageType":{"enum":[1,2,3],"type":"integer","format":"int32","uniqueKey":"results.oneOf.0.items.[INDEX].messages.oneOf.0.items.[INDEX].messageType","typeLabel":"enum\u003cinteger>"},"code":{"oneOf":[{"type":"string","uniqueKey":"results.oneOf.0.items.[INDEX].messages.oneOf.0.items.[INDEX].code.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"results.oneOf.0.items.[INDEX].messages.oneOf.0.items.[INDEX].code.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.oneOf.0.items.[INDEX].messages.oneOf.0.items.[INDEX].code","typeLabel":"string | null"},"context":{"oneOf":[{"type":"string","uniqueKey":"results.oneOf.0.items.[INDEX].messages.oneOf.0.items.[INDEX].context.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"results.oneOf.0.items.[INDEX].messages.oneOf.0.items.[INDEX].context.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.oneOf.0.items.[INDEX].messages.oneOf.0.items.[INDEX].context","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","uniqueKey":"results.oneOf.0.items.[INDEX].messages.oneOf.0.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"results.oneOf.0.items.[INDEX].messages.oneOf.0.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.oneOf.0.items.[INDEX].messages.oneOf.0.items.[INDEX].description","typeLabel":"string | null"},"field":{"oneOf":[{"type":"string","uniqueKey":"results.oneOf.0.items.[INDEX].messages.oneOf.0.items.[INDEX].field.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"results.oneOf.0.items.[INDEX].messages.oneOf.0.items.[INDEX].field.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.oneOf.0.items.[INDEX].messages.oneOf.0.items.[INDEX].field","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"results.oneOf.0.items.[INDEX].messages.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"results.oneOf.0.items.[INDEX].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":"results.oneOf.0.items.[INDEX].messages.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.oneOf.0.items.[INDEX].messages","typeLabel":"object[] | null"},"codigo":{"type":"string","format":"uuid","uniqueKey":"results.oneOf.0.items.[INDEX].codigo","typeLabel":"string\u003cuuid>"}},"additionalProperties":false,"uniqueKey":"results.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"results.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"msg":{"oneOf":[{"type":"string"},{"type":"null"}]},"hasError":{"type":"boolean"},"messages":{"oneOf":[{"type":"array","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}},{"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}}]},"codigo":{"type":"string","format":"uuid"}},"additionalProperties":false},"uniqueKey":"results.oneOf.1","typeLabel":"null"}],"uniqueKey":"results","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>"}],"results":[{"msg":"\u003cstring>","hasError":true,"messages":[{"messageType":1,"code":"\u003cstring>","context":"\u003cstring>","description":"\u003cstring>","field":"\u003cstring>"}],"codigo":"3c90c3cc-0d44-4b50-8888-8dd25736052a"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"fca24a77-40dd-4517-96a6-da1fb63e07c1":{"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":"17 - Salvar Endereços - BMP","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"pt-BR":{"href":"/caas/referencias-de-api/onboarding/17-salvar-enderecos","matchLevel":0},"en":{"href":"/homepage/english-homepage/about-us","matchLevel":4}}},"lastModified":"2026-10-28T17:46:05.132Z","originalFileLocation":"caas/referencias-de-api/onboarding/17-salvar-enderecos.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=\"17 - Salvar Endereços - 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/17-salvar-enderecos\">\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=17+-+Salvar+Endere%C3%A7os\u0026amp;theme=e1418ef4c4ce228a24d581f0\u0026amp;signature=030d6507faedeb6220b158992c2fbe9d09e3e289ce0b53b79f67407b9c5a3ea9\">\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=\"17 - Salvar Endereços - BMP\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://bmpmoneyplus-sandbox.mintlify.app/_mintlify/api/og/v2?division=Onboarding\u0026amp;title=17+-+Salvar+Endere%C3%A7os\u0026amp;theme=e1418ef4c4ce228a24d581f0\u0026amp;signature=030d6507faedeb6220b158992c2fbe9d09e3e289ce0b53b79f67407b9c5a3ea9\">\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/17-salvar-enderecos\">\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/17-salvar-enderecos.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/17-salvar-enderecos#webpage\",\"url\":\"https://bmpmoneyplus-sandbox.mintlify.app/caas/referencias-de-api/onboarding/17-salvar-enderecos\",\"name\":\"17 - Salvar Endereços\",\"dateModified\":\"2026-10-28T17:46:05.132Z\",\"isPartOf\":{\"@id\":\"https://bmpmoneyplus-sandbox.mintlify.app#website\"},\"breadcrumb\":{\"@id\":\"https://bmpmoneyplus-sandbox.mintlify.app/caas/referencias-de-api/onboarding/17-salvar-enderecos#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://bmpmoneyplus-sandbox.mintlify.app/caas/referencias-de-api/onboarding/17-salvar-enderecos#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\":\"17 - Salvar Endereços\",\"item\":\"https://bmpmoneyplus-sandbox.mintlify.app/caas/referencias-de-api/onboarding/17-salvar-enderecos\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://bmpmoneyplus-sandbox.mintlify.app/caas/referencias-de-api/onboarding/17-salvar-enderecos#apireference\",\"headline\":\"17 - Salvar Endereços\",\"name\":\"17 - Salvar Endereços\",\"url\":\"https://bmpmoneyplus-sandbox.mintlify.app/caas/referencias-de-api/onboarding/17-salvar-enderecos\",\"mainEntityOfPage\":{\"@id\":\"https://bmpmoneyplus-sandbox.mintlify.app/caas/referencias-de-api/onboarding/17-salvar-enderecos#webpage\"},\"dateModified\":\"2026-10-28T17:46:05.132Z\",\"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","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","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","description":null,"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","description":null,"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":"17 - Salvar Endereços - 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"]}