Corgi BankDocumentation
OpenAPI

Capture actual current lending obligations and collateral; retain close blockers

POST/affiliate-controls/monitoring-runs

Verified affiliate reader captures a current observation after lending accrual. BusinessDate names the requested completed close, ObservationDate names the current business date, and each lending source must be accrued through the requested close. This does not reconstruct historical obligations. The service retains actual source obligations including all accrued/uncollected interest and unpaid fees, current relationship reviews, original and additional cash holds, and capital comparisons. Source and ledger inconsistency, missing/expired evidence, unresolved funding, or collateral shortfall remain explicit close blockers. Full original commitment remains counted until reviewed release. Source calls occur outside the bankwide lock, then the unchanged reservation inventory and nonlocking source revisions are checked before capture. The exact current attribution plan is retained. Readiness records a collected observation; revision checks are not a distributed write fence. This observation is dated exception evidence, not a guarantee of uninterrupted compliance or external exposure completeness.

Headers

Idempotency-KeystringOptional

Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.

Body parameters

business_datestring · dateRequired

A business date, YYYY-MM-DD

Returns

201 Created

actorstringRequired
all_affiliate_exposureintegerRequired
blockersarray of objectsRequired
2 child attributes
reasonstringRequired
transaction_refstringRequired
business_datestring · dateRequired

A business date, YYYY-MM-DD

capital_stock_and_surplusintegerRequired
capture_started_atstring · date-timeRequired
captured_atstring · date-timeRequired
content_sha256stringRequired
idstringRequired
itemsarray of objectsRequired
14 child attributes
accrued_interest_amountinteger or nullOptional
actual_cash_collateral_amountintegerRequired
blockersarray of stringsRequired
collateralarray of objectsRequired
6 child attributes
amountintegerRequired
hold_idstringRequired

Example hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm

ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

record_idstringRequired
source_servicestringRequired
statusstringRequired
lending_sourceobjectOptional
lending_source_sha256stringOptional
lending_versionobjectOptional
planobjectRequired
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
rationalestringRequired
reservation_idstringRequired
content_sha256stringRequired
customer_sha256stringOptional
customer_snapshotobjectOptional
decisionobject or nullOptional
6 child attributes
actorstringRequired
atstring · date-timeRequired
content_sha256stringRequired
decisionstringRequired
evidenceobjectRequired
rationalestringRequired
idstringRequired
kindstringRequired
planobject or nullOptional
8 child attributes
attribution_customer_idsarray of stringsRequired
attribution_evidenceobjectRequired
cash_collateralobject 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.

market_terms_evidenceobjectRequired
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
coverage_evidenceobjectRequired
existing_exposuresarray of objectsRequired

External opening book, never duplicates locally reserved commitments

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
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
obligation_terminatedboolean or nullOptional
rationalestringRequired
reservation_idstringRequired
principal_amountinteger or nullOptional
registry_recordsarray 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
rationalestringRequired
reservation_idstringRequired
content_sha256stringRequired
customer_sha256stringOptional
customer_snapshotobjectOptional
decisionobject or nullOptional
6 child attributes
actorstringRequired
atstring · date-timeRequired
content_sha256stringRequired
decisionstringRequired
evidenceobjectRequired
rationalestringRequired
idstringRequired
kindstringRequired
planobject or nullOptional
8 child attributes
attribution_customer_idsarray of stringsRequired
attribution_evidenceobjectRequired
cash_collateralobject 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.

market_terms_evidenceobjectRequired
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
coverage_evidenceobjectRequired
existing_exposuresarray of objectsRequired

External opening book, never duplicates locally reserved commitments

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
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
obligation_terminatedboolean or nullOptional
rationalestringRequired
reservation_idstringRequired
required_covered_amountintegerRequired
reservationobjectRequired
17 child attributes
actorstringRequired
affiliate_idstringOptional
all_exposure_afterintegerRequired
capital_stock_and_surplusintegerRequired
cash_hold_idstringOptional

Example hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm

covered_amountintegerRequired
created_atstring · date-timeRequired
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
idstringRequired
monitor_idstringOptional
plan_idstringRequired
plan_sha256stringRequired
policy_idstringRequired
policy_sha256stringRequired
registry_idsarray of stringsRequired
single_exposure_afterintegerRequired
statusstringRequired

Preparing, reserved, released; preparing still consumes capacity

undrawn_amountinteger or nullOptional
unpaid_fees_amountinteger or nullOptional
observation_datestring · dateRequired

A business date, YYYY-MM-DD

policyobjectRequired
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
readybooleanRequired
single_affiliate_exposuresobjectRequired

Errors

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

400401403404409412413422424429500503

to move to open esc to close