Corgi BankDocumentation
OpenAPI

Capture an immutable regulatory correction against its approved predecessor; dedicated staff scope and recent authentication

POST/lending-risk/targets/{kind}/{target}/revisions

Requires dedicated lending:monitoring:write or lending:risk:write staff authority and authentication within five minutes. Monitoring identities cannot also hold lending:write or operations:approve. kind is loan or facility. Corrections name the current approved previous_id; evidence remains immutable. Monitoring uses the 2026 FIG registry; fields use official 1-based field-number keys. No demographics enter underwriting. Risk grades name an evidenced scale/version and nonfuture effective date.

Path parameters

kindstringRequired
targetstringRequired

Headers

Idempotency-KeystringRequired

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

monitoringobject or nullOptional

Capture may be approved while collection is in progress, but only complete, reportable records enter a draft LAR export. Keys are the FIG's 1-based field numbers; explicit blanks are preserved and never replaced with invented codes.

8 child attributes
collection_evidenceobjectRequired

Evidence identifies the actual reviewed input, never an inferred geocode or identity.

2 child attributes
referencestringRequired
sha256stringRequired
fieldsobjectRequired
geographyobject or nullOptional

Geography preserves the supplied census/assessment-area determination and its vintage. An outside-area result is distinct from an unassessed result.

9 child attributes
assessment_area_evidenceobjectRequired

Evidence identifies the actual reviewed input, never an inferred geocode or identity.

2 child attributes
referencestringRequired
sha256stringRequired
assessment_area_idstringRequired
assessment_area_versionstringRequired
census_tractstringRequired
census_vintageintegerRequired
countystringRequired
geocodeobjectRequired

Evidence identifies the actual reviewed input, never an inferred geocode or identity.

2 child attributes
referencestringRequired
sha256stringRequired
in_assessment_areaboolean or nullOptional
statestringRequired
hmda_reportabilitystringRequired

Reportable, not_reportable, undetermined

readinessstringRequired

In_progress, complete

reportability_evidenceobjectRequired

Evidence identifies the actual reviewed input, never an inferred geocode or identity.

2 child attributes
referencestringRequired
sha256stringRequired
reporting_yearintegerRequired
schema_idstringRequired
previous_idstringRequired
reasonstringRequired
risk_gradeobject or nullOptional
7 child attributes
classificationstringRequired
effective_datestring · dateRequired

A business date, YYYY-MM-DD

gradestringRequired
policyobjectRequired

Evidence identifies the actual reviewed input, never an inferred geocode or identity.

2 child attributes
referencestringRequired
sha256stringRequired
scale_idstringRequired
scale_versionstringRequired
sourceobjectRequired

Evidence identifies the actual reviewed input, never an inferred geocode or identity.

2 child attributes
referencestringRequired
sha256stringRequired

Returns

200 OK

actorstringRequired
categorystringRequired
created_atstring · date-timeRequired
decisionobject or nullOptional
5 child attributes
actorstringRequired
approvebooleanRequired
atstring · date-timeRequired
evidenceobjectRequired

Evidence identifies the actual reviewed input, never an inferred geocode or identity.

2 child attributes
referencestringRequired
sha256stringRequired
reasonstringRequired
idstringRequired
proposalobjectRequired
4 child attributes
monitoringobject or nullOptional

Capture may be approved while collection is in progress, but only complete, reportable records enter a draft LAR export. Keys are the FIG's 1-based field numbers; explicit blanks are preserved and never replaced with invented codes.

8 child attributes
collection_evidenceobjectRequired

Evidence identifies the actual reviewed input, never an inferred geocode or identity.

2 child attributes
referencestringRequired
sha256stringRequired
fieldsobjectRequired
geographyobject or nullOptional

Geography preserves the supplied census/assessment-area determination and its vintage. An outside-area result is distinct from an unassessed result.

9 child attributes
assessment_area_evidenceobjectRequired

Evidence identifies the actual reviewed input, never an inferred geocode or identity.

assessment_area_idstringRequired
assessment_area_versionstringRequired
census_tractstringRequired
census_vintageintegerRequired
countystringRequired
geocodeobjectRequired

Evidence identifies the actual reviewed input, never an inferred geocode or identity.

in_assessment_areaboolean or nullOptional
statestringRequired
hmda_reportabilitystringRequired

Reportable, not_reportable, undetermined

readinessstringRequired

In_progress, complete

reportability_evidenceobjectRequired

Evidence identifies the actual reviewed input, never an inferred geocode or identity.

2 child attributes
referencestringRequired
sha256stringRequired
reporting_yearintegerRequired
schema_idstringRequired
previous_idstringRequired
reasonstringRequired
risk_gradeobject or nullOptional
7 child attributes
classificationstringRequired
effective_datestring · dateRequired

A business date, YYYY-MM-DD

gradestringRequired
policyobjectRequired

Evidence identifies the actual reviewed input, never an inferred geocode or identity.

2 child attributes
referencestringRequired
sha256stringRequired
scale_idstringRequired
scale_versionstringRequired
sourceobjectRequired

Evidence identifies the actual reviewed input, never an inferred geocode or identity.

2 child attributes
referencestringRequired
sha256stringRequired
reporting_yearintegerRequired
sha256stringRequired
target_idstringRequired
target_kindstringRequired

Errors

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

400401403404409412413422424429500503

to move to open esc to close