Skip to main content
POST
/
journey
/
start
Start journey
curl --request POST \
  --url https://eu.platform.go.gbgplc.com/captain/api/journey/start \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "resourceId": "2ec919f77eb9858f16a9c102913f68c2ede2e31952d3e2b8f5ca7028d5c480bc@latest",
  "context": {
    "subject": {
      "identity": {
        "firstName": "John",
        "lastName": "Doe",
        "dateOfBirth": "1990-01-01",
        "emails": [
          {
            "type": "home",
            "email": "john.doe@example.com"
          }
        ]
      }
    },
    "documents": [],
    "biometrics": []
  }
}'
{
  "instanceId": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
resourceId
string
required

Unique identifier for the journey. Append '@latest' to use the most recent version.

Example:

"2ec919f77eb9858f16a9c102913f68c2ede2e31952d3e2b8f5ca7028d5c480bc@latest"

​
context
object

Prefilled identity data for the journey.

Example:
{
  "subject": {
    "identity": {
      "firstName": "John",
      "lastName": "Doe",
      "dateOfBirth": "1990-01-01",
      "emails": [
        {
          "type": "home",
          "email": "john.doe@example.com"
        }
      ]
    }
  },
  "documents": [],
  "biometrics": []
}

Response

Journey started successfully.

​
instanceId
string

Unique identifier for the active journey instance.

⌘I