Before you start building, we highly recommend reading the Core
Concepts to understand how Licenses, Guarantees,
and related terms work.
1
1st - POST users/apikeys
Call the Create API Key endpoint to generate your API credentials.
Use your corporate email and the password for the selected environment (Sandbox or Production) to generate the key.
You can also create it through our platform by following this guide.
After you receive your API key, include it in every request header as
X-API-KEY.2
2nd - GET /licenses (optional)
Understand your operational licenses. Before you start, we recommend reviewing
and understanding your operational licenses. See
List Licenses for the endpoint that
returns the configuration of your licenses and the key constraints you must
consider when creating guarantees.
3
3rd - GET /guarantees/coverages (optional)
Before creating your guarantee, you may want to estimate the portion of your
credit covered by Anzi and the premium you would pay. This endpoint returns
both coverage and premium based on your license configuration. See
Get Coverages for details.
4
4th - POST /guarantees
This endpoint is ready to work in tandem with your credit origination system,
enabling you to create guarantees for your credits that you wish to be covered
by Anzi in case of default. See
Create Guarantee.
5
5th - PUT /guarantees/credit-status (Claim Guarantees)
Periodically update your portfolio’s credit status through this endpoint. You
can also declare claims for guarantees that have gone into default. See
Update Credit Status.