Initial Guide
- About Credit as a Service
- Credit Operations
Developer's Guide
- API Integration Guide
APIs Reference
- Simulations
- Onboarding
- POST1 - Client Registration
- POST2 - Address Registration
- POST3 - Document Consultation
- POST4 - Person Consultation
- POST5 - Onboarding Status Consultation
- POST6 - Include Document
- POST7 - Include Person Onboarding
- POST8 - Save Addresses
- POST9 - Save Partner
- POST10 - Save Partners
- POST11 - Include Guarantor
- POST12 - Include Guarantors
- POST
- Hiring
- Guarantees
- Document Printing
- Signatures
- Disbursement
Use Cases
- Personal Loan
Onboarding
8 - Save Addresses
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": [
{
"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
}
]
}'
{
"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.
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
Informe o token
Headers
Body
Documento federal do cliente
Maximum length:
20
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
Response
200
text/plain
OK
Was this page helpful?
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": [
{
"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
}
]
}'
{
"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"
}
]
}