inquiries

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.

post/inquiries/{inquiry-id}/resume

Request

  • Base URL: https://api.withpersona.com/api/v1
  • URL: https://api.withpersona.com/api/v1/inquiries/{inquiry-id}/resume
  • Auth: HTTP bearer

Path parameters

inquiry-idstring required

Query parameters

includestring

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.

fieldsobject

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.

Headers

Key-Inflection'camel' | 'kebab' | 'snake'

Determines casing for the API response.

Idempotency-Keystring

Ensures the request is idempotent.

Persona-Version'2026-09-29' | '2025-12-08' | '2025-10-27' | '2023-01-05' | '2022-09-01' | '2021-08-18' | '2021-07-05' | '2021-02-21' | '2020-05-18'

Server API version. More info on versioning can be found here.

Response

This endpoint returns an Inquiry object and (optionally) its related objects in included.

Changes

No recorded changes to this operation across all 1 revision of this API.