--- title: "Retrieve an Inquiry Session" method: GET path: "/inquiry-sessions/{inquiry-session-id}" tags: ["inquirySessions"] --- # Retrieve an Inquiry Session `GET /inquiry-sessions/{inquiry-session-id}` ## Request - Base URL: `https://api.withpersona.com/api/v1` - URL: `https://api.withpersona.com/api/v1/inquiry-sessions/{inquiry-session-id}` - Auth: HTTP bearer Retrieves details of a specific Inquiry Session. ## Path parameters - `inquiry-session-id` string, required ## Query parameters - `include` string - `fields` object ## Headers - `Key-Inflection` 'camel' | 'kebab' | 'snake' - `Idempotency-Key` string - `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](https://docs.withpersona.com/versioning). ## Response `200` This endpoint returns an Inquiry Session object and (optionally) its related objects in `included`. - InquirySessionsRetrieveAnInquirySessionResponse200 - `data` InquirySession, required - `id` string - `attributes` InquiryIncludedObjectsItemsDiscriminatorMappingInquirySessionAttributes - `status` string: Possible values: - new - active - expired Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `created-at` string, date-time - `started-at` string, date-time, nullable - `expired-at` string, date-time, nullable - `ip-address` string, nullable - `user-agent` string, nullable - `os-name` string, nullable - `os-full-version` string, nullable - `device-type` string, nullable - `device-name` string, nullable - `browser-name` string, nullable - `browser-full-version` string, nullable - `mobile-sdk-name` string, nullable - `mobile-sdk-full-version` string, nullable - `device-handoff-method` string, nullable - `is-proxy` boolean, nullable - `is-tor` boolean, nullable - `is-datacenter` boolean, nullable - `is-vpn` boolean, nullable - `threat-level` string, nullable - `country-code` string, nullable - `country-name` string, nullable - `region-code` string, nullable - `region-name` string, nullable - `latitude` number, double, nullable - `longitude` number, double, nullable - `gps-latitude` number, double, nullable - `gps-longitude` number, double, nullable - `gps-precision` string, nullable - `gps-country-code` string, nullable: ISO 3166-1 alpha-2 country code stored from the session's GPS coordinates. Null when it has not been stored, including for sessions created before this value existed; null does not mean a GPS country cannot be derived. - `ip-connection-type` string, nullable - `ip-isp` string, nullable - `network-organization` string, nullable - `relationships` InquiryIncludedObjectsItemsDiscriminatorMappingInquirySessionRelationships - `inquiry` InquiryIncludedObjectsItemsDiscriminatorMappingInquirySessionRelationshipsInquiry - `data` InquiryIncludedObjectsItemsDiscriminatorMappingInquirySessionRelationshipsInquiryData - `type` 'inquiry' - `id` string - `device` InquiryIncludedObjectsItemsDiscriminatorMappingInquirySessionRelationshipsDevice - `data` InquiryIncludedObjectsItemsDiscriminatorMappingInquirySessionRelationshipsDeviceData - `type` 'device' - `id` string - `network` InquiryIncludedObjectsItemsDiscriminatorMappingInquirySessionRelationshipsNetwork - `data` InquiryIncludedObjectsItemsDiscriminatorMappingInquirySessionRelationshipsNetworkData - `type` 'network' - `id` string - `included` InquirySessionsIncludedObjectsItems[] - union - object: device variant - `type` 'device', required: Discriminator value: device - `id` string: Unique identifier for this Device. Starts with `dev_`. - `attributes` InquirySessionsIncludedObjectsItemsDiscriminatorMappingDeviceAttributes - `device-vendor-id` string, nullable - `device-fingerprint` string, nullable - `browser-fingerprint` string, nullable - object: An Inquiry object - `type` 'inquiry', required: Discriminator value: inquiry - `id` string, required - `attributes` SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributes, required - `status` string, required: The status of the Inquiry Possible values: - created - pending - completed - expired - failed - needs_review - approved - declined Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `reference-id` string, nullable, required - `note` string, nullable, required - `behaviors` object, nullable, required: Risk signals surfaced to enterprise customers. Specific keys are not enumerated in the public spec and may be added or removed over time. Contact your Persona account team for more information. - `tags` string[], required - `creator` string, required - `reviewer-comment` string, nullable, required - `created-at` string, date-time, required - `updated-at` string, date-time, required - `started-at` string, date-time, nullable, required - `expires-at` string, date-time, nullable, required - `completed-at` string, date-time, nullable, required - `failed-at` string, date-time, nullable, required: Set when an Inquiry transitions to `failed`. Not typically set on `declined` Inquiries — those carry `completed-at` from the transition that preceded the decision. - `marked-for-review-at` string, date-time, nullable, required - `decisioned-at` string, date-time, nullable, required - `expired-at` string, date-time, nullable, required - `redacted-at` string, date-time, nullable, required - `previous-step-name` string, nullable, required - `next-step-name` string, nullable, required - `fields` SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFields, required: JSON key-value pairs of field name to field value. Exact schema depends on the configuration of the Inquiry template for this Inquiry. - `name-first` SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsNameFirst - … - `name-middle` SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsNameMiddle - … - `name-last` SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsNameLast - … - `address-street-1` SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsAddressStreet1 - … - `address-street-2` SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsAddressStreet2 - … - `address-city` SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsAddressCity: City of residence address. Not all international addresses use this attribute. - … - `address-subdivision` SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsAddressSubdivision: State or subdivision of residence address. In the US, this should be the unabbreviated name. Not all international addresses use this attribute. - … - `address-postal-code` SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsAddressPostalCode: ZIP or postal code of residence address. Not all international addresses use this attribute. - … - `address-country-code` SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsAddressCountryCode: ISO 3166-1 alpha 2 country code. - … - `birthdate` SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsBirthdate - … - `email-address` SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsEmailAddress - … - `phone-number` SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsPhoneNumber - … - `identification-number` SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsIdentificationNumber - … - `birthdate` string, date, nullable: Birthdate, must be in the format "YYYY-MM-DD". - `name-first` string, nullable: Given or first name. - `name-middle` string, nullable: Middle name. - `name-last` string, nullable: Family or last name. - `phone-number` string, nullable: Phone number. - `email-address` string, nullable: Email address. - `social-security-number` string, nullable: Social security number. - `address-street-1` string, nullable: Street name of residence address. - `address-street-2` string, nullable: Extension of residence address, usually apartment or suite number. - `address-city` string, nullable: City of residence address. Not all international addresses use this attribute. - `address-subdivision` string, nullable: State or subdivision of residence address. In the US, this should be the unabbreviated name. Not all international addresses use this attribute. - `address-postal-code` string, nullable: ZIP or postal code of residence address. Not all international addresses use this attribute. - `address-subdivision-abbr` string, nullable - `address-postal-code-abbr` string, nullable - `identification-number` string, nullable - `relationships` SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationships, required - `account` SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsAccount - `data` SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsAccountData - … - `documents` SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsDocuments - `data` SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsDocumentsDataItems[] - … - `template` SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsTemplate: Only present for Legacy 2.0 inquiries - `data` SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsTemplateData - … - `inquiry-template` SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsInquiryTemplate: Only present for Dynamic Flow inquiries - `data` SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsInquiryTemplateData - … - `inquiry-template-version` SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsInquiryTemplateVersion: Only present for Dynamic Flow inquiries - `data` SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsInquiryTemplateVersionData - … - `reports` SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsReports - `data` SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsReportsDataItems[] - … - `transaction` SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsTransaction - `data` SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsTransactionData - … - `reviewer` SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsReviewer: Actor that decisioned the Inquiry. `data` is `null` while the Inquiry has not been decisioned. Once decisioned, `data.type` and `data.id` identify the reviewer: - `user` + `user_*` — a dashboard user reviewed and decisioned the Inquiry. - `workflow` + `wfl_*` — Workflows 1.0 auto-decisioned the Inquiry. - `workflow-run` + `wfr_*` — Workflows 2.0 auto-decisioned the Inquiry (the dominant case in automation-heavy organizations). - `data` SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsReviewerData - … - `selfies` SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsSelfies - `data` SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsSelfiesDataItems[] - … - `sessions` SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsSessions - `data` SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsSessionsDataItems[] - … - `verifications` SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsVerifications - `data` SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsVerificationsDataItems[] - … - object: network variant - `type` 'network', required: Discriminator value: network - `id` string: Unique identifier for this Network. Starts with `net_`. - `attributes` InquirySessionsIncludedObjectsItemsDiscriminatorMappingNetworkAttributes - `created-at` string, date-time - `ip-address` string, nullable - `service-provider` string, nullable - `service-type` string, nullable: Possible values: - residential - mobile - datacenter - corporate - education Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `proxy-type` string, nullable: Possible values: - residential - mobile - corporate - vpn - unknown - tor Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `threat-level` string, nullable: Possible values: - unknown - low - medium - high Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `country-code` string, nullable - `country-name` string, nullable - `region-code` string, nullable - `region-name` string, nullable - `latitude` number, double, nullable - `longitude` number, double, nullable ## Other responses - `400`: The request was unacceptable, often due to invalid parameters. - `401`: An invalid API key was provided. - `403`: The given API key doesn’t have permissions to perform the request or a quota has been exceeded. - `404`: The requested resource doesn’t exist. - `429`: Your organization’s rate limit has been exceeded. We recommend an exponential backoff on requests. --- [API](https://skmtc.dev/withpersona/apis/withpersona-3.md) - [All operations](https://skmtc.dev/withpersona/apis/withpersona-3/llms.txt) - [OpenAPI document](https://skmtc.dev/withpersona/apis/withpersona-3/revisions/0a3310d5046f?raw)