List licenses (paginated)

GET

licenses

all

curl --request GET \
  --url https://sandbox-api.anzi.finance/v1/licenses/all \
  --header 'X-API-KEY: <api-key>'

const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};

fetch('https://sandbox-api.anzi.finance/v1/licenses/all', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "licenses": [
    {
      "uid": "LIC-0001-XYZ",
      "tokenId": "123456",
      "active": true,
      "administrationFee": 0,
      "billCycle": "P1M",
      "coveragePercentage": 50,
      "daysForGuaranteesDueDate": 365,
      "historicPremiums": 120000,
      "installmentStrategy": "INSTALLMENT_COUNT",
      "installmentsEnabled": true,
      "isPremiumDefinedByClient": true,
      "isVariablePremium": true,
      "lastPortfolioUpdateDate": "2025-09-01T12:00:00.000Z",
      "lastRevision": "2025-08-15T00:00:00.000Z",
      "maximumCoverage": 50000,
      "maximumLoanAmount": 15000,
      "maximumLoanTerm": "P18M",
      "maximumPremium": 5,
      "minimumDaysToDeclareDefault": 190,
      "minimumLoanAmount": 1000,
      "minimumLoanTerm": "P1M",
      "minimumPremium": 2.5,
      "name": "Operative License A",
      "portfolioCoverageCap": 2000000,
      "portfolioCoverageUsed": 750000,
      "premium": 3.5,
      "taxRate": 0.19,
      "timezone": "America/Bogota",
      "type": 0,
      "validityPeriod": "P6M"
    },
    {
      "uid": "LIC-0002-XYZ",
      "tokenId": "123457",
      "active": true,
      "name": "Operative License B",
      "billCycle": "P1M",
      "coveragePercentage": 60,
      "timezone": "America/Bogota",
      "type": 0
    }
  ],
  "pagination": {
    "startCursor": "LIC-0001-XYZ",
    "endCursor": "LIC-0002-XYZ",
    "hasNextPage": true,
    "hasPreviousPage": false,
    "totalCount": 12
  }
}

{
  "code": "<string>",
  "message": "<string>"
}

{
  "code": "AUTH_2",
  "message": "Unauthorized"
}

{
  "code": "LI_00",
  "message": "License Not Found"
}

The response contains the licenses tied to your organization, wrapped in a paginated envelope: the rows travel under licenses and the paging metadata under pagination. page, limit and sort are optional. Calling this endpoint with no query params returns only the first 10 licenses — the response is a normal 200 OK, so if your organization has more than 10 licenses and you do not paginate, the extra ones are simply missing. Send an explicit limit, or page through the results while pagination.hasNextPage is true. Requesting a page beyond the last one is not an error: it answers 200 with an empty licenses array and the real totalCount.

Authorizations

X-API-KEY

string

header

required

Query Parameters

page

integer

default:1

Page number (1-based). Defaults to 1.

Required range: x >= 1

limit

integer

default:10

Page size, up to 100. Defaults to 10 — send it explicitly if you expect more.

Required range: 1 <= x <= 100

sort

enum<string>

default:asc

Sort direction applied to the license uid. Defaults to ascending.

Available options:

asc,

ascending,

desc,

descending

Response

Paginated list of licenses

licenses

object[]

Show child attributes

pagination

object

Cursor-like pagination structure returned alongside results.

Show child attributes

List licenses (paginated)

curl --request GET \
  --url https://sandbox-api.anzi.finance/v1/licenses/all \
  --header 'X-API-KEY: <api-key>'

const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};

fetch('https://sandbox-api.anzi.finance/v1/licenses/all', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "licenses": [
    {
      "uid": "LIC-0001-XYZ",
      "tokenId": "123456",
      "active": true,
      "administrationFee": 0,
      "billCycle": "P1M",
      "coveragePercentage": 50,
      "daysForGuaranteesDueDate": 365,
      "historicPremiums": 120000,
      "installmentStrategy": "INSTALLMENT_COUNT",
      "installmentsEnabled": true,
      "isPremiumDefinedByClient": true,
      "isVariablePremium": true,
      "lastPortfolioUpdateDate": "2025-09-01T12:00:00.000Z",
      "lastRevision": "2025-08-15T00:00:00.000Z",
      "maximumCoverage": 50000,
      "maximumLoanAmount": 15000,
      "maximumLoanTerm": "P18M",
      "maximumPremium": 5,
      "minimumDaysToDeclareDefault": 190,
      "minimumLoanAmount": 1000,
      "minimumLoanTerm": "P1M",
      "minimumPremium": 2.5,
      "name": "Operative License A",
      "portfolioCoverageCap": 2000000,
      "portfolioCoverageUsed": 750000,
      "premium": 3.5,
      "taxRate": 0.19,
      "timezone": "America/Bogota",
      "type": 0,
      "validityPeriod": "P6M"
    },
    {
      "uid": "LIC-0002-XYZ",
      "tokenId": "123457",
      "active": true,
      "name": "Operative License B",
      "billCycle": "P1M",
      "coveragePercentage": 60,
      "timezone": "America/Bogota",
      "type": 0
    }
  ],
  "pagination": {
    "startCursor": "LIC-0001-XYZ",
    "endCursor": "LIC-0002-XYZ",
    "hasNextPage": true,
    "hasPreviousPage": false,
    "totalCount": 12
  }
}

{
  "code": "<string>",
  "message": "<string>"
}

{
  "code": "AUTH_2",
  "message": "Unauthorized"
}

{
  "code": "LI_00",
  "message": "License Not Found"
}

Getting Started

Core Concepts

API Reference

List licenses (paginated)

Authorizations

Query Parameters

Response