API Reference

Update Journey Application

put
https://sandbox.alloy.co/v1/journeys//applications/

This endpoint has 3 different use cases:

  • Send the additional or updated data required to advance the application.
    • Only available if one or more entity applications have the statuses pending_documents, pending_step_up, or data_request.
  • Send new, additional entities to be processed.
    • Only available if the parameter do_await_additional_entities was set to true in the POST request to create the journey application.
  • Inform the system that the user has finished sending all additional entities by passing the parameter has_finished_sending_additional_entities with value true.
    • Only available if the parameter do_await_additional_entities was set to true in the POST request to create the journey application.

Any of the headers used with the original application (ex: alloy-sandbox) will also be used here.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Token associated with your Journey

string
required

Token associated with your Journey Application

Query Params
string
enum

If this value is true, each event of type completed_evaluation in the array at response._embedded._events includes the full evaluation response.

Allowed:
Body Params
boolean

If the parameter do_await_additional_entities was set to true in the POST request to create the journey application, sending this value as true informs the system that all additional entities have been sent in.

entities
array

List of entities that can refer either of the following, or a mix of both:

  • Option 1: Adding new entities
    • This option is valid in the case where the parameter do_await_additional_entities was set to true in the POST request to create the journey application.
    • The parameters for this option are exactly the same as the entity object in the POST request to create the journey application.
  • Option 2: Updating data for an existing person entity
    • This option is valid in the case where the entity's application status is data_request.
    • For multi-entity applications, the entity application must be identified by using at least one of the following parameters: external_entity_id, entity_application_token, or entity_token. See those parameters' descriptions for more detail.
    • For single entity applications, no entity identifier is necessary.
    • The data in the field data is recursively merged with the existing data object for the entity (i.e., the data passed in the POST request and the previous requests to this endpoint, if any).
  • Option 3: Associating documents for an existing person entity
    • This option is valid in the case where the entity's application status is pending_step_up or pending_documents (legacy).
entities
Headers
boolean

This endpoint returns a synchronous response by default. If you would like to override this behavior and get an asynchronous response back immediately, send the header alloy-journey-override-sync as true.

Responses

Updated 6 months ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 months ago