Read a segregated revision with sensitive-access evidence
/lending-monitoring/revisions/{revision}Dedicated read authority and a nonempty purpose query required; access is recorded.
Path parameters
revisionstringRequiredReturns
200 OK
actorstringRequiredcategorystringRequiredcreated_atstring · date-timeRequireddecisionobject or nullOptional5 child attributes
actorstringRequiredapprovebooleanRequiredatstring · date-timeRequiredevidenceobjectRequiredEvidence identifies the actual reviewed input, never an inferred geocode or identity.
2 child attributes
referencestringRequiredsha256stringRequiredreasonstringRequiredidstringRequiredproposalobjectRequired4 child attributes
monitoringobject or nullOptionalCapture 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_evidenceobjectRequiredEvidence identifies the actual reviewed input, never an inferred geocode or identity.
2 child attributes
referencestringRequiredsha256stringRequiredfieldsobjectRequiredgeographyobject or nullOptionalGeography 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_evidenceobjectRequiredEvidence identifies the actual reviewed input, never an inferred geocode or identity.
assessment_area_idstringRequiredassessment_area_versionstringRequiredcensus_tractstringRequiredcensus_vintageintegerRequiredcountystringRequiredgeocodeobjectRequiredEvidence identifies the actual reviewed input, never an inferred geocode or identity.
in_assessment_areaboolean or nullOptionalstatestringRequiredhmda_reportabilitystringRequiredReportable, not_reportable, undetermined
readinessstringRequiredIn_progress, complete
reportability_evidenceobjectRequiredEvidence identifies the actual reviewed input, never an inferred geocode or identity.
2 child attributes
referencestringRequiredsha256stringRequiredreporting_yearintegerRequiredschema_idstringRequiredprevious_idstringRequiredreasonstringRequiredrisk_gradeobject or nullOptional7 child attributes
classificationstringRequiredeffective_datestring · dateRequiredA business date, YYYY-MM-DD
gradestringRequiredpolicyobjectRequiredEvidence identifies the actual reviewed input, never an inferred geocode or identity.
2 child attributes
referencestringRequiredsha256stringRequiredscale_idstringRequiredscale_versionstringRequiredsourceobjectRequiredEvidence identifies the actual reviewed input, never an inferred geocode or identity.
2 child attributes
referencestringRequiredsha256stringRequiredreporting_yearintegerRequiredsha256stringRequiredtarget_idstringRequiredtarget_kindstringRequiredErrors
Every error is a problem document with a stable code. See Errors.
400401403404409412413422424429500503