Capture an assigned collections or loss-mitigation case with retained borrower evidence
/lending-servicing/casesDedicated lending:servicing:write human staff authority and authentication within five minutes required. Records assigned collections/loss-mitigation work, actual receipt and source evidence. A captured loss-mitigation request immediately prevents foreclosure referral; acknowledgment/evaluation work remains visible. No claim that recording a notice delivers it.
Headers
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
assigned_tostringRequiredevidenceobjectRequiredEvidence identifies the actual reviewed input, never an inferred geocode or identity.
2 child attributes
referencestringRequiredsha256stringRequiredkindstringRequiredCollections, loss_mitigation
loan_idstringRequiredExample loan_2tVh8nqLxq4GbDe0K1F6S9zRcWm
reasonstringRequiredreceived_atstring · date-timeRequiredReturns
200 OK
acknowledgment_duestring · dateRequiredA business date, YYYY-MM-DD
actionsarray of objectsRequired8 child attributes
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.
sent_atstring · date-timeRequiredprevious_idstringOptionalreasonstringRequiredrelated_action_idstringOptionaltransferobject or nullOptional6 child attributes
receiver_acknowledgment_evidenceobjectRequiredEvidence identifies the actual reviewed input, never an inferred geocode or identity.
receiving_servicer_contactstringRequiredreceiving_servicer_idstringRequiredreceiving_servicer_namestringRequiredservicing_contract_evidenceobjectRequiredEvidence identifies the actual reviewed input, never an inferred geocode or identity.
snapshot_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
actorstringRequiredcreated_atstring · date-timeRequiredevaluation_duestring · date or nullOptionalA business date, YYYY-MM-DD
idstringRequiredrequestobjectRequiredCase tracks actual servicing work. A loss-mitigation request protects against foreclosure from capture, without waiting for staff approval of the request.
6 child attributes
assigned_tostringRequiredevidenceobjectRequiredEvidence identifies the actual reviewed input, never an inferred geocode or identity.
2 child attributes
referencestringRequiredsha256stringRequiredkindstringRequiredCollections, loss_mitigation
loan_idstringRequiredExample loan_2tVh8nqLxq4GbDe0K1F6S9zRcWm
reasonstringRequiredreceived_atstring · date-timeRequiredwork_neededarray of stringsRequiredErrors
Every error is a problem document with a stable code. See Errors.
400401403404409412413422424429500503