Propose evidenced forbearance, loss-mitigation resolution, foreclosure referral or servicing transfer
/lending-servicing/cases/{id}/actionsDedicated lending:servicing:write staff authority with fresh authentication required. Reviewed forbearance suspends staff/service collection debits and late fees on protected installment dates; contractual delinquency, interest, nonaccrual and charge-off accounting remain accurate. Denial requires complete-application evidence, actual notice and at least 14 days to appeal. Supported mortgage foreclosure referral requires more than 120 days past due and no borrower protection. Recording a referral does not perform an external legal filing.
Path parameters
idstringRequiredHeaders
Idempotency-KeystringRequiredSend on every write that creates or changes money or state; a replay with the same key returns the original result with 200.
Body parameters
appeal_untilstring · date or nullOptionalA business date, YYYY-MM-DD
effective_datestring · dateRequiredA business date, YYYY-MM-DD
endsstring · dateOptionalA business date, YYYY-MM-DD
evidenceobjectRequiredEvidence identifies the actual reviewed input, never an inferred geocode or identity.
2 child attributes
referencestringRequiredsha256stringRequiredkindstringRequiredContact, acknowledge, complete_application, forbearance, denial, withdrawal, foreclosure_referral, transfer_out
noticeobject or nullOptional3 child attributes
channelstringRequiredevidenceobjectRequiredEvidence identifies the actual reviewed input, never an inferred geocode or identity.
2 child attributes
referencestringRequiredsha256stringRequiredsent_atstring · date-timeRequiredprevious_idstringOptionalreasonstringRequiredrelated_action_idstringOptionaltransferobject or nullOptional6 child attributes
receiver_acknowledgment_evidenceobjectRequiredEvidence identifies the actual reviewed input, never an inferred geocode or identity.
2 child attributes
referencestringRequiredsha256stringRequiredreceiving_servicer_contactstringRequiredreceiving_servicer_idstringRequiredreceiving_servicer_namestringRequiredservicing_contract_evidenceobjectRequiredEvidence identifies the actual reviewed input, never an inferred geocode or identity.
2 child attributes
referencestringRequiredsha256stringRequiredsnapshot_sha256stringRequiredReturns
200 OK
actionobjectRequired10 child attributes
appeal_untilstring · date or nullOptionalA business date, YYYY-MM-DD
effective_datestring · dateRequiredA business date, YYYY-MM-DD
endsstring · dateOptionalA business date, YYYY-MM-DD
evidenceobjectRequiredEvidence identifies the actual reviewed input, never an inferred geocode or identity.
2 child attributes
referencestringRequiredsha256stringRequiredkindstringRequiredContact, acknowledge, complete_application, forbearance, denial, withdrawal, foreclosure_referral, transfer_out
noticeobject or nullOptional3 child attributes
channelstringRequiredevidenceobjectRequiredEvidence identifies the actual reviewed input, never an inferred geocode or identity.
2 child attributes
referencestringRequiredsha256stringRequiredsent_atstring · date-timeRequiredprevious_idstringOptionalreasonstringRequiredrelated_action_idstringOptionaltransferobject or nullOptional6 child attributes
receiver_acknowledgment_evidenceobjectRequiredEvidence identifies the actual reviewed input, never an inferred geocode or identity.
2 child attributes
referencestringRequiredsha256stringRequiredreceiving_servicer_contactstringRequiredreceiving_servicer_idstringRequiredreceiving_servicer_namestringRequiredservicing_contract_evidenceobjectRequiredEvidence identifies the actual reviewed input, never an inferred geocode or identity.
2 child attributes
referencestringRequiredsha256stringRequiredsnapshot_sha256stringRequiredactorstringRequiredcase_idstringRequiredExample case_2tVh8nqLxq4GbDe0K1F6S9zRcWm
content_sha256stringRequiredcreated_atstring · date-timeRequireddecisionobject or nullOptional5 child attributes
actorstringRequiredapprovebooleanRequiredatstring · date-timeRequiredevidenceobjectRequiredEvidence identifies the actual reviewed input, never an inferred geocode or identity.
2 child attributes
referencestringRequiredsha256stringRequiredreasonstringRequiredidstringRequiredloan_idstringRequiredExample loan_2tVh8nqLxq4GbDe0K1F6S9zRcWm
Errors
Every error is a problem document with a stable code. See Errors.
400401403404409412413422424429500503