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
2 - Address Registration
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"
}
Through this endpoint, the partner can create or update address records for a specific client using the already registered CPF/CNPJ. For an update to occur, the ‘codigo’ field must be filled with the record number in the BMP database; otherwise, the search will be conducted using the ZIP code field (CEP).
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
Was this page helpful?
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"
}