Initial Guide
- About Credit as a Service
- Credit Operations
Developer's Guide
- API Integration Guide
APIs Reference
- Simulations
- Onboarding
- Hiring
- Guarantees
- Document Printing
- Signatures
- Disbursement
Use Cases
- Personal Loan
23 - Extended Consultation
curl --request POST \
--url https://api.bmpdigital.moneyp.dev.br/Proposta/ConsultarEstendida \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'IdempotencyKey: <idempotencykey>' \
--data '{
"dto": {
"codigoProposta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"codigoOperacao": "<string>",
"numeroProposta": 123
},
"dtoEstendida": {
"carregarDadosVeiculo": true,
"carregarDadosAnaliseDocumentos": true,
"carregarDadosAnaliseBMPCred": true
}
}'
{
"msg": "<string>",
"hasError": true,
"messages": [
{
"messageType": 1,
"code": "<string>",
"context": "<string>",
"description": "<string>",
"field": "<string>"
}
],
"proposta": {
"msg": "<string>",
"hasError": true,
"messages": [
{
"messageType": 1,
"code": "<string>",
"context": "<string>",
"description": "<string>",
"field": "<string>"
}
],
"codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dtInclusao": "<string>",
"situacao": 123,
"vlrFinanciado": 123,
"qtdeParcelas": 123,
"vlrParcela": 123,
"vlrTAC": 123,
"vlrBoleto": 123,
"vlrSeguro": 123,
"vlrIOF": 123,
"vlrOutrasDespesas": 123,
"vlrOutrosServicos": 123,
"vlrTotalCredito": 123,
"vlrTotalDivida": 123,
"vlrDesembolso": 123,
"percCETMensal": 123,
"percCETAnual": 123,
"percJurosMensal": 123,
"percJurosAnual": 123,
"codigoOperacao": "<string>",
"tipoContrato": "<string>",
"dtPagamento": "2023-11-07T05:31:56Z",
"codigoProposta": "<string>",
"numeroCCB": "<string>",
"motivoRejeicao": "<string>",
"textoRetornoPagamento": "<string>",
"autenticacaoBancaria": "<string>",
"controleBancario": "<string>",
"textoMotivoAnalise": "<string>",
"nomeFavorecido": "<string>",
"documentoFavorecido": "<string>",
"propostaLancamentos": [
{
"campoID": "<string>",
"descricaoCampo": "<string>",
"vlrTransacao": 123,
"dtPrevPagto": "2023-11-07T05:31:56Z",
"dtPagamento": "2023-11-07T05:31:56Z",
"situacao": 123,
"linhaDigitavel": "<string>",
"dtVenctoBoleto": "2023-11-07T05:31:56Z",
"vlrBoleto": 123,
"codigoBanco": 123,
"numeroBanco": "<string>",
"tipoConta": 123,
"agencia": "<string>",
"agenciaDig": "<string>",
"conta": "<string>",
"contaDig": "<string>",
"documentoFederal": "<string>",
"nomePagamento": "<string>",
"textoRetornoPagamento": "<string>",
"autenticacaoBancaria": "<string>",
"controleBancario": "<string>",
"descricaoOcorrencia": "<string>"
}
],
"propostaContaPagamento": {
"codigoBanco": 123,
"tipoConta": 123,
"agencia": "<string>",
"agenciaDig": "<string>",
"conta": "<string>",
"contaDig": "<string>",
"numeroBanco": "<string>",
"documentoFederalPagamento": "<string>",
"nomePagamento": "<string>"
}
},
"propostaDadosVeiculos": [
{
"placa": "<string>",
"marca": "<string>",
"modelo": "<string>",
"versaoModelo": "<string>",
"anoFab": 123,
"anoMod": 123,
"cor": "<string>",
"chassis": "<string>",
"renavam": "<string>",
"proprietario": "<string>",
"documentoFederalProprietario": "<string>",
"financiado": true,
"saldoFinanciamento": 5000000000000000,
"tipoPlaca": 123,
"tipoVeiculo": 123,
"ufPlaca": "<string>",
"ufLicenciamento": "<string>",
"tipoRestricao": 123,
"tipoChassi": 123,
"codigoFipe": "<string>",
"situacaoGravame": 123,
"descricaoGravame": "<string>",
"codigoRetornoGravame": 123,
"dtSituacaoGravame": "2023-11-07T05:31:56Z",
"origemGravame": 123,
"nroGravame": 123,
"nroRegristroGecov": "<string>"
}
],
"propostaDocumentos": [
{
"codigoDocumento": "<string>",
"tipo": 123,
"conferido": true,
"situacao": 123,
"ocorrencias": [
{
"messageType": 123,
"context": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}
],
"pessoaDocumentos": [
{
"codigoDocumento": "<string>",
"tipo": 123,
"conferido": true,
"situacao": 123,
"ocorrencias": [
{
"messageType": 123,
"context": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}
],
"propostaAnaliseBMPCred": [
{
"bmpCredResponse": {
"tomadores": [
{
"cpfcnpj": 123,
"proposito": "<string>",
"resultado": 123,
"observacao": {
"cePsEncontradosBureauCadastral": [
"<string>"
],
"scoreBMP": 123,
"flags": [
"<string>"
],
"motivo": "<string>",
"motivoRecusaOnboarding": {
"mensagem": "<string>",
"motivo": "<string>"
},
"prazo": 123,
"taxa": 123,
"valorParcela": 123
}
}
],
"codigo": 123,
"mensagem": "<string>"
}
}
]
}
Through this endpoint, the partner can consult information regarding all changes made to the proposal, which may or may not require partner intervention.
Category | Operation | Action | Code | Detailed Code | Message |
---|---|---|---|---|---|
Proposta | ConsultaPropostaEstendida | ConsultarEstendida | C0019 | V0001 | Produto não configurado para esta integração |
Proposta | ConsultaPropostaEstendida | ConsultarEstendida | C0113 | V0001 | Proposta não encontrada |
Proposta | ConsultaPropostaEstendida | ConsultarEstendida | C0113 | V0002 | A Proposta não pertence à esta Integração |
Proposta | ConsultaPropostaEstendida | ConsultarEstendida | C0306 | V0000 | Análise realizada com sucesso |
Proposta | ConsultaPropostaEstendida | ConsultarEstendida | C0306 | V0001 | Data de nascimento não informada no cadastro do cliente da proposta |
Proposta | ConsultaPropostaEstendida | ConsultarEstendida | C0306 | V0002 | Data de nascimento declarada no documento de identidade não condiz com o cadastro da proposta |
Proposta | ConsultaPropostaEstendida | ConsultarEstendida | C0306 | V0003 | CPF não informado no cadastro do cliente da proposta |
Proposta | ConsultaPropostaEstendida | ConsultarEstendida | C0306 | V0004 | CPF declarado no documento de identidade não condiz com o cadastro do cliente da proposta |
Proposta | ConsultaPropostaEstendida | ConsultarEstendida | C0306 | V0005 | Nome não informado no cadastro do cliente da proposta |
Proposta | ConsultaPropostaEstendida | ConsultarEstendida | C0306 | V0006 | Nome declarado no documento de identidade não condiz com o cadastro do cliente da proposta |
Proposta | ConsultaPropostaEstendida | ConsultarEstendida | C0306 | V0007 | Data de nascimento não informada no cadastro do cliente da proposta |
Proposta | ConsultaPropostaEstendida | ConsultarEstendida | C0306 | V0008 | Data de nascimento declarada no documento de identidade não condiz com o cadastro da proposta |
Proposta | ConsultaPropostaEstendida | ConsultarEstendida | C0306 | V0009 | CPF não informado no cadastro do cliente da proposta |
Proposta | ConsultaPropostaEstendida | ConsultarEstendida | C0306 | V0010 | CPF declarado no documento de identidade não condiz com o cadastro do cliente da proposta |
Proposta | ConsultaPropostaEstendida | ConsultarEstendida | C0306 | V0011 | Nome não informado no cadastro do cliente da proposta |
Proposta | ConsultaPropostaEstendida | ConsultarEstendida | C0306 | V0012 | Nome declarado no documento de identidade não condiz com o cadastro do cliente da proposta |
Proposta | ConsultaPropostaEstendida | ConsultarEstendida | C0306 | V0013 | Chassi não informado no cadastro do veículo vinculado à proposta |
Proposta | ConsultaPropostaEstendida | ConsultarEstendida | C0306 | V0014 | Chassi declarado no DUT não condiz com o cadastro do veículo vinculado à proposta |
Proposta | ConsultaPropostaEstendida | ConsultarEstendida | C0306 | V0015 | Ano de fabricação não informado no cadastro do veículo vinculado à proposta |
Proposta | ConsultaPropostaEstendida | ConsultarEstendida | C0306 | V0016 | Ano de fabricação declarado no DUT não condiz com o cadastro do veículo vinculado à proposta |
Proposta | ConsultaPropostaEstendida | ConsultarEstendida | C0306 | V0017 | Ano do modelo não informado no cadastro do veículo vinculado à proposta |
Proposta | ConsultaPropostaEstendida | ConsultarEstendida | C0306 | V0018 | Ano do modelo declarado no DUT não condiz com o cadastro do veículo vinculado à proposta |
Proposta | ConsultaPropostaEstendida | ConsultarEstendida | C0306 | V0019 | Modelo não informado no cadastro do veículo vinculado à proposta |
Proposta | ConsultaPropostaEstendida | ConsultarEstendida | C0306 | V0020 | Modelo declarado no DUT não condiz com o cadastro do veículo vinculado à proposta |
Proposta | ConsultaPropostaEstendida | ConsultarEstendida | C0306 | V0021 | Marca não informada no cadastro do veículo vinculado à proposta |
Proposta | ConsultaPropostaEstendida | ConsultarEstendida | C0306 | V0022 | Marca declarada no DUT não condiz com o cadastro do veículo vinculado à proposta |
Proposta | ConsultaPropostaEstendida | ConsultarEstendida | C0306 | V0023 | CEP não informado no cadastro do cliente da proposta |
Proposta | ConsultaPropostaEstendida | ConsultarEstendida | C0306 | V0024 | CEP declarado no comprovante de residência não condiz com o cadastro do cliente da proposta |
Proposta | ConsultaPropostaEstendida | ConsultarEstendida | C0306 | V0025 | Logradouro não informado no cadastro do cliente da proposta |
Proposta | ConsultaPropostaEstendida | ConsultarEstendida | C0306 | V0026 | Logradouro declarado no comprovante de residência não condiz com o cadastro da proposta |
Proposta | ConsultaPropostaEstendida | ConsultarEstendida | C0306 | V0027 | Placa não informada no cadastro do veículo vinculado à proposta |
Proposta | ConsultaPropostaEstendida | ConsultarEstendida | C0306 | V0028 | Placa declarada no DUT não condiz com o cadastro do veículo vinculado à proposta |
Proposta | ConsultaPropostaEstendida | ConsultarEstendida | C0306 | V0029 | Chassi não informado no cadastro da Nota Fiscal do veículo vinculado à proposta |
Proposta | ConsultaPropostaEstendida | ConsultarEstendida | C0306 | V0030 | Chassi declarado na Nota Fiscal do veículo não condiz com o cadastro do veículo vinculado |
Proposta | ConsultaPropostaEstendida | ConsultarEstendida | C0306 | V0031 | Ano de fabricação não informado no cadastro do veículo vinculado à proposta |
Proposta | ConsultaPropostaEstendida | ConsultarEstendida | C0306 | V0032 | Ano de fabricação declarado na Nota Fiscal do veículo não condiz com o cadastro do veículo |
Proposta | ConsultaPropostaEstendida | ConsultarEstendida | C0306 | V0033 | Marca não informada no cadastro do veículo vinculado à proposta |
Proposta | ConsultaPropostaEstendida | ConsultarEstendida | C0306 | V0034 | Marca declarada na Nota Fiscal do veículo não condiz com o cadastro do veículo |
Proposta | ConsultaPropostaEstendida | ConsultarEstendida | C0306 | V0035 | Renavam não informado no cadastro do veículo vinculado à proposta |
Proposta | ConsultaPropostaEstendida | ConsultarEstendida | C0306 | V0036 | Renavam declarada no DUT não condiz com o cadastro do veículo vinculado |
Proposta | ConsultaPropostaEstendida | ConsultarEstendida | B0001 | V0000 | Sucesso |
Proposta | ConsultaPropostaEstendida | ConsultarEstendida | B0001 | V0001 | Não é um arquivo válido para análise |
Proposta | ConsultaPropostaEstendida | ConsultarEstendida | B0001 | V0002 | Arquivo enviado em cópia preto e branco |
Proposta | ConsultaPropostaEstendida | ConsultarEstendida | B0001 | V0003 | Arquivo desatualizado |
Proposta | ConsultaPropostaEstendida | ConsultarEstendida | B0001 | V0004 | Informações ilegíveis |
Proposta | ConsultaPropostaEstendida | ConsultarEstendida | B0001 | V0005 | Nome do titular inválido |
Proposta | ConsultaPropostaEstendida | ConsultarEstendida | B0001 | V0006 | Data de nascimento inválida |
Proposta | ConsultaPropostaEstendida | ConsultarEstendida | B0001 | V0007 | Número do documento inválido |
Proposta | ConsultaPropostaEstendida | ConsultarEstendida | B0001 | V0008 | Data de expedição inválida |
Proposta | ConsultaPropostaEstendida | ConsultarEstendida | B0001 | V0009 | Data de expiração inválida |
Proposta | ConsultaPropostaEstendida | ConsultarEstendida | B0001 | V0010 | Data da primeira emissão inválida |
Proposta | ConsultaPropostaEstendida | ConsultarEstendida | B0001 | V0011 | Categoria inválida |
Proposta | ConsultaPropostaEstendida | ConsultarEstendida | B0001 | V0012 | Arquivo inválido para análise. Parâmetro: Código |
Proposta | ConsultaPropostaEstendida | ConsultarEstendida | B0001 | V0013 | Arquivo inválido para análise. Parâmetro: Tipo |
Proposta | ConsultaPropostaEstendida | ConsultarEstendida | B0001 | V0014 | Arquivo inválido para análise. Parâmetro: Base64 |
Proposta | ConsultaPropostaEstendida | ConsultarEstendida | B0001 | V0015 | Arquivo inválido para análise. Parâmetro: TipoBureau |
Proposta | ConsultaPropostaEstendida | ConsultarEstendida | B0001 | V0016 | Bureau inválido para o documento consultado |
Proposta | ConsultaPropostaEstendida | ConsultarEstendida | B0001 | V0017 | Quantidade de arquivos inválida |
Proposta | ConsultaPropostaEstendida | ConsultarEstendida | B0001 | V0018 | Consulta não implementada |
Proposta | ConsultaPropostaEstendida | ConsultarEstendida | B0001 | V0019 | {Mensagem dinâmica} |
Proposta | ConsultaPropostaEstendida | ConsultarEstendida | B0001 | V0020 | Retorno de análise inválida. Parâmetro: Código |
Proposta | ConsultaPropostaEstendida | ConsultarEstendida | B0001 | V0021 | Retorno de análise inválida. Parâmetro: Tipo |
Proposta | ConsultaPropostaEstendida | ConsultarEstendida | B0001 | V0022 | Retorno de análise inválida. Parâmetro: Situacao |
Proposta | ConsultaPropostaEstendida | ConsultarEstendida | B0001 | V0023 | {Mensagem dinâmica} |
Proposta | ConsultaPropostaEstendida | ConsultarEstendida | B0001 | V0024 | Tipo de arquivo de retorno inválido |
Proposta | ConsultaPropostaEstendida | ConsultarEstendida | B0001 | V0099 | Erro não catalogado |
Authorizations
Informe o token
Headers
Body
Response
Código do banco
Tipo de conta
Agência
Conta bancária
Dígito da conta
Número do banco
Dígito da agência
Novo documento federal para pagamento
Nome referente ao novo documento federal para pagamento
Placa do veículo
10
Marca do veículo
30
Modelo do veículo
30
Caracterização do assinante
50
Ano de fabricação
Ano do modelo
Cor do veículo
30
Chassis
50
Registro Nacional de Veículos Automotores (Renavam)
30
Nome do proprietário
60
Documento do proprietário
20
Indica se veículo ainda está em financiamento
Saldo do financiamento
0 <= x <= 10000000000000000
Tipo de placa: 1-Particular, 2-Comercial, 3-Oficial, 4-Diplomático, 5-Especial, 6-Colecionador
Tipo de veículo: 1-Carro, 2-Moto, 3-Caminhão, 4-Van/Utilitário, 5-SUV
Unidade Federal (UF) da placa
2
Unidade Federal (UF) do Licenciamento
2
Tipo de restrição
Tipo de chassi
Código da Fundação Instituto de Pesquisas Econômicas (Fipe)
30
Situação do Gravame
Descrição do Gravame
1000
Código Retorno Gravame
Data de situação do Gravame
Indica a origem do gravame do veículo (interno, externo ou ambos).
Gravame
Número registro do GECOV – Gerenciador de contratos de veículos.
50
Was this page helpful?
curl --request POST \
--url https://api.bmpdigital.moneyp.dev.br/Proposta/ConsultarEstendida \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'IdempotencyKey: <idempotencykey>' \
--data '{
"dto": {
"codigoProposta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"codigoOperacao": "<string>",
"numeroProposta": 123
},
"dtoEstendida": {
"carregarDadosVeiculo": true,
"carregarDadosAnaliseDocumentos": true,
"carregarDadosAnaliseBMPCred": true
}
}'
{
"msg": "<string>",
"hasError": true,
"messages": [
{
"messageType": 1,
"code": "<string>",
"context": "<string>",
"description": "<string>",
"field": "<string>"
}
],
"proposta": {
"msg": "<string>",
"hasError": true,
"messages": [
{
"messageType": 1,
"code": "<string>",
"context": "<string>",
"description": "<string>",
"field": "<string>"
}
],
"codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dtInclusao": "<string>",
"situacao": 123,
"vlrFinanciado": 123,
"qtdeParcelas": 123,
"vlrParcela": 123,
"vlrTAC": 123,
"vlrBoleto": 123,
"vlrSeguro": 123,
"vlrIOF": 123,
"vlrOutrasDespesas": 123,
"vlrOutrosServicos": 123,
"vlrTotalCredito": 123,
"vlrTotalDivida": 123,
"vlrDesembolso": 123,
"percCETMensal": 123,
"percCETAnual": 123,
"percJurosMensal": 123,
"percJurosAnual": 123,
"codigoOperacao": "<string>",
"tipoContrato": "<string>",
"dtPagamento": "2023-11-07T05:31:56Z",
"codigoProposta": "<string>",
"numeroCCB": "<string>",
"motivoRejeicao": "<string>",
"textoRetornoPagamento": "<string>",
"autenticacaoBancaria": "<string>",
"controleBancario": "<string>",
"textoMotivoAnalise": "<string>",
"nomeFavorecido": "<string>",
"documentoFavorecido": "<string>",
"propostaLancamentos": [
{
"campoID": "<string>",
"descricaoCampo": "<string>",
"vlrTransacao": 123,
"dtPrevPagto": "2023-11-07T05:31:56Z",
"dtPagamento": "2023-11-07T05:31:56Z",
"situacao": 123,
"linhaDigitavel": "<string>",
"dtVenctoBoleto": "2023-11-07T05:31:56Z",
"vlrBoleto": 123,
"codigoBanco": 123,
"numeroBanco": "<string>",
"tipoConta": 123,
"agencia": "<string>",
"agenciaDig": "<string>",
"conta": "<string>",
"contaDig": "<string>",
"documentoFederal": "<string>",
"nomePagamento": "<string>",
"textoRetornoPagamento": "<string>",
"autenticacaoBancaria": "<string>",
"controleBancario": "<string>",
"descricaoOcorrencia": "<string>"
}
],
"propostaContaPagamento": {
"codigoBanco": 123,
"tipoConta": 123,
"agencia": "<string>",
"agenciaDig": "<string>",
"conta": "<string>",
"contaDig": "<string>",
"numeroBanco": "<string>",
"documentoFederalPagamento": "<string>",
"nomePagamento": "<string>"
}
},
"propostaDadosVeiculos": [
{
"placa": "<string>",
"marca": "<string>",
"modelo": "<string>",
"versaoModelo": "<string>",
"anoFab": 123,
"anoMod": 123,
"cor": "<string>",
"chassis": "<string>",
"renavam": "<string>",
"proprietario": "<string>",
"documentoFederalProprietario": "<string>",
"financiado": true,
"saldoFinanciamento": 5000000000000000,
"tipoPlaca": 123,
"tipoVeiculo": 123,
"ufPlaca": "<string>",
"ufLicenciamento": "<string>",
"tipoRestricao": 123,
"tipoChassi": 123,
"codigoFipe": "<string>",
"situacaoGravame": 123,
"descricaoGravame": "<string>",
"codigoRetornoGravame": 123,
"dtSituacaoGravame": "2023-11-07T05:31:56Z",
"origemGravame": 123,
"nroGravame": 123,
"nroRegristroGecov": "<string>"
}
],
"propostaDocumentos": [
{
"codigoDocumento": "<string>",
"tipo": 123,
"conferido": true,
"situacao": 123,
"ocorrencias": [
{
"messageType": 123,
"context": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}
],
"pessoaDocumentos": [
{
"codigoDocumento": "<string>",
"tipo": 123,
"conferido": true,
"situacao": 123,
"ocorrencias": [
{
"messageType": 123,
"context": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}
],
"propostaAnaliseBMPCred": [
{
"bmpCredResponse": {
"tomadores": [
{
"cpfcnpj": 123,
"proposito": "<string>",
"resultado": 123,
"observacao": {
"cePsEncontradosBureauCadastral": [
"<string>"
],
"scoreBMP": 123,
"flags": [
"<string>"
],
"motivo": "<string>",
"motivoRecusaOnboarding": {
"mensagem": "<string>",
"motivo": "<string>"
},
"prazo": 123,
"taxa": 123,
"valorParcela": 123
}
}
],
"codigo": 123,
"mensagem": "<string>"
}
}
]
}