Common Data Holds
Specifying a DataHold setting with the application update and document business events allows you to control when the events trigger delivery. Review the table below for the most common DataHolds.
|
Application Statuses Excluded |
DataHold Setting |
When to Use This DataHold Setting |
|---|---|---|
|
InProgress |
"dataHold": "InProgress" |
When you want to receive application data in response to every update AFTER an applicant submits |
|
Undelivered, OnHold, ConductReview, Manual, Redirected, Received, Complete, Verified |
"dataHold": "Undelivered,OnHold,ConductReview,Manual,Redirected,Received,Complete,Verified" |
When you want to receive application data in response to every update BEFORE an applicant submits |
|
InProgress, Received |
"dataHold": "InProgress,Received" |
When you want to receive application data in response to every update AFTER an applicant's application becomes "Complete" |
|
Undelivered, OnHold, ConductReview, Manual, Redirected, Complete, Verified |
"dataHold": "Undelivered,OnHold,ConductReview,Manual,Redirected,Complete,Verified" |
When you want to receive application data in response to every update BEFORE an applicant's application becomes "Complete" |
|
InProgress, Received, Complete |
"dataHold": "InProgress,Received,Complete" |
When you want to receive application data in response to every update AFTER an applicant's application becomes "Verified" |
|
Undelivered, OnHold, ConductReview, Manual, Redirected, Verified |
"dataHold": "Undelivered,OnHold,ConductReview,Manual,Redirected,Verified" |
When you want to receive application data in response to every update BEFORE an applicant's application becomes "Verified" |
|
InProgress, Undelivered, OnHold, ConductReview, Manual, Redirected, Complete, Verified |
"dataHold": "InProgress,Undelivered,OnHold,ConductReview,Manual,Redirected,Complete,Verified" |
When you want to receive application data in response to every update ONLY when an application is in "Received" (AFTER submission and BEFORE completion) |
|
InProgress, Undelivered, OnHold, ConductReview, Manual, Redirected, Verified |
"dataHold": "InProgress,Undelivered,OnHold,ConductReview,Manual,Redirected,Verified" |
When you want to receive application data in response to every update ONLY when an application is in "Received" or "Complete" (AFTER submission and BEFORE Verification) |