List assignment candidates with eligibility verdicts

Scores the tenant’s assignable pool against ONE fund’s registration and returns a verdict per receivable: eligible, or cut with exactly one reason. Every limit and policy (per debtor, payment source, assignor, arrears, suspended registration, repeated cuts) is the fund’s own; one it did not register is not applied, and in mode none only the repeated-cut brake is. The ledger’s integrity rules run in every mode. Concentration is measured against the fund’s accepted stock plus the admitted set, and the response states that base. A receivable attributed to another fund at origination is not in this fund’s pool.

GET /api/v1/assignment/funds/{fundId}/candidates

List assignment candidates with eligibility verdicts

cURL

curl --request GET \
  --url https://lender.sandbox.lerian.net/api/v1/assignment/funds/{fundId}/candidates \
  --header 'Authorization: Bearer <token>'

200

{
  "concentrationBase": "<string>",
  "currency": "<string>",
  "data": [
    {
      "attributed": true,
      "borrowerRef": "<string>",
      "currency": "<string>",
      "cutCount": 123,
      "eligible": true,
      "exposureAmount": "<string>",
      "paymentSourceRef": "<string>",
      "reason": "<string>",
      "receivableRef": "<string>",
      "requiresExceptionReview": true
    }
  ],
  "dimensionsNotEvaluated": [
    "<string>"
  ],
  "eligibilityMode": "<string>",
  "eligibleCount": 123,
  "eligibleExposure": "<string>",
  "fundId": "<string>",
  "observedAt": "<string>",
  "poolStateObserved": true,
  "ruleVersion": "<string>",
  "truncated": true
}

Autorizaciones

Authorization · string · header · requerido

JWT bearer token issued by the identity provider.

Parámetros de ruta

fundId · string<uuid> · requerido

Fund registration identifier.

Parámetros de consulta

limit · integer<int64> · predeterminado: 100

Pool window size. The window takes the receivables attributed to the fund first. Verdicts are computed over the returned window as the proposed set.

Rango requerido: 1 <= x <= 500

Respuesta

200

application/json

OK

concentrationBase · string · requerido

Denominator the surviving composition was measured against: the fund's accepted stock plus the admitted set.

currency · string · requerido

ISO currency code every amount in this response is denominated in.

data · object[] | null · requerido

One verdict per candidate, in receivable-reference order. Always present, empty slice when the pool is empty.

Show child attributes

dimensionsNotEvaluated · string[] | null · requerido

Concentration dimensions this scoring did not measure: borrower, payment_source or assignor when the fund registered no limit for it (all three under eligibility mode none), assignor also when the composition carries no per-receivable assignor, and sector always (no data source).

eligibilityMode · string · requerido

full (our verification is authoritative), prefilter (the administrator verifies; this runs ahead of the offer file) or none (the client checks eligibility at the fund: only the ledger's integrity rules and a registered repeated-cut brake run here).

eligibleCount · integer<int64> · requerido

How many receivables survived every rule.

eligibleExposure · string · requerido

Total exposure of the surviving composition, decimal string, scale 2.

fundId · string · requerido

Fund registration the pool was scored for.

observedAt · string · requerido

Instant the pool was read (RFC3339, UTC).

poolStateObserved · boolean · requerido

False when the fund's accepted stock, in-flight set membership and repeated-cut tally could not be read. In that state the caps were measured against the proposed set alone and the exclusivity and repeated-cut fences were NOT evaluated.

ruleVersion · string · requerido

Identifier of the eligibility/concentration rule that produced these verdicts.

truncated · boolean · requerido

True when more assignable receivables exist than the requested window. Verdicts are computed OVER the returned window as the proposed set.