Journey Application Use Cases

Supplying the External Entity ID

When creating a new Journey Application, you can provide your External Entity ID in the external_entity_id field inside the entities[] array:

{
  "entities": [
    {
      "external_entity_id": "yourExternalEntityId",
       "entity_type": "person",
       "branch_name": "persons",
      "data": {
        "name_first": "John",
        "name_last": "Doe",
        ...
      }
    }
  ]
}

Retrieving the Entity Token

From the Journey Application response, you can parse the Entity Token from the embedded entity_applications[] section in the entity_token field:

{
   "_embedded": {
     "entity_applications": [
       {
         "entity_token": "P-FsGCs0P9aytzrMe7vLVh",
         "entity_application_token": "EA-TXfIxuBvBdkA1Gkd357o",
         "entity_application_outcome": "approved",
         "entity_application_status": "completed",
         "entity_application_status_details": null,
         "external_entity_identifier": "yourExternalEntityId",
       }
     ],
}