Documentation Index
Fetch the complete documentation index at: https://api-docs.anzi.finance/llms.txt
Use this file to discover all available pages before exploring further.
What is a License?
A License is the backbone of your interaction with Anzi. It defines the operational parameters that govern how your integration works with us. These parameters include, among others:- Coverage configuration and limits
- Minimum/maximum loan amounts and terms
- Conditions for default declaration
- Total portfolio that can be guaranteed
- Premium settings (fixed or variable, ranges and rules)
License Types
There are two license types today, and we are working on adding more in order to unlock new guarantee use cases: See details, differences, and examples in License Types.Learn more: License Types
How Many Licenses Can I Have?
Your Anzi account can have any number of licenses of any type. Each guarantee you create is associated with exactly one license, and the license’s configuration governs validations, limits, coverage, and premium behavior.Who Manages Licenses?
Licenses are fully administered by Anzi. You cannot create or modify licenses directly. If you need an adjustment to your license configuration, please contact us at info@anzi.finance or reach out to your account executive.What is a License Revision?
(Applies only to Surety licenses) From time to time, Anzi reviews the performance of licenses within a specific period. Metrics such as default rate, coverage usage, and other parameters are analyzed, with the goal of adjusting coverage and guarantee pricing.Related Reference
- List your licenses: GET /licenses/all
License Data
Below is a summary of theLicense schema fields and their meanings.
| Field | Type | Description |
|---|---|---|
| uid | string | Unique identifier of the license. |
| name | string | Friendly and understandable name for your license. |
| tokenId | string | Identifier for NFT associated to the license. |
| coveragePercentage | number | For FIRST LOSS licenses (license.type = FIRST_LOSS), coverage depends exclusively on the amount the user has in their own reserve fund (wallet). |
| maximumCoverage | number | For FIRST LOSS licenses (license.type = FIRST_LOSS), coverage depends exclusively on the amount the user has in their own reserve fund (wallet). |
| premium | number | Percentage of the borrowed capital representing the premium to be paid. |
| active | boolean | Indicates if the license is active or not. |
| timezone | string | Reference to the location from which the time zone should be taken for license management. |
| maximumLoanTerm | string | Maximum duration of a loan in ISO 8601 duration format. |
| minimumLoanTerm | string | Minimum duration of a loan in ISO 8601 duration format. |
| daysForGuaranteesDueDate | number | The number of days after the surety.loanPaymentDueDate, during which the surety will still be valid. |
| minimumDaysToDeclareDefault | number | The number of days that must elapse since the last payment to declare a default. |
| portfolioCoverageCap | number | Total approved coverage amount for this license. |
| portfolioCoverageUsed | number | Total coverage issued to date, representing what has been spent from the authorized portfolio coverage cap on this license. |
| maximumLoanAmount | number | Maximum loan amount to be covered by Anzi. |
| minimumLoanAmount | number | Minimum loan amount to be covered by Anzi. |
| lastRevision | string (date-time) | ISO 8601 Date. Date of the last review of license configurations by the Anzi team. |
| validityPeriod | string | ISO 8601 duration. Validity period granted to the license since the last revision. |
| type | integer | 0 = SURETY, 1 = FIRST_LOSS |
| administrationFee | number | Amount of the administration fee to be paid over the reserve fund, only valid for FIRST LOSS licenses (license.type = FIRST_LOSS). |
| historicPremiums | number | Accumulated premium history amount. |
| isVariablePremium | boolean | Indicates if the premium is variable. |
| maximumPremium | number | Maximum premium amount to be paid for coverage concept, only valid if license.isVariablePremium is true. |
| minimumPremium | number | Minimum premium amount to be paid for coverage concept, only valid if license.isVariablePremium is true. |
| taxRate | number | Tax rate to be applied to the premium amount. |
| accountingEmails | string[] | Accounting emails list. Must contain at least one email. |
| billCycle | string | ISO 8601 duration for billing cycle (e.g., P1M). |
| isPremiumDefinedByClient | boolean | Indicates if the premium must be defined by the client. |