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 '
{
"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
}
]
}
'import requests
url = "https://api.bmpdigital.moneyp.dev.br/Pessoa/SalvarEnderecos"
payload = { "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
}
] }
headers = {
"IdempotencyKey": "<idempotencykey>",
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
IdempotencyKey: '<idempotencykey>',
Authorization: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
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
}
]
})
};
fetch('https://api.bmpdigital.moneyp.dev.br/Pessoa/SalvarEnderecos', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.bmpdigital.moneyp.dev.br/Pessoa/SalvarEnderecos",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json",
"IdempotencyKey: <idempotencykey>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.bmpdigital.moneyp.dev.br/Pessoa/SalvarEnderecos"
payload := strings.NewReader("{\n \"dtos\": [\n {\n \"cep\": \"<string>\",\n \"logradouro\": \"<string>\",\n \"cidade\": \"<string>\",\n \"uf\": \"<string>\",\n \"tipoEndereco\": 123,\n \"tipoResidencia\": 123,\n \"codigo\": \"<string>\",\n \"nroLogradouro\": \"<string>\",\n \"bairro\": \"<string>\",\n \"complemento\": \"<string>\",\n \"enderecoDesde\": \"2023-11-07T05:31:56Z\",\n \"enderecoPrincipal\": true,\n \"enderecoCorrespondencia\": true\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("IdempotencyKey", "<idempotencykey>")
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.bmpdigital.moneyp.dev.br/Pessoa/SalvarEnderecos")
.header("IdempotencyKey", "<idempotencykey>")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"dtos\": [\n {\n \"cep\": \"<string>\",\n \"logradouro\": \"<string>\",\n \"cidade\": \"<string>\",\n \"uf\": \"<string>\",\n \"tipoEndereco\": 123,\n \"tipoResidencia\": 123,\n \"codigo\": \"<string>\",\n \"nroLogradouro\": \"<string>\",\n \"bairro\": \"<string>\",\n \"complemento\": \"<string>\",\n \"enderecoDesde\": \"2023-11-07T05:31:56Z\",\n \"enderecoPrincipal\": true,\n \"enderecoCorrespondencia\": true\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bmpdigital.moneyp.dev.br/Pessoa/SalvarEnderecos")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["IdempotencyKey"] = '<idempotencykey>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"dtos\": [\n {\n \"cep\": \"<string>\",\n \"logradouro\": \"<string>\",\n \"cidade\": \"<string>\",\n \"uf\": \"<string>\",\n \"tipoEndereco\": 123,\n \"tipoResidencia\": 123,\n \"codigo\": \"<string>\",\n \"nroLogradouro\": \"<string>\",\n \"bairro\": \"<string>\",\n \"complemento\": \"<string>\",\n \"enderecoDesde\": \"2023-11-07T05:31:56Z\",\n \"enderecoPrincipal\": true,\n \"enderecoCorrespondencia\": true\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"msg": "<string>",
"hasError": true,
"messages": [
{
"code": "<string>",
"context": "<string>",
"description": "<string>",
"field": "<string>"
}
],
"results": [
{
"msg": "<string>",
"hasError": true,
"messages": [
{
"code": "<string>",
"context": "<string>",
"description": "<string>",
"field": "<string>"
}
],
"codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
]
}{
"msg": "<string>",
"hasError": true,
"messages": [
{
"code": "<string>",
"context": "<string>",
"description": "<string>",
"field": "<string>"
}
]
}Onboarding
17 - Salvar Endereços
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 '
{
"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
}
]
}
'import requests
url = "https://api.bmpdigital.moneyp.dev.br/Pessoa/SalvarEnderecos"
payload = { "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
}
] }
headers = {
"IdempotencyKey": "<idempotencykey>",
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
IdempotencyKey: '<idempotencykey>',
Authorization: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
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
}
]
})
};
fetch('https://api.bmpdigital.moneyp.dev.br/Pessoa/SalvarEnderecos', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.bmpdigital.moneyp.dev.br/Pessoa/SalvarEnderecos",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json",
"IdempotencyKey: <idempotencykey>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.bmpdigital.moneyp.dev.br/Pessoa/SalvarEnderecos"
payload := strings.NewReader("{\n \"dtos\": [\n {\n \"cep\": \"<string>\",\n \"logradouro\": \"<string>\",\n \"cidade\": \"<string>\",\n \"uf\": \"<string>\",\n \"tipoEndereco\": 123,\n \"tipoResidencia\": 123,\n \"codigo\": \"<string>\",\n \"nroLogradouro\": \"<string>\",\n \"bairro\": \"<string>\",\n \"complemento\": \"<string>\",\n \"enderecoDesde\": \"2023-11-07T05:31:56Z\",\n \"enderecoPrincipal\": true,\n \"enderecoCorrespondencia\": true\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("IdempotencyKey", "<idempotencykey>")
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.bmpdigital.moneyp.dev.br/Pessoa/SalvarEnderecos")
.header("IdempotencyKey", "<idempotencykey>")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"dtos\": [\n {\n \"cep\": \"<string>\",\n \"logradouro\": \"<string>\",\n \"cidade\": \"<string>\",\n \"uf\": \"<string>\",\n \"tipoEndereco\": 123,\n \"tipoResidencia\": 123,\n \"codigo\": \"<string>\",\n \"nroLogradouro\": \"<string>\",\n \"bairro\": \"<string>\",\n \"complemento\": \"<string>\",\n \"enderecoDesde\": \"2023-11-07T05:31:56Z\",\n \"enderecoPrincipal\": true,\n \"enderecoCorrespondencia\": true\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bmpdigital.moneyp.dev.br/Pessoa/SalvarEnderecos")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["IdempotencyKey"] = '<idempotencykey>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"dtos\": [\n {\n \"cep\": \"<string>\",\n \"logradouro\": \"<string>\",\n \"cidade\": \"<string>\",\n \"uf\": \"<string>\",\n \"tipoEndereco\": 123,\n \"tipoResidencia\": 123,\n \"codigo\": \"<string>\",\n \"nroLogradouro\": \"<string>\",\n \"bairro\": \"<string>\",\n \"complemento\": \"<string>\",\n \"enderecoDesde\": \"2023-11-07T05:31:56Z\",\n \"enderecoPrincipal\": true,\n \"enderecoCorrespondencia\": true\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"msg": "<string>",
"hasError": true,
"messages": [
{
"code": "<string>",
"context": "<string>",
"description": "<string>",
"field": "<string>"
}
],
"results": [
{
"msg": "<string>",
"hasError": true,
"messages": [
{
"code": "<string>",
"context": "<string>",
"description": "<string>",
"field": "<string>"
}
],
"codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
]
}{
"msg": "<string>",
"hasError": true,
"messages": [
{
"code": "<string>",
"context": "<string>",
"description": "<string>",
"field": "<string>"
}
]
}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
Tabela de códigos auxiliares
Mostrar Tabela TipoEndereco
Mostrar Tabela TipoEndereco
| ID | Descrição |
|---|---|
| 1 | Residencial |
| 2 | Comercial |
Mostrar Tabela TipoResidencia
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
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 |
| 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 |
Autorizações
Informe o token
Cabeçalhos
Corpo
application/jsontext/jsonapplication/*+json
Esta página foi útil?
⌘I

