Alloy Journeys API

openapi: 3.2.0
info:
  title: Alloy Com Journeys API
  version: '1.0'
  description: 'Operations tagged Journeys across 2 of this provider''s published API definitions: alloy-com-identity-api-openapi.yml, alloy-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://sandbox.alloy.co/v1
  description: Sandbox environment
- url: https://alloy.co/v1
  description: Production environment
- url: https://api.alloy.co/v1
  description: Production environment
tags:
- name: Journeys
  description: A Journey is a decision configuration that allows you to run multiple workflows.
paths:
  /journeys/{journey_token}/applications/{journey_application_token}:
    parameters:
    - in: path
      name: journey_token
      schema:
        type: string
      required: true
      description: Token associated with your Journey
      example: J-VCQoADBJxeHtmdAvFqoS
    - in: path
      name: journey_application_token
      schema:
        type: string
      required: true
      description: Token associated with your Journey Application
      example: JA-mhjlfS6nZe1G6HuvAKVq
    - $ref: '#/paths/~1journeys~1%7Bjourney_token%7D~1applications/parameters/2'
    get:
      parameters:
      - $ref: '#/paths/~1journeys~1%7Bjourney_token%7D~1applications/parameters/2'
      - $ref: '#/paths/~1journeys~1%7Bjourney_token%7D~1applications/parameters/3'
      tags:
      - Journeys
      summary: Get Journey Application
      description: 'Returns relevant data associated with a journey application.

        '
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  journey_application_token:
                    type: string
                  status:
                    type: string
                    enum:
                    - 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
                  sandbox:
                    type: boolean
                  created_at:
                    type: integer
                  updated_at:
                    type: integer
                  closed_at:
                    type: integer
                  complete_outcome:
                    type: string
                  recent_outcome:
                    type: string
                    description: Deprecated field
                  is_shadow_app:
                    description: 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.
                    type: boolean
                  is_part_of_shadow_test:
                    description: 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.
                    type: boolean
                  journey_application_status:
                    description: 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.
                    type: string
                  is_archived:
                    type: boolean
                  external_group_id:
                    type: string
                  external_application_id:
                    description: allows to associate one or multiple Journey Applications with an external identifier
                    type: string
                  is_rerun:
                    type: boolean
                  archived_at:
                    type: string
                  terminal_reconciliation_output:
                    allOf:
                    - type: object
                      properties:
                        outcome_reasons:
                          type: array
                          items:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                                enum:
                                - adverse_action
                                - null
                        tags:
                          type: array
                          items:
                            type: string
                        output_attributes:
                          type: object
                          additionalProperties:
                            oneOf:
                            - type: string
                            - type: number
                            description: NOTE the dynamic property name refers to the name of the output attribute
                        matrix_models:
                          type: object
                          additionalProperties:
                            type: object
                            description: NOTE the dynamic property name refers to the name of the matrix model
                            properties:
                              matrix_model_public_version:
                                type: integer
                              matrix_model_token:
                                type: string
                              name:
                                type: string
                              result:
                                type:
                                - number
                                - 'null'
                              status:
                                type: string
                                enum:
                                - executed
                                - not_executed
                              x_bucket:
                                type:
                                - number
                                - 'null'
                                description: x-coordinate of the matrix
                              x_value:
                                type:
                                - number
                                - 'null'
                              y_bucket:
                                type:
                                - number
                                - 'null'
                                description: y-coordinate of the matrix
                              y_value:
                                type:
                                - number
                                - 'null'
                    type: object
                    description: Data aggregated from the output of the terminal reconciliation evaluation
                  application_meta:
                    type: object
                    description: Optional, allows to provide additional metadata applied to all entities in the Application.
                  _embedded:
                    type: object
                    properties:
                      rerun:
                        description: The journey application that this is a rerun of
                        type: object
                        properties:
                          initiated_by:
                            type: string
                            enum:
                            - api
                            - dashboard
                          previous_journey_application_token:
                            type: string
                          root_external_group_id:
                            type: string
                          root_journey_application_token:
                            type: string
                      reruns:
                        description: The journey applications that are rerun versions of this application
                        type: array
                        items:
                          type: object
                          properties:
                            initiated_by:
                              type: string
                              enum:
                              - dashboard
                              - api
                            next_journey_application_token:
                              type: string
                            created_at:
                              type: integer
                      events:
                        description: List of journey application events, ordered chronologically. The fields displayed in the event will depend on the event type
                        type: array
                        items:
                          type: object
                          properties:
                            journey_application_event_token:
                              type: string
                            journey_application_token:
                              type: string
                            journey_type:
                              type: string
                              enum:
                              - alert
                              - application
                            type:
                              type: string
                              enum:
                              - application_archived
                              - application_expired
                              - application_unarchived
                              - completed_action
                              - completed_application
                              - completed_branch
                              - completed_evaluation
                              - completed_mid_journey_reconciliation
                              - completed_reconciliation
                              - completed_review
                              - completed_review_journey_application
                              - data_request_evaluation
                              - error
                              - executed_branch_change
                              - has_finished_sending_additional_entities
                              - journey_application_retriggered
                              - maximum_retries_reached
                              - pending_action
                              - pending_action_expired
                              - pending_documents
                              - pending_evaluation
                              - pending_review
                              - pending_step_up
                              - pending_step_up_expired
                              - pending_workflow_service
                              - queued_branch_change
                              - reached_application_outcome
                              - reached_auto_decision_node
                              - reached_mid_journey_reconciliation_node
                              - reached_retry_node
                              - started_application
                              - started_evaluation
                              - started_mid_journey_reconciliation
                              - started_reconciliation
                              - started_rerun_application
                              - started_review
                              - visited_node
                            external_partner_id:
                              type: string
                            external_product_id:
                              type: string
                            external_group_id:
                              type: string
                            reason:
                              type: string
                            reasons:
                              type: array
                              items:
                                type: string
                            timestamp:
                              type: integer
                            outcome:
                              type: string
                              description: 'Populated for the following event types: `completed_action`, `completed_application`, `completed_branch`, `completed_evaluation`, `completed_review`, `pending_action_expired`'
                            evaluation_token:
                              type: string
                              description: Identifying evaluation token (only in evaluation type events)
                            entity_token:
                              type: string
                            entity_application_token:
                              type: string
                            error_data:
                              type: object
                              description: Additional error data populated when available for `error` event types
                              properties:
                                error:
                                  type: object
                                  properties:
                                    type:
                                      type: string
                                    details:
                                      type: object
                                    message:
                                      type: string
                                    minor_code:
                                      type: integer
                                    error_token:
                                      type: string
                                timestamp:
                                  type: integer
                                status_code:
                                  type: integer
                                entity_token:
                                  type: string
                                evaluation_token:
                                  type: string
                                application_token:
                                  type: string
                                application_version_id:
                                  type: integer
                            _embedded:
                              type: object
                              properties:
                                node:
                                  type: object
                                  properties:
                                    name:
                                      type: string
                                    id:
                                      type: string
                                    type:
                                      type: string
                                      enum:
                                      - start
                                      - workflow
                                      - review
                                      - outcome
                                      - action
                                      - docv
                                    config:
                                      description: Config related to the specific node, depending on the type
                                      type: object
                                    workflow_name:
                                      type: string
                                    sdk_config:
                                      type: object
                                      description: Settings to be read by SDK to handle processing. Only present on workflow node events.
                                      properties:
                                        documents:
                                          type: array
                                          items:
                                            type: string
                                        selfie:
                                          type: boolean
                            _links:
                              type: object
                              properties:
                                evaluation:
                                  type: object
                                  properties:
                                    href:
                                      type: string
                                case:
                                  type: object
                                  properties:
                                    href:
                                      type: string
                      journey:
                        type: object
                        properties:
                          journey_name:
                            type: string
                          journey_type:
                            type: string
                            enum:
                            - application
                            - alert
                          journey_token:
                            type: string
                          journey_version_num:
                            type: string
                          _links:
                            type: object
                            properties:
                              self:
                                type: object
                                properties:
                                  href:
                                    type: string
                                    description: GET route for the Journey
                              callback_by_entity_application_token:
                                type: object
                                description: When applicable, the route to send a PUT request to for each entity application to resolve its current pending state
                      child_entities:
                        type: array
                        items:
                          type: object
                          properties:
                            external_entity_identifier:
                              type: string
                            name:
                              type: string
                            token:
                              type: string
                            type:
                              type: string
                            entity_application_token:
                              type: string
                            entity_application_status:
                              type: string
                            entity_application_outcome:
                              type: string
                            entity_application_branch_name:
                              type: string
                            created:
                              type: string
                            sandbox_persona_name:
                              type: string
                              description: When applicable, name of sandbox persona used for this child entity
                      entity_applications:
                        type: array
                        items:
                          type: object
                          properties:
                            entity_token:
                              type: string
                            entity_application_token:
                              type: string
                            entity_application_outcome:
                              type: string
                            entity_application_status:
                              type: string
                            sdk_link:
                              type: string
                            dimensions:
                              type: array
                              description: The dimension(s) that triggered this entity application. This is only applicable when the application was created by a portfolio evaluation.
                              items:
                                type: object
                                properties:
                                  dimension:
                                    type: string
                                  dimension_type:
                                    type: string
                            entity_application_status_details:
                              type: object
                              description: "Additional details for applications that have status `data_request` or `pending_workflow_service`. \n* If the status is `data_request`, the `required`, `or`, and `optional` fields will be populated based on the journey configuration.\n* If the status is `pending_workflow_service`, the fields will be dependent on the services configured for the journey. Please speak to your representative for more information.\n"
                              properties:
                                required:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      key:
                                        type: string
                                      type:
                                        type: string
                                      regex:
                                        type: string
                                      message:
                                        type: string
                                      description:
                                        type: string
                                or:
                                  type: string
                                optional:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      key:
                                        type: string
                                      type:
                                        type: string
                                      regex:
                                        type: string
                                      description:
                                        type: string
                            output:
                              allOf:
                              - $ref: '#/paths/~1journeys~1%7Bjourney_token%7D~1applications~1%7Bjourney_application_token%7D/get/responses/200/content/application~1json/schema/properties/terminal_reconciliation_output/allOf/0'
                              type: object
                              description: Data aggregated from the outputs of every evaluation run for the entity application
                      entity:
                        description: The journey application entity
                        type: object
                        properties:
                          external_entity_identifier:
                            type: string
                          name:
                            type: string
                          token:
                            type: string
                          type:
                            type: string
                      entity_group:
                        description: The entity group associated with the application
                        type: object
                        properties:
                          name:
                            type: string
                          token:
                            type: string
                          type:
                            type: string
                            enum:
                            - business
                            - joint_account
                            - membership
                            - merchant
                      multi_environment_config:
                        allOf:
                        - type: object
                          properties:
                            multi_environment_config_token:
                              type: string
                            multi_environment_config_notes:
                              type: string
                            created_at:
                              type: string
                            journey_token:
                              type: string
                            journey_name:
                              type: string
                            journey_public_version:
                              type: number
                            actions:
                              description: List of journey actions that have been configured as part of this Multi-Environment Configuration.
                              type: array
                              items:
                                type: object
                                properties:
                                  journey_action_id:
                                    type: number
                                  action_version:
                                    type: number
                                  action_name:
                                    type: string
                                  outcome:
                                    description: The outcome that all action nodes for this journey action will be decisioned to.
                                    type: string
                            workflows:
                              description: 'List of workflows that have been configured as part of this Multi-Environment Configuration.

                                Workflows will either have an outcome or a list of configured services.

                                '
                              type: array
                              items:
                                type: object
                                properties:
                                  workflow_name:
                                    type: string
                                  workflow_node_type:
                                    description: The type of node this workflow is used as, for example Step Up
                                    type: string
                                  workflow_token:
                                    type: string
                                  workflow_public_version:
                                    type: number
                                  outcome:
                                    description: The outcome that all workflow nodes using this workflow will be decisioned to.
                                    type: string
                                  configured_services:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        service_name:
                                          type: string
                                        has_credentials:
                                          description: True if this service has been configured with test credentials, false otherwise.
                                          type: boolean
                                        sandbox:
                                          description: True if this service has been configured to run in Alloy's sandbox environment, false otherwise.
                                          type: boolean
                                        credentials_description:
                                          type: string
                        description: If the application has been created with a Multi-Environment Configuration, the details will be included here.
                      is_pending_additional_entities:
                        allOf:
                        - $ref: '#/paths/~1journeys~1%7Bjourney_token%7D~1applications/post/requestBody/content/application~1json/schema/properties/do_await_additional_entities'
                      investigations:
                        type: array
                        description: When applicable, the list of Investigations created by this Alert.
                        items:
                          type: object
                          properties:
                            investigation_token:
                              type: string
                            investigation_state:
                              type: string
                              enum:
                              - alert_review
                              - alert_review_closed
                              - case_review
                              - case_review_closed
                              - open
                  _links:
                    type: object
                    properties:
                      self:
                        type: object
                        properties:
                          href:
                            description: GET route for the Application
                            type: string
                example:
                  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
    

# --- truncated at 32 KB (72 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/alloy-com/refs/heads/main/openapi/alloy-com-journeys-api-openapi.yml