8 - Save Addresses

cURL

cURL

curl --request POST \
  --url https://api.bmpdigital.moneyp.dev.br/Pessoa/SalvarEnderecos \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'IdempotencyKey: <idempotencykey>' \
  --data '
{
  "param": {
    "documentoCliente": "<string>"
  },
  "dtos": [
    {
      "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
    }
  ]
}
'

200

{
  "msg": "<string>",
  "hasError": true,
  "messages": [
    {
      "messageType": 1,
      "code": "<string>",
      "context": "<string>",
      "description": "<string>",
      "field": "<string>"
    }
  ],
  "results": [
    {
      "msg": "<string>",
      "hasError": true,
      "messages": [
        {
          "messageType": 1,
          "code": "<string>",
          "context": "<string>",
          "description": "<string>",
          "field": "<string>"
        }
      ],
      "codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ]
}

Through this endpoint, the partner includes or updates address records of a specific client. To update, it is necessary to send the “código” field, filled with the record code in the BMP database, or the search will be done through the “CEP” field.

Show Messages

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
Pessoa	CreateUpdatePessoaEnderecos	SalvarEnderecos	T0608	D0001	Informe o CEP
Pessoa	CreateUpdatePessoaEnderecos	SalvarEnderecos	T0608	D0002	CEP inválido
Pessoa	CreateUpdatePessoaEnderecos	SalvarEnderecos	T0608	D0003	Informe o Logradouro
Pessoa	CreateUpdatePessoaEnderecos	SalvarEnderecos	T0608	D0004	Informe a Cidade
Pessoa	CreateUpdatePessoaEnderecos	SalvarEnderecos	T0608	D0005	Informe o Estado
Pessoa	CreateUpdatePessoaEnderecos	SalvarEnderecos	T0608	D0006	Informe o Tipo de Imóvel
Pessoa	CreateUpdatePessoaEnderecos	SalvarEnderecos	T0608	D0007	Informe o Tipo de Endereço
Pessoa	CreateUpdatePessoaEnderecos	SalvarEnderecos	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

param · object

Show child attributes

param. documentoCliente · string | null · required

Documento federal do cliente

Maximum string length: 20

dtos · object[] | null

Show child attributes

dtos. cep · string | null · required

Código de endereçamento postal (CEP)

dtos. logradouro · string | null · required

Logradouro

dtos. cidade · string | null · required

Cidade

dtos. uf · string | null · required

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

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

Consultar tabela Tipo de Endereço

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

Consultar tabela Tipo de residência

dtos. codigo · string | null

Será preenchido apenas pelo método SelectPessoa

dtos. nroLogradouro · string | null

Número do Logradouro

dtos. bairro · string | null

Bairro

dtos. complemento · string | null

Complemento

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

Data de início no endereço

dtos. enderecoPrincipal · boolean | null

Indica se é o endereço principal

dtos. enderecoCorrespondencia · boolean | null

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

Response

200

text/plain

OK

msg · string | null

hasError · boolean

messages · object[] | null

Show child attributes

messages. messageType · enum<integer>

Available options: 1, 2, 3

messages. code · string | null

messages. context · string | null

messages. description · string | null

messages. field · string | null

results · object[] | null

Show child attributes

results. msg · string | null

results. hasError · boolean

results. messages · object[] | null

Show child attributes

results.messages. messageType · enum<integer>

Available options: 1, 2, 3

results.messages. code · string | null

results.messages. context · string | null

results.messages. description · string | null

results.messages. field · string | null

results. codigo · string<uuid>