28 - Vehicle Registration

cURL

curl --request POST \
  --url https://api.bmpdigital.moneyp.dev.br/Proposta/IncluirDadosVeiculo \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'IdempotencyKey: <idempotencykey>' \
  --data '
{
  "dto": {
    "codigoProposta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "codigoOperacao": "<string>",
    "numeroProposta": 123
  },
  "dadosVeiculoDTO": {
    "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>",
    "vlrFipe": 49999999.995,
    "vlrVeiculo": 49999999.995,
    "zeroKM": true,
    "km": 499999
  }
}
'

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

cURL

curl --request POST \
  --url https://api.bmpdigital.moneyp.dev.br/Proposta/IncluirDadosVeiculo \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'IdempotencyKey: <idempotencykey>' \
  --data '
{
  "dto": {
    "codigoProposta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "codigoOperacao": "<string>",
    "numeroProposta": 123
  },
  "dadosVeiculoDTO": {
    "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>",
    "vlrFipe": 49999999.995,
    "vlrVeiculo": 49999999.995,
    "zeroKM": true,
    "km": 499999
  }
}
'

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

Through this endpoint, the partner includes vehicle data for a proposal. The vehicle must have a license plate provided, and other fields are optional. The vehicle data is validated by our credit analysts and serves as a basis for approving or rejecting the proposal. The use will be according to the integration needs. Rules and Validations:

The same license plate cannot be included more than once in the proposal;
Alphanumeric fields will be truncated according to the size defined in the manual.

Show Mensageria

Categoria	Operação	Ação	Código	Código Detalhado	Mensagem
Proposta	IncluirPropostaDadosVeiculo	IncluirDadosVeiculo	C0112	V0001	Proposta não encontrada
Proposta	IncluirPropostaDadosVeiculo	IncluirDadosVeiculo	C0112	V0002	A Proposta não pertence à esta Integração
Proposta	IncluirPropostaDadosVeiculo	IncluirDadosVeiculo	T0680	D0001	Proposta não encontrada
Proposta	IncluirPropostaDadosVeiculo	IncluirDadosVeiculo	T0680	D0002	Chassi já cadastrada nessa proposta
Proposta	IncluirPropostaDadosVeiculo	IncluirDadosVeiculo	T0680	D0003	Codigo identificador já cadastrado nessa proposta

Authorizations

Authorization

string

header

required

Informe o token

Headers

IdempotencyKey

string

required

Body

dto

object

Show child attributes

dto.codigoProposta

string<uuid> | null

Código identificador da proposta

dto.codigoOperacao

string | null

Código da operação do parceiro

dto.numeroProposta

integer<int64> | null

Número sequencial da proposta

dadosVeiculoDTO

object

Show child attributes

dadosVeiculoDTO.placa

string | null

required

Placa do veículo

Maximum string length: 10

dadosVeiculoDTO.marca

string | null

Marca do veículo

Maximum string length: 30

dadosVeiculoDTO.modelo

string | null

Modelo do veículo

Maximum string length: 30

dadosVeiculoDTO.versaoModelo

string | null

Caracterização do assinante

Maximum string length: 50

dadosVeiculoDTO.anoFab

integer<int32> | null

Ano de fabricação

dadosVeiculoDTO.anoMod

integer<int32> | null

Ano do modelo

dadosVeiculoDTO.cor

string | null

Cor do veículo

Maximum string length: 30

dadosVeiculoDTO.chassis

string | null

Chassis

Maximum string length: 50

dadosVeiculoDTO.renavam

string | null

Registro Nacional de Veículos Automotores (Renavam)

Maximum string length: 30

dadosVeiculoDTO.proprietario

string | null

Nome do proprietário

Maximum string length: 60

dadosVeiculoDTO.documentoFederalProprietario

string | null

Documento do proprietário

Maximum string length: 20

dadosVeiculoDTO.financiado

boolean | null

Indica se veículo ainda está em financiamento

dadosVeiculoDTO.saldoFinanciamento

number<double> | null

Saldo do financiamento

Required range: 0 <= x <= 10000000000000000

dadosVeiculoDTO.tipoPlaca

integer<int32> | null

Tipo de placa: 1-Particular, 2-Comercial, 3-Oficial, 4-Diplomático, 5-Especial, 6-Colecionador

dadosVeiculoDTO.tipoVeiculo

integer<int32> | null

Tipo de veículo: 1-Carro, 2-Moto, 3-Caminhão, 4-Van/Utilitário, 5-SUV

dadosVeiculoDTO.ufPlaca

string | null

Unidade Federal (UF) da placa

Maximum string length: 2

dadosVeiculoDTO.ufLicenciamento

string | null

Unidade Federal (UF) do Licenciamento

Maximum string length: 2

dadosVeiculoDTO.tipoRestricao

integer<int32> | null

Tipo de restrição

dadosVeiculoDTO.tipoChassi

integer<int32> | null

Tipo de chassi

dadosVeiculoDTO.codigoFipe

string | null

Código da Fundação Instituto de Pesquisas Econômicas (Fipe)

Maximum string length: 30

dadosVeiculoDTO.situacaoGravame

integer<int32> | null

Situação do Gravame

dadosVeiculoDTO.descricaoGravame

string | null

Descrição do Gravame

Maximum string length: 1000

dadosVeiculoDTO.codigoRetornoGravame

integer<int32> | null

Código Retorno Gravame

dadosVeiculoDTO.dtSituacaoGravame

string<date-time> | null

Data de situação do Gravame

dadosVeiculoDTO.origemGravame

integer<int32> | null

Indica a origem do gravame do veículo (interno, externo ou ambos).

dadosVeiculoDTO.nroGravame

integer<int32> | null

Gravame

dadosVeiculoDTO.nroRegristroGecov

string | null

Número registro do GECOV – Gerenciador de contratos de veículos.

Maximum string length: 50

dadosVeiculoDTO.vlrFipe

number<double> | null

Valor da Fundação Instituto de Pesquisas Econômicas - Fipe.

Required range: 0 <= x <= 99999999.99

dadosVeiculoDTO.vlrVeiculo

number<double> | null

Valor do veiculo.

Required range: 0 <= x <= 99999999.99

dadosVeiculoDTO.zeroKM

boolean | null

Indica se o veículo possui zero quilômetros rodados.

dadosVeiculoDTO.km

integer<int32> | null

Valor da quilometragem do veículo.

Required range: 0 <= x <= 999999

Response

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

codigo

string<uuid>

numero

integer<int64>

27 - Reject 29 - Save Proposal Guarantee Asset

⌘I

Initial Guide

Signature Methods

Developer's Guide

APIs Reference

Use Cases

28 - Vehicle Registration

Authorizations

Headers

Body

Response