v1

latestOpenAPI 3.0.02026-07-241220330.3 KB

Journeys

Create Journey Application

Create a journey application for one or more entities.

post/journeys/{journey_token}/applications

Request body

external_group_idstring

Optional, but if you have an identifier in your system that is unique and that you would like to tie to an Application in a 1:1 relationship, you can include it here. This field will not update the Entity Group object.

external_application_idstring

Optional, but if you have an identifier in your system that refers to an application or an entire account, and you would like to associate it with one or more Journey Applications, you can include it here. We also have a number of endpoints that allow you to reference a Journey Application by external application id instead of by Journey Application token when retrieving, rerunning or updating the Application. Supported characters are: a-zA-Z0-9_-

do_await_additional_entitiesboolean

If this value is true, additional entities can be sent by using the PUT endpoint that updates a Journey Application.

The Journey Application will not complete until the parameter has_finished_sending_additional_entities is sent with the value true to the PUT endpoint.

application_metaobject

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

external_entity_group_idstring

Optional, but if you wish to associate the entities within this application with an existing entity group or create a new entity group with this identifier, you can include it here.

For more information on entity groups, visit our guide: https://developer.alloy.com/public/docs/onboarding-with-entity-groups

entity_group_tokenstring

Optional, but if you wish to associate the entities within this application with an existing entity group, you can include it here.

entity_group_namestring

Optional, but if you wish to create a new entity group with this name, you can include it here.

entity_group_type'business' | 'joint_account' | 'membership' | 'merchant'

Optional, but if you wish to create a new entity group with this type, you can include it here.

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",
        "document_ssn": 111223333,
        "email_address": "john@alloy.com",
        "phone_number": 8443825569,
        "ip_address_v4": "42.206.213.70",
        "addresses": [
          {
            "type": "primary",
            "line_1": "41 E. 11th",
            "line_2": "2nd floor",
            "city": "New York",
            "state": "NY",
            "postal_code": 10003,
            "country_code": "US"
          }
        ],
        "meta": {
          "user_type": "vip"
        }
      },
      "entity_type": "person",
      "branch_name": "persons"
    },
    {
      "external_entity_id": "my_system_entity_id_345",
      "data": {
        "business_name": "Acme Corporation",
        "business_federal_ein": 122334455,
        "business_phone_number": 111222333,
        "business_url": "https://www.acmeco.com/",
        "addresses": [
          {
            "type": "business_primary",
            "line_1": "41 E. 11th",
            "line_2": "2nd floor",
            "city": "New York",
            "state": "NY",
            "postal_code": 10003,
            "country_code": "US"
          }
        ],
        "representatives": [
          {
            "name_first": "John",
            "name_middle": "Franklin",
            "name_last": "Doe",
            "type": "principal_owner",
            "birth_date": "1990-01-25",
            "document_ssn": 111223333,
            "email_address": "john@alloy.com",
            "phone_number": 8443825569,
            "ownership_percentage": 40,
            "addresses": [
              {
                "type": "primary",
                "line_1": "41 E. 11th",
                "line_2": "2nd floor",
                "city": "New York",
                "state": "NY",
                "postal_code": 10003,
                "country_code": "US"
              }
            ]
          }
        ],
        "meta": {
          "sic_code": 1531
        }
      },
      "entity_type": "business",
      "branch_name": "businesses"
    }
  ],
  "external_group_id": "my_system_group_id_456"
}