API ReferenceInquiries

Resume an Inquiry

Creates a session token that is returned as meta.session-token. If the inquiry’s status is expired, changes the status to pending. The session-token must be included when loading the inquiry flow if the inquiry’s status is pending. This endpoint will error if the inquiry is redacted. This endpoint first tries to reuse any existing valid unused sessions. If none exist, a new session is created. For more information, see Resuming Inquiries.

Path parameters

inquiry-idstringRequired

Headers

AuthorizationstringRequired

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

Key-InflectionenumOptional
Determines casing for the API response
Allowed values:
Idempotency-KeystringOptional
Ensures the request is idempotent
Persona-VersionenumOptionalDefaults to 2023-01-05
Allowed values:

Query parameters

includestringOptional

A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the included key in the response. See Serialization for more details.

fieldsmap from strings to stringsOptional

Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See Serialization for more details.

Response

OK
dataobject or null
An Inquiry object
includedlist of objects or null

Objects that may be returned if specified via the include query parameter in the request.

metaobject or null

Errors