Realtime Responses

Realtime Responses

If you are rendering a user interface, and the applicant must know in short order what the state of the application is (for example, to support a document verification flow), we provide a header to get near-real-time responses:

Send the header alloy-journey-application-sync value true and the application will pause, up to 20 seconds, while it waits on the evaluation result. We strongly recommend that you do NOT drive business rules off of this response, and instead consistently wait for the completed_application webhook event. Waiting for the webhook will allow you to consistently handle manual reviews and realtime decisions without additional development.

When sending alloy-journey-application-sync, the response will be identical to “Get an Application” below. We will respond as soon as the application reaches one of the statuses completedwaiting_reviewdatarequesterror, or if 20 seconds passes.


Did this page help you?