Skip to main content
PUT
/
guarantees
/
credit-status
Update credit status
curl --request PUT \
  --url https://sandbox-api.anzi.finance/v1/guarantees/credit-status \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "status": "CURRENT"
}
'
{
  "uid": "b4c2d1e3-9a8f-4b7d-86e1-2f3a4c5b6d7e",
  "tokenId": 987654321,
  "coverage": 25000,
  "disbursementDate": "2025-09-05T00:00:00.000Z",
  "dueDate": "2026-12-04T23:59:59.999Z",
  "status": 2,
  "premiumStatus": 2,
  "premium": 1750,
  "principalName": "Empresa XYZ SAS",
  "promissoryNoteId": "PN-0001-XYZ",
  "loanPaymentDueDate": "2025-12-05T23:59:59.999Z",
  "loanAmount": 50000,
  "type": 0,
  "premiumPercentage": 3.5,
  "coveragePercentage": 50,
  "externalReference": "CR-000001-XYZ",
  "isNovation": false,
  "creditStatus": 0,
  "creditStatusUpdatedAt": "2025-09-02T10:30:00.000Z",
  "creditPrincipalOutstanding": 12500,
  "creditLastPaymentDate": "2025-09-10T00:00:00.000Z"
}
Claims in Anzi are automatically managed through credit status updates. If you want to make a claim, you must update the credit status to CLAIM_GUARANTEE.

​
Business rules

  • You cannot update a credit that:
    • already has a claim or is in the “claim guarantee” step, or
    • has a guarantee in a terminal state (CLOSED, CANCELLED, or NOVATED).
You must provide creditPrincipalOutstanding and creditLastPaymentDate when the outstanding balance has changed or when the credit status has changed (e.g., to DELINQUENT, CLAIM_GUARANTEE, etc.).
  • Outstanding balance (creditPrincipalOutstanding):
    • Cannot be higher than the last recorded outstanding balance (when there is a previous outstanding balance recorded).
    • Cannot be higher than the original loan amount.
    • Cannot be negative.
  • Last payment date (creditLastPaymentDate):
    • If you provide it, it must be after the day the loan was disbursed.
    • If a last payment was already recorded, the new date cannot be earlier than the previously recorded date.
    • It cannot be a future date.
  • Coupled fields rule (both-or-none):
    • If you provide creditLastPaymentDate, you must also provide creditPrincipalOutstanding.
    • If you provide creditPrincipalOutstanding, you must also provide creditLastPaymentDate.
  • Update frequency:
    • You can only update the credit status once per calendar day (evaluated in the license timezone).

Authorizations

​
X-API-KEY
string
header
required

Query Parameters

​
license
string
required

License UID

​
uid
string
required

Guarantee UID

Body

application/json
​
status
enum<string>
required

New credit status to set for the guarantee.

Available options:
CURRENT,
DELINQUENT,
CLAIM_GUARANTEE,
NOVATED,
PAID
​
creditPrincipalOutstanding
number

Outstanding principal amount of the credit as of the borrower’s last payment date.

Required range: x >= 0
​
creditLastPaymentDate
string<date-time>

Last payment date (ISO 8601).

Response

Credit status updated

​
uid
string

Unique identifier of the guarantee.

​
tokenId
number

Numeric identifier assigned to the guarantee token.

​
coverage
number

Maximum amount payable if the linked loan defaults. For guarantees created under FIRST LOSS licenses (license.type = FIRST_LOSS), coverage depends exclusively on the amount the user has in their own reserve fund (wallet).

​
disbursementDate
string<date-time>

Date and time when the credit was disbursed.

​
claimDate
string<date-time> | null

Date and time when a claim was registered for this guarantee (if any).

​
dueDate
string<date-time>

Guarantee due date.

​
status
enum<integer>

0=PENDING_ACTIVATION, 1=VALIDATING_PREMIUM_PAYMENT, 2=COVERING, 3=PENDING_CLAIM, 4=CLAIM_APPROVED, 5=PAYING_GUARANTEE, 6=CLOSED, 7=CLAIM_REJECTED, 8=CANCELLED, 9=NOVATED

Available options:
0,
1,
2,
3,
4,
5,
6,
7,
8,
9
​
creditStatus
enum<integer>

0=CURRENT, 1=DELINQUENT, 2=CLAIM_GUARANTEE, 3=NOVATED, 4=PAID

Available options:
0,
1,
2,
3,
4
​
creditStatusUpdatedAt
string<date-time>

Timestamp of the last update to creditStatus.

​
creditPrincipalOutstanding
number

Outstanding principal amount of the credit as of the borrower’s last payment date.

​
creditLastPaymentDate
string<date-time> | null

Date and time of the last credit payment (if any).

​
premiumStatus
enum<integer>

0=PENDING, 1=PROCESSING, 2=PAID

Available options:
0,
1,
2
​
premium
number

Premium amount charged for the guarantee (monetary value).

​
principalName
string

Borrower or principal name associated with the credit.

​
loanPaymentDueDate
string<date-time>

Date and time when the loan payment is/was completed by the borrower.

​
interestRate
number | null

Credit interest rate used by the client (optional).

​
loanAmount
number

Original loan principal amount linked to this guarantee.

​
type
enum<integer>

0 = SURETY, 1 = FIRST_LOSS. License type under which this guarantee was created.

Available options:
0,
1
​
premiumPercentage
number

Percentage applied to the loan amount to compute the premium.

​
coveragePercentage
number

Percentage of the principal amount that is covered by the guarantee. For guarantees created under FIRST LOSS licenses (license.type = FIRST_LOSS), coverage depends exclusively on the amount the user has in their own reserve fund (wallet).

​
externalReference
string

Unique credit reference in your system used to identify the guarantee.

​
isNovation
boolean

Indicates if this guarantee results from a novation of a prior guarantee.