Create Guarantee - Anzi Docs

Authorizations

X-API-KEY

string

header

required

Query Parameters

license

string

required

License UID

Body

application/json

borrowerAddress

string | null

required

Borrower address (optional).

borrowerEmail

string<email> | null

required

Borrower email (optional).

borrowerIdType

enum<string>

required

National ID document type (LATAM + US).

PA: Pasaporte (Passport)
CC: Cédula de Ciudadanía (Colombia)
CE: Cédula de Extranjería (Colombia, código único)
NIT: Número de Identificación Tributaria (Colombia, empresas)
RUT: Registro Único Tributario (Colombia, cuando aplique)
PPT: Permiso por Protección Temporal (Colombia)
CDE: Cédula de Extranjería (Colombia, código legado)
DNI_AG: Documento Nacional de Identidad (Argentina)
CUIT: Clave Única de Identificación Tributaria (Argentina)
CUIL: Clave Única de Identificación Laboral (Argentina)
CDI: Clave de Identificación (Argentina)
INE: Credencial para votar (México)
CURP: Clave Única de Registro de Población (México)
RFC: Registro Federal de Contribuyentes (México)
SSN: Social Security Number (EE. UU.)
ITIN: Individual Taxpayer Identification Number (EE. UU.)
EIN: Employer Identification Number (EE. UU., empresas)
CI: Cédula de Identidad (Uruguay)
RUT_UY: Registro Único Tributario (Uruguay)
DNI_PE: Documento Nacional de Identidad (Perú)
RUC: Registro Único de Contribuyentes (Perú)
PTP: Permiso Temporal de Permanencia (Perú)
CPP: Carné de Permiso Temporal de Permanencia (Perú)

Available options:

PA,

CC,

CE,

NIT,

RUT,

PPT,

CDE,

DNI_AG,

CUIT,

CUIL,

CDI,

INE,

CURP,

RFC,

SSN,

ITIN,

EIN,

CI,

RUT_UY,

DNI_PE,

RUC,

PTP,

CPP

borrowerNationalId

string

required

Borrower national ID.

borrowerPhone

string | null

required

Borrower phone (optional).

disbursementDate

string<date>

required

Disbursement date (YYYY-MM-DD). Defaults to current date in license timezone and is validated against allowed windows.

externalReference

string

required

Unique credit reference in your system. Must be unique per license.

frequency

enum<integer>

required

Installment frequency NONE (0) WEEKLY (1), BIWEEKLY (2), MONTHLY (3). Rule: When a credit is repaid through a single payment instead of installments, the frequency must be set to NONE.

Available options:

0,

1,

2,

3

installmentsCount

integer

required

Number of installments for the loan. Rule: when frequency is NONE, send installmentsCount = 1.

Required range: x >= 1

loanAmount

number

required

Loan amount. Must be within the license allowed range.

paymentTerm

string<date>

required

Loan due date (YYYY-MM-DD). Must be within the license min/max terms.

premiumPercentage

number

required

Premium percentage to apply to the loan. For variable-premium licenses defined by the client, it must be within [license.minimumPremium, license.maximumPremium]. For other licenses, send the agreed premium percentage (typically the license.premium)

principalName

string

required

Principal/borrower name.

promissoryNoteId

string

required

Promissory note identifier. Must be unique per license.

borrowerMunicipalityCode

string | null

Municipality code where the borrower is located (optional).

gracePeriod

number | null

Days of grace period after due date (optional).

Required range: x >= 0

lineOfCredit

string | null

Line of credit identifier (optional).

Response

Guarantee created

Response shape returned right after creating a guarantee

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.

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=CANCELED, 9=NOVATED, 10=REVOKED

Available options:

0,

1,

2,

3,

4,

5,

6,

7,

8,

9,

10

creditStatus

enum<integer>

0=CURRENT, 1=DELINQUENT, 2=CLAIM_GUARANTEE, 3=NOVATED, 4=PAID, 5=REVOKED. For new guarantees the initial status is always CURRENT=0.

Available options:

0,

1,

2,

3,

4,

5

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 due.

loanAmount

number

Original loan principal amount.

type

enum<integer>

0 = SURETY, 1 = FIRST_LOSS

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 is equal to the loan amount but it depends exclusively on the amount the user has in their own reserve fund (wallet).

externalReference

string

Unique credit reference in your system.

isNovation

boolean

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

promissoryNoteId

string

Promissory note identifier.