Plate Enrichment

In this article you will learn how to:

• What is Plate Enrichment?
• Why use Plate Enrichment?
• How does Celcoin Plate Enrichment work?

Prerequisites for implementation

• Have a Celcoin API key, for more information access this link
• Have familiarity with the REST standard using the OAuth 2.0 protocol.
• Have the Plate Enrichment product/solution contracted and enabled in production.
  • If you want to use the functionality in a production environment, please contact our sales team via email at [email protected]. For technical questions, simply contact support via the link .

What is Plate Enrichment?

Through the Vehicle License Plate, this functionality allows basic vehicle information to be identified, such as: State, Renavam, Owner's Document, Model, Color and Year of Manufacture. With this data in hand, it is possible to carry out Debt Inquiries with the competent bodies and find out if the vehicle has any outstanding debts.

Why Use Plate Enrichment?

By using License Plate Enrichment, you ensure greater assertiveness and confidence in vehicle data, since your user does not need to provide it, making Vehicle Debt queries successful.

In addition, Plate Enrichment brings better performance, scalability and operational improvements on a daily basis.

How does Celcoin Plate Enrichment work?

In the Celcoin API, this feature is available in the Enriched Query call. Below is a manual on how to use this API.

🦉

Débitos Veiculares (Consulta Enriquecida) - cel_payments

Open Recipe

Plate Enrichment Request Form

cURL

curl --location --request POST 'https://sandbox.openfinance.celcoin.dev/vehicledebtsapi/v1/enrichment/getdata' \ -H 'accept: application/json' \ -H 'Authorization: Bearer acess_token' \ -H 'Content-Type: application/json-patch+json' \ -d '{ "licensePlate": "KXS6161", "clientRequestId": "{{$guid}}" }'

info

The data provided in the request template is for example purposes only.

Descriptive Table of Request Fields:

uf	Status of the plate consulted	String	True
licensePlate	Placa do Veículo	String	True
clientRequestId	Transaction identifier, can be an internal transaction ID	String	True

Return model

JSON

{ "errorCode": "000", "message": "Veículo Encontrado", "vehicle": { "status": true, "uf": "MG", "licensePlate": "KXS6161", "renavam": "217788721", "document": "00201022713", "model": "TOYOTA/COROLLA XEI20FLEX", "year": "2011", "color": "Azul" }, "enrichmentId": "d5ee5597-185b-4589-ac72-3afaf92ada26" }

info

The owner's document is only returned in the states of RJ, PE and PR where this data is mandatory to carry out the Debt Consultation.

info

If it is not possible to return any data, this field can assume the value null .

Tabela Descritiva dos Campos de Retorno:

Field	Description	Type
status	Indicates whether the Vehicle's UF is active in Celcoin	Boolean
uf	Estado do Veículo	String
licensePlate	Placa do Veículo	String
reindeer	National Motor Vehicle Registry of the Vehicle	String
document	Vehicle owner's CPF/CNJP	String
model	Vehicle Make and Model	String
year	Vehicle Year of Vehicle	String
color	Vehicle Color	String
enrichmentId	Plate Enrichment Query Identifier	String

info

The Plate Enrichment API is Synchronous, without the need to register a new webhook. The query result is returned moments after the request.

Descriptive Table of Returned Errors

Error Message	Error Code	Resolution
Query unavailable.	804	When this error occurs, you should wait, as the product may be experiencing momentary instability.
Vehicle not located	806	When performing the enriched query, the vehicle reported was not found in the database.
Invalid licensePlate field	809	Enter a correct license plate
Please check that the field type is in the correct format and try again.	809	Check the data provided in the request.
Product not released.	900	Contact support if you have purchased the product. If you don't have one, please contact our sales consultants.