11 - Cadastro do Endereço

cURL

cURL

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": {
    "cep": "<string>",
    "logradouro": "<string>",
    "cidade": "<string>",
    "uf": "<string>",
    "tipoEndereco": 123,
    "tipoResidencia": 123,
    "codigo": "<string>",
    "nroLogradouro": "<string>",
    "bairro": "<string>",
    "complemento": "<string>",
    "enderecoDesde": "2023-11-07T05:31:56Z",
    "enderecoPrincipal": true,
    "enderecoCorrespondencia": true
  },
  "param": {
    "documentoCliente": "<string>"
  }
}
'

200

{
  "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 de códigos auxiliares

Mostrar Tabela TipoOcupacao

ID	Descrição
1	Aposentado
2	Pensionista
3	Empregado/Assalariado
4	Autônomo
5	Desempregado
6	Profissional Liberal
7	Sócio Proprietário
8	Outros

Mostrar Tabela TipoResidencia

ID	Descrição
1	Alugado
2	Próprio
3	Financiado
4	Casa Funcional

​

Mensagens de erro

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	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

Authorization · string · header · required

Informe o token

Headers

IdempotencyKey · string · required

Body

dto · object

Mostrar atributos filhos

dto. cep · string | null · required

Código de endereçamento postal (CEP)

dto. logradouro · string | null · required

Logradouro

dto. cidade · string | null · required

Cidade

dto. uf · string | null · required

Unidade Federal (UF). Exemplo: SC (Sigla de Santa Catarina)

dto. tipoEndereco · integer<int32> | null · required

Consultar tabela Tipo de Endereço

dto. tipoResidencia · integer<int32> | null · required

Consultar tabela Tipo de residência

dto. codigo · string | null

Será preenchido apenas pelo método SelectPessoa

dto. nroLogradouro · string | null

Número do Logradouro

dto. bairro · string | null

Bairro

dto. complemento · string | null

Complemento

dto. enderecoDesde · string<date-time> | null

Data de início no endereço

dto. enderecoPrincipal · boolean | null

Indica se é o endereço principal

dto. enderecoCorrespondencia · boolean | null

Indica se é o endereço que recebe correspondências

param · object

Mostrar atributos filhos

param. documentoCliente · string | null · required

Documento federal do cliente

Maximum string length: 20

Response

200

text/plain

OK

msg · string | null

hasError · boolean

messages · object[] | null

Mostrar atributos filhos

messages. messageType · enum<integer>

Opções disponíveis: 1, 2, 3

messages. code · string | null

messages. context · string | null

messages. description · string | null

messages. field · string | null

codigo · string<uuid>