List loan accounts

curl --request GET \
  --url https://lender.sandbox.lerian.net/api/v1/loan-accounts \
  --header 'Authorization: Bearer <token>'

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://lender.sandbox.lerian.net/api/v1/loan-accounts"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://lender.sandbox.lerian.net/api/v1/loan-accounts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": [
    {
      "assignedOfficerId": "officer-xyz",
      "borrowerId": "550e8400-e29b-41d4-a716-446655440002",
      "createdAt": "2026-06-14T12:00:00Z",
      "currency": "BRL",
      "loanAccountId": "550e8400-e29b-41d4-a716-446655440000",
      "loanProductVersionId": "550e8400-e29b-41d4-a716-446655440001",
      "principalAmount": "1234.56",
      "status": "active",
      "disbursedAt": "2026-06-15",
      "lifecycleStatus": "settled"
    }
  ]
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

List loan accounts

Returns one page of the loan book, newest first, for an operator holding no account identifier. Filters narrow the page; omitting one does not narrow. By default only live accounts are returned — set includeClosed to also see the ones a terminal lifecycle fact closed, each carrying the lifecycleStatus that says whether it was settled, ceded, ported, reversed, renegotiated or written off. A caller without the book:read permission sees only the accounts assigned to them; a request carrying no authenticated identity is refused rather than served the whole book.

GET

api

loan-accounts

List loan accounts

curl --request GET \
  --url https://lender.sandbox.lerian.net/api/v1/loan-accounts \
  --header 'Authorization: Bearer <token>'

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://lender.sandbox.lerian.net/api/v1/loan-accounts"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://lender.sandbox.lerian.net/api/v1/loan-accounts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": [
    {
      "assignedOfficerId": "officer-xyz",
      "borrowerId": "550e8400-e29b-41d4-a716-446655440002",
      "createdAt": "2026-06-14T12:00:00Z",
      "currency": "BRL",
      "loanAccountId": "550e8400-e29b-41d4-a716-446655440000",
      "loanProductVersionId": "550e8400-e29b-41d4-a716-446655440001",
      "principalAmount": "1234.56",
      "status": "active",
      "disbursedAt": "2026-06-15",
      "lifecycleStatus": "settled"
    }
  ]
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

Autorizaciones

Authorization

string

header

requerido

JWT bearer token issued by the identity provider.

Parámetros de consulta

status

enum<string>

Narrow to one originating application status. Only these two statuses ever carry a loan account.

Opciones disponibles:

disbursed,

active

Ejemplo:

"active"

borrowerId

string<uuid>

Narrow to one borrower's book. The borrower identifier is a UUID — the same identity origination stored on the contract.

Ejemplo:

"550e8400-e29b-41d4-a716-446655440002"

assignedOfficerId

string

Narrow to one loan officer's book. Free-form authenticated identity subject, not necessarily a UUID, at most 255 characters; a system-originated contract carries the empty officer.

Maximum string length: 255

Ejemplo:

"officer-xyz"

loanProductVersionId

string

Narrow to the contracts booked under one loan product version.

Ejemplo:

"550e8400-e29b-41d4-a716-446655440001"

currency

string

Narrow to one ISO-4217 denomination.

Pattern: ^[A-Z]{3}$

Ejemplo:

"BRL"

includeClosed

boolean

predeterminado:false

Include accounts a terminal lifecycle fact closed — settled, ceded, ported, reversed, renegotiated or written_off. Default false: the live book only. Included rows carry lifecycleStatus saying which of the six closed them.

limit

integer<int64>

predeterminado:25

Page size.

Rango requerido: 1 <= x <= 100

offset

integer<int64>

predeterminado:0

Page offset.

Rango requerido: 0 <= x <= 10000

Respuesta

data

object[] | null

requerido

Page of loan accounts, newest first; always present, empty slice when none match.

Show child attributes

Productos de préstamo de Brasil

Operaciones de consignado

Ciclo de vida del producto

Versiones del producto

Configuración del producto

Tablas de tasa flotante

Plantillas de documento

Solicitudes de Préstamo

Garantías

Instrumentos de crédito

Divulgaciones regulatorias y riesgo

Liquidación y prepago

Bajas contables y recuperación de crédito

Resumen y auditoría de cuenta

Cargos y calendario

Pagos

Transacciones

Cuentas por cobrar de pago devuelto

Fondos de cesión

Lotes de cesión

Excepciones y dossiers de la cesión

Contabilidad

Paneles de cartera

Jurisdicciones

Impuestos

Acceso de socios

Sesión

Fecha de negocio

Streaming

Manejo de errores

Eventos

List loan accounts

Autorizaciones

Parámetros de consulta

Respuesta