Skip to main content
POST
/
journey
/
interaction
/
fetch
Fetch Interaction
curl --request POST \
  --url https://eu.platform.go.gbgplc.com/v2/captain/journey/interaction/fetch \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "instanceId": "PiKR2O0IjyUR8KV3RviKt4we"
}
'
{
  "instanceId": "Pq_hhIX6-sHUy9FLSDzPLu",
  "interactionId": "grn:::gbg:design:interaction:segment1@latest",
  "journey": {
    "status": "InProgress"
  },
  "interaction": {
    "grId": "grn:::gbg:design:interaction:segment1@latest",
    "resource": {
      "id": "segment1",
      "name": "segment1",
      "version": "latest",
      "type": "interaction",
      "data": {
        "pages": [
          {
            "id": "personal_details",
            "label": "Personal details",
            "cards": [
              {
                "id": "NameCard"
              },
              {
                "id": "DateOfBirthCard"
              },
              {
                "id": "IdentifierCardSSN"
              },
              {
                "id": "ControlCard"
              }
            ]
          },
          {
            "id": "contact_details",
            "label": "Contact details",
            "cards": [
              {
                "id": "EmailCardPersonalEmail"
              },
              {
                "id": "PhoneCardMobilePhone"
              },
              {
                "id": "ControlCard"
              }
            ]
          },
          {
            "id": "address_details",
            "label": "Address details",
            "cards": [
              {
                "id": "AddressCard",
                "config": {
                  "secrets": {
                    "loqateApiKey": {
                      "value": "WJ28-WP43-WG34-YD87"
                    }
                  }
                }
              },
              {
                "id": "ControlCard"
              }
            ]
          },
          {
            "id": "previous_addresses",
            "label": "Previous Addresses",
            "cards": [
              {
                "id": "PreviousAddressesCard"
              },
              {
                "id": "ControlCard"
              }
            ]
          },
          {
            "id": "document_capture",
            "label": "Document Capture",
            "cards": [
              {
                "id": "DocumentCard"
              }
            ]
          }
        ]
      }
    },
    "collects": [
      {
        "ref": "FullName",
        "spec": "required"
      },
      {
        "ref": "DateOfBirth",
        "spec": "required"
      },
      {
        "ref": "CurrentAddress",
        "spec": "required"
      },
      {
        "ref": "PreviousAddresses",
        "spec": "optional"
      },
      {
        "ref": "MobilePhone",
        "spec": "optional"
      },
      {
        "ref": "PersonalEmail",
        "spec": "optional"
      },
      {
        "ref": "SSN",
        "spec": "optional"
      },
      {
        "ref": "PrimaryDocument",
        "spec": "required"
      }
    ],
    "consumes": []
  },
  "outstanding": [
    "FullName",
    "DateOfBirth",
    "CurrentAddress",
    "PrimaryDocument"
  ]
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
instanceId
string
required

Journey instance identifier

Response

Success

​
instanceId
string
required

Journey instance identifier

​
interactionId
string
required

Interaction identifier

​
journey
object
required

Current journey state.

​
interaction
object
required

The current interaction definition, including the resource (pages/cards) and data collection requirements.

​
outstanding
string[]
required

List of data element references that are still required but not yet collected.