Start journey

Start a customer verification journey in GBG GO to create a trackable journey instance for an end user.

POST /journey/start

Start journey

cURL

curl --request POST \
  --url https://eu.platform.go.gbgplc.com/v2/captain/journey/start \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "resourceId": "97c8b0c5272ba450c48899cc78f6e3f3ba89b5d131c42f7ea972588bd8213b3e@y5z6bj7o",
  "context": {
    "config": {
      "delivery": "page"
    },
    "subject": {}
  }
}
'

import requests

url = "https://eu.platform.go.gbgplc.com/v2/captain/journey/start"

payload = {
    "resourceId": "97c8b0c5272ba450c48899cc78f6e3f3ba89b5d131c42f7ea972588bd8213b3e@y5z6bj7o",
    "context": {
        "config": { "delivery": "page" },
        "subject": {}
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    resourceId: '97c8b0c5272ba450c48899cc78f6e3f3ba89b5d131c42f7ea972588bd8213b3e@y5z6bj7o',
    context: {config: {delivery: 'page'}, subject: {}}
  })
};

fetch('https://eu.platform.go.gbgplc.com/v2/captain/journey/start', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://eu.platform.go.gbgplc.com/v2/captain/journey/start",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'resourceId' => '97c8b0c5272ba450c48899cc78f6e3f3ba89b5d131c42f7ea972588bd8213b3e@y5z6bj7o',
    'context' => [
        'config' => [
                'delivery' => 'page'
        ],
        'subject' => [
                
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://eu.platform.go.gbgplc.com/v2/captain/journey/start"

	payload := strings.NewReader("{\n  \"resourceId\": \"97c8b0c5272ba450c48899cc78f6e3f3ba89b5d131c42f7ea972588bd8213b3e@y5z6bj7o\",\n  \"context\": {\n    \"config\": {\n      \"delivery\": \"page\"\n    },\n    \"subject\": {}\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://eu.platform.go.gbgplc.com/v2/captain/journey/start")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"resourceId\": \"97c8b0c5272ba450c48899cc78f6e3f3ba89b5d131c42f7ea972588bd8213b3e@y5z6bj7o\",\n  \"context\": {\n    \"config\": {\n      \"delivery\": \"page\"\n    },\n    \"subject\": {}\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://eu.platform.go.gbgplc.com/v2/captain/journey/start")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"resourceId\": \"97c8b0c5272ba450c48899cc78f6e3f3ba89b5d131c42f7ea972588bd8213b3e@y5z6bj7o\",\n  \"context\": {\n    \"config\": {\n      \"delivery\": \"page\"\n    },\n    \"subject\": {}\n  }\n}"

response = http.request(request)
puts response.read_body

201

{
  "instanceId": "Pq_hhIX6-sHUy9FLSDzPLu",
  "instanceUrl": "/journey/Pq_hhIX6-sHUy9FLSDzPLu",
  "status": "started",
  "message": "Journey Pq_hhIX6-sHUy9FLSDzPLu started successfully"
}

{
  "status": 404,
  "message": "Not Found Error, validate resource Id",
  "error": "not-found-error"
}

{
  "status": 405,
  "message": "Method Not Allowed.",
  "error": "method-not-allowed-error"
}

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:

"97c8b0c5272ba450c48899cc78f6e3f3ba89b5d131c42f7ea972588bd8213b3e@y5z6bj7o"

context · object

Prefilled identity data for the journey.

Example:

{
  "config": { "delivery": "page" },
  "subject": {}
}

Response

201

application/json

Journey started successfully.

instanceId · string

Unique identifier for the active journey instance.

instanceUrl · string

The URL path for the hosted journey page.

status · string

Indicates the result of the start request.

message · string

Human-readable confirmation message.