List immutable bank-affiliate controls and review evidence

GET/affiliate-controls/policies

Verified affiliate-control staff/service reader required; immutable source records and decisions, cursor pagination.

Query parameters

limitintegerOptional

Page size

Default 10. Maximum 100.

starting_afterstringOptional

The id of the last item seen; returns the page after it

ending_beforestringOptional

The id of the first item seen; returns the page before it

Returns

200 OK

dataarray of objectsRequired

13 child attributes

collateralobject or nullOptional

CollateralAdjustmentRequest adds cash to an existing commitment's collateral. Amount is the additional pledge, not a replacement for the original pledge.

3 child attributes

cash_collateralobjectRequired

8 child attributes

account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

amountintegerRequired

evidenceobjectRequired

ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

no_other_lienboolean or nullOptional

owner_customer_idstringRequired

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

perfected_and_enforceableboolean or nullOptional

segregated_and_earmarkedboolean or nullOptional

rationalestringRequired

reservation_idstringRequired

content_sha256stringRequired

customer_sha256stringOptional

customer_snapshotobjectOptional

decisionobject or nullOptional

6 child attributes

actorstringRequired

atstring · date-timeRequired

content_sha256stringRequired

decisionstringRequired

evidenceobjectRequired

2 child attributes

referencestringRequired

sha256stringRequired

rationalestringRequired

idstringRequired

kindstringRequired

planobject or nullOptional

8 child attributes

attribution_customer_idsarray of stringsRequired

attribution_evidenceobjectRequired

2 child attributes

referencestringRequired

sha256stringRequired

cash_collateralobject or nullOptional

8 child attributes

account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

amountintegerRequired

evidenceobjectRequired

ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

no_other_lienboolean or nullOptional

owner_customer_idstringRequired

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

perfected_and_enforceableboolean or nullOptional

segregated_and_earmarkedboolean or nullOptional

creditobjectRequired

CreditRequest is created by the lending service from its immutable legal terms, never accepted from a customer as an authorization assertion. Amount is gross full commitment, including undrawn obligatory funds, not net cash after fees.

7 child attributes

amountintegerRequired

currency_codestringRequired

customer_idstringRequired

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

destination_account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

kindstringRequired

Term_loan or facility; affiliate facility execution is refused

terms_sha256stringRequired

transaction_refstringRequired

market_terms_evidenceobjectRequired

2 child attributes

referencestringRequired

sha256stringRequired

rationalestringRequired

settlement_gl_codestringOptional

Nonaffiliate facility only: reviewed card/rail settlement payable

valid_throughstring · dateRequired

A business date, YYYY-MM-DD

policyobject or nullOptional

10 child attributes

capitalobjectRequired

10 child attributes

allowance_amountinteger or nullOptional

allowance_excluded_from_tier2_amountinteger or nullOptional

deducted_financial_subsidiary_amountinteger or nullOptional

filed_atstring · date-timeRequired

filing_evidenceobjectRequired

frameworkstringRequired

Standardized or cblr

framework_evidenceobjectRequired

report_datestring · dateRequired

A business date, YYYY-MM-DD

tier1_amountinteger or nullOptional

tier2_amountinteger or nullOptional

coverage_evidenceobjectRequired

2 child attributes

referencestringRequired

sha256stringRequired

existing_exposuresarray of objectsRequired

External opening book, never duplicates locally reserved commitments

3 child attributes

affiliate_idstringRequired

amountintegerRequired

evidenceobjectRequired

exposure_as_ofstring · dateRequired

A business date, YYYY-MM-DD

legal_entitystringRequired

namestringRequired

rationalestringRequired

service_subjectsarray of stringsRequired

valid_fromstring · dateRequired

A business date, YYYY-MM-DD

valid_throughstring · dateRequired

A business date, YYYY-MM-DD

proposed_atstring · date-timeRequired

proposed_bystringRequired

registryobject or nullOptional

8 child attributes

affiliate_idstringOptional

Canonical company identity, not a whole customer group

classificationstringRequired

Affiliate or nonaffiliate; a miss never implies nonaffiliate

customer_idstringRequired

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

ownership_evidenceobjectRequired

2 child attributes

referencestringRequired

sha256stringRequired

rationalestringRequired

relationshipstringRequired

valid_fromstring · dateRequired

A business date, YYYY-MM-DD

valid_throughstring · dateRequired

A business date, YYYY-MM-DD

releaseobject or nullOptional

4 child attributes

evidenceobjectRequired

2 child attributes

referencestringRequired

sha256stringRequired

obligation_terminatedboolean or nullOptional

rationalestringRequired

reservation_idstringRequired

has_morebooleanRequired

Whether another page follows

Errors

Every error is a problem document with a stable code. See Errors.

400401403404409412413422424429500503