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": []
    }
  }
}
'
import requests

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

payload = {
    "resourceId": "2ec919f77eb9858f16a9c102913f68c2ede2e31952d3e2b8f5ca7028d5c480bc@latest",
    "context": { "subject": {
            "identity": {
                "firstName": "John",
                "lastName": "Doe",
                "dateOfBirth": "1990-01-01",
                "emails": [
                    {
                        "type": "home",
                        "email": "john.doe@example.com"
                    }
                ]
            },
            "documents": [],
            "biometrics": []
        } }
}
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: '2ec919f77eb9858f16a9c102913f68c2ede2e31952d3e2b8f5ca7028d5c480bc@latest',
    context: {
      subject: {
        identity: {
          firstName: 'John',
          lastName: 'Doe',
          dateOfBirth: '1990-01-01',
          emails: [{type: 'home', email: 'john.doe@example.com'}]
        },
        documents: [],
        biometrics: []
      }
    }
  })
};

fetch('https://eu.platform.go.gbgplc.com/captain/api/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/captain/api/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' => '2ec919f77eb9858f16a9c102913f68c2ede2e31952d3e2b8f5ca7028d5c480bc@latest',
    'context' => [
        'subject' => [
                'identity' => [
                                'firstName' => 'John',
                                'lastName' => 'Doe',
                                'dateOfBirth' => '1990-01-01',
                                'emails' => [
                                                                [
                                                                                                                                'type' => 'home',
                                                                                                                                'email' => 'john.doe@example.com'
                                                                ]
                                ]
                ],
                'documents' => [
                                
                ],
                'biometrics' => [
                                
                ]
        ]
    ]
  ]),
  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/captain/api/journey/start"

	payload := strings.NewReader("{\n  \"resourceId\": \"2ec919f77eb9858f16a9c102913f68c2ede2e31952d3e2b8f5ca7028d5c480bc@latest\",\n  \"context\": {\n    \"subject\": {\n      \"identity\": {\n        \"firstName\": \"John\",\n        \"lastName\": \"Doe\",\n        \"dateOfBirth\": \"1990-01-01\",\n        \"emails\": [\n          {\n            \"type\": \"home\",\n            \"email\": \"john.doe@example.com\"\n          }\n        ]\n      },\n      \"documents\": [],\n      \"biometrics\": []\n    }\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/captain/api/journey/start")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"resourceId\": \"2ec919f77eb9858f16a9c102913f68c2ede2e31952d3e2b8f5ca7028d5c480bc@latest\",\n  \"context\": {\n    \"subject\": {\n      \"identity\": {\n        \"firstName\": \"John\",\n        \"lastName\": \"Doe\",\n        \"dateOfBirth\": \"1990-01-01\",\n        \"emails\": [\n          {\n            \"type\": \"home\",\n            \"email\": \"john.doe@example.com\"\n          }\n        ]\n      },\n      \"documents\": [],\n      \"biometrics\": []\n    }\n  }\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://eu.platform.go.gbgplc.com/captain/api/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\": \"2ec919f77eb9858f16a9c102913f68c2ede2e31952d3e2b8f5ca7028d5c480bc@latest\",\n  \"context\": {\n    \"subject\": {\n      \"identity\": {\n        \"firstName\": \"John\",\n        \"lastName\": \"Doe\",\n        \"dateOfBirth\": \"1990-01-01\",\n        \"emails\": [\n          {\n            \"type\": \"home\",\n            \"email\": \"john.doe@example.com\"\n          }\n        ]\n      },\n      \"documents\": [],\n      \"biometrics\": []\n    }\n  }\n}"

response = http.request(request)
puts response.read_body
{
  "instanceId": "<string>"
}
{
  "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:

"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.