Consultas

API em desenvolvimento

A API ainda está em fase de desenvolvimento, sendo assim, este manual está sujeito a alterações.

Consultar Dívida

Retorna os dados de uma dívida ou uma lista paginada de dívidas. Os filtros são passados como query parameters.

ENDPOINT

/debt

MÉTODO

GET

Query Parameters

Parâmetro	Tipo	Descrição	Obrig.
key	String (UUID)	Identificador único da dívida	NÃO
contract_number	String	Número do contrato	NÃO
issuer_document_number	String	CPF ou CNPJ do tomador	NÃO
status	String	Status da dívida (ex: opened, waiting_signature, disbursed, canceled, settled)	NÃO
page	Integer	Número da página (padrão: 1)	NÃO
page_size	Integer	Quantidade de registros por página (padrão: 10, máx: 100)	NÃO

Response — Busca por key (registro único)

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": "automobile",
                    "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 — Busca paginada (lista)

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

---

Consultar Reserva (Gravame)

Retorna o status atual do registro de gravame no SNG/B3.

ENDPOINT

/debt/DEBT-KEY/vehicle_collateral/reservation

MÉTODO

GET

Response Body (200)

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

Campos da Response

Campo	Tipo	Descrição
status	String	Status atual do gravame (ver Mapa de Status). Valores possíveis: pending_reservation, pending_reservation_confirmation, reserved, pending_requester_action, refused
last_updated_at	String	Timestamp da última atualização (YYYY-MM-DD HH:MM:SS)
chassi_number	String	Número do chassi do veículo
license_state	String	UF de licenciamento do veículo (2 chars, caixa alta)
collateral_number	String	Número da garantia (até 8 chars; "0" se ainda não disponível)

---

Consultar Contrato (Registro DETRAN)

Retorna o status atual do registro de contrato no DETRAN/Registradora.

ENDPOINT

/debt/DEBT-KEY/vehicle_collateral/contract

MÉTODO

GET

Response Body (200)

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

Campos da Response

Campo	Tipo	Descrição
status	String	Status atual do contrato (ver Mapa de Status). Valores possíveis: pending_registration_confirmation, pending_send_contract, pending_send_contract_confirmation, deleted
last_updated_at	String	Timestamp da última atualização (YYYY-MM-DD HH:MM:SS)
chassi_number	String	Número do chassi do veículo
license_state	String	UF de licenciamento do veículo (2 chars, caixa alta)

---

Endpoints Auxiliares

Endpoint	Método	Descrição
/	GET	Nome do serviço e PID
/health_check	GET	204 No Content — health check
/vehicle_collateral/fees?state=&vehicle_type=	GET	Cálculo de tarifas por estado e tipo de veículo
/vehicle_collateral/mock_time	GET	Datetime atual — disponível apenas em DEV/LOCAL/SANDBOX