Retrieve an Inquiry
Retrieves the details of an existing Inquiry.
In the [Embedded Flow](https://docs.withpersona.com/embedded-flow), the `inquiry-id` is the first parameter of the onStart callback. In the [Hosted Flow](https://docs.withpersona.com/hosted-flow), the `inquiry-id` is a query parameter in the onComplete callback.
Template information will be found in `data.relationships.inquiry-template` if the inquiry is a Dynamic Flow inquiry, and in `data.relationships.template` if the inquiry is a Legacy 2.0 inquiry. For more information, see [Dynamic Flow vs. Legacy Templates](https://docs.withpersona.com/inquiry-templates#dynamic-flow-vs-legacy-templates).
Authentication
AuthorizationBearer
Bearer authentication of the form Bearer <token>, where token is your auth token.
Path parameters
inquiry-id
Headers
Key-Inflection
Determines casing for the API response.
Allowed values:
Idempotency-Key
Ensures the request is idempotent.
Persona-Version
Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).
Query parameters
include
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](https://docs.withpersona.com/serialization#inclusion-of-related-resources) for more details.
fields
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](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details.
Response headers
RateLimit-Limit
The maximum number of requests permitted in the current rate limit window for the API key used to authenticate the request. Returned on every authenticated response.
RateLimit-Remaining
The number of requests remaining in the current rate limit window for the API key used to authenticate the request. Returned on every authenticated response.
RateLimit-Reset
The number of seconds until the current rate limit window resets. Returned on every authenticated response.
Request-Id
The unique identifier of the API log entry that recorded this request. Starts with req_. Include this value when reaching out to Persona support. Present on every authenticated response, including error responses.
Persona-Environment-Id
The token of the Persona environment that handled the request. Returned on every authenticated response, including most error responses.
Persona-Organization-Id
The token of the Persona organization that handled the request. Returned on every authenticated response, including most error responses.
Response
This endpoint returns an Inquiry object and (optionally) its related objects in included.
data
An Inquiry object
included
Included by default:
- Reports
- Verifications
- Inquiry Sessions
- Documents
- Inquiry Template
Anything else must be explicitly requested with the include query parameter.
Errors
400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error