34 - Registro de Veículo

cURL

cURL

curl --request POST \
  --url https://api.example.com/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
  }
}
'

200

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

Por meio deste endpoint o parceiro inclui os dados de veículo para uma proposta. O veículo obrigatoriamente deve ter uma placa informada, demais campos são opcionais. Os dados de veículos são validados pelos nossos analistas de crédito e servem como base para aprovar ou rejeitar a proposta. O uso será de acordo com a necessidade da integração.

Regras e Validações:

• A mesma placa não pode ser incluída mais de uma vez na proposta;
• Campos alfanuméricos serão truncados conforme o tamanho definido no manual;
• O campo documentoFederalProprietario aceita strings com 11 caracteres para CPF e 14 caracteres para CNPJ (apenas números).

​

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

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
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

​

Tabela de códigos auxuliares

Mostrar Tabelas

Mostrar TipoVeículo

ID	Descrição
1	Particular
2	Comercial
3	Oficial
4	Diplomático
5	Especial
6	Colecionador

Mostrar Tabela TipoRestrição

ID	Descrição
1	Arredondamento mercantil/leasing
2	Reserva e domínio/outros
3	Alienação fiduciária
4	Penhor

Mostrar Tabela TipoChassi

ID	Descrição
1	Remarcado
2	Normal

Mostrar Tabela SituaçãoGravame

ID	Descrição
2	Significa que existe alguma pendência gravame

Mostrar Tabela OrigemGravame

ID	Descrição
1	Interno
2	Externo
3	Ambos

---

Autorizações

Authorization · string · header · obrigatório

Informe o token

Cabeçalhos

IdempotencyKey · string · obrigatório

Corpo

application/jsontext/jsonapplication/*+json

dto · object

Show child attributes

dadosVeiculoDTO · object

Show child attributes

Resposta

200

text/plain

OK

msg · string | null

hasError · boolean

messages · object[] | null

Show child attributes

codigo · string<uuid>

numero · integer<int64>