Guia Inicial
- Sobre o FGTS
Monitoramento Serviços Caixa
Métodos de Assinaturas
Guia do Desenvolvedor
- Guia de Integração Via API
APIs Reference
- Simulações
- Onboarding
- Contratação
- Impressão de Documentos
- Assinaturas
- Desembolso
Casos de Uso
4 - Cadastro do endereço
curl --request POST \
--url https://api.bmpdigital.moneyp.dev.br/Pessoa/SalvarEndereco \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'IdempotencyKey: <idempotencykey>' \
--data '{
"dto": {
"codigo": "<string>",
"cep": "<string>",
"logradouro": "<string>",
"nroLogradouro": "<string>",
"bairro": "<string>",
"complemento": "<string>",
"cidade": "<string>",
"uf": "<string>",
"tipoEndereco": 123,
"tipoResidencia": 123,
"enderecoDesde": "2023-11-07T05:31:56Z",
"enderecoPrincipal": true,
"enderecoCorrespondencia": true
},
"param": {
"documentoCliente": "<string>"
}
}'
{
"msg": "<string>",
"hasError": true,
"messages": [
{
"messageType": 1,
"code": "<string>",
"context": "<string>",
"description": "<string>",
"field": "<string>"
}
],
"codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
Por meio deste endpoint o parceiro pode criar ou atualizar registros de endereços de um cliente específico, utilizando o CPF /CNPJ já cadastrado. Para que ocorra uma atualização, é necessário que o campo código, seja preenchido com o número do registro na base da BMP, pois caso isso não ocorra, a busca será feita pelo campo CEP (código de endereçamento postal).
Tabelas
ID | Descrição |
---|---|
1 | Residencial |
2 | Comercial |
ID | Descrição |
---|---|
1 | Alugado |
2 | Próprio |
3 | Financiado |
4 | Casa Funcional |
Mensageria
Categoria | Operação | Ação | Código | Código Detalhado | Mensagem |
---|---|---|---|---|---|
Pessoa | CreateUpdatePessoaEndereco | SalvarEndereco | C0108 | V0001 | Documento Federal deve ser informado |
Pessoa | CreateUpdatePessoaEndereco | SalvarEndereco | C0108 | V0002 | Cliente não encontrado com o documento {documentoCliente} |
Pessoa | CreateUpdatePessoaEndereco | SalvarEndereco | C0108 | V0003 | Cliente não cadastrado pelo parceiro de integração |
Pessoa | CreateUpdatePessoaEndereco | SalvarEndereco | T0608 | D0001 | Informe o CEP |
Pessoa | CreateUpdatePessoaEndereco | SalvarEndereco | T0608 | D0002 | CEP inválido |
Pessoa | CreateUpdatePessoaEndereco | SalvarEndereco | T0608 | D0003 | Informe o Logradouro |
Pessoa | CreateUpdatePessoaEndereco | SalvarEndereco | T0608 | D0004 | Informe a Cidade |
Pessoa | CreateUpdatePessoaEndereco | SalvarEndereco | T0608 | D0005 | Informe o Estado |
Pessoa | CreateUpdatePessoaEndereco | SalvarEndereco | T0608 | D0006 | Informe o Tipo de Imóvel |
Pessoa | CreateUpdatePessoaEndereco | SalvarEndereco | T0608 | D0007 | Informe o Tipo de Endereço |
Pessoa | CreateUpdatePessoaEndereco | SalvarEndereco | T0608 | D0008 | Informe o tempo em que está situado no endereço |
Authorizations
Informe o token
Headers
Body
Código de endereçamento postal (CEP)
Logradouro
Cidade
Unidade Federal (UF). Exemplo: SC (Sigla de Santa Catarina)
Consultar tabela Tipo de Endereço
Consultar tabela Tipo de residência
Será preenchido apenas pelo método SelectPessoa
Número do Logradouro
Bairro
Complemento
Data de início no endereço
Indica se é o endereço principal
Indica se é o endereço que recebe correspondências
Esta página foi útil?
curl --request POST \
--url https://api.bmpdigital.moneyp.dev.br/Pessoa/SalvarEndereco \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'IdempotencyKey: <idempotencykey>' \
--data '{
"dto": {
"codigo": "<string>",
"cep": "<string>",
"logradouro": "<string>",
"nroLogradouro": "<string>",
"bairro": "<string>",
"complemento": "<string>",
"cidade": "<string>",
"uf": "<string>",
"tipoEndereco": 123,
"tipoResidencia": 123,
"enderecoDesde": "2023-11-07T05:31:56Z",
"enderecoPrincipal": true,
"enderecoCorrespondencia": true
},
"param": {
"documentoCliente": "<string>"
}
}'
{
"msg": "<string>",
"hasError": true,
"messages": [
{
"messageType": 1,
"code": "<string>",
"context": "<string>",
"description": "<string>",
"field": "<string>"
}
],
"codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}