Skip to main content
POST
Delete journey state
This request deletes the journey’s data from the GBG Go API service only. It doesn’t delete the journey session record, documents, or biometrics in the Investigation portal. To delete those, for example for a GDPR erasure request, use Delete journey session in the Investigation portal.
Your API credentials need the DELETE:journey permission. For step-by-step instructions, error codes, and what the request deletes, see Delete journey data with the API.

Authorizations

Authorization
string
header
required

Customer JWT token for journey lifecycle operations. Required for: journey/start, journey/state/fetch, device/start

Body

application/json
instanceId
string
required

Journey Instance Id, a unique identifier for a started journey instance.

Required string length: 16 - 64
Pattern: ^[A-Za-z0-9_-]+$
{key}
any

Response

Journey deleted

instanceId
string
required
status
enum<string>
required
Available options:
deleted
message
string
required