Submit task data

Submit customer identity data, documents, and verification inputs to a GBG GO journey task. Deprecated.

POST /journey/task/update

Submit task data

cURL

curl --request POST \
  --url https://eu.platform.go.gbgplc.com/v2/captain/journey/task/update \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "intent": "Complete",
  "instanceId": "PiIbYsgiHp4R8JPz2vU5Y9l4",
  "taskId": "Tkob6dMMHp4R8JPz2vU5Y9l4",
  "context": {
    "subject": {
      "identity": {
        "currentAddress": {
          "country": "GBR",
          "postalCode": "BA133BN",
          "locality": "Westbury",
          "thoroughfare": "High Street",
          "building": "4",
          "administrativeArea": "Wilts"
        },
        "dateOfBirth": "1967-01-01",
        "firstName": "pari",
        "middleNames": [
          "c"
        ],
        "lastNames": [
          "powell"
        ]
      }
    }
  }
}
'

import requests

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

payload = {
    "intent": "Complete",
    "instanceId": "PiIbYsgiHp4R8JPz2vU5Y9l4",
    "taskId": "Tkob6dMMHp4R8JPz2vU5Y9l4",
    "context": { "subject": { "identity": {
                "currentAddress": {
                    "country": "GBR",
                    "postalCode": "BA133BN",
                    "locality": "Westbury",
                    "thoroughfare": "High Street",
                    "building": "4",
                    "administrativeArea": "Wilts"
                },
                "dateOfBirth": "1967-01-01",
                "firstName": "pari",
                "middleNames": ["c"],
                "lastNames": ["powell"]
            } } }
}
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({
    intent: 'Complete',
    instanceId: 'PiIbYsgiHp4R8JPz2vU5Y9l4',
    taskId: 'Tkob6dMMHp4R8JPz2vU5Y9l4',
    context: {
      subject: {
        identity: {
          currentAddress: {
            country: 'GBR',
            postalCode: 'BA133BN',
            locality: 'Westbury',
            thoroughfare: 'High Street',
            building: '4',
            administrativeArea: 'Wilts'
          },
          dateOfBirth: '1967-01-01',
          firstName: 'pari',
          middleNames: ['c'],
          lastNames: ['powell']
        }
      }
    }
  })
};

fetch('https://eu.platform.go.gbgplc.com/v2/captain/journey/task/update', 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/task/update",
  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([
    'intent' => 'Complete',
    'instanceId' => 'PiIbYsgiHp4R8JPz2vU5Y9l4',
    'taskId' => 'Tkob6dMMHp4R8JPz2vU5Y9l4',
    'context' => [
        'subject' => [
                'identity' => [
                                'currentAddress' => [
                                                                'country' => 'GBR',
                                                                'postalCode' => 'BA133BN',
                                                                'locality' => 'Westbury',
                                                                'thoroughfare' => 'High Street',
                                                                'building' => '4',
                                                                'administrativeArea' => 'Wilts'
                                ],
                                'dateOfBirth' => '1967-01-01',
                                'firstName' => 'pari',
                                'middleNames' => [
                                                                'c'
                                ],
                                'lastNames' => [
                                                                'powell'
                                ]
                ]
        ]
    ]
  ]),
  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/task/update"

	payload := strings.NewReader("{\n  \"intent\": \"Complete\",\n  \"instanceId\": \"PiIbYsgiHp4R8JPz2vU5Y9l4\",\n  \"taskId\": \"Tkob6dMMHp4R8JPz2vU5Y9l4\",\n  \"context\": {\n    \"subject\": {\n      \"identity\": {\n        \"currentAddress\": {\n          \"country\": \"GBR\",\n          \"postalCode\": \"BA133BN\",\n          \"locality\": \"Westbury\",\n          \"thoroughfare\": \"High Street\",\n          \"building\": \"4\",\n          \"administrativeArea\": \"Wilts\"\n        },\n        \"dateOfBirth\": \"1967-01-01\",\n        \"firstName\": \"pari\",\n        \"middleNames\": [\n          \"c\"\n        ],\n        \"lastNames\": [\n          \"powell\"\n        ]\n      }\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/v2/captain/journey/task/update")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"intent\": \"Complete\",\n  \"instanceId\": \"PiIbYsgiHp4R8JPz2vU5Y9l4\",\n  \"taskId\": \"Tkob6dMMHp4R8JPz2vU5Y9l4\",\n  \"context\": {\n    \"subject\": {\n      \"identity\": {\n        \"currentAddress\": {\n          \"country\": \"GBR\",\n          \"postalCode\": \"BA133BN\",\n          \"locality\": \"Westbury\",\n          \"thoroughfare\": \"High Street\",\n          \"building\": \"4\",\n          \"administrativeArea\": \"Wilts\"\n        },\n        \"dateOfBirth\": \"1967-01-01\",\n        \"firstName\": \"pari\",\n        \"middleNames\": [\n          \"c\"\n        ],\n        \"lastNames\": [\n          \"powell\"\n        ]\n      }\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"intent\": \"Complete\",\n  \"instanceId\": \"PiIbYsgiHp4R8JPz2vU5Y9l4\",\n  \"taskId\": \"Tkob6dMMHp4R8JPz2vU5Y9l4\",\n  \"context\": {\n    \"subject\": {\n      \"identity\": {\n        \"currentAddress\": {\n          \"country\": \"GBR\",\n          \"postalCode\": \"BA133BN\",\n          \"locality\": \"Westbury\",\n          \"thoroughfare\": \"High Street\",\n          \"building\": \"4\",\n          \"administrativeArea\": \"Wilts\"\n        },\n        \"dateOfBirth\": \"1967-01-01\",\n        \"firstName\": \"pari\",\n        \"middleNames\": [\n          \"c\"\n        ],\n        \"lastNames\": [\n          \"powell\"\n        ]\n      }\n    }\n  }\n}"

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

201

{
  "instanceId": "<string>",
  "taskId": "<string>"
}

Authorizations

Authorization · string · header · required

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

Body

application/json

intent · string · required

The intent of the request.

Example:

"Complete"

instanceId · string · required

Unique identifier for the active journey instance.

Example:

"PiIbYsgiHp4R8JPz2vU5Y9l4"

taskId · string · required

Unique identifier for the task being updated.

Example:

"Tkob6dMMHp4R8JPz2vU5Y9l4"

context · object

The data required to complete the task.

Show child attributes

Response

201 - application/json

Task data submitted successfully.

instanceId · string

Unique identifier for the active journey instance.

taskId · string

Unique identifier for the task.