Skip to main content

Vehicle Collateral Manual

API under development

The API is still in development phase, therefore, this manual is subject to changes.

Warning!

QI Tech webhooks should not be mapped restrictively. Additional fields may be included in the webhook payloads returned by our APIs.

Webhook Resend

Webhooks can be queried and resent following the detailed instructions in the documentation: Webhook Resend.

This manual describes the complete flow of a credit operation with vehicle collateral (lien). Lien registration at SNG/B3, contract registration at DETRAN/Registrar, image submission, and cancellation are all handled internally by QI Tech. The process is tracked via consultation (GET) endpoints and webhooks.

Prerequisites​

  1. Have access credentials for the QI Tech API (see Getting Started);
  2. Have completed sandbox environment homologation;
  3. The vehicle must have valid chassis, RENAVAM (when already licensed), and licensing state information.

Flow Overview​

  1. Simulate — Send POST /debt_simulation with collateral_type: "vehicle" (see Simulation and Issuance);
  2. Create the operation — Send POST /debt including vehicle data in the collaterals object (see Simulation and Issuance);
  3. Signature receipt — The partner signs the contract and QI Tech receives the signature confirmation. Webhook sent: signature_finished;
  4. QI Tech registers the lien — After signing, QI Tech automatically submits lien registration to SNG/B3. Webhooks are sent: pending_reservation_confirmation → reserved;
  5. Disbursement — After lien confirmation (reserved), QI Tech disburses funds to the specified bank account;
  6. QI Tech registers the contract — QI Tech automatically submits contract registration to DETRAN/Registrar. Webhooks are sent: pending_registration_confirmation → registered;
  7. QI Tech submits the contract image — QI Tech handles image submission to DETRAN/Registrar;
  8. Track progress — Query the reservation (lien) and registration (contract) at any time via GET endpoints (see Queries);
  9. Receive notifications — Lien webhooks use type laas.vehicle_collateral.reservation_status_change (SNG/B3) and contract webhooks use laas.vehicle_collateral.register_status_change (DETRAN) (see Webhooks).
Base URLs

Staging: Provided by QI Tech during onboarding.
Production: Provided by QI Tech after homologation.

HTTP Codes

200 = Success · 201 = Created · 400 = Validation failure (see body) · 401 = Unauthorized · 403 = Forbidden · 404 = Not found · 500 = Internal error