Journeys

Update Journey Application

Changed on

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.

put/journeys/{journey_token}/applications/{journey_application_token}

Request

  • Base URL
    https://sandbox.alloy.co/v1
  • Auth
    • OAuth 2
      Client credentials
      Token URL/oauth/bearer
    • or HTTP basic

Headers

alloy-journey-override-syncboolean

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.

Request body

has_finished_sending_additional_entitiesboolean

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.

Example request

{
  "entities": [
    {
      "external_entity_id": "my_system_entity_id_123",
      "data": {
        "name_first": "John",
        "name_middle": "Franklin",
        "name_last": "Doe",
        "birth_date": "1990-01-25",
        "email_address": "john@alloy.com",
        "gender": "male",
        "ip_address_v4": "42.206.213.70",
        "addresses": [
          {
            "type": "primary",
            "line_1": "41 E. 11th",
            "line_2": "2nd floor",
            "city": "New York",
            "state": "NY",
            "country_code": "US"
          }
        ],
        "meta": {
          "user_type": "vip"
        }
      },
      "entity_type": "person",
      "branch_name": "my_person_branch_name",
      "entity_token": "P-1GoQALm40nPQSp7UVTJS"
    }
  ]
}

Response

Success

OR

Example response

{
  "journey_application_token": "JA-ddjP31DhduTI334Cs3uT",
  "credit_limit": "42",
  "annual_interest_rate": "70",
  "status": "completed",
  "sandbox": false,
  "created_at": 1634059958368,
  "updated_at": 1634059961458,
  "closed_at": 1634059961464,
  "recent_outcome": null,
  "complete_outcome": "Approved",
  "journey_application_status": "Approved",
  "is_rerun": true,
  "external_partner_id": "null,",
  "external_group_id": "null,",
  "external_application_id": "null,",
  "is_archived": "false,",
  "is_escalated": "false,",
  "is_shadow_application": "false,",
  "is_part_of_shadow_test": "false,",
  "archived_at": "null,",
  "application_meta": "null,",
  "terminal_reconciliation_output": {
    "outcome_reasons": [
      {
        "name": "Fraud Risk",
        "type": null
      }
    ],
    "tags": [
      "fraud_tag",
      "Fraud Risk"
    ],
    "output_attributes": {
      "income_calculation": 98000
    },
    "matrix_models": {
      "my_matrix": {
        "matrix_model_public_version": 5,
        "matrix_model_token": "MM-Z37VkZwHMbnzhLJM7ZlX",
        "name": "my_matrix",
        "result": 15,
        "status": "executed",
        "x_bucket": 1,
        "x_value": 1000,
        "y_bucket": 0,
        "y_value": 300
      }
    }
  },
  "_embedded": {
    "rerun": {
      "initiated_by": "dashboard",
      "previous_journey_application_token": "JA-zvtpApEGBnmKepPwygBx",
      "root_external_group_id": null,
      "root_journey_application_token": "JA-zvtpApEGBnmKepPwygBx"
    },
    "reruns": [],
    "events": [
      {
        "type": "started_application",
        "timestamp": 1634059958414,
        "entity_token": null,
        "_embedded": {
          "node": {
            "name": null,
            "id": "1632850505316",
            "type": "workflow",
            "config": {
              "workflow_token": "vUr2Fs1y8Qiz1a79kNJk1dk7EfYUAJRK",
              "workflow_version_id": 1
            }
          }
        },
        "_links": {}
      },
      {
        "type": "started_evaluation",
        "timestamp": 1634059958531,
        "evaluation_token": "L-Vn9uOp0ZyYvjDL1t3Sd7",
        "entity_token": null,
        "_embedded": {
          "node": {
            "name": null,
            "id": "1632850505316",
            "type": "workflow",
            "config": {
              "workflow_token": "vUr2Fs1y8Qiz1a79kNJk1dk7EfYUAJRK",
              "workflow_version_id": 1
            }
          }
        },
        "_links": {
          "evaluation": {
            "href": "/v1/evaluations/L-Vn9uOp0ZyYvjDL1t3Sd7"
          }
        },
        "sdk_config": {
          "documents": [
            "passport"
          ],
          "selfie": true
        }
      },
      {
        "type": "completed_evaluation",
        "timestamp": 1634059960557,
        "outcome": "Approved",
        "evaluation_token": "L-Vn9uOp0ZyYvjDL1t3Sd7",
        "entity_token": "P-tZOLIOQGVxfixICuvkS0",
        "_embedded": {
          "node": {
            "name": null,
            "id": "1632850505316",
            "type": "workflow",
            "config": {
              "workflow_token": "vUr2Fs1y8Qiz1a79kNJk1dk7EfYUAJRK",
              "workflow_version_id": 1
            }
          }
        },
        "_links": {
          "evaluation": {
            "href": "/v1/evaluations/L-Vn9uOp0ZyYvjDL1t3Sd7"
          }
        }
      },
      {
        "type": "completed_application",
        "timestamp": 1634059961453,
        "outcome": "Approved",
        "entity_token": "P-tZOLIOQGVxfixICuvkS0",
        "_embedded": {
          "node": {
            "name": null,
            "id": "1633639581306",
            "type": "outcome",
            "config": {
              "outcome": "Approved"
            }
          }
        },
        "_links": {}
      }
    ],
    "journey": {
      "journey_name": "",
      "journey_type": "application",
      "journey_token": "J-qDydegaMK8otdsRYquOR",
      "_links": {
        "self": {
          "href": "/v1/journeys/J-qDydegaMK8otdsRYquOR"
        },
        "callback_by_entity_application_token": {
          "href": "/v1/journeys/J-rTE9lsgkluEMB6pWp6Y5/applications/JA-iLh1wxtrpfGuncHQVcwK/nodes/97b927fe-637b-42be-aa70-1e998ad57bb3"
        }
      }
    },
    "child_entities": [
      {
        "external_entity_identifier": "external_entity_id123",
        "name": "John Doe",
        "token": "P-tZOLIOQGVxfixICuvkS0",
        "type": "person",
        "entity_application_token": "EA-GessHRonFRTSXCmErk7J",
        "entity_application_status": "completed",
        "entity_application_outcome": "approved",
        "created": "2021-10-12T20:38:26.493Z",
        "external_entity_ids": [
          {
            "external_entity_id": "test-eeid-primary-001",
            "external_entity_id_type": "cif"
          }
        ]
      }
    ],
    "entity_applications": [
      {
        "entity_token": "P-tZOLIOQGVxfixICuvkS0",
        "entity_application_token": "EA-GessHRonFRTSXCmErk7J",
        "entity_application_outcome": "approved",
        "entity_application_status": "completed",
        "entity_application_status_details": null,
        "sdk_link": null,
        "external_entity_identifiers": [
          {
            "external_entity_identifier": "test-eeid-primary-001",
            "external_entity_identifier_type": "cif"
          }
        ],
        "dimensions": null,
        "output": {
          "outcome_reasons": [
            {
              "name": "Fraud Risk",
              "type": null
            }
          ],
          "tags": [
            "fraud_tag",
            "Fraud Risk"
          ],
          "output_attributes": {
            "income_calculation": 98000
          },
          "matrix_models": {
            "my_matrix": {
              "matrix_model_public_version": 5,
              "matrix_model_token": "MM-Z37VkZwHMbnzhLJM7ZlX",
              "name": "my_matrix",
              "result": 15,
              "status": "executed",
              "x_bucket": 1,
              "x_value": 1000,
              "y_bucket": 0,
              "y_value": 300
            }
          }
        }
      }
    ],
    "is_pending_additional_entities": false,
    "entity": {
      "external_entity_identifier": null,
      "name": null,
      "token": "G-wBdsvC7hA84j7p4PTVcD",
      "type": "group"
    },
    "entity_group": {
      "name": "Jane's Biscuit Co.",
      "token": "EG-CNh8eYbhfN8vJVE1Ljpk",
      "type": "business"
    }
  },
  "_links": {
    "self": {
      "href": "/v1/journeys/J-qDydegaMK8otdsRYquOR/applications/JA-ddjP31DhduTI334Cs3uT"
    }
  }
}

Changes

    • info

      added the new optional query request parameter fullData to all path's operations

    • info

      added the new optional header request parameter alloy-journey-override-sync

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status