{"info":{"_postman_id":"c8be523d-aaaf-4907-9390-19b1fed4fdf4","name":"Anzi Finance - V 0.0.9","description":"<html><head></head><body><h1 id=\"welcome-to-anzi-developers\">Welcome to Anzi Developers.</h1>\n<h5 id=\"you-are-one-step-away-from-safeguarding-your-and-your-investors-money-from-defaults-by-integrating-anzis-coverages-into-your-credit-ecosystem\"><strong>You are one step away from safeguarding your and your investors' money from defaults by integrating Anzi's coverages into your credit ecosystem.</strong></h5>\n<h5 id=\"test-endpoint-httpssandbox-api-wmu9pondigitaloceanapp\"><strong>Test Endpoint:</strong> <a href=\"https://sandbox-api-wmu9p.ondigitalocean.app/\">https://sandbox-api-wmu9p.ondigitalocean.app</a></h5>\n<h2 id=\"how-to-get-started-with-anzi-🛠️\">How to get started with Anzi? 🛠️</h2>\n<ol>\n<li>Ensure you have an operational license granted by Anzi.<br> • For Production: If you already have an operational license, go to the next step; otherwise, <a href=\"https://calendly.com/reuniones_andres/reunion\">Let's schedule a call.</a><br> • For Development: <strong>You can start NOW</strong> your integration using our sandbox. If you don't have an account on Anzi, go to our <a href=\"https://anzi-finance.vercel.app/\">platform</a>, create your user, and follow the steps to enter our <a href=\"https://sandbox-anzi.vercel.app/auth/login\">sandbox</a>. If you already have a password assigned to enter our <a href=\"https://sandbox-anzi.vercel.app/auth/login\">sandbox</a> (we sent it to your email when you created your account), log in to the sandbox and set up your license (it takes less than 2 minutes).</li>\n<li>Generate your API KEY by calling our <a href=\"#c95e4ec2-ff07-4d5f-96ee-08ee5df895f1\">Create API key</a> endpoint using your corporate email and password you use to log in. <strong>For development, use the sandbox password sent to your email when you created your account.</strong></li>\n<li>From this point on, you can create coverages for your loans using the <a href=\"#436cb60b-7f13-4d11-ad7c-ff9f6323cb8e\">Create surety</a> endpoint. <strong>You also can follow our</strong> <a href=\"#47fd0aef-ba74-492d-879f-3e6565672557\">Basic API Flow instructions</a><strong>.</strong></li>\n</ol>\n<blockquote>\n<p><strong>A little help for our developer community:</strong> You might come across some finance-related terms in this documentation that you're not familiar with. That's why <a href=\"#fc32c6ed-d96e-48f8-81e5-797ab6c7b67f\">we've created our glossary</a>, where you can find definitions for words that might be new to you. We hope it helps!</p>\n</blockquote>\n</body></html>","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Welcome to Anzi Developers.","slug":"welcome-to-anzi-developers"}],"owner":"29201474","collectionId":"c8be523d-aaaf-4907-9390-19b1fed4fdf4","publishedId":"2s9YsM8qEo","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-01-11T21:10:28.000Z"},"item":[{"name":"Basic API Flow","item":[],"id":"47fd0aef-ba74-492d-879f-3e6565672557","description":"<blockquote>\n<p>In this session, you can find the basic flow for generating and claiming the guarantees for your loans. </p>\n</blockquote>\n<h3 id=\"here-are-the-basic-steps-for-integration\">Here are the basic steps for integration:</h3>\n<h3 id=\"1st---post-usersapi-key\"><em>1st - Post</em> <a href=\"#c95e4ec2-ff07-4d5f-96ee-08ee5df895f1\"><i>/users/api-key</i></a></h3>\n<p>This endpoint allows you to create an API key using the email with which you registered.</p>\n<ul>\n<li><strong>For Development:</strong> Use the sandbox password sent to your email.</li>\n<li><strong>For Production:</strong> Use your original registration password to generate a production API Key.</li>\n</ul>\n<p>After calling this endpoint and receiving your API key, always include it in the header as X-API-KEY for every subsequent call to our API.</p>\n<h3 id=\"2nd---get-suretiescoverages-optional\"><em>2nd - Get</em> <a href=\"#d257f8b8-ad77-4b6a-935b-569fdef6e06b\">/sureties/coverages</a> (optional)</h3>\n<p>Before creating your surety, you will likely want to know the amount of your loan that will be covered by Anzi and the premium amount you will have to pay in exchange for that coverage. This endpoint will provide you with that information.</p>\n<h3 id=\"3rd---post-sureties\"><em>3rd - Post</em> <a href=\"#436cb60b-7f13-4d11-ad7c-ff9f6323cb8e\">/sureties</a></h3>\n<p>This endpoint is ready to work in tandem with your loan origination system, enabling you to create a surety for a loan that you wish to be covered by Anzi in case of default. The created surety will be linked to your current Anzi Operative license.</p>\n<h3 id=\"4th---get-claimsvalidate-optional\"><em>4th - Get</em> <a href=\"#86c0258a-6150-4c53-a6ea-6d63226c6cde\">/claims/validate</a> (optional)</h3>\n<p>In the event that your borrower fails to meet their payment obligations, you can consult this endpoint before making a claim, to validate if your claim is valid according to the configuration of your Anzi operative license. If valid, we will return the amount to be paid and the payment date of the coverage, along with the boolean <em>isEnabledForAutomaticPayment</em>, which indicates whether a payment will be made automatically at the times agreed upon between the client and Anzi.</p>\n<h3 id=\"5th---post-claims\"><em>5th - Post</em> <a href=\"#6ab76ad1-f9ed-46d0-87b3-b5b6e970ee9a\">/claims</a></h3>\n<p>In the event that one of your borrowers fails to meet their payment obligation for a number of days greater than or equal to that specified in the <em>minimumDaysToDeclareDefault</em> parameter of your Anzi operative license, you can call this endpoint. It will register your claim and notify us to proceed with scheduling your coverage payment according to the terms agreed upon with Anzi.</p>\n<h4 id=\"thats-how-simple-it-is-to-safeguard-your-and-your-investors-money-from-defaults-by-integrating-anzis-coverages-into-your-credit-ecosystem\"><em>That's how simple it is to safeguard your and your investors' money from defaults by integrating Anzi's coverages into your credit ecosystem.</em></h4>\n","_postman_id":"47fd0aef-ba74-492d-879f-3e6565672557","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{api-key}}"}]},"isInherited":true,"source":{"_postman_id":"c8be523d-aaaf-4907-9390-19b1fed4fdf4","id":"c8be523d-aaaf-4907-9390-19b1fed4fdf4","name":"Anzi Finance - V 0.0.9","type":"collection"}}},{"name":"Authorization","item":[{"name":"Create API KEY","id":"c95e4ec2-ff07-4d5f-96ee-08ee5df895f1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n  \"email\": \"test@fintech.com\",\r\n  \"password\": \"123456\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/v1/users/api-key","description":"<p>This endpoint allows you to generate an API key to begin integrating with our services, using only your user email and password.</p>\n<ul>\n<li><strong>For Development:</strong> Use the sandbox password sent to your email.</li>\n<li><strong>For Production:</strong> Use your original registration password to generate a production API Key.</li>\n</ul>\n<blockquote>\n<p>⚠️ <strong>Securely store and remain confidential your API key immediately upon generation, as it cannot be viewed again</strong> ⚠️ </p>\n</blockquote>\n<h4 id=\"body-request\">BODY REQUEST</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameter</th>\n<th>Type</th>\n<th>Required</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>email</td>\n<td>String</td>\n<td>Yes</td>\n<td>The user's email address for authentication.</td>\n</tr>\n<tr>\n<td>password</td>\n<td>String</td>\n<td>Yes</td>\n<td>The user's password for authentication.</td>\n</tr>\n<tr>\n<td>name</td>\n<td>String</td>\n<td>Yes</td>\n<td>Give your new api key a cool name to differentiate it from your other api keys.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">RESPONSE</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameter</th>\n<th>Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>apiKey</td>\n<td>String</td>\n<td>The generated API key</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"path":["v1","users","api-key"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"992d81ed-538c-4496-a990-47350933dbea","name":"success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n  \"email\": \"fernando@onepayment.finance\",\r\n  \"password\": \"prueba123\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/v1/users/api-key"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"38"},{"key":"ETag","value":"W/\"26-lCMWx/qQIg+wLAga3ooLtPLyC2c\""},{"key":"Date","value":"Tue, 09 Jan 2024 23:08:24 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n    \"apiKey\": \"dc1c3e72.98eb99-c3a9-4607-9e01-6fd008fac.90d23a8e-329d-4ad4-bfd-6538c0d1\"\n}"}],"_postman_id":"c95e4ec2-ff07-4d5f-96ee-08ee5df895f1"}],"id":"6a94d0a6-1300-4687-a3a8-d684524b881e","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"c1d1ce55-3f15-4e19-97de-0d74b1cc2f3c","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"516bc910-5730-4707-976b-e7264a6f7426","type":"text/javascript","exec":[""]}}],"_postman_id":"6a94d0a6-1300-4687-a3a8-d684524b881e","description":""},{"name":"Sureties","item":[{"name":"Create a surety","id":"436cb60b-7f13-4d11-ad7c-ff9f6323cb8e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n    \"loanPaymentConfig\": 1,\r\n    \"loanAmount\": 1500000,\r\n    \"principalName\": \"Test Client\",\r\n    \"paymentTerm\": \"2024-06-12\",\r\n    \"interestRate\": 5,\r\n    \"numberOfInstallments\": 5,\r\n    \"frequency\": 1\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/v1/sureties","description":"<p>This endpoint allows you to create a surety for a loan that you want to be covered by Anzi in case of default. The created surety will be linked to your current license.</p>\n<h4 id=\"body-request\">BODY REQUEST</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameter</th>\n<th>Type</th>\n<th>Required</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>loanPaymentConfig</td>\n<td>Integer</td>\n<td>Yes</td>\n<td>Type of periodicity the borrower has committed to pay. [ONE_PAYMENT, INSTALLMENTS]. <a href=\"https://documenter.getpostman.com/view/29201474/2s9YsM8qEo#076cba52-d17e-4b0b-9077-ee8ea3792049\">VIew Payment Config for specifications.</a></td>\n</tr>\n<tr>\n<td>loanAmount</td>\n<td>Float</td>\n<td>Yes</td>\n<td>Total principal amount of the loan.</td>\n</tr>\n<tr>\n<td>principalName</td>\n<td>String</td>\n<td>Yes</td>\n<td>The name of the company that takes the loan covered by this surety.</td>\n</tr>\n<tr>\n<td>paymentTerm</td>\n<td>String</td>\n<td>Yes</td>\n<td>ISO8601 Date on which the total debt must be paid.</td>\n</tr>\n<tr>\n<td>interestRate</td>\n<td>Float</td>\n<td>Yes</td>\n<td>Interest rate of the loan.</td>\n</tr>\n<tr>\n<td>numberOfInstallments</td>\n<td>Integer</td>\n<td>Required if loanPaymentConfig is INSTALLMENTS (1).</td>\n<td>Number of installments to be paid by the borrower to complete the loan payment.</td>\n</tr>\n<tr>\n<td>frequency</td>\n<td>Integer</td>\n<td>Required if loanPaymentConfig is INSTALLMENTS (1).</td>\n<td>Payment frequency of the borrower's installments [WEEKLY, MONTHLY]. <a href=\"https://documenter.getpostman.com/view/29201474/2s9YsM8qEo#9644f735-c1c6-404a-ab77-8d6c49266c03\">VIew installments frequency for specifications.</a></td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">RESPONSE.</h4>\n<p><a href=\"#7ecc4cf9-d236-4aa4-b4a1-56fccd9f613e\">In case of an error response, please review our table of error codes.</a></p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameter</th>\n<th>Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>uid</td>\n<td>String</td>\n<td>Unique identifier of the surety.  <br />Status of the surety.</td>\n</tr>\n<tr>\n<td>tokenId</td>\n<td>Integer</td>\n<td>Identifier for NFT associated with the surety.</td>\n</tr>\n<tr>\n<td>coverage</td>\n<td>Float</td>\n<td>Total principal amount covered by the surety.</td>\n</tr>\n<tr>\n<td>issuanceDate</td>\n<td>Date</td>\n<td>ISO8601 Date. Issuance date of the surety.</td>\n</tr>\n<tr>\n<td>dueDate</td>\n<td>Date</td>\n<td>ISO8601 Date. Surety expiration date, until this date the user can claim the surety.</td>\n</tr>\n<tr>\n<td>premiumPaymentDueDate</td>\n<td>Date</td>\n<td>ISO8601 Date of the deadline for premium payment of this surety.</td>\n</tr>\n<tr>\n<td>status</td>\n<td>Integer</td>\n<td>Status of the surety. [COVERING, CLAIMED, PAYING , CLOSE]. <a href=\"https://documenter.getpostman.com/view/29201474/2s9YsM8qEo#c5e740ef-49eb-4498-affa-1c4e2fd484dd\">View surety status for specifications.</a></td>\n</tr>\n<tr>\n<td>premium</td>\n<td>Float</td>\n<td>Value of the surety premium.</td>\n</tr>\n<tr>\n<td>premiumStatus</td>\n<td>Integer</td>\n<td>Status of the premium. [PENDING , PAID , OVERDUE]. <a href=\"https://documenter.getpostman.com/view/29201474/2s9YsM8qEo#155f02e3-2daf-410b-b254-01ca19b372e3\">VIew premium status for specifications</a></td>\n</tr>\n<tr>\n<td>principalName</td>\n<td>String</td>\n<td>The name of the company that takes the loan covered by this surety.</td>\n</tr>\n<tr>\n<td>numberOfInstallments</td>\n<td>Integer</td>\n<td>Number of installments to be paid by the borrower to complete the loan payment. No zero value if surety.loanPaymentConfig is INSTALLMENTS.</td>\n</tr>\n<tr>\n<td>frequency</td>\n<td>Integer</td>\n<td>Payment frequency of the borrower's installments, [WEEKLY , MONTHLY]. No null if surety.loanPaymentConfig is INSTALLMENTS. <a href=\"https://documenter.getpostman.com/view/29201474/2s9YsM8qEo#9644f735-c1c6-404a-ab77-8d6c49266c03\">VIew installments frequency for specifications.</a></td>\n</tr>\n<tr>\n<td>loanPaymentDueDate</td>\n<td>Date</td>\n<td>ISO8601 Date on which the total debt must be paid.</td>\n</tr>\n<tr>\n<td>loanPaymentConfig</td>\n<td>Integer</td>\n<td>Type of periodicity the borrower has committed to pay. [ONE_PAYMENT , INSTALLMENTS]. <a href=\"https://documenter.getpostman.com/view/29201474/2s9YsM8qEo#076cba52-d17e-4b0b-9077-ee8ea3792049\">VIew Payment Config for specifications.</a></td>\n</tr>\n<tr>\n<td>interestRate</td>\n<td>Float</td>\n<td>Interest rate of the loan.</td>\n</tr>\n<tr>\n<td>loanAmount</td>\n<td>Float</td>\n<td>Total principal amount of the loan.</td>\n</tr>\n<tr>\n<td>principalDocuments</td>\n<td>[String]</td>\n<td>Loan support documents</td>\n</tr>\n</tbody>\n</table>\n</div>","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{api-key}}"}]},"isInherited":true,"source":{"_postman_id":"c8be523d-aaaf-4907-9390-19b1fed4fdf4","id":"c8be523d-aaaf-4907-9390-19b1fed4fdf4","name":"Anzi Finance - V 0.0.9","type":"collection"}},"urlObject":{"path":["v1","sureties"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"3750d1d1-717e-46e8-9b96-96159e5c44bc","name":"success - ONE PAYMENT","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n    \"loanPaymentConfig\": 0,\r\n    \"loanAmount\": 1500000,\r\n    \"principalName\": \"Test Client\",\r\n    \"paymentTerm\": \"2024-01-26\",\r\n    \"interestRate\": 5\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:3001/v1/sureties"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"446"},{"key":"ETag","value":"W/\"1be-rC8R5qql55wa4TL6B3qXM6XcLyU\""},{"key":"Date","value":"Thu, 11 Jan 2024 16:12:35 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n    \"uid\": \"aa21d28a-757d-4d28-ac3a-bc6be6f2f92c\",\n    \"tokenId\": 1208344565,\n    \"coverage\": 750000,\n    \"issuanceDate\": \"2024-01-12T04:59:59.000Z\",\n    \"dueDate\": \"2024-09-09T04:59:59.000Z\",\n    \"premiumPaymentDueDate\": \"2024-01-14T04:59:59.000Z\",\n    \"status\": 0,\n    \"premium\": 37500,\n    \"principalName\": \"Test Client\",\n    \"numberOfInstallments\": 0,\n    \"frequency\": null,\n    \"loanPaymentDueDate\": \"2024-03-13T04:59:59.000Z\",\n    \"loanPaymentConfig\": 0,\n    \"interestRate\": 5,\n    \"loanAmount\": 1500000,\n    \"principalDocuments\": []\n}"},{"id":"b1fb26b1-2f4e-4d87-956a-3fc1dac0fc2f","name":"success - INSTALLMENTS","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n    \"loanPaymentConfig\": 1,\r\n    \"loanAmount\": 1500000,\r\n    \"principalName\": \"Test Client\",\r\n    \"paymentTerm\": \"2024-01-26\",\r\n    \"interestRate\": 5,\r\n    \"numberOfInstallments\": 5,\r\n    \"frequency\": 1\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:3001/v1/sureties"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"443"},{"key":"ETag","value":"W/\"1bb-SB5YL6nInRBDgGSNKNKUuxSa9HU\""},{"key":"Date","value":"Thu, 11 Jan 2024 16:37:50 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n    \"uid\": \"90fa8abe-fb53-4c3d-9068-c977430d2a76\",\n    \"tokenId\": 1600976805,\n    \"coverage\": 750000,\n    \"issuanceDate\": \"2024-01-12T04:59:59.000Z\",\n    \"dueDate\": \"2024-12-10T04:59:59.000Z\",\n    \"premiumPaymentDueDate\": \"2024-01-14T04:59:59.000Z\",\n    \"status\": 0,\n    \"premium\": 37500,\n    \"principalName\": \"Test Client\",\n    \"numberOfInstallments\": 5,\n    \"frequency\": 1,\n    \"loanPaymentDueDate\": \"2024-06-13T04:59:59.000Z\",\n    \"loanPaymentConfig\": 1,\n    \"interestRate\": 5,\n    \"loanAmount\": 1500000,\n    \"principalDocuments\": []\n}"}],"_postman_id":"436cb60b-7f13-4d11-ad7c-ff9f6323cb8e"},{"name":"Get coverage info","id":"d257f8b8-ad77-4b6a-935b-569fdef6e06b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{baseUrl}}/v1/sureties/coverages?loanAmount=450000","description":"<p>Before creating a surety, you can call this endpoint to determine, according to your Anzi License configuration, if a loan amount is valid, the amount that will be covered by Anzi's surety, and the premium value.</p>\n<h4 id=\"request-query-params\">REQUEST QUERY PARAMS</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameter</th>\n<th>Type</th>\n<th>Required</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>loanAmount</td>\n<td>Integer</td>\n<td>Yes</td>\n<td>The loan amount on which the coverage and premium estimate will be based.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">RESPONSE</h4>\n<p><a href=\"#7ecc4cf9-d236-4aa4-b4a1-56fccd9f613e\">In case of an error response, please review our table of error codes.</a></p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameter</th>\n<th>Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>coverage</td>\n<td>Float</td>\n<td>This is the maximum amount of your credit that Anzi's surety will cover.</td>\n</tr>\n<tr>\n<td>premium</td>\n<td>Float</td>\n<td>This is the amount you will need to pay for a surety.</td>\n</tr>\n</tbody>\n</table>\n</div>","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{api-key}}"}]},"isInherited":true,"source":{"_postman_id":"c8be523d-aaaf-4907-9390-19b1fed4fdf4","id":"c8be523d-aaaf-4907-9390-19b1fed4fdf4","name":"Anzi Finance - V 0.0.9","type":"collection"}},"urlObject":{"path":["v1","sureties","coverages"],"host":["{{baseUrl}}"],"query":[{"key":"loanAmount","value":"450000"}],"variable":[]}},"response":[{"id":"acf4768b-62df-4b92-a7c6-955b4a201157","name":"success","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/v1/sureties/coverages?loanAmount=450000","host":["{{baseUrl}}"],"path":["v1","sureties","coverages"],"query":[{"key":"loanAmount","value":"450000"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 15 Jan 2024 17:51:54 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"35"},{"key":"Connection","value":"keep-alive"},{"key":"x-powered-by","value":"Express"},{"key":"access-control-allow-origin","value":"*"},{"key":"etag","value":"W/\"23-Ktx1qUJGRrNRT1aMogrUlMJmD7U\""},{"key":"x-do-app-origin","value":"89637336-8256-431d-bccc-78f5431c62a3"},{"key":"cache-control","value":"private"},{"key":"x-do-orig-status","value":"200"},{"key":"CF-Cache-Status","value":"MISS"},{"key":"Accept-Ranges","value":"bytes"},{"key":"Set-Cookie","value":"__cf_bm=aVoCq6KZwpfnYGYto9I04MTKIwoMJqmRusQ0U0duGuk-1705341114-1-ATn1SdwiDI1QfvlHs75Kk8cifpaz94ZRUVTN6TMfBqSuDK8XQBfQ/lvvGyX1aubg7jzT08TuBSNt6E5b8eJO690=; path=/; expires=Mon, 15-Jan-24 18:21:54 GMT; domain=.ondigitalocean.app; HttpOnly; Secure; SameSite=None"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"845ff829ba36da7b-MIA"}],"cookie":[],"responseTime":null,"body":"{\n    \"premium\": 11250,\n    \"coverage\": 225000\n}"}],"_postman_id":"d257f8b8-ad77-4b6a-935b-569fdef6e06b"},{"name":"Get a surety by UID","id":"4b0168af-c8ff-4606-9f3e-f7a9f25dc06e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{baseUrl}}/v1/sureties/:uid","description":"<p><strong>Get a specific surety by UID.</strong></p>\n<h4 id=\"request-path-variables\">REQUEST PATH VARIABLES</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameter</th>\n<th>Type</th>\n<th>Required</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>uid</td>\n<td>String</td>\n<td>Yes</td>\n<td>The surety UID</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">RESPONSE</h4>\n<p><a href=\"#7ecc4cf9-d236-4aa4-b4a1-56fccd9f613e\">In case of an error response, please review our table of error codes.</a></p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameter</th>\n<th>Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>uid</td>\n<td>String</td>\n<td>Unique identifier of the surety.  <br />Status of the surety.</td>\n</tr>\n<tr>\n<td>tokenId</td>\n<td>Integer</td>\n<td>Identifier for NFT associated with the surety.</td>\n</tr>\n<tr>\n<td>coverage</td>\n<td>Float</td>\n<td>Total principal amount covered by the surety.</td>\n</tr>\n<tr>\n<td>issuanceDate</td>\n<td>Date</td>\n<td>ISO8601 Date. Issuance date of the surety.</td>\n</tr>\n<tr>\n<td>dueDate</td>\n<td>Date</td>\n<td>ISO8601 Date. Surety expiration date, until this date the user can claim the surety.</td>\n</tr>\n<tr>\n<td>premiumPaymentDueDate</td>\n<td>Date</td>\n<td>ISO8601 Date of the deadline for premium payment of this surety.</td>\n</tr>\n<tr>\n<td>status</td>\n<td>Integer</td>\n<td>Status of the surety. [COVERING, CLAIMED, PAYING , CLOSE]. <a href=\"https://documenter.getpostman.com/view/29201474/2s9YsM8qEo#c5e740ef-49eb-4498-affa-1c4e2fd484dd\">View surety status for specifications.</a></td>\n</tr>\n<tr>\n<td>premium</td>\n<td>Float</td>\n<td>Value of the surety premium.</td>\n</tr>\n<tr>\n<td>premiumStatus</td>\n<td>Integer</td>\n<td>Status of the premium. [PENDING , PAID , OVERDUE]. <a href=\"https://documenter.getpostman.com/view/29201474/2s9YsM8qEo#155f02e3-2daf-410b-b254-01ca19b372e3\">VIew premium status for specifications</a></td>\n</tr>\n<tr>\n<td>principalName</td>\n<td>String</td>\n<td>The name of the company that takes the loan covered by this surety.</td>\n</tr>\n<tr>\n<td>numberOfInstallments</td>\n<td>Integer</td>\n<td>Number of installments to be paid by the borrower to complete the loan payment. No zero value if surety.loanPaymentConfig is INSTALLMENTS.</td>\n</tr>\n<tr>\n<td>frequency</td>\n<td>Integer</td>\n<td>Payment frequency of the borrower's installments, [WEEKLY , MONTHLY]. No null if surety.loanPaymentConfig is INSTALLMENTS. <a href=\"https://documenter.getpostman.com/view/29201474/2s9YsM8qEo#9644f735-c1c6-404a-ab77-8d6c49266c03\">VIew installments frequency for specifications.</a></td>\n</tr>\n<tr>\n<td>loanPaymentDueDate</td>\n<td>Date</td>\n<td>ISO8601 Date on which the total debt must be paid.</td>\n</tr>\n<tr>\n<td>loanPaymentConfig</td>\n<td>Integer</td>\n<td>Type of periodicity the borrower has committed to pay. [ONE_PAYMENT , INSTALLMENTS]. <a href=\"https://documenter.getpostman.com/view/29201474/2s9YsM8qEo#076cba52-d17e-4b0b-9077-ee8ea3792049\">VIew Payment Config for specifications.</a></td>\n</tr>\n<tr>\n<td>interestRate</td>\n<td>Float</td>\n<td>Interest rate of the loan.</td>\n</tr>\n<tr>\n<td>loanAmount</td>\n<td>Float</td>\n<td>Total principal amount of the loan.</td>\n</tr>\n<tr>\n<td>principalDocuments</td>\n<td>[String]</td>\n<td>Loan support documents</td>\n</tr>\n</tbody>\n</table>\n</div>","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{api-key}}"}]},"isInherited":true,"source":{"_postman_id":"c8be523d-aaaf-4907-9390-19b1fed4fdf4","id":"c8be523d-aaaf-4907-9390-19b1fed4fdf4","name":"Anzi Finance - V 0.0.9","type":"collection"}},"urlObject":{"path":["v1","sureties",":uid"],"host":["{{baseUrl}}"],"query":[],"variable":[{"description":{"content":"<p>(Required) The surety UID</p>\n","type":"text/plain"},"type":"any","value":"","key":"uid"}]}},"response":[{"id":"b77d366c-2e74-4bfb-be24-4f1a5c61c659","name":"success","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/v1/sureties/:uid","host":["{{baseUrl}}"],"path":["v1","sureties",":uid"],"variable":[{"key":"uid","value":"172029e2-560f-4b82-bb13-e9981bb8c2","description":"(Required) Esta es una descipcion"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"481"},{"key":"ETag","value":"W/\"1e1-TY1wvpN0k201R7/nMmCsnrrNq70\""},{"key":"Date","value":"Wed, 10 Jan 2024 14:40:35 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n    \"uid\": \"172029e2-560f-4b82-bb13-e9981bb8c2\",\n    \"tokenId\": 1476233776,\n    \"coverage\": 825000,\n    \"issuanceDate\": \"2024-01-10T04:59:59.000Z\",\n    \"dueDate\": \"2024-07-29T23:59:59.000Z\",\n    \"premiumPaymentDueDate\": \"2024-01-14T04:59:59.000Z\",\n    \"status\": 0,\n    \"premium\": 41250,\n    \"principalName\": \"Client 433\",\n    \"numberOfInstallments\": null,\n    \"frequency\": 0,\n    \"loanPaymentDueDate\": \"2024-01-31T23:59:59.000Z\",\n    \"loanPaymentConfig\": 0,\n    \"interestRate\": 0,\n    \"loanAmount\": 1650000,\n    \"principalDocuments\": [\n        \"https://example.com/principal-docs\"\n    ]\n}"}],"_postman_id":"4b0168af-c8ff-4606-9f3e-f7a9f25dc06e"},{"name":"Get sureties by status","id":"6eb8c289-ff68-4073-b57e-10677d7effe3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{baseUrl}}/v1/sureties/by-status?status=&page=&limit=","description":"<p>This endpoint allows you to retrieve sureties linked to your license using their status as a filter.</p>\n<h4 id=\"request-query-params\">REQUEST QUERY PARAMS</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameter</th>\n<th>Type</th>\n<th>Required</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>status</td>\n<td>Integer</td>\n<td>Yes</td>\n<td>The status of sureties to filter. <a href=\"https://documenter.getpostman.com/view/29201474/2s9YsM8qEo#c5e740ef-49eb-4498-affa-1c4e2fd484dd\">View surety status for specifications.</a></td>\n</tr>\n<tr>\n<td>page</td>\n<td>Integer</td>\n<td>Yes</td>\n<td>The page number for pagination.</td>\n</tr>\n<tr>\n<td>limit</td>\n<td>Integer</td>\n<td>Yes</td>\n<td>The number of results per page.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">RESPONSE</h4>\n<p>The API will respond with a list of sureties matching the specified status filter, along with pagination information <a href=\"https://documenter.getpostman.com/view/29201474/2s9YsM8qEo#baf1aace-6569-4564-863d-bc1df65ed903\">(View pagination structure for specification).</a></p>\n<p><a href=\"#7ecc4cf9-d236-4aa4-b4a1-56fccd9f613e\">In case of an error response, please review our table of error codes.</a></p>\n<p><a href=\"https://documenter.getpostman.com/view/29201474/2s9YsM8qEo#baf1aace-6569-4564-863d-bc1df65ed903\"></a></p>\n<h6 id=\"surety-schema-in-response\">Surety Schema in response</h6>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameter</th>\n<th>Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>uid</td>\n<td>String</td>\n<td>Unique identifier of the surety.  <br />Status of the surety.</td>\n</tr>\n<tr>\n<td>tokenId</td>\n<td>Integer</td>\n<td>Identifier for NFT associated with the surety.</td>\n</tr>\n<tr>\n<td>coverage</td>\n<td>Float</td>\n<td>Total principal amount covered by the surety.</td>\n</tr>\n<tr>\n<td>issuanceDate</td>\n<td>Date</td>\n<td>ISO8601 Date. Issuance date of the surety.</td>\n</tr>\n<tr>\n<td>dueDate</td>\n<td>Date</td>\n<td>ISO8601 Date. Surety expiration date, until this date the user can claim the surety.</td>\n</tr>\n<tr>\n<td>premiumPaymentDueDate</td>\n<td>Date</td>\n<td>ISO8601 Date of the deadline for premium payment of this surety.</td>\n</tr>\n<tr>\n<td>status</td>\n<td>Integer</td>\n<td>Status of the surety. [COVERING, CLAIMED, PAYING , CLOSE]. <a href=\"https://documenter.getpostman.com/view/29201474/2s9YsM8qEo#c5e740ef-49eb-4498-affa-1c4e2fd484dd\">View surety status for specifications.</a></td>\n</tr>\n<tr>\n<td>premium</td>\n<td>Float</td>\n<td>Value of the surety premium.</td>\n</tr>\n<tr>\n<td>premiumStatus</td>\n<td>Integer</td>\n<td>Status of the premium. [PENDING , PAID , OVERDUE]. <a href=\"https://documenter.getpostman.com/view/29201474/2s9YsM8qEo#155f02e3-2daf-410b-b254-01ca19b372e3\">VIew premium status for specifications</a></td>\n</tr>\n<tr>\n<td>principalName</td>\n<td>String</td>\n<td>The name of the company that takes the loan covered by this surety.</td>\n</tr>\n<tr>\n<td>numberOfInstallments</td>\n<td>Integer</td>\n<td>Number of installments to be paid by the borrower to complete the loan payment. No zero value if surety.loanPaymentConfig is INSTALLMENTS.</td>\n</tr>\n<tr>\n<td>frequency</td>\n<td>Integer</td>\n<td>Payment frequency of the borrower's installments, [WEEKLY , MONTHLY]. No null if surety.loanPaymentConfig is INSTALLMENTS. <a href=\"https://documenter.getpostman.com/view/29201474/2s9YsM8qEo#9644f735-c1c6-404a-ab77-8d6c49266c03\">VIew installments frequency for specifications.</a></td>\n</tr>\n<tr>\n<td>loanPaymentDueDate</td>\n<td>Date</td>\n<td>ISO8601 Date on which the total debt must be paid.</td>\n</tr>\n<tr>\n<td>loanPaymentConfig</td>\n<td>Integer</td>\n<td>Type of periodicity the borrower has committed to pay. [ONE_PAYMENT , INSTALLMENTS]. <a href=\"https://documenter.getpostman.com/view/29201474/2s9YsM8qEo#076cba52-d17e-4b0b-9077-ee8ea3792049\">VIew Payment Config for specifications.</a></td>\n</tr>\n<tr>\n<td>interestRate</td>\n<td>Float</td>\n<td>Interest rate of the loan.</td>\n</tr>\n<tr>\n<td>loanAmount</td>\n<td>Float</td>\n<td>Total principal amount of the loan.</td>\n</tr>\n<tr>\n<td>principalDocuments</td>\n<td>[String]</td>\n<td>Loan support documents</td>\n</tr>\n</tbody>\n</table>\n</div>","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{api-key}}"}]},"isInherited":true,"source":{"_postman_id":"c8be523d-aaaf-4907-9390-19b1fed4fdf4","id":"c8be523d-aaaf-4907-9390-19b1fed4fdf4","name":"Anzi Finance - V 0.0.9","type":"collection"}},"urlObject":{"path":["v1","sureties","by-status"],"host":["{{baseUrl}}"],"query":[{"key":"status","value":""},{"key":"page","value":""},{"key":"limit","value":""}],"variable":[]}},"response":[{"id":"d4e3346b-0ff1-409a-a163-348b53d66376","name":"success","originalRequest":{"method":"GET","header":[],"url":{"raw":"http://localhost:3001/v1/sureties/by-status?page=1&status=0&limit=5","protocol":"http","host":["localhost"],"port":"3001","path":["v1","sureties","by-status"],"query":[{"key":"page","value":"1"},{"key":"status","value":"0"},{"key":"limit","value":"5"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"2606"},{"key":"ETag","value":"W/\"a2e-nUoaM0YN20/20QKbmQqei+c8iXs\""},{"key":"Date","value":"Wed, 10 Jan 2024 16:02:28 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n    \"sureties\": [\n        {\n            \"uid\": \"172029e2-560f-4b82-bb13-e9981bb8c203\",\n            \"tokenId\": 1476233776,\n            \"coverage\": 825000,\n            \"issuanceDate\": \"2024-01-10T04:59:59.000Z\",\n            \"dueDate\": \"2024-07-29T23:59:59.000Z\",\n            \"premiumPaymentDueDate\": \"2024-01-14T04:59:59.000Z\",\n            \"status\": 0,\n            \"premium\": 41250,\n            \"principalName\": \"Client 433\",\n            \"numberOfInstallments\": null,\n            \"frequency\": 0,\n            \"loanPaymentDueDate\": \"2024-01-31T23:59:59.000Z\",\n            \"loanPaymentConfig\": 0,\n            \"interestRate\": 0,\n            \"loanAmount\": 1650000,\n            \"principalDocuments\": [\n                \"https://example.com/principal-docs\"\n            ]\n        },\n        {\n            \"uid\": \"bdc7fe55-1571-4ce3-9a09-a17e4ece4a7c\",\n            \"tokenId\": 4098969444,\n            \"coverage\": 750000,\n            \"issuanceDate\": \"2024-01-10T04:59:59.000Z\",\n            \"dueDate\": \"2024-09-07T04:59:59.000Z\",\n            \"premiumPaymentDueDate\": \"2024-01-14T04:59:59.000Z\",\n            \"status\": 0,\n            \"premium\": 37500,\n            \"principalName\": \"Test Client\",\n            \"numberOfInstallments\": 0,\n            \"frequency\": null,\n            \"loanPaymentDueDate\": \"2024-03-11T04:59:59.000Z\",\n            \"loanPaymentConfig\": 0,\n            \"interestRate\": 5,\n            \"loanAmount\": 1500000,\n            \"principalDocuments\": [\n                \"https://example.com/principal-docs\"\n            ]\n        },\n        {\n            \"uid\": \"65e2406f-d983-46fe-91e3-d63fbf345f1c\",\n            \"tokenId\": 2892241341,\n            \"coverage\": 750000,\n            \"issuanceDate\": \"2024-01-10T04:59:59.000Z\",\n            \"dueDate\": \"2024-09-07T04:59:59.000Z\",\n            \"premiumPaymentDueDate\": \"2024-01-14T04:59:59.000Z\",\n            \"status\": 0,\n            \"premium\": 37500,\n            \"principalName\": \"Test Client\",\n            \"numberOfInstallments\": 8,\n            \"frequency\": 0,\n            \"loanPaymentDueDate\": \"2024-03-11T04:59:59.000Z\",\n            \"loanPaymentConfig\": 0,\n            \"interestRate\": 5,\n            \"loanAmount\": 1500000,\n            \"principalDocuments\": [\n                \"https://example.com/principal-docs\"\n            ]\n        },\n        {\n            \"uid\": \"af3058a3-b61c-44e0-a130-1d3d86c4dc1c\",\n            \"tokenId\": 3801139779,\n            \"coverage\": 227272.72,\n            \"issuanceDate\": \"2024-01-06T04:59:59.000Z\",\n            \"dueDate\": \"2024-07-18T23:59:59.000Z\",\n            \"premiumPaymentDueDate\": \"2024-01-07T04:59:59.000Z\",\n            \"status\": 0,\n            \"premium\": 11363.64,\n            \"principalName\": \"sda\",\n            \"numberOfInstallments\": null,\n            \"frequency\": 0,\n            \"loanPaymentDueDate\": \"2024-01-20T23:59:59.000Z\",\n            \"loanPaymentConfig\": 0,\n            \"interestRate\": 0,\n            \"loanAmount\": 454545.44,\n            \"principalDocuments\": [\n                \"https://example.com/principal-docs\"\n            ]\n        },\n        {\n            \"uid\": \"824c1c77-609f-4ddf-bb5d-c0547c751f59\",\n            \"tokenId\": 3099813407,\n            \"coverage\": 439393.94,\n            \"issuanceDate\": \"2024-01-06T04:59:59.000Z\",\n            \"dueDate\": \"2024-07-25T23:59:59.000Z\",\n            \"premiumPaymentDueDate\": \"2024-01-07T04:59:59.000Z\",\n            \"status\": 0,\n            \"premium\": 21969.7,\n            \"principalName\": \"test098\",\n            \"numberOfInstallments\": null,\n            \"frequency\": 0,\n            \"loanPaymentDueDate\": \"2024-01-27T23:59:59.000Z\",\n            \"loanPaymentConfig\": 0,\n            \"interestRate\": 0,\n            \"loanAmount\": 878787.87,\n            \"principalDocuments\": [\n                \"https://example.com/principal-docs\"\n            ]\n        }\n    ],\n    \"pagination\": {\n        \"startCursor\": \"172029e2-560f-4b82-bb13-e9981bb8c203\",\n        \"endCursor\": \"824c1c77-609f-4ddf-bb5d-c0547c751f59\",\n        \"hasNextPage\": true,\n        \"hasPreviousPage\": false,\n        \"totalCount\": 60\n    }\n}"}],"_postman_id":"6eb8c289-ff68-4073-b57e-10677d7effe3"},{"name":"Get sureties by license","id":"e0e54f42-5443-4b6c-aacd-dc44f70d278d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{baseUrl}}/v1/sureties/by-license?limit=&page=","description":"<p>This endpoint allows you to retrieve sureties linked to your license.</p>\n<h4 id=\"request-query-params\">REQUEST QUERY PARAMS</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameter</th>\n<th>Type</th>\n<th>Required</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>page</td>\n<td>Integer</td>\n<td>Yes</td>\n<td>The page number for pagination.</td>\n</tr>\n<tr>\n<td>limit</td>\n<td>Integer</td>\n<td>Yes</td>\n<td>The number of results per page.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">RESPONSE</h4>\n<p>The API will respond with a list of sureties linked to your license, along with pagination information <a href=\"https://documenter.getpostman.com/view/29201474/2s9YsM8qEo#baf1aace-6569-4564-863d-bc1df65ed903\">(View pagination structure for specification).</a></p>\n<p><a href=\"https://documenter.getpostman.com/view/29201474/2s9YsM8qEo#baf1aace-6569-4564-863d-bc1df65ed903\"></a><a href=\"#7ecc4cf9-d236-4aa4-b4a1-56fccd9f613e\">In case of an error response, please review our table of error codes.</a></p>\n<h6 id=\"surety-schema-in-response\">Surety Schema in response</h6>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameter</th>\n<th>Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>uid</td>\n<td>String</td>\n<td>Unique identifier of the surety.  <br />Status of the surety.</td>\n</tr>\n<tr>\n<td>tokenId</td>\n<td>Integer</td>\n<td>Identifier for NFT associated with the surety.</td>\n</tr>\n<tr>\n<td>coverage</td>\n<td>Float</td>\n<td>Total principal amount covered by the surety.</td>\n</tr>\n<tr>\n<td>issuanceDate</td>\n<td>Date</td>\n<td>ISO8601 Date. Issuance date of the surety.</td>\n</tr>\n<tr>\n<td>dueDate</td>\n<td>Date</td>\n<td>ISO8601 Date. Surety expiration date, until this date the user can claim the surety.</td>\n</tr>\n<tr>\n<td>premiumPaymentDueDate</td>\n<td>Date</td>\n<td>ISO8601 Date of the deadline for premium payment of this surety.</td>\n</tr>\n<tr>\n<td>status</td>\n<td>Integer</td>\n<td>Status of the surety. [COVERING, CLAIMED, PAYING , CLOSE]. <a href=\"https://documenter.getpostman.com/view/29201474/2s9YsM8qEo#c5e740ef-49eb-4498-affa-1c4e2fd484dd\">View surety status for specifications.</a></td>\n</tr>\n<tr>\n<td>premium</td>\n<td>Float</td>\n<td>Value of the surety premium.</td>\n</tr>\n<tr>\n<td>premiumStatus</td>\n<td>Integer</td>\n<td>Status of the premium. [PENDING , PAID , OVERDUE]. <a href=\"https://documenter.getpostman.com/view/29201474/2s9YsM8qEo#155f02e3-2daf-410b-b254-01ca19b372e3\">VIew premium status for specifications</a></td>\n</tr>\n<tr>\n<td>principalName</td>\n<td>String</td>\n<td>The name of the company that takes the loan covered by this surety.</td>\n</tr>\n<tr>\n<td>numberOfInstallments</td>\n<td>Integer</td>\n<td>Number of installments to be paid by the borrower to complete the loan payment. No zero value if surety.loanPaymentConfig is INSTALLMENTS.</td>\n</tr>\n<tr>\n<td>frequency</td>\n<td>Integer</td>\n<td>Payment frequency of the borrower's installments, [WEEKLY , MONTHLY]. No null if surety.loanPaymentConfig is INSTALLMENTS. <a href=\"https://documenter.getpostman.com/view/29201474/2s9YsM8qEo#9644f735-c1c6-404a-ab77-8d6c49266c03\">VIew installments frequency for specifications.</a></td>\n</tr>\n<tr>\n<td>loanPaymentDueDate</td>\n<td>Date</td>\n<td>ISO8601 Date on which the total debt must be paid.</td>\n</tr>\n<tr>\n<td>loanPaymentConfig</td>\n<td>Integer</td>\n<td>Type of periodicity the borrower has committed to pay. [ONE_PAYMENT , INSTALLMENTS]. <a href=\"https://documenter.getpostman.com/view/29201474/2s9YsM8qEo#076cba52-d17e-4b0b-9077-ee8ea3792049\">VIew Payment Config for specifications.</a></td>\n</tr>\n<tr>\n<td>interestRate</td>\n<td>Float</td>\n<td>Interest rate of the loan.</td>\n</tr>\n<tr>\n<td>loanAmount</td>\n<td>Float</td>\n<td>Total principal amount of the loan.</td>\n</tr>\n<tr>\n<td>principalDocuments</td>\n<td>[String]</td>\n<td>Loan support documents</td>\n</tr>\n</tbody>\n</table>\n</div>","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{api-key}}"}]},"isInherited":true,"source":{"_postman_id":"c8be523d-aaaf-4907-9390-19b1fed4fdf4","id":"c8be523d-aaaf-4907-9390-19b1fed4fdf4","name":"Anzi Finance - V 0.0.9","type":"collection"}},"urlObject":{"path":["v1","sureties","by-license"],"host":["{{baseUrl}}"],"query":[{"key":"limit","value":""},{"key":"page","value":""}],"variable":[]}},"response":[{"id":"cf0fd581-7158-4dbe-b1e4-3664c97e8427","name":"success","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/v1/sureties/by-license?limit=3&page=1","host":["{{baseUrl}}"],"path":["v1","sureties","by-license"],"query":[{"key":"limit","value":"3"},{"key":"page","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1637"},{"key":"ETag","value":"W/\"665-ZdC8Js49BMTc1MJnejBGraPQ9nw\""},{"key":"Date","value":"Thu, 11 Jan 2024 15:16:16 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n    \"sureties\": [\n        {\n            \"uid\": \"172029e2-560f-4b82-bb13-e9981bb8c203\",\n            \"tokenId\": 1476233776,\n            \"coverage\": 825000,\n            \"issuanceDate\": \"2024-01-10T04:59:59.000Z\",\n            \"dueDate\": \"2024-07-29T23:59:59.000Z\",\n            \"premiumPaymentDueDate\": \"2024-01-14T04:59:59.000Z\",\n            \"status\": 0,\n            \"premium\": 41250,\n            \"principalName\": \"Client 433\",\n            \"numberOfInstallments\": null,\n            \"frequency\": 0,\n            \"loanPaymentDueDate\": \"2024-01-31T23:59:59.000Z\",\n            \"loanPaymentConfig\": 0,\n            \"interestRate\": 0,\n            \"loanAmount\": 1650000,\n            \"principalDocuments\": [\n                \"https://example.com/principal-docs\"\n            ]\n        },\n        {\n            \"uid\": \"bdc7fe55-1571-4ce3-9a09-a17e4ece4a7c\",\n            \"tokenId\": 4098969444,\n            \"coverage\": 750000,\n            \"issuanceDate\": \"2024-01-10T04:59:59.000Z\",\n            \"dueDate\": \"2024-09-07T04:59:59.000Z\",\n            \"premiumPaymentDueDate\": \"2024-01-14T04:59:59.000Z\",\n            \"status\": 0,\n            \"premium\": 37500,\n            \"principalName\": \"Test Client\",\n            \"numberOfInstallments\": 0,\n            \"frequency\": null,\n            \"loanPaymentDueDate\": \"2024-03-11T04:59:59.000Z\",\n            \"loanPaymentConfig\": 0,\n            \"interestRate\": 5,\n            \"loanAmount\": 1500000,\n            \"principalDocuments\": [\n                \"https://example.com/principal-docs\"\n            ]\n        },\n        {\n            \"uid\": \"65e2406f-d983-46fe-91e3-d63fbf345f1c\",\n            \"tokenId\": 2892241341,\n            \"coverage\": 750000,\n            \"issuanceDate\": \"2024-01-10T04:59:59.000Z\",\n            \"dueDate\": \"2024-09-07T04:59:59.000Z\",\n            \"premiumPaymentDueDate\": \"2024-01-14T04:59:59.000Z\",\n            \"status\": 0,\n            \"premium\": 37500,\n            \"principalName\": \"Test Client\",\n            \"numberOfInstallments\": 8,\n            \"frequency\": 0,\n            \"loanPaymentDueDate\": \"2024-03-11T04:59:59.000Z\",\n            \"loanPaymentConfig\": 0,\n            \"interestRate\": 5,\n            \"loanAmount\": 1500000,\n            \"principalDocuments\": [\n                \"https://example.com/principal-docs\"\n            ]\n        }\n    ],\n    \"pagination\": {\n        \"startCursor\": \"172029e2-560f-4b82-bb13-e9981bb8c203\",\n        \"endCursor\": \"65e2406f-d983-46fe-91e3-d63fbf345f1c\",\n        \"hasNextPage\": true,\n        \"hasPreviousPage\": false,\n        \"totalCount\": 62\n    }\n}"}],"_postman_id":"e0e54f42-5443-4b6c-aacd-dc44f70d278d"},{"name":"Get sureties by premium status","id":"5ab42083-4b3b-43fd-9bb0-213c6fcb53ef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{baseUrl}}/v1/sureties/by-premium-status?status&limit&page","description":"<p>This endpoint allows you to retrieve sureties using its premium status as a filter.</p>\n<h4 id=\"request-query-params\">REQUEST QUERY PARAMS</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameter</th>\n<th>Type</th>\n<th>Required</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>status</td>\n<td>Integer</td>\n<td>Yes</td>\n<td>The Status of the premium. [PENDING , PAID, OVERDUE]. <a href=\"https://documenter.getpostman.com/view/29201474/2s9YsM8qEo#155f02e3-2daf-410b-b254-01ca19b372e3\">VIew premium status for specifications</a></td>\n</tr>\n<tr>\n<td>page</td>\n<td>Integer</td>\n<td>Yes</td>\n<td>The page number for pagination.</td>\n</tr>\n<tr>\n<td>limit</td>\n<td>Integer</td>\n<td>Yes</td>\n<td>The number of results per page.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">RESPONSE</h4>\n<p>The API will respond with a list of sureties matching the specified status filter, along with pagination information <a href=\"https://documenter.getpostman.com/view/29201474/2s9YsM8qEo#baf1aace-6569-4564-863d-bc1df65ed903\">(View pagination structure for specification).<br /></a></p>\n<h6 id=\"surety-schema-in-response\">Surety Schema in response</h6>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameter</th>\n<th>Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>uid</td>\n<td>String</td>\n<td>Unique identifier of the surety.  <br />Status of the surety.</td>\n</tr>\n<tr>\n<td>tokenId</td>\n<td>Integer</td>\n<td>Identifier for NFT associated with the surety.</td>\n</tr>\n<tr>\n<td>coverage</td>\n<td>Float</td>\n<td>Total principal amount covered by the surety.</td>\n</tr>\n<tr>\n<td>issuanceDate</td>\n<td>Date</td>\n<td>ISO8601 Date. Issuance date of the surety.</td>\n</tr>\n<tr>\n<td>dueDate</td>\n<td>Date</td>\n<td>ISO8601 Date. Surety expiration date, until this date the user can claim the surety.</td>\n</tr>\n<tr>\n<td>premiumPaymentDueDate</td>\n<td>Date</td>\n<td>ISO8601 Date of the deadline for premium payment of this surety.</td>\n</tr>\n<tr>\n<td>status</td>\n<td>Integer</td>\n<td>Status of the surety. [COVERING, CLAIMED, PAYING , CLOSE]. <a href=\"https://documenter.getpostman.com/view/29201474/2s9YsM8qEo#c5e740ef-49eb-4498-affa-1c4e2fd484dd\">View surety status for specifications.</a></td>\n</tr>\n<tr>\n<td>premium</td>\n<td>Float</td>\n<td>Value of the surety premium.</td>\n</tr>\n<tr>\n<td>premiumStatus</td>\n<td>Integer</td>\n<td>Status of the premium. [PENDING , PAID , OVERDUE]. <a href=\"https://documenter.getpostman.com/view/29201474/2s9YsM8qEo#155f02e3-2daf-410b-b254-01ca19b372e3\">VIew premium status for specifications</a></td>\n</tr>\n<tr>\n<td>principalName</td>\n<td>String</td>\n<td>The name of the company that takes the loan covered by this surety.</td>\n</tr>\n<tr>\n<td>numberOfInstallments</td>\n<td>Integer</td>\n<td>Number of installments to be paid by the borrower to complete the loan payment. No zero value if surety.loanPaymentConfig is INSTALLMENTS.</td>\n</tr>\n<tr>\n<td>frequency</td>\n<td>Integer</td>\n<td>Payment frequency of the borrower's installments, [WEEKLY , MONTHLY]. No null if surety.loanPaymentConfig is INSTALLMENTS. <a href=\"https://documenter.getpostman.com/view/29201474/2s9YsM8qEo#9644f735-c1c6-404a-ab77-8d6c49266c03\">VIew installments frequency for specifications.</a></td>\n</tr>\n<tr>\n<td>loanPaymentDueDate</td>\n<td>Date</td>\n<td>ISO8601 Date on which the total debt must be paid.</td>\n</tr>\n<tr>\n<td>loanPaymentConfig</td>\n<td>Integer</td>\n<td>Type of periodicity the borrower has committed to pay. [ONE_PAYMENT , INSTALLMENTS]. <a href=\"https://documenter.getpostman.com/view/29201474/2s9YsM8qEo#076cba52-d17e-4b0b-9077-ee8ea3792049\">VIew Payment Config for specifications.</a></td>\n</tr>\n<tr>\n<td>interestRate</td>\n<td>Float</td>\n<td>Interest rate of the loan.</td>\n</tr>\n<tr>\n<td>loanAmount</td>\n<td>Float</td>\n<td>Total principal amount of the loan.</td>\n</tr>\n<tr>\n<td>principalDocuments</td>\n<td>[String]</td>\n<td>Loan support documents</td>\n</tr>\n</tbody>\n</table>\n</div>","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{api-key}}"}]},"isInherited":true,"source":{"_postman_id":"c8be523d-aaaf-4907-9390-19b1fed4fdf4","id":"c8be523d-aaaf-4907-9390-19b1fed4fdf4","name":"Anzi Finance - V 0.0.9","type":"collection"}},"urlObject":{"path":["v1","sureties","by-premium-status"],"host":["{{baseUrl}}"],"query":[{"key":"status","value":null},{"key":"limit","value":null},{"key":"page","value":null}],"variable":[]}},"response":[{"id":"0341c60a-ba0d-4de4-83c4-ad9a9dd85dcd","name":"success","originalRequest":{"method":"GET","header":[],"url":{"raw":"http://localhost:3001/v1/sureties/by-status?page=1&status=0&limit=5","protocol":"http","host":["localhost"],"port":"3001","path":["v1","sureties","by-status"],"query":[{"key":"page","value":"1"},{"key":"status","value":"0"},{"key":"limit","value":"5"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"2606"},{"key":"ETag","value":"W/\"a2e-nUoaM0YN20/20QKbmQqei+c8iXs\""},{"key":"Date","value":"Wed, 10 Jan 2024 16:02:28 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n    \"sureties\": [\n        {\n            \"uid\": \"172029e2-560f-4b82-bb13-e9981bb8c203\",\n            \"tokenId\": 1476233776,\n            \"coverage\": 825000,\n            \"issuanceDate\": \"2024-01-10T04:59:59.000Z\",\n            \"dueDate\": \"2024-07-29T23:59:59.000Z\",\n            \"premiumPaymentDueDate\": \"2024-01-14T04:59:59.000Z\",\n            \"status\": 0,\n            \"premium\": 41250,\n            \"principalName\": \"Client 433\",\n            \"numberOfInstallments\": null,\n            \"frequency\": 0,\n            \"loanPaymentDueDate\": \"2024-01-31T23:59:59.000Z\",\n            \"loanPaymentConfig\": 0,\n            \"interestRate\": 0,\n            \"loanAmount\": 1650000,\n            \"principalDocuments\": [\n                \"https://example.com/principal-docs\"\n            ]\n        },\n        {\n            \"uid\": \"bdc7fe55-1571-4ce3-9a09-a17e4ece4a7c\",\n            \"tokenId\": 4098969444,\n            \"coverage\": 750000,\n            \"issuanceDate\": \"2024-01-10T04:59:59.000Z\",\n            \"dueDate\": \"2024-09-07T04:59:59.000Z\",\n            \"premiumPaymentDueDate\": \"2024-01-14T04:59:59.000Z\",\n            \"status\": 0,\n            \"premium\": 37500,\n            \"principalName\": \"Test Client\",\n            \"numberOfInstallments\": 0,\n            \"frequency\": null,\n            \"loanPaymentDueDate\": \"2024-03-11T04:59:59.000Z\",\n            \"loanPaymentConfig\": 0,\n            \"interestRate\": 5,\n            \"loanAmount\": 1500000,\n            \"principalDocuments\": [\n                \"https://example.com/principal-docs\"\n            ]\n        },\n        {\n            \"uid\": \"65e2406f-d983-46fe-91e3-d63fbf345f1c\",\n            \"tokenId\": 2892241341,\n            \"coverage\": 750000,\n            \"issuanceDate\": \"2024-01-10T04:59:59.000Z\",\n            \"dueDate\": \"2024-09-07T04:59:59.000Z\",\n            \"premiumPaymentDueDate\": \"2024-01-14T04:59:59.000Z\",\n            \"status\": 0,\n            \"premium\": 37500,\n            \"principalName\": \"Test Client\",\n            \"numberOfInstallments\": 8,\n            \"frequency\": 0,\n            \"loanPaymentDueDate\": \"2024-03-11T04:59:59.000Z\",\n            \"loanPaymentConfig\": 0,\n            \"interestRate\": 5,\n            \"loanAmount\": 1500000,\n            \"principalDocuments\": [\n                \"https://example.com/principal-docs\"\n            ]\n        },\n        {\n            \"uid\": \"af3058a3-b61c-44e0-a130-1d3d86c4dc1c\",\n            \"tokenId\": 3801139779,\n            \"coverage\": 227272.72,\n            \"issuanceDate\": \"2024-01-06T04:59:59.000Z\",\n            \"dueDate\": \"2024-07-18T23:59:59.000Z\",\n            \"premiumPaymentDueDate\": \"2024-01-07T04:59:59.000Z\",\n            \"status\": 0,\n            \"premium\": 11363.64,\n            \"principalName\": \"sda\",\n            \"numberOfInstallments\": null,\n            \"frequency\": 0,\n            \"loanPaymentDueDate\": \"2024-01-20T23:59:59.000Z\",\n            \"loanPaymentConfig\": 0,\n            \"interestRate\": 0,\n            \"loanAmount\": 454545.44,\n            \"principalDocuments\": [\n                \"https://example.com/principal-docs\"\n            ]\n        },\n        {\n            \"uid\": \"824c1c77-609f-4ddf-bb5d-c0547c751f59\",\n            \"tokenId\": 3099813407,\n            \"coverage\": 439393.94,\n            \"issuanceDate\": \"2024-01-06T04:59:59.000Z\",\n            \"dueDate\": \"2024-07-25T23:59:59.000Z\",\n            \"premiumPaymentDueDate\": \"2024-01-07T04:59:59.000Z\",\n            \"status\": 0,\n            \"premium\": 21969.7,\n            \"principalName\": \"test098\",\n            \"numberOfInstallments\": null,\n            \"frequency\": 0,\n            \"loanPaymentDueDate\": \"2024-01-27T23:59:59.000Z\",\n            \"loanPaymentConfig\": 0,\n            \"interestRate\": 0,\n            \"loanAmount\": 878787.87,\n            \"principalDocuments\": [\n                \"https://example.com/principal-docs\"\n            ]\n        }\n    ],\n    \"pagination\": {\n        \"startCursor\": \"172029e2-560f-4b82-bb13-e9981bb8c203\",\n        \"endCursor\": \"824c1c77-609f-4ddf-bb5d-c0547c751f59\",\n        \"hasNextPage\": true,\n        \"hasPreviousPage\": false,\n        \"totalCount\": 60\n    }\n}"}],"_postman_id":"5ab42083-4b3b-43fd-9bb0-213c6fcb53ef"}],"id":"a3e51e73-36c1-4b5e-94f3-4d22c0edbc56","_postman_id":"a3e51e73-36c1-4b5e-94f3-4d22c0edbc56","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{api-key}}"}]},"isInherited":true,"source":{"_postman_id":"c8be523d-aaaf-4907-9390-19b1fed4fdf4","id":"c8be523d-aaaf-4907-9390-19b1fed4fdf4","name":"Anzi Finance - V 0.0.9","type":"collection"}}},{"name":"Claims","item":[{"name":"Create claim","id":"6ab76ad1-f9ed-46d0-87b3-b5b6e970ee9a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n    \"totalPaidToPrincipalToDate\": 100000,\r\n    \"lastPaymentDate\": \"2024-04-12\",\r\n    \"suretyUID\": \"f108c82b-17f8-4309-b249-67aa6390a\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/v1/claims","description":"<p>This endpoint allows you to claim a surety. By calling this endpoint, you notify us of your default and allow us to schedule the payment of your coverage.</p>\n<h4 id=\"body-request\">BODY REQUEST</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameter</th>\n<th>Type</th>\n<th>Required</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>totalPaidToPrincipalToDate</td>\n<td>Float</td>\n<td>Yes</td>\n<td>Total amount paid to principal by the borrower at the time of making the claim.</td>\n</tr>\n<tr>\n<td>lastPaymentDate</td>\n<td>Date</td>\n<td>Yes</td>\n<td>The date of the last payment made, formatted as ISO 8601.</td>\n</tr>\n<tr>\n<td>suretyUID</td>\n<td>String</td>\n<td>Yes</td>\n<td>Unique identifier for the surety related to this claim.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">RESPONSE</h4>\n<p><a href=\"#7ecc4cf9-d236-4aa4-b4a1-56fccd9f613e\">In case of an error response, please review our table of error codes.</a></p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameter</th>\n<th>Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>uid</td>\n<td>String</td>\n<td>Unique identifier of the claim.</td>\n</tr>\n<tr>\n<td>claimDate</td>\n<td>Date</td>\n<td>ISO 8601. Date of the moment the claim was made.</td>\n</tr>\n<tr>\n<td>endorsementDocuments</td>\n<td>[String]</td>\n<td>Links to documents of the default support and the debt endorsement.</td>\n</tr>\n<tr>\n<td>totalPaidToPrincipalToDate</td>\n<td>Float</td>\n<td>Total amount paid to principal by the borrower at the time of making the claim.</td>\n</tr>\n<tr>\n<td>dateOfPayment</td>\n<td>Date</td>\n<td>The date on which Anzi will make the coverage payment.</td>\n</tr>\n<tr>\n<td>coverageValueToPay</td>\n<td>Float</td>\n<td>Total amount to be paid by anzi for coverage.</td>\n</tr>\n<tr>\n<td>automaticPayment</td>\n<td>Boolean</td>\n<td>Whether the license still maintains the default below the default threshold allowed by anzi, the payment will be made automatically in the agreed times with anzi.</td>\n</tr>\n<tr>\n<td>status</td>\n<td>Integer</td>\n<td>Status of the claim.[APPROVED, CLAIM_ANALYSIS, REJECTED]. <a href=\"https://documenter.getpostman.com/view/29201474/2s9YsM8qEo#f12bbd51-0c47-41ee-a49b-cc8f29a27e82\">View claim status for specifications.</a></td>\n</tr>\n</tbody>\n</table>\n</div>","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{api-key}}"}]},"isInherited":true,"source":{"_postman_id":"c8be523d-aaaf-4907-9390-19b1fed4fdf4","id":"c8be523d-aaaf-4907-9390-19b1fed4fdf4","name":"Anzi Finance - V 0.0.9","type":"collection"}},"urlObject":{"path":["v1","claims"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"5a227e9a-14d3-433e-9b0e-c6d837c46422","name":"Create claim","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n    \"totalPaidToPrincipalToDate\": 100000,\r\n    \"lastPaymentDate\": \"2024-04-12\",\r\n    \"suretyUID\": \"f108c82b-17f8-4309-b249-67aa6390a\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:3001/v1/claims"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 16 Jan 2024 15:04:28 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-powered-by","value":"Express"},{"key":"access-control-allow-origin","value":"*"},{"key":"etag","value":"W/\"49-KuiSr60/6eWM/tI4a6zxxlneg1o\""},{"key":"x-do-app-origin","value":"89637336-8256-431d-bccc-78f5431c62a3"},{"key":"cache-control","value":"private"},{"key":"x-do-orig-status","value":"404"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Set-Cookie","value":"__cf_bm=1LBAqpznaJRR6QcwqwGckl5mX86jwfSwcd3VuYC7Hms-1705417468-1-AaUcM3NCaHTPgUaSR0dAof1pHbzHV6ejGwIIQjtOyaNRBHJ033q5iGphJ+w1fmWVk/tCyQr/KM/hq4PaiyESoTE=; path=/; expires=Tue, 16-Jan-24 15:34:28 GMT; domain=.ondigitalocean.app; HttpOnly; Secure; SameSite=None"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8467404bc9dedab5-MIA"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n    \"uid\": \"74e9b0-d32-44d2-a3ac-f9498fc160\",\n    \"claimDate\": \"2024-01-30T15:02:06Z\",\n    \"endorsementDocuments\": [\"https://example.com/documents/endorsement12345\"],\n    \"totalPaidToPrincipalToDate\": 300000,\n    \"dateOfPayment\": \"2024-02-16T15:02:06Z\",\n    \"coverageValueToPay\": 200000,\n    \"automaticPayment\": true,\n    \"status\": 0\n}\n"}],"_postman_id":"6ab76ad1-f9ed-46d0-87b3-b5b6e970ee9a"},{"name":"Get claim validation","id":"86c0258a-6150-4c53-a6ea-6d63226c6cde","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\r\n    \"totalPaidToPrincipalToDate\": 100000,\r\n    \"lastPaymentDate\": \"2024-04-12\",\r\n    \"suretyUID\": \"f108c82b-17f8-4309-b249-67aa6390a\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/v1/claims/validate","description":"<p>Before creating a claim, you can call this endpoint to determine, according to your Anzi License configuration, if a loan claim is valid, the amount that will be covered by Anzi's surety, and the date when the coverage will be paid</p>\n<h4 id=\"body-request\">BODY REQUEST</h4>\n<p><a href=\"#7ecc4cf9-d236-4aa4-b4a1-56fccd9f613e\">In case of an error response, please review our table of error codes.</a></p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameter</th>\n<th>Type</th>\n<th>Required</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>totalPaidToPrincipalToDate</td>\n<td>Float</td>\n<td>Yes</td>\n<td>Total amount paid to principal by the borrower at the time of making the claim.</td>\n</tr>\n<tr>\n<td>lastPaymentDate</td>\n<td>Date</td>\n<td>Yes</td>\n<td>The date of the last payment made, formatted as ISO 8601.</td>\n</tr>\n<tr>\n<td>suretyUID</td>\n<td>String</td>\n<td>Yes</td>\n<td>Unique identifier for the surety related to this claim.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">RESPONSE</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameter</th>\n<th>Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>dateOfPayment</td>\n<td>Date</td>\n<td>The date on which Anzi will make the coverage payment.</td>\n</tr>\n<tr>\n<td>coverageValueToPay</td>\n<td>Float</td>\n<td>Total amount to be paid by Anzi for coverage.</td>\n</tr>\n<tr>\n<td>isEnabledForAutomaticPayment</td>\n<td>Boolean</td>\n<td>Define if the payment for this claim will be made automatically in the agreed times with anzi. It's true only if the license still maintains the default below the default threshold allowed by anzi.</td>\n</tr>\n</tbody>\n</table>\n</div>","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{api-key}}"}]},"isInherited":true,"source":{"_postman_id":"c8be523d-aaaf-4907-9390-19b1fed4fdf4","id":"c8be523d-aaaf-4907-9390-19b1fed4fdf4","name":"Anzi Finance - V 0.0.9","type":"collection"}},"urlObject":{"path":["v1","claims","validate"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"155dc30e-ba34-4cbb-98e5-a786e50d6601","name":"success","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\r\n    \"totalPaidToPrincipalToDate\": 100000,\r\n    \"lastPaymentDate\": \"2024-04-12\",\r\n    \"suretyUID\": \"f108c82b-17f8-4309-b249-67aa6390a\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:3001/v1/claims/validate"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 16 Jan 2024 00:33:14 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-powered-by","value":"Express"},{"key":"access-control-allow-origin","value":"*"},{"key":"etag","value":"W/\"51-08PtOt5vFd2Cg9QY8SbinH9tZHU\""},{"key":"x-do-app-origin","value":"89637336-8256-431d-bccc-78f5431c62a3"},{"key":"cache-control","value":"private"},{"key":"x-do-orig-status","value":"404"},{"key":"CF-Cache-Status","value":"MISS"},{"key":"Set-Cookie","value":"__cf_bm=MNVlY5GRYFOp8BusycTkcPWz9K1xoCTsripO87CE1FU-1705365194-1-AaBYyPPLhbIu8lg18hGWWjaaicH1wx7vdd8CFyMEfthfnOonf+3CyphiYTc8Q2eABUQ9V1GxVHWjo32ONY24kQg=; path=/; expires=Tue, 16-Jan-24 01:03:14 GMT; domain=.ondigitalocean.app; HttpOnly; Secure; SameSite=None"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8462440ebd3a31f8-MIA"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n    \"dateOfPayment\": \"2024-02-16T00:35:34.312141\",\n    \"coverageValueToPay\": 250000,\n    \"isEnabledForAutomaticPayment\": true\n}"}],"_postman_id":"86c0258a-6150-4c53-a6ea-6d63226c6cde"}],"id":"5d1cfc20-3627-4e18-bd1f-d6665737c9f4","_postman_id":"5d1cfc20-3627-4e18-bd1f-d6665737c9f4","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{api-key}}"}]},"isInherited":true,"source":{"_postman_id":"c8be523d-aaaf-4907-9390-19b1fed4fdf4","id":"c8be523d-aaaf-4907-9390-19b1fed4fdf4","name":"Anzi Finance - V 0.0.9","type":"collection"}}},{"name":"License","item":[{"name":"Get License","id":"6ffa1d23-741c-4356-ad91-0358f9647b99","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{baseUrl}}/v1/licenses","description":"<p>This endpoint allows you to retrieve the license information associated with your Anzi account</p>\n<h4 id=\"response\">RESPONSE</h4>\n<p><a href=\"#7ecc4cf9-d236-4aa4-b4a1-56fccd9f613e\">In case of an error response, please review our table of error codes.</a></p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameter</th>\n<th>Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>uid</td>\n<td>String</td>\n<td>Unique identifier of the license.</td>\n</tr>\n<tr>\n<td>tokenId</td>\n<td>String</td>\n<td>Identifier for NFT associated to the license.</td>\n</tr>\n<tr>\n<td>coveragePercentage</td>\n<td>Float</td>\n<td>Maximum coverage <strong>percentage</strong> for each loan.</td>\n</tr>\n<tr>\n<td>maximumCoverage</td>\n<td>Float</td>\n<td>Maximum coverage <strong>amount</strong> for each loan.</td>\n</tr>\n<tr>\n<td>suretyPremium</td>\n<td>Float</td>\n<td>Percentage of the borrowed capital representing the premium to be paid.</td>\n</tr>\n<tr>\n<td>active</td>\n<td>Boolean</td>\n<td>Indicates if the license is active or not.</td>\n</tr>\n<tr>\n<td>timezone</td>\n<td>String</td>\n<td>Reference to the location from which the time zone should be taken for license management. For more info: <a href=\"https://momentjs.com/timezone/\">Timezone Reference</a></td>\n</tr>\n<tr>\n<td>maximumLoanTerm</td>\n<td>String</td>\n<td>Maximum duration of a loan in ISO 8601 duration format.</td>\n</tr>\n<tr>\n<td>minimumLoanTerm</td>\n<td>String</td>\n<td>Minimum duration of a loan in ISO 8601 duration format.</td>\n</tr>\n<tr>\n<td>daysForSuretyDueDate</td>\n<td>Integer</td>\n<td>The number of days after the surety.loanPaymentDueDate, during which the surety will still be valid. This value controls the expiration of the surety.</td>\n</tr>\n<tr>\n<td>minimumDaysToDeclareDefault</td>\n<td>Integer</td>\n<td>The number of days that must elapse since the last payment to declare a default.</td>\n</tr>\n<tr>\n<td>baseClosingDate</td>\n<td>Date</td>\n<td>ISO 8601 date. Reference to the due date of the oldest pending premiums for payment.</td>\n</tr>\n<tr>\n<td>lastClosingDate</td>\n<td>Date</td>\n<td>ISO 8601 date. Reference to the last closing date pending for payment.</td>\n</tr>\n<tr>\n<td>nextClosingDate</td>\n<td>Date</td>\n<td>ISO 8601 date. Reference to the future closing date.</td>\n</tr>\n<tr>\n<td>quota</td>\n<td>Integer</td>\n<td>Total approved coverage amount for this license.</td>\n</tr>\n<tr>\n<td>spentQuota</td>\n<td>Float</td>\n<td>Total coverage issued to date, representing what has been spent from the authorized quota on this license.</td>\n</tr>\n<tr>\n<td>maximumLoanAmount</td>\n<td>Float</td>\n<td>Maximum loan amount to be covered by Anzi.</td>\n</tr>\n<tr>\n<td>minimumLoanAmount</td>\n<td>Float</td>\n<td>Minimum loan amount to be covered by Anzi.</td>\n</tr>\n<tr>\n<td>automaticPaymentApproval</td>\n<td>Boolean</td>\n<td>Automatic payment controller when a default is declared.</td>\n</tr>\n<tr>\n<td>premiumAmountPending</td>\n<td>Float</td>\n<td>Total amount pending to be paid for premiums.</td>\n</tr>\n<tr>\n<td>nextClosingDatePremium</td>\n<td>Float</td>\n<td>Total amount to be paid on the next closing date for premiums.</td>\n</tr>\n<tr>\n<td>totalClaimed</td>\n<td>Float</td>\n<td>Total value of claims made by this license to date.</td>\n</tr>\n<tr>\n<td>claimHealthThreshold</td>\n<td>Float</td>\n<td>Represents the percentage of the license.quota that can be in default without losing the automatic payment status when a claim is made.</td>\n</tr>\n<tr>\n<td>lastRevision</td>\n<td>Date</td>\n<td>ISO 8601 Date. Date of the last review of license configurations by the Anzi team.</td>\n</tr>\n<tr>\n<td>validityPeriod</td>\n<td>String</td>\n<td>ISO 8601 duration. Validity period granted to the license since the last revision.</td>\n</tr>\n</tbody>\n</table>\n</div>","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{api-key}}"}]},"isInherited":true,"source":{"_postman_id":"c8be523d-aaaf-4907-9390-19b1fed4fdf4","id":"c8be523d-aaaf-4907-9390-19b1fed4fdf4","name":"Anzi Finance - V 0.0.9","type":"collection"}},"urlObject":{"path":["v1","licenses"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"7abd5ff3-ee52-4c5a-a9cd-edc29408633e","name":"success","originalRequest":{"method":"GET","header":[],"url":"http://localhost:3001/v1/licenses"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"587"},{"key":"ETag","value":"W/\"24b-gaArPYHInCyI0ob0xL+h4rDWIiE\""},{"key":"Date","value":"Thu, 11 Jan 2024 16:50:47 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n    \"uid\": \"136139f5-3bea-4caf-98fb-445a39f12194\",\n    \"tokenId\": \"3561724282\",\n    \"coveragePercentage\": 50,\n    \"maximumCoverage\": 3000000,\n    \"suretyPremium\": 2.5,\n    \"active\": true,\n    \"timezone\": \"America/Bogota\",\n    \"maximumLoanTerm\": \"P6M\",\n    \"minimumLoanTerm\": \"P15D\",\n    \"claimHealthThreshold\": 80,\n    \"daysForSuretyDueDate\": 180,\n    \"minimumDaysToDeclareDefault\": 60,\n    \"baseClosingDate\": \"2024-03-23T04:59:59.000Z\",\n    \"nextClosingDate\": \"2024-06-15T04:59:59.000Z\",\n    \"lastClosingDate\": \"2024-05-04T04:59:59.000Z\",\n    \"nextClosingDatePremium\": 37500,\n    \"quota\": 202000000,\n    \"spentQuota\": 21774466.17,\n    \"maximumLoanAmount\": 6000000,\n    \"minimumLoanAmount\": 1500000,\n    \"automaticPaymentApproval\": true,\n    \"premiumAmountPending\": 450000,\n    \"totalClaimed\": 0,\n    \"lastRevision\": \"2024-03-01T05:00:00.000Z\",\n    \"validityPeriod\": \"P3M\"\n}"}],"_postman_id":"6ffa1d23-741c-4356-ad91-0358f9647b99"}],"id":"afa1bcdb-eb2d-4838-a130-413b261bdd2a","_postman_id":"afa1bcdb-eb2d-4838-a130-413b261bdd2a","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{api-key}}"}]},"isInherited":true,"source":{"_postman_id":"c8be523d-aaaf-4907-9390-19b1fed4fdf4","id":"c8be523d-aaaf-4907-9390-19b1fed4fdf4","name":"Anzi Finance - V 0.0.9","type":"collection"}}},{"name":"Schemas","item":[{"name":"License","item":[],"id":"611083a0-ce17-4ca4-b9ac-4887b5af52ad","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameter</th>\n<th>Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>uid</td>\n<td>String</td>\n<td>Unique identifier of the license.</td>\n</tr>\n<tr>\n<td>tokenId</td>\n<td>String</td>\n<td>Identifier for NFT associated to the license.</td>\n</tr>\n<tr>\n<td>coveragePercentage</td>\n<td>Float</td>\n<td>Maximum coverage <strong>percentage</strong> for each loan.</td>\n</tr>\n<tr>\n<td>maximumCoverage</td>\n<td>Float</td>\n<td>Maximum coverage <strong>amount</strong> for each loan.</td>\n</tr>\n<tr>\n<td>suretyPremium</td>\n<td>Float</td>\n<td>Percentage of the borrowed capital representing the premium to be paid.</td>\n</tr>\n<tr>\n<td>active</td>\n<td>Boolean</td>\n<td>Indicates if the license is active or not.</td>\n</tr>\n<tr>\n<td>timezone</td>\n<td>String</td>\n<td>Reference to the location from which the time zone should be taken for license management. For more info: <a href=\"https://momentjs.com/timezone/\">Timezone Reference</a></td>\n</tr>\n<tr>\n<td>maximumLoanTerm</td>\n<td>String</td>\n<td>Maximum duration of a loan in ISO 8601 duration format.</td>\n</tr>\n<tr>\n<td>minimumLoanTerm</td>\n<td>String</td>\n<td>Minimum duration of a loan in ISO 8601 duration format.</td>\n</tr>\n<tr>\n<td>daysForSuretyDueDate</td>\n<td>Integer</td>\n<td>The number of days after the surety.loanPaymentDueDate, during which the surety will still be valid. This value controls the expiration of the surety.</td>\n</tr>\n<tr>\n<td>minimumDaysToDeclareDefault</td>\n<td>Integer</td>\n<td>The number of days that must elapse since the last payment to declare a default.</td>\n</tr>\n<tr>\n<td>baseClosingDate</td>\n<td>Date</td>\n<td>ISO 8601 date. Reference to the due date of the oldest pending premiums for payment.</td>\n</tr>\n<tr>\n<td>lastClosingDate</td>\n<td>Date</td>\n<td>ISO 8601 date. Reference to the last closing date pending for payment.</td>\n</tr>\n<tr>\n<td>nextClosingDate</td>\n<td>Date</td>\n<td>ISO 8601 date. Reference to the future closing date.</td>\n</tr>\n<tr>\n<td>quota</td>\n<td>Integer</td>\n<td>Total approved coverage amount for this license.</td>\n</tr>\n<tr>\n<td>spentQuota</td>\n<td>Float</td>\n<td>Total coverage issued to date, representing what has been spent from the authorized quota on this license.</td>\n</tr>\n<tr>\n<td>maximumLoanAmount</td>\n<td>Float</td>\n<td>Maximum loan amount to be covered by Anzi.</td>\n</tr>\n<tr>\n<td>minimumLoanAmount</td>\n<td>Float</td>\n<td>Minimum loan amount to be covered by Anzi.</td>\n</tr>\n<tr>\n<td>automaticPaymentApproval</td>\n<td>Boolean</td>\n<td>Automatic payment controller when a default is declared.</td>\n</tr>\n<tr>\n<td>premiumAmountPending</td>\n<td>Float</td>\n<td>Total amount pending to be paid for premiums.</td>\n</tr>\n<tr>\n<td>nextClosingDatePremium</td>\n<td>Float</td>\n<td>Total amount to be paid on the next closing date or premiums.</td>\n</tr>\n<tr>\n<td>totalClaimed</td>\n<td>Float</td>\n<td>Total value of claims made by this license to date.</td>\n</tr>\n<tr>\n<td>claimHealthThreshold</td>\n<td>Float</td>\n<td>Represents the percentage of the license.quota that can be in default without losing the automatic payment status when a claim is made.</td>\n</tr>\n<tr>\n<td>lastRevision</td>\n<td>Date</td>\n<td>ISO 8601 Date. Date of the last review of license configurations by the Anzi team.</td>\n</tr>\n<tr>\n<td>validityPeriod</td>\n<td>String</td>\n<td>ISO 8601 duration. Validity period granted to the license since the last revision.</td>\n</tr>\n</tbody>\n</table>\n</div>","_postman_id":"611083a0-ce17-4ca4-b9ac-4887b5af52ad","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"e9acbefa-c023-4183-93e5-4cd64d9a4c06","id":"e9acbefa-c023-4183-93e5-4cd64d9a4c06","name":"Schemas","type":"folder"}}},{"name":"Surety","item":[],"id":"ea592ac8-ff4e-4ebc-8aa8-ce2215399bda","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameter</th>\n<th>Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>uid</td>\n<td>String</td>\n<td>Unique identifier of the surety.  <br />Status of the surety.</td>\n</tr>\n<tr>\n<td>tokenId</td>\n<td>Integer</td>\n<td>Identifier for NFT associated with the surety.</td>\n</tr>\n<tr>\n<td>coverage</td>\n<td>Float</td>\n<td>Total principal amount covered by the surety.</td>\n</tr>\n<tr>\n<td>issuanceDate</td>\n<td>Date</td>\n<td>ISO8601 Date. Issuance date of the surety.</td>\n</tr>\n<tr>\n<td>dueDate</td>\n<td>Date</td>\n<td>ISO8601 Date. Surety expiration date, until this date the user can claim the surety.</td>\n</tr>\n<tr>\n<td>premiumPaymentDueDate</td>\n<td>Date</td>\n<td>ISO8601 Date of the deadline for premium payment of this surety.</td>\n</tr>\n<tr>\n<td>status</td>\n<td>Integer</td>\n<td>Status of the surety. [COVERING, CLAIMED, PAYING , CLOSE]. <a href=\"https://documenter.getpostman.com/view/29201474/2s9YsM8qEo#c5e740ef-49eb-4498-affa-1c4e2fd484dd\">View surety status for specifications.</a></td>\n</tr>\n<tr>\n<td>premium</td>\n<td>Float</td>\n<td>Value of the surety premium.</td>\n</tr>\n<tr>\n<td>premiumStatus</td>\n<td>Integer</td>\n<td>Status of the premium. [PENDING , PAID , OVERDUE]. <a href=\"https://documenter.getpostman.com/view/29201474/2s9YsM8qEo#155f02e3-2daf-410b-b254-01ca19b372e3\">VIew premium status for specifications</a></td>\n</tr>\n<tr>\n<td>principalName</td>\n<td>String</td>\n<td>The name of the company that takes the loan covered by this surety.</td>\n</tr>\n<tr>\n<td>numberOfInstallments</td>\n<td>Integer</td>\n<td>Number of installments to be paid by the borrower to complete the loan payment. No zero value if surety.loanPaymentConfig is INSTALLMENTS.</td>\n</tr>\n<tr>\n<td>frequency</td>\n<td>Integer</td>\n<td>Payment frequency of the borrower's installments, [WEEKLY , MONTHLY]. No null if surety.loanPaymentConfig is INSTALLMENTS. <a href=\"https://documenter.getpostman.com/view/29201474/2s9YsM8qEo#9644f735-c1c6-404a-ab77-8d6c49266c03\">VIew installments frequency for specifications.</a></td>\n</tr>\n<tr>\n<td>loanPaymentDueDate</td>\n<td>Date</td>\n<td>ISO8601 Date on which the total debt must be paid.</td>\n</tr>\n<tr>\n<td>loanPaymentConfig</td>\n<td>Integer</td>\n<td>Type of periodicity the borrower has committed to pay. [ONE_PAYMENT , INSTALLMENTS]. <a href=\"https://documenter.getpostman.com/view/29201474/2s9YsM8qEo#076cba52-d17e-4b0b-9077-ee8ea3792049\">VIew Payment Config for specifications.</a></td>\n</tr>\n<tr>\n<td>interestRate</td>\n<td>Float</td>\n<td>Interest rate of the loan.</td>\n</tr>\n<tr>\n<td>loanAmount</td>\n<td>Float</td>\n<td>Total principal amount of the loan.</td>\n</tr>\n<tr>\n<td>principalDocuments</td>\n<td>[String]</td>\n<td>Loan support documents</td>\n</tr>\n</tbody>\n</table>\n</div>","_postman_id":"ea592ac8-ff4e-4ebc-8aa8-ce2215399bda","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"e9acbefa-c023-4183-93e5-4cd64d9a4c06","id":"e9acbefa-c023-4183-93e5-4cd64d9a4c06","name":"Schemas","type":"folder"}}},{"name":"Surety Status","item":[],"id":"c5e740ef-49eb-4498-affa-1c4e2fd484dd","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Status</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>COVERING (0)</td>\n<td>The surety is active and has coverage by Anzi.</td>\n</tr>\n<tr>\n<td>CLAIMED (1)</td>\n<td>A default has been declared on this surety.</td>\n</tr>\n<tr>\n<td>PAID (2)</td>\n<td>The coverage for this surety has already been paid.</td>\n</tr>\n<tr>\n<td>CLOSE (3)</td>\n<td>The surety has expired or has been paid off.</td>\n</tr>\n</tbody>\n</table>\n</div>","_postman_id":"c5e740ef-49eb-4498-affa-1c4e2fd484dd","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"e9acbefa-c023-4183-93e5-4cd64d9a4c06","id":"e9acbefa-c023-4183-93e5-4cd64d9a4c06","name":"Schemas","type":"folder"}}},{"name":"Claim Status","item":[],"id":"f12bbd51-0c47-41ee-a49b-cc8f29a27e82","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Status</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>APPROVED (0)</td>\n<td>The payment for this surety is approved. This is the default status if your total default is below the threshold established by Anzi.</td>\n</tr>\n<tr>\n<td>CLAIM_ANALYSIS (1)</td>\n<td>If your total default is above or iqual to the threshold established by Anzi, your claim will be subject to an analysis process.</td>\n</tr>\n<tr>\n<td>REJECTED (2)</td>\n<td>If your claim does not comply with Anzi's policies, it will be rejected.</td>\n</tr>\n</tbody>\n</table>\n</div>","_postman_id":"f12bbd51-0c47-41ee-a49b-cc8f29a27e82","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"e9acbefa-c023-4183-93e5-4cd64d9a4c06","id":"e9acbefa-c023-4183-93e5-4cd64d9a4c06","name":"Schemas","type":"folder"}}},{"name":"Premium Status","item":[],"id":"155f02e3-2daf-410b-b254-01ca19b372e3","description":"<p>Status of a surety premium</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Status</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>PENDING (0)</td>\n<td>The premium for this surety is pending payment. Payment must be made before the specified date in <code>surety.premiumPaymentDueDate</code>.</td>\n</tr>\n<tr>\n<td>PAID (1)</td>\n<td>The premium related to this surety has been successfully paid.</td>\n</tr>\n<tr>\n<td>OVERDUE (2)</td>\n<td>The premium for this surety is overdue, and the credit is at risk of losing Anzi coverage.</td>\n</tr>\n</tbody>\n</table>\n</div>","_postman_id":"155f02e3-2daf-410b-b254-01ca19b372e3","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"e9acbefa-c023-4183-93e5-4cd64d9a4c06","id":"e9acbefa-c023-4183-93e5-4cd64d9a4c06","name":"Schemas","type":"folder"}}},{"name":"Installments Frequency","item":[],"id":"9644f735-c1c6-404a-ab77-8d6c49266c03","description":"<p>Payment frequency of the borrower's installments. <strong>No null if</strong> <strong><code>surety.loanPaymentConfig</code></strong> <strong>is INSTALLMENTS.</strong></p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Frequency</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>WEEKLY (0)</td>\n<td>Payments are made on a weekly basis.</td>\n</tr>\n<tr>\n<td>MONTHLY (1)</td>\n<td>Payments are made on a monthly basis.</td>\n</tr>\n</tbody>\n</table>\n</div>","_postman_id":"9644f735-c1c6-404a-ab77-8d6c49266c03","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"e9acbefa-c023-4183-93e5-4cd64d9a4c06","id":"e9acbefa-c023-4183-93e5-4cd64d9a4c06","name":"Schemas","type":"folder"}}},{"name":"Payment Config","item":[],"id":"076cba52-d17e-4b0b-9077-ee8ea3792049","description":"<p>Type of periodicity the borrower has committed to pay.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>ONE_PAYMENT (0)</td>\n<td>The borrower has committed to make a single payment.</td>\n</tr>\n<tr>\n<td>INSTALLMENTS (1)</td>\n<td>The borrower has committed to make multiple payments in installments.</td>\n</tr>\n</tbody>\n</table>\n</div>","_postman_id":"076cba52-d17e-4b0b-9077-ee8ea3792049","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"e9acbefa-c023-4183-93e5-4cd64d9a4c06","id":"e9acbefa-c023-4183-93e5-4cd64d9a4c06","name":"Schemas","type":"folder"}}},{"name":"Pagination","item":[],"id":"baf1aace-6569-4564-863d-bc1df65ed903","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Property</th>\n<th>Type</th>\n<th>Description</th>\n<th>Example</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>startCursor</td>\n<td>String</td>\n<td>The UID of the element at the start of the page.</td>\n<td>\"bdc7fe55-1571-4ce3-9a09-a17e4ece4a7c\"</td>\n</tr>\n<tr>\n<td>endCursor</td>\n<td>String</td>\n<td>The UID of the element at the end of the page.</td>\n<td>\"65e2406f-d983-46fe-91e3-d63fbf345f1c\"</td>\n</tr>\n<tr>\n<td>hasNextPage</td>\n<td>Boolean</td>\n<td>A Boolean flag indicating if there are more pages available after the current page.</td>\n<td>true</td>\n</tr>\n<tr>\n<td>hasPreviousPage</td>\n<td>Boolean</td>\n<td>A Boolean flag indicating if there are pages available before the current page.</td>\n<td>false</td>\n</tr>\n<tr>\n<td>totalCount</td>\n<td>Integer</td>\n<td>The total number of items that match the current request constraints.</td>\n<td>200</td>\n</tr>\n</tbody>\n</table>\n</div>","_postman_id":"baf1aace-6569-4564-863d-bc1df65ed903","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"e9acbefa-c023-4183-93e5-4cd64d9a4c06","id":"e9acbefa-c023-4183-93e5-4cd64d9a4c06","name":"Schemas","type":"folder"}}}],"id":"e9acbefa-c023-4183-93e5-4cd64d9a4c06","description":"<p>Here you can find the schemas used in the API along with a brief explanation of each one. If you have any questions, please don't hesitate to contact us at <a href=\"https://null\">admin@anzi.finance</a>.</p>\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"b6185209-f50d-4d3d-944d-50e961a9763a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"f1f90262-ac72-41b6-ac31-091c004df0a2","type":"text/javascript","exec":[""]}}],"_postman_id":"e9acbefa-c023-4183-93e5-4cd64d9a4c06"},{"name":"Error codes","item":[],"id":"7ecc4cf9-d236-4aa4-b4a1-56fccd9f613e","description":"<p>If an error is returned from our API, the response will look like this:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"message\": \"&lt;message&gt;\",\n    \"code\": \"&lt;error-code&gt;\"\n}\n\n</code></pre>\n<p>Here you can find our error codes and their respective descriptions.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Error Code</th>\n<th>Message</th>\n<th>HTTP Status</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>AUTH_1</td>\n<td>Invalid API Key</td>\n<td>401</td>\n</tr>\n<tr>\n<td>AUTH_2</td>\n<td>User Unauthorized</td>\n<td>401</td>\n</tr>\n<tr>\n<td>AUTH_3</td>\n<td>Email Already Used</td>\n<td>401</td>\n</tr>\n<tr>\n<td>LI_00</td>\n<td>License Not Found</td>\n<td>404</td>\n</tr>\n<tr>\n<td>LI_01</td>\n<td>License Not Active</td>\n<td>400</td>\n</tr>\n<tr>\n<td>SU_00</td>\n<td>Quota Exceeded</td>\n<td>400</td>\n</tr>\n<tr>\n<td>SU_01</td>\n<td>Payment Term mismatch with your license config</td>\n<td>400</td>\n</tr>\n<tr>\n<td>SU_02</td>\n<td>Loan Durations mismatch with your license config</td>\n<td>400</td>\n</tr>\n<tr>\n<td>SU_03</td>\n<td>Loan Amount disallowed by license config</td>\n<td>400</td>\n</tr>\n<tr>\n<td>SU_04</td>\n<td>Coverage for this loan exceeds license config</td>\n<td>400</td>\n</tr>\n<tr>\n<td>SU_05</td>\n<td>The surety has expired</td>\n<td>400</td>\n</tr>\n<tr>\n<td>CL_00</td>\n<td>The current surety status is not COVERING</td>\n<td>400</td>\n</tr>\n<tr>\n<td>CL_01</td>\n<td>The premium must be paid before claim</td>\n<td>400</td>\n</tr>\n<tr>\n<td>CL_02</td>\n<td>The minimum time to make a claim has not been met</td>\n<td>400</td>\n</tr>\n<tr>\n<td>CL_03</td>\n<td>The amount paid to the principal is incorrect</td>\n<td>400</td>\n</tr>\n<tr>\n<td>GE_00</td>\n<td>Internal Error</td>\n<td>500</td>\n</tr>\n<tr>\n<td>GE_01</td>\n<td>Bad Request</td>\n<td>400</td>\n</tr>\n<tr>\n<td>GE_03</td>\n<td>Resource Not Found</td>\n<td>404</td>\n</tr>\n</tbody>\n</table>\n</div>","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"211339dc-b755-49f7-9356-e55a6eebd2df","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"1d8b4f47-8bab-4aea-a9c7-09e010260238","type":"text/javascript","exec":[""]}}],"_postman_id":"7ecc4cf9-d236-4aa4-b4a1-56fccd9f613e"},{"name":"Glossary","item":[],"id":"fc32c6ed-d96e-48f8-81e5-797ab6c7b67f","description":"<ul>\n<li><p><strong>Anzi Operative License (commonly referred to as License or ANZOL):</strong> A specific authorization provided by Anzi, after analyzing your business's credit allocation and risk policies, enables entities to access and integrate Anzi's default guarantees.</p>\n</li>\n<li><p><strong>Credit allocation:</strong> is the way credit (like loans or funding) is given out to different people or projects, based on things like how risky they are or how much they need the money.</p>\n</li>\n<li><p><strong>Premium:</strong> The amount paid to Anzi for a Surety.</p>\n</li>\n<li><p><strong>Surety:</strong> A financial guarantee by one party (Anzi) to assume responsibility for the debt obligation of a borrower (up to 50% of the debt in the case of Anzi) if that borrower defaults.</p>\n</li>\n<li><p><strong>Borrower</strong>: An individual or entity that receives funds from a lender with the agreement to repay the borrowed amount, plus any agreed-upon interest, over a specified period.</p>\n</li>\n<li><p><strong>Claim</strong>: A formal request by a lender to an coverage provider (like Anzi) for payment due to the occurrence of a covered event, such as a default.</p>\n</li>\n<li><p><strong>Coverage</strong>: The amount of protection provided under an insurance policy or a financial guarantee against specific types of loss or risk.</p>\n</li>\n<li><p><strong>Default</strong>: Failure to meet the legal obligations or conditions of a loan, typically when a borrower does not make a scheduled payment on time.</p>\n</li>\n<li><p><strong>Lender</strong>: An individual, institution, or entity that lends money to borrowers with the expectation that the money will be repaid, typically with interest.</p>\n</li>\n<li><p><strong>Loan</strong>: Money, property, or other material goods given to another party in exchange for future repayment of the loan value amount, along with interest or other finance charges.</p>\n</li>\n</ul>\n","_postman_id":"fc32c6ed-d96e-48f8-81e5-797ab6c7b67f","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{api-key}}"}]},"isInherited":true,"source":{"_postman_id":"c8be523d-aaaf-4907-9390-19b1fed4fdf4","id":"c8be523d-aaaf-4907-9390-19b1fed4fdf4","name":"Anzi Finance - V 0.0.9","type":"collection"}}}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"{{api-key}}"}]}},"event":[{"listen":"prerequest","script":{"id":"82ef92cd-5a01-4794-80e1-1e5d7cac7807","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a532d9be-d08f-4a58-b2dc-d0a3a749bdfb","type":"text/javascript","exec":[""]}}]}