Status Map and Stages

API under development

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

Overview — Complete Lifecycle

The diagram below presents the complete lifecycle of a vehicle collateral operation, from debt creation through contract registration and image submission.

flowchart LR
    A["POST /debt"] --> B["Signature"]
    B --> C["Lien\n(SNG/B3)"]
    C --> D["Disbursement"]
    D --> E["Contract\n(DETRAN)"]
    E --> F["Contract\nImage"]
    F --> G["Completed"]

---

Collateral Lifecycle (Lien)

After the contract signature, QI Tech automatically sends the lien inclusion request to SNG/B3.

stateDiagram-v2
    [*] --> pending_reservation: Debt created with collateral_data

    state "pending_reservation" as pending_reservation
    state "pending_reservation_confirmation" as pending_confirmation
    state "reserved" as reserved
    state "pending_requester_action" as requester_action
    state "canceled" as canceled

    pending_reservation --> pending_confirmation: QI Tech sends to SNG/B3
    pending_reservation --> canceled: Canceled by partner

    pending_confirmation --> reserved: Lien registered successfully
    pending_confirmation --> requester_action: Data error
    pending_confirmation --> canceled: Impediment or restriction

    requester_action --> pending_confirmation: Data corrected and resubmitted

    reserved --> [*]: Ready for disbursement and contract registration
    canceled --> [*]

Status	Enumerator	Description
Reservation Pending	pending_reservation	Data entered in the platform, awaiting submission to SNG/B3
Reservation Confirmation Pending	pending_reservation_confirmation	Data sent to SNG/B3. Awaiting lien registration confirmation
Reserved	reserved	Lien registered successfully at SNG/B3. Operation ready for disbursement and contract registration
Requester Action Pending	pending_requester_action	Error in submitted data or restriction detected. Partner must correct and resubmit
Canceled	canceled	Request canceled on the platform

Cancellation Lifecycle (Lien Deletion)

When an operation needs to be canceled after the lien has been registered, the deletion flow is triggered:

flowchart LR
    A["reserved /\nregistered"] -->|Cancellation requested| B["pending_deletion"]
    B -->|Deletion sent to SNG/B3| C["pending_deletion_confirmation"]
    C -->|Deletion confirmed| D["deleted"]

Status	Enumerator	Description
Deletion Pending	pending_deletion	Cancellation requested, awaiting deletion submission to SNG/B3
Deletion Confirmation Pending	pending_deletion_confirmation	Deletion request sent. Awaiting SNG/B3 confirmation
Deleted	deleted	Collateral and contract fully canceled at SNG/B3 and DETRAN

---

Contract Lifecycle

After the lien is confirmed (reserved) and disbursement is completed, QI Tech automatically sends the contract registration to DETRAN/Registrar.

stateDiagram-v2
    [*] --> pending_registration_confirmation: Lien confirmed + disbursement

    state "pending_registration_confirmation" as pending_reg
    state "registered" as registered
    state "pending_send_contract" as pending_send
    state "pending_send_contract_confirmation" as pending_send_conf
    state "pending_requester_action" as requester_action
    state "deleted" as deleted

    pending_reg --> registered: Contract registered at DETRAN
    pending_reg --> requester_action: Invalid data or DETRAN counter
    pending_reg --> deleted: Canceled

    registered --> pending_send: Ready for contract image submission
    pending_send --> pending_send_conf: Image sent to DETRAN
    pending_send_conf --> registered: Image approved
    pending_send_conf --> requester_action: Image rejected (resubmission required)

    requester_action --> pending_reg: Data corrected and resubmitted
    deleted --> [*]

Status	Enumerator	Description
Registration Confirmation Pending	pending_registration_confirmation	Contract sent to DETRAN/Registrar. Awaiting validation and registration
Registered	registered	Contract registered successfully at DETRAN. Next step: image submission
Contract Send Pending	pending_send_contract	Contract registered, awaiting contract image submission
Contract Send Confirmation Pending	pending_send_contract_confirmation	Image sent to DETRAN/Registrar. Awaiting validation
Requester Action Pending	pending_requester_action	DETRAN counter (DF/TO: debtor must appear in person) or invalid data/image
Deleted	deleted	Contract canceled on the platform

Internal Statuses

Image validation statuses (e.g., invalid_image) are exclusively internal and are not sent to external clients via webhook.