Public APINo auth

Ativos

Consulta de ativos (recebíveis) que compõem os patrimônios securitizados. Ativos representam os direitos creditórios individuais — como CCBs, CRIs e debêntures — que lastram as séries tokenizadas.

Base URL

Todos os endpoints da Public API usam a base URL https://api.liqi.com.br. Nenhuma autenticação é necessária.

Dados Sensíveis

Para proteger a privacidade dos devedores, documentos (CPF/CNPJ) são retornados parcialmente mascarados. Apenas os últimos dígitos são visíveis.

Listar Ativos

GET/public/assets

Retorna uma lista paginada de ativos (recebíveis) públicos.

Query Parameters

Name	Type	Required	Description
`page`	integer	Optional	Número da página.(default: `1`)
`limit`	integer	Optional	Registros por página.(default: `10`)
`patrimonyId`	uuid	Optional	Filtrar ativos de um patrimônio específico.
`status`	string	Optional	Filtrar por status do ativo: ACTIVE, SETTLED, DEFAULTED, WRITTEN_OFF.
`type`	string	Optional	Filtrar por tipo de ativo: CCB, CRI, CRA, DEBENTURE, PRECATORIO.
`search`	string	Optional	Busca textual por ID externo ou nome do devedor.

Resposta

Retorna um objeto paginado com o array data. Cada ativo inclui valor original, saldo devedor atual, taxa de juros, número de parcelas e status de pagamento.

Detalhes do Ativo

GET/public/assets/:id

Retorna os dados completos de um ativo específico, incluindo histórico de pagamentos.

Path Parameters

Name	Type	Required	Description
`id`	uuid	Required	ID único do ativo.

Resposta

Além dos dados básicos, a resposta inclui:

patrimonyName — nome do patrimônio vinculado
batchId / batchName — lote de importação
paymentHistory — histórico de parcelas pagas e pendentes
nextDueDate / finalDueDate — próxima e última data de vencimento

Resumo de Ativos

GET/public/assets/summary

Retorna estatísticas agregadas do portfolio de ativos, opcionalmente filtrado por patrimônio.

Query Parameters

Name	Type	Required	Description
`patrimonyId`	uuid	Optional	Filtrar estatísticas de um patrimônio específico. Se omitido, retorna o consolidado de todos os patrimônios.

Campos da Resposta

Name	Type	Required	Description
`totalAssets`	integer	Required	Número total de ativos no portfolio.
`activeAssets`	integer	Required	Ativos atualmente em dia.
`settledAssets`	integer	Required	Ativos completamente liquidados.
`defaultedAssets`	integer	Required	Ativos em inadimplência.
`totalOriginalValue`	decimal	Required	Valor original total de todos os ativos em R$.
`totalCurrentBalance`	decimal	Required	Saldo devedor total atual em R$.
`totalReceivedPayments`	decimal	Required	Total de pagamentos recebidos em R$.
`defaultRate`	decimal	Required	Taxa de inadimplência em percentual (ex: 1.79 = 1,79%).
`byType`	object	Required	Breakdown por tipo de ativo, com count e totalValue para cada tipo.

Performance

O endpoint de resumo usa cache de 5 minutos. Para dados em tempo real, consulte os ativos individualmente.

Referência de Valores

Status do Ativo

Valor	Descrição
`ACTIVE`	Ativo em dia, com parcelas sendo pagas regularmente.
`SETTLED`	Ativo completamente liquidado (todas as parcelas pagas).
`DEFAULTED`	Ativo em inadimplência (atraso superior a 90 dias).
`WRITTEN_OFF`	Ativo baixado como perda (irrecuperável).

Tipo de Ativo

Valor	Descrição
`CCB`	Cédula de Crédito Bancário.
`CRI`	Certificado de Recebíveis Imobiliários.
`CRA`	Certificado de Recebíveis do Agronegócio.
`DEBENTURE`	Debênture (título de dívida corporativa).
`PRECATORIO`	Precatório (crédito judicial contra o poder público).

Listar Ativos

cURL

curl -X GET "https://api.liqi.com.br/public/assets?page=1&limit=10" \
  -H "Accept: application/json"

200Lista paginada de ativos

{
  "data": [
    {
      "id": "e1f2a3b4-c5d6-7890-abcd-ef1234567890",
      "externalId": "CCB-2024-001234",
      "type": "CCB",
      "status": "ACTIVE",
      "debtorName": "Maria Silva Santos",
      "debtorDocument": "***.***.***-90",
      "originalValue": "25000.00",
      "currentBalance": "18750.00",
      "interestRate": "2.50",
      "installments": 24,
      "paidInstallments": 8,
      "dueDate": "2026-05-15",
      "patrimonyId": "f1a2b3c4-d5e6-7890-abcd-ef1234567890",
      "createdAt": "2024-05-20T14:30:00.000Z"
    }
  ],
  "total": 1847,
  "page": 1,
  "limit": 10
}

Buscar por ID

cURL

curl -X GET "https://api.liqi.com.br/public/assets/e1f2a3b4-c5d6-7890-abcd-ef1234567890" \
  -H "Accept: application/json"

200Detalhes do ativo

{
  "id": "e1f2a3b4-c5d6-7890-abcd-ef1234567890",
  "externalId": "CCB-2024-001234",
  "type": "CCB",
  "status": "ACTIVE",
  "debtorName": "Maria Silva Santos",
  "debtorDocument": "***.***.***-90",
  "originalValue": "25000.00",
  "currentBalance": "18750.00",
  "interestRate": "2.50",
  "interestType": "MONTHLY",
  "installments": 24,
  "paidInstallments": 8,
  "nextDueDate": "2025-02-15",
  "finalDueDate": "2026-05-15",
  "patrimonyId": "f1a2b3c4-d5e6-7890-abcd-ef1234567890",
  "patrimonyName": "Patrimonio Roberta",
  "batchId": "d4e5f6a7-b8c9-0123-defg-456789012345",
  "batchName": "Lote Janeiro 2024",
  "paymentHistory": [
    {
      "installmentNumber": 8,
      "dueDate": "2025-01-15",
      "paidDate": "2025-01-14",
      "amount": "1250.00",
      "status": "PAID"
    },
    {
      "installmentNumber": 9,
      "dueDate": "2025-02-15",
      "paidDate": null,
      "amount": "1250.00",
      "status": "PENDING"
    }
  ],
  "createdAt": "2024-05-20T14:30:00.000Z",
  "updatedAt": "2025-01-14T10:15:00.000Z"
}

Resumo de Ativos

cURL

curl -X GET "https://api.liqi.com.br/public/assets/summary?patrimonyId=f1a2b3c4-..." \
  -H "Accept: application/json"

200Estatísticas agregadas dos ativos

{
  "totalAssets": 1847,
  "activeAssets": 1502,
  "settledAssets": 312,
  "defaultedAssets": 33,
  "totalOriginalValue": "46175000.00",
  "totalCurrentBalance": "34631250.00",
  "totalReceivedPayments": "11543750.00",
  "averageInterestRate": "2.35",
  "averageRemainingInstallments": 14,
  "defaultRate": "1.79",
  "byType": {
    "CCB": {
      "count": 1200,
      "totalValue": "30000000.00"
    },
    "CRI": {
      "count": 450,
      "totalValue": "11250000.00"
    },
    "DEBENTURE": {
      "count": 197,
      "totalValue": "4925000.00"
    }
  }
}