Skip to main content
POST
/
journey
/
device
/
connect
Connect end user device
curl --request POST \
  --url https://eu.platform.go.gbgplc.com/captain/api/journey/device/connect \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "deviceInfo": {
    "deviceId": "exampleDeviceId123",
    "deviceName": "deviceName",
    "deviceType": "deviceType"
  },
  "connectToken": "FtKXWJ7dQ6HTEDa9ScPWzNKY0kHoG_wA"
}
'
{
  "endUserToken": "J9HIsgB5pJ3F2RkV4C.EyInZlJX9hbVTRn0pUliYFiE0cH8TQyJ1aNwSWdGxXjRkIEmA2S1dOehf3bL5i9WcF8pNEBqAHl.7aZgCInxkV2I4uI3sEoT0RShH1T9JpB",
  "tokenType": "end-user",
  "expiresIn": 3600
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
deviceInfo
object
required

Information about the connecting device.

​
connectToken
string
required

The connect token obtained from the /journey/device/start endpoint.

Response

Device connected successfully. Returns an end-user token.

​
endUserToken
string
required

A JWT token that the end-user device uses for subsequent API calls.

​
tokenType
enum<string>
required

The type of token returned.

Available options:
end-user
​
expiresIn
number
required

Number of seconds until the end-user token expires.