Sign in
latestOpenAPI 3.0.02026-07-241220330.3 KB

405799de4d2a

Journeys

Get Journey Application

Returns relevant data associated with a journey application.

get/journeys/{journey_token}/applications/{journey_application_token}

Parameters

#/paths/~1journeys~1%7Bjourney_token%7D~1applications/parameters/2 — unresolved $ref
#/paths/~1journeys~1%7Bjourney_token%7D~1applications/parameters/3 — unresolved $ref

Response

Success

journey_application_tokenstring
status'completed' | 'data_request' | 'error' | 'expired' | 'pending_action' | 'pending_additional_entities' | 'pending_documents' | 'pending_journey_application_review' | 'pending_reconciliation' | 'pending_step_up' | 'pending_workflow_service' | 'running' | 'waiting_review'
sandboxboolean
created_atinteger
updated_atinteger
closed_atinteger
complete_outcomestring
recent_outcomestring

Deprecated field

is_shadow_appboolean

indicates if the application was generated for a shadow test. This value is false for the parent applications that trigger the generation of the shadow applications.

is_part_of_shadow_testboolean

indicates if the application is a part of a shadow test. This value is true for both the parent applications that trigger the generation of the shadow applications, as well as the shadow applications.

journey_application_statusstring

derived from the status and complete_outcome, this value represents a simplified display status, as seen on the Journey Application Queue and Journey Application pages.

is_archivedboolean
external_group_idstring
external_application_idstring

allows to associate one or multiple Journey Applications with an external identifier

is_rerunboolean
archived_atstring
application_metaobject

Optional, allows to provide additional metadata applied to all entities in the Application.

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"
      }
    ],
    "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,
        "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"
    }
  }
}