> ## Documentation Index > Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt > Use this file to discover all available pages before exploring further. # List guarantees by contract or by the client's number > Exactly one of loanApplicationId (the guarantees standing on that contract) and externalReference (the guarantees carrying that number in any institution of the tenant). At most 100, newest first. ## OpenAPI ````yaml /es/openapi/v3-current/lender.yaml get /api/v1/br/guarantees openapi: 3.1.0 info: contact: email: contact@lerian.studio name: Lerian Studio url: https://lerian.studio description: >- Code-first OpenAPI 3.1 surface for the Lender service. Routes that move money are at-most-once per X-Idempotency: when one answers 5xx, the X-Idempotency-Fenced response header says whether that key is now refusing resends (true) or free to retry (false or absent). license: name: Lerian Studio General License title: Lender API version: 1.0.0 servers: - url: https://lender.sandbox.lerian.net security: - BearerAuth: [] tags: - description: >- Caller session projection: validated subject and effective permissions for the presented token. name: Session - description: >- Ledger accounting operations: journal entries and accrual postings for loan accounts. Operations under /api/v1/internal are back-office operations for the client's operators: they require a person's login, and a service credential gets 403. name: Accounting - description: >- Loan application intake and lifecycle: submission, decisioning, and status. name: LoanApplications - description: >- Loan product catalog: definition, versioning, and activation of lending products. name: LoanProducts - description: >- Loan account servicing operations: balances, schedules, and account-level actions. name: Loan Accounts - description: >- Portfolio dashboard read operations: aggregated portfolio and performance views. name: Dashboard - description: >- Jurisdiction registry: supported jurisdiction profiles and their capabilities. name: Jurisdictions - description: >- Jurisdiction-specific loan application operations (Brazil origination surface). name: Loan Applications - description: >- Tax computation operations for jurisdiction-specific lending (e.g. Brazil IOF). name: Tax - description: >- Brazil consignado privado operations: contract lifecycle, exclusion repair, and compensating adjustments. Operations under /api/v1/internal are back-office operations for the client's operators: they require a person's login, and a service credential gets 403. name: Consignado - description: >- Inbound record quarantine. Operations under /api/v1/internal are back-office operations for the client's operators: they require a person's login, and a service credential gets 403. name: Streaming - description: >- Credit-instrument document template registry: versioned drafting and publication of CCB clausulado. name: DocumentTemplates paths: /api/v1/br/guarantees: get: tags: - Guarantees summary: List guarantees by contract or by the client's number description: >- Exactly one of loanApplicationId (the guarantees standing on that contract) and externalReference (the guarantees carrying that number in any institution of the tenant). At most 100, newest first. operationId: listGuarantees parameters: - description: >- The contract: lists the guarantees standing on it. Exactly one of the two filters. explode: false in: query name: loanApplicationId schema: description: >- The contract: lists the guarantees standing on it. Exactly one of the two filters. format: uuid type: string - description: >- The client's number: lists the guarantees carrying it, in every institution of the tenant. Exactly one of the two filters. explode: false in: query name: externalReference schema: description: >- The client's number: lists the guarantees carrying it, in every institution of the tenant. Exactly one of the two filters. type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListGuaranteesOutputBody' description: OK '401': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Unauthorized '403': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Forbidden '404': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Not Found '422': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Unprocessable Entity '500': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Internal Server Error '503': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Service Unavailable '504': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Gateway Timeout default: content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: >- Any other status this operation may carry, rendered as a problem document — including a refusal produced ahead of the service, such as a gateway or ingress answering on its behalf. components: schemas: ListGuaranteesOutputBody: additionalProperties: false properties: data: description: At most 100, newest first. items: $ref: '#/components/schemas/GuaranteeResponse' type: - array - 'null' required: - data type: object Detail: additionalProperties: true properties: code: description: >- Stable, machine-readable domain error code scoped to the emitting service (format: -NNNN). type: string detail: description: >- A human-readable explanation specific to this occurrence of the problem. examples: - Property foo is required but is missing. type: string errors: description: Optional list of individual error details items: $ref: '#/components/schemas/ErrorDetail' type: - array - 'null' instance: description: >- A URI reference that identifies the specific occurrence of the problem. examples: - https://example.com/error-log/abc123 format: uri type: string status: description: HTTP status code examples: - 400 format: int64 type: integer title: description: >- A short, human-readable summary of the problem type. This value should not change between occurrences of the error. examples: - Bad Request type: string type: default: about:blank description: A URI reference to human-readable documentation for the error. examples: - https://example.com/errors/example format: uri type: string upstream: $ref: '#/components/schemas/Upstream' description: >- RFC 9457 extension member: the error a proxied third-party provider reported. Absent unless the emitting service explicitly surfaced one. type: object GuaranteeResponse: additionalProperties: false properties: createdAt: description: When it was registered. format: date-time type: string createdBy: description: Who registered it. type: string currency: description: The currency of its first contract. type: string description: description: The asset or the aval in general terms. type: string executedAt: description: The first execution receipt's instant; absent until one executes it. format: date-time type: string externalReference: description: The client's number for the guarantee. type: string guarantorHolderId: description: The guarantor's CRM holder; absent on an asset. format: uuid type: string id: description: The guarantee. format: uuid type: string identification: description: Gar.Ident of a real guarantee. type: string links: description: The standing links. items: $ref: '#/components/schemas/GuaranteeLinkResponse' type: - array - 'null' midazOrganizationId: description: The institution the guarantee belongs to. type: string originalValue: description: Gar.VlrOrig. type: string receipts: description: One item per contract of each execution. items: $ref: '#/components/schemas/GuaranteeReceiptResponse' type: - array - 'null' revaluation: $ref: '#/components/schemas/GuaranteeRevaluationResponse' description: The reassessment in force. scr: $ref: '#/components/schemas/GuaranteeSCRResponse' required: - id - midazOrganizationId - description - currency - scr - links - receipts - createdAt - createdBy type: object ErrorDetail: additionalProperties: false properties: location: description: >- Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id' type: string message: description: Error message text type: string value: description: The value at the given location type: object Upstream: additionalProperties: false properties: code: description: The upstream provider's own error code, verbatim. examples: - E4001 type: string message: description: >- The upstream provider's own error message, verbatim (bounded, never its raw response body). examples: - account not found at provider type: string type: object GuaranteeLinkResponse: additionalProperties: false properties: coveredPercentage: description: The percentage of the contract the guarantee covers. examples: - '50.00' type: string linkedAt: description: When the link was recorded (RFC 3339, UTC). format: date-time type: string linkedBy: description: Who linked it. type: string loanApplicationId: description: The contract. format: uuid type: string required: - loanApplicationId - coveredPercentage - linkedAt - linkedBy type: object GuaranteeReceiptResponse: additionalProperties: false properties: amount: description: The allocation to the contract (2 d.p. string). type: string appliedAs: description: How the contract took it. enum: - repayment - credit_loss_recovery type: string heldAmount: description: >- What of the excess stayed as the borrower's held cash (2 d.p. string). type: string id: description: The receipt. format: uuid type: string loanApplicationId: description: The contract it was booked on. format: uuid type: string prepaidAmount: description: >- What of the excess the contract took in cash after the due leg: the prepayment's net, or the arrears it paid (2 d.p. string). type: string receivedAt: description: When the money arrived. format: date-time type: string required: - id - loanApplicationId - amount - appliedAs - heldAmount - prepaidAmount - receivedAt type: object GuaranteeRevaluationResponse: additionalProperties: false properties: percentage: description: The reassessed percentage; absent when not stated. type: string reassessedOn: description: The civil day (YYYY-MM-DD). type: string value: description: The reassessed value; absent when not stated. type: string required: - reassessedOn type: object GuaranteeSCRResponse: additionalProperties: false properties: situation: description: The last Gar.SitGar declared. type: string type: description: Gar.Tp. type: string valueType: description: Gar.TpVlrGar. type: string required: - type - valueType - situation type: object securitySchemes: BearerAuth: bearerFormat: JWT description: JWT bearer token issued by the identity provider. scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.