> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.withpersona.com/2020-05-18/api-reference/webhooks/inquiry-session-events/webhook-inquiry-session-canceled/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.withpersona.com/_mcp/server. # Inquiry session canceled POST Webhook for the `inquiry-session.canceled` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks). Reference: https://docs.withpersona.com/api-reference/webhooks/inquiry-session-events/webhook-inquiry-session-canceled ## Request ### Headers - `Persona-Signature` (string, optional) — Header. An HMAC that you should use to check that requests are authentic. Compare this value with your own digest, computed from the request body and your webhook secret. For more info see [Webhook Best Practices](https://docs.withpersona.com/webhooks-best-practices). - `Persona-Webhook-Attempts-Made` (integer, optional) — The number of times that Persona has attempted to deliver this webhook. This value is incremented each time Persona attempts to deliver the webhook, regardless of whether the delivery was successful. - `Persona-Webhook-Attempts-Left` (integer, optional) — The number of times that Persona will attempt to deliver this webhook. This value is decremented each time Persona attempts to deliver the webhook. - `Persona-Webhook-First-Attempted-At` (integer, optional) — The time at which Persona first attempted to deliver this webhook. This value is a Unix timestamp in seconds. ### Payload - `data` (WebhooksWebhookInquirySessionCanceledPayloadContentApplicationJsonSchemaData, optional) ## Types ### WebhooksWebhookInquirySessionCanceledPayloadContentApplicationJsonSchemaData - `attributes` (WebhooksWebhookInquirySessionCanceledPayloadContentApplicationJsonSchemaDataAttributes, optional) - `id` (string, optional) — Unique identifier for this Event. Starts with `evt_`. - `type` ("event", optional) ### WebhooksWebhookInquirySessionCanceledPayloadContentApplicationJsonSchemaDataAttributes - `created-at` (datetime, optional) — Datetime when the event was created. - `name` ("inquiry-session.canceled", optional) - `payload` (WebhooksWebhookInquirySessionCanceledPayloadContentApplicationJsonSchemaDataAttributesPayload, optional) ### WebhooksWebhookInquirySessionCanceledPayloadContentApplicationJsonSchemaDataAttributesPayload - `data` (inquiry-session, optional) - `included` (list of InquirySessionsIncludedObjectsItems, optional) — All objects that are present in `data.attributes.relationships` will be provided in `included`. ### inquiry-session - `id` (string, optional) - `attributes` (InquiryIncludedObjectsItemsDiscriminatorMappingInquirySessionAttributes, optional) - `relationships` (InquiryIncludedObjectsItemsDiscriminatorMappingInquirySessionRelationships, optional) ### InquirySessionsIncludedObjectsItems - `type`: `device` (device) - `attributes` (InquirySessionsIncludedObjectsItemsDiscriminatorMappingDeviceAttributes, optional) - `id` (string, optional) — Unique identifier for this Device. Starts with `dev_`. - `type`: `inquiry` (inquiry) - `attributes` (SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributes, required) - `id` (string, required) - `relationships` (SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationships, required) - `type`: `network` (network) - `attributes` (InquirySessionsIncludedObjectsItemsDiscriminatorMappingNetworkAttributes, optional) - `id` (string, optional) — Unique identifier for this Network. Starts with `net_`. ### InquiryIncludedObjectsItemsDiscriminatorMappingInquirySessionAttributes - `status` (string, optional) — 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` (datetime, optional) - `started-at` (datetime, optional, nullable) - `expired-at` (datetime, optional, nullable) - `ip-address` (string, optional, nullable) - `user-agent` (string, optional, nullable) - `os-name` (string, optional, nullable) - `os-full-version` (string, optional, nullable) - `device-type` (string, optional, nullable) - `device-name` (string, optional, nullable) - `browser-name` (string, optional, nullable) - `browser-full-version` (string, optional, nullable) - `mobile-sdk-name` (string, optional, nullable) - `mobile-sdk-full-version` (string, optional, nullable) - `device-handoff-method` (string, optional, nullable) - `is-proxy` (boolean, optional, nullable) - `is-tor` (boolean, optional, nullable) - `is-datacenter` (boolean, optional, nullable) - `is-vpn` (boolean, optional, nullable) - `threat-level` (string, optional, nullable) - `country-code` (string, optional, nullable) - `country-name` (string, optional, nullable) - `region-code` (string, optional, nullable) - `region-name` (string, optional, nullable) - `latitude` (double, optional, nullable) - `longitude` (double, optional, nullable) - `gps-latitude` (double, optional, nullable) - `gps-longitude` (double, optional, nullable) - `gps-precision` (string, optional, nullable) - `gps-country-code` (string, optional, 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, optional, nullable) - `ip-isp` (string, optional, nullable) - `network-organization` (string, optional, nullable) - `browser-fingerprint` (string, optional, nullable, deprecated) — (DEPRECATED) Use `browser-fingerprint` from the session's device relationship instead. ### InquiryIncludedObjectsItemsDiscriminatorMappingInquirySessionRelationships - `inquiry` (InquiryIncludedObjectsItemsDiscriminatorMappingInquirySessionRelationshipsInquiry, optional) - `device` (InquiryIncludedObjectsItemsDiscriminatorMappingInquirySessionRelationshipsDevice, optional) - `network` (InquiryIncludedObjectsItemsDiscriminatorMappingInquirySessionRelationshipsNetwork, optional) ### InquirySessionsIncludedObjectsItemsDiscriminatorMappingDeviceAttributes - `device-vendor-id` (string, optional, nullable) - `device-fingerprint` (string, optional, nullable) - `browser-fingerprint` (string, optional, nullable) ### SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributes - `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, required, nullable) - `note` (string, required, nullable) - `behaviors` (map from string to any, required, nullable) — 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` (list of string, required) - `creator` (string, required) - `reviewer-comment` (string, required, nullable) - `created-at` (datetime, required) - `updated-at` (datetime, required) - `started-at` (datetime, required, nullable) - `expires-at` (datetime, required, nullable) - `completed-at` (datetime, required, nullable) - `failed-at` (datetime, required, nullable) — 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` (datetime, required, nullable) - `decisioned-at` (datetime, required, nullable) - `expired-at` (datetime, required, nullable) - `redacted-at` (datetime, required, nullable) - `previous-step-name` (string, required, nullable) - `next-step-name` (string, required, nullable) - `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. - `birthdate` (date, optional, nullable) — Birthdate, must be in the format "YYYY-MM-DD". - `name-first` (string, optional, nullable) — Given or first name. - `name-middle` (string, optional, nullable) — Middle name. - `name-last` (string, optional, nullable) — Family or last name. - `phone-number` (string, optional, nullable) — Phone number. - `email-address` (string, optional, nullable) — Email address. - `social-security-number` (string, optional, nullable) — Social security number. - `address-street-1` (string, optional, nullable) — Street name of residence address. - `address-street-2` (string, optional, nullable) — Extension of residence address, usually apartment or suite number. - `address-city` (string, optional, nullable) — City of residence address. Not all international addresses use this attribute. - `address-subdivision` (string, optional, 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, optional, nullable) — ZIP or postal code of residence address. Not all international addresses use this attribute. - `address-subdivision-abbr` (string, optional, nullable) - `address-postal-code-abbr` (string, optional, nullable) - `identification-number` (string, optional, nullable) - `reviewer` (string, optional, nullable) — The email address or identifier of the reviewer who made the decision on this inquiry. For User reviewers, this is their email address. For Workflow reviewers, this is the workflow token. For API decisions, this is "api". - `reviewer-type` (string, optional, nullable) — The type of reviewer who made the decision. Can be "user", "workflow", "workflow-run", or "api". - `driver-license-number` (string, optional, nullable, deprecated) - `passport-number` (string, optional, nullable, deprecated) ### SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationships - `account` (SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsAccount, optional) - `documents` (SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsDocuments, optional) - `template` (SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsTemplate, optional) — Only present for Legacy 2.0 inquiries - `inquiry-template` (SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsInquiryTemplate, optional) — Only present for Dynamic Flow inquiries - `inquiry-template-version` (SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsInquiryTemplateVersion, optional) — Only present for Dynamic Flow inquiries - `reports` (SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsReports, optional) - `transaction` (SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsTransaction, optional) - `selfies` (SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsSelfies, optional) - `sessions` (SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsSessions, optional) - `verifications` (SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsVerifications, optional) ### InquirySessionsIncludedObjectsItemsDiscriminatorMappingNetworkAttributes - `created-at` (datetime, optional) - `ip-address` (string, optional, nullable) - `service-provider` (string, optional, nullable) - `service-type` (string, optional, 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, optional, 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, optional, 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, optional, nullable) - `country-name` (string, optional, nullable) - `region-code` (string, optional, nullable) - `region-name` (string, optional, nullable) - `latitude` (double, optional, nullable) - `longitude` (double, optional, nullable) ### InquiryIncludedObjectsItemsDiscriminatorMappingInquirySessionRelationshipsInquiry - `data` (InquiryIncludedObjectsItemsDiscriminatorMappingInquirySessionRelationshipsInquiryData, optional) ### InquiryIncludedObjectsItemsDiscriminatorMappingInquirySessionRelationshipsDevice - `data` (InquiryIncludedObjectsItemsDiscriminatorMappingInquirySessionRelationshipsDeviceData, optional, nullable) ### InquiryIncludedObjectsItemsDiscriminatorMappingInquirySessionRelationshipsNetwork - `data` (InquiryIncludedObjectsItemsDiscriminatorMappingInquirySessionRelationshipsNetworkData, optional, nullable) ### SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFields 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, optional) - `name-middle` (SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsNameMiddle, optional) - `name-last` (SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsNameLast, optional) - `address-street-1` (SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsAddressStreet1, optional) - `address-street-2` (SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsAddressStreet2, optional) - `address-city` (SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsAddressCity, optional) — City of residence address. Not all international addresses use this attribute. - `address-subdivision` (SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsAddressSubdivision, optional) — 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, optional) — ZIP or postal code of residence address. Not all international addresses use this attribute. - `address-country-code` (SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsAddressCountryCode, optional) — ISO 3166-1 alpha 2 country code. - `birthdate` (SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsBirthdate, optional) - `email-address` (SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsEmailAddress, optional) - `phone-number` (SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsPhoneNumber, optional) - `driver-license-number` (SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsDriverLicenseNumber, optional, deprecated) - `passport-number` (SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsPassportNumber, optional, deprecated) ### SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsAccount - `data` (SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsAccountData, optional, nullable) ### SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsDocuments - `data` (list of SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsDocumentsDataItems, optional) ### SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsTemplate Only present for Legacy 2.0 inquiries - `data` (SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsTemplateData, optional, nullable) ### SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsInquiryTemplate Only present for Dynamic Flow inquiries - `data` (SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsInquiryTemplateData, optional, nullable) ### SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsInquiryTemplateVersion Only present for Dynamic Flow inquiries - `data` (SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsInquiryTemplateVersionData, optional, nullable) ### SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsReports - `data` (list of SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsReportsDataItems, optional) ### SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsTransaction - `data` (SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsTransactionData, optional, nullable) ### SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsSelfies - `data` (list of SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsSelfiesDataItems, optional) ### SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsSessions - `data` (list of SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsSessionsDataItems, optional) ### SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsVerifications - `data` (list of SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsVerificationsDataItems, optional) ### InquiryIncludedObjectsItemsDiscriminatorMappingInquirySessionRelationshipsInquiryData - `type` ("inquiry", optional) - `id` (string, optional) ### InquiryIncludedObjectsItemsDiscriminatorMappingInquirySessionRelationshipsDeviceData - `type` ("device", optional) - `id` (string, optional) ### InquiryIncludedObjectsItemsDiscriminatorMappingInquirySessionRelationshipsNetworkData - `type` ("network", optional) - `id` (string, optional) ### SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsNameFirst - `type` (string, optional) - `value` (string, optional, nullable) ### SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsNameMiddle - `type` (string, optional) - `value` (string, optional, nullable) ### SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsNameLast - `type` (string, optional) - `value` (string, optional, nullable) ### SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsAddressStreet1 - `type` (string, optional) - `value` (string, optional, nullable) ### SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsAddressStreet2 - `type` (string, optional) - `value` (string, optional, nullable) ### SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsAddressCity City of residence address. Not all international addresses use this attribute. - `type` (string, optional) - `value` (string, optional, nullable) ### SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsAddressSubdivision State or subdivision of residence address. In the US, this should be the unabbreviated name. Not all international addresses use this attribute. - `type` (string, optional) - `value` (string, optional, nullable) ### SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsAddressPostalCode ZIP or postal code of residence address. Not all international addresses use this attribute. - `type` (string, optional) - `value` (string, optional, nullable) ### SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsAddressCountryCode ISO 3166-1 alpha 2 country code. - `type` (string, optional) - `value` (string, optional, nullable) ### SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsBirthdate - `type` (string, optional) - `value` (string, optional, nullable) — Date of birth in YYYY-MM-DD format ### SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsEmailAddress - `type` (string, optional) - `value` (string, optional, nullable) ### SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsPhoneNumber - `type` (string, optional) - `value` (string, optional, nullable) ### SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsDriverLicenseNumber - `type` (string, optional) - `value` (string, optional, nullable) ### SelfieIncludedObjectsItemsDiscriminatorMappingInquiryAttributesFieldsPassportNumber - `type` (string, optional) - `value` (string, optional, nullable) ### SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsAccountData - `id` (string, optional) - `type` ("account", optional) ### SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsDocumentsDataItems - `id` (string, optional) - `type` (string, optional) ### SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsTemplateData - `id` (string, optional) - `type` ("template", optional) ### SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsInquiryTemplateData - `id` (string, optional) - `type` ("inquiry-template", optional) ### SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsInquiryTemplateVersionData - `id` (string, optional) - `type` ("inquiry-template-version", optional) ### SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsReportsDataItems - `id` (string, optional) - `type` (string, optional) ### SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsTransactionData - `id` (string, optional) - `type` ("transaction", optional) ### SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsSelfiesDataItems - `id` (string, optional) - `type` (string, optional) ### SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsSessionsDataItems - `id` (string, optional) - `type` ("inquiry-session", optional) ### SelfieIncludedObjectsItemsDiscriminatorMappingInquiryRelationshipsVerificationsDataItems - `id` (string, optional) - `type` (string, optional)