Queries

API under development

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

Query Debt

Returns the data for a single debt or a paginated list of debts. Filters are passed as query parameters.

ENDPOINT

/debt

METHOD

GET

Query Parameters

Parameter	Type	Description	Req.
key	String (UUID)	Unique debt identifier	NO
contract_number	String	Contract number	NO
issuer_document_number	String	Borrower CPF or CNPJ	NO
status	String	Debt status (e.g., opened, waiting_signature, disbursed, canceled, settled)	NO
page	Integer	Page number (default: 1)	NO
page_size	Integer	Records per page (default: 10, max: 100)	NO

Response — Search by key (single record)

STATUS

200

Response Body

{
    "data": {
        "key": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
        "contract_number": "OP-000000000000001",
        "status": "disbursed",
        "borrower": {
            "name": "João da Silva",
            "document_number": "12345678901",
            "person_type": "natural"
        },
        "financial": {
            "interest_type": "pre_price_days",
            "credit_operation_type": "ccb",
            "monthly_interest_rate": 0.018,
            "number_of_installments": 12,
            "issue_amount": 5419.55,
            "disbursement_date": "2025-05-10",
            "first_due_date": "2025-06-15"
        },
        "collaterals": [
            {
                "collateral_type": "vehicle",
                "collateral_key": "f1e2d3c4-b5a6-7890-fedc-ba0987654321",
                "collateral_data": {
                    "vehicle_type": "car",
                    "plate": "ABC1D23",
                    "license_state": "SP",
                    "chassi_number": "9BWZZZ37780001234",
                    "renavam": "12345678901"
                }
            }
        ],
        "created_at": "2025-05-10T14:30:00.000000",
        "updated_at": "2025-05-10T16:00:00.000000"
    }
}

Response — Paginated search (list)

Response Body

{
    "data": [
        {
            "key": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
            "contract_number": "OP-000000000000001",
            "status": "disbursed",
            "borrower": {
                "name": "João da Silva",
                "document_number": "12345678901",
                "person_type": "natural"
            },
            "financial": {
                "issue_amount": 5419.55,
                "number_of_installments": 12,
                "disbursement_date": "2025-05-10"
            },
            "created_at": "2025-05-10T14:30:00.000000"
        }
    ],
    "pagination": {
        "current_page": 1,
        "page_size": 10,
        "total_pages": 1,
        "total_items": 1
    }
}

---

Query Reservation Status (Lien)

Returns the current status of the lien (gravame) registration at SNG/B3.

ENDPOINT

/debt/DEBT-KEY/vehicle_collateral/reservation

METHOD

GET

Response Body (200)

{
    "status": "reserved",
    "last_updated_at": "2026-02-13 20:38:07",
    "chassi_number": "9BWZZZ37780001234",
    "license_state": "SP",
    "collateral_number": "12345678"
}

Response Fields

Field	Type	Description
status	String	Current lien status (see Status Map). Possible values: pending_reservation, pending_reservation_confirmation, reserved, pending_requester_action, canceled
last_updated_at	String	Last update timestamp (YYYY-MM-DD HH:MM:SS)
chassi_number	String	Vehicle chassis number
license_state	String	Vehicle licensing state (2 chars, uppercase)
collateral_number	String	Collateral number (up to 8 chars; "0" if not yet available)

---

Query Registration Status (Contract)

Returns the current status of the contract registration at DETRAN/Registrar.

ENDPOINT

/debt/DEBT-KEY/vehicle_collateral/register

METHOD

GET

Response Body (200)

{
    "status": "registered",
    "last_updated_at": "2026-02-14 10:45:07",
    "chassi_number": "9BWZZZ37780001234",
    "license_state": "SP"
}

Response Fields

Field	Type	Description
status	String	Current contract status (see Status Map). Possible values: pending_registration_confirmation, registered, pending_send_contract, pending_send_contract_confirmation, pending_requester_action, deleted
last_updated_at	String	Last update timestamp (YYYY-MM-DD HH:MM:SS)
chassi_number	String	Vehicle chassis number
license_state	String	Vehicle licensing state (2 chars, uppercase)