--- title: "Retrieve a Generic Document" method: GET path: "/document/generics/{document-id}" tags: ["documents"] --- # Retrieve a Generic Document `GET /document/generics/{document-id}` ## Request - Base URL: `https://api.withpersona.com/api/v1` - URL: `https://api.withpersona.com/api/v1/document/generics/{document-id}` - Auth: HTTP bearer Retrieves the details of a generic document that has been previously created. ## Path parameters - `document-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 a Generic Document object and (optionally) its related objects in `included`. - DocumentsRetrieveAGenericDocumentResponse200 - `data` DocumentGeneric, required: A Document Generic object - `id` string - `attributes` VerificationIncludedObjectsItemsDiscriminatorMappingDocumentGenericAttributes - `status` string: Possible values: - initiated - submitted - processed - errored 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 - `processed-at` string, date-time, nullable - `processed-at-ts` integer, nullable - `kind` string - `files` File[]: The files uploaded to the document for processing. - `filename` string - `url` string - `byte-size` integer - `files-normalized` File[] - `filename` string - `url` string - `byte-size` integer - `extraction-responses` ExtractionResponsesItems[], nullable: A list of extractions resulting from processing the uploaded documents corresponding to the document's extraction configuration. - `extraction-type` string - `field-name` string - `structured-results` object[]: A list of structured AI extraction results with locations stripped. Values are recursive — objects contain nested structured results — but bounding-box location data is omitted from the API response. - `results` ExtractionResponsesItemsResultsItems[]: A list of objects containing the actual value extracted and additional information relevant to the extraction result. - `value` string - `page` integer: The page number the extraction result is detected. Page is 1-indexed. - `match-level` string: If extraction-type is guided, match-level describes the degree in which the extracted value is similar to the source value. Otherwise the match-level is full. - `metadata` ExtractionResponsesItemsResultsItemsMetadata: This is a free-form object containing potentially helpful metadata on the extraction result. - `document-type` string, nullable: The classification of the document if detected. If unable to be detected, this will be other. - `fields` object: JSON key-value pairs of field name to field value. Exact schema depends on the configuration of your template. - `extraction-results` VerificationIncludedObjectsItemsDiscriminatorMappingDocumentGenericAttributesExtractionResultsItems[], nullable: DEPRECATED: Use extraction-responses instead. Legacy extraction results format. This field is only available for API versions before 2021-08-18. - `name` string: The name of the extraction field - `accepts` VerificationIncludedObjectsItemsDiscriminatorMappingDocumentGenericAttributesExtractionResultsItemsAcceptsItems[]: Accepted extraction results - `result` string: The extracted value - `extraction-type` 'inquiry_field' | 'text' | 'regex' | 'entity' | 'license_plate_jp_class' | 'license_plate_jp_text': Type of extraction performed - `similarity` string: Match similarity level (for inquiry_field type) - `source-value` string: Source value for comparison (for inquiry_field type) - `pattern` string: Pattern used for extraction (for text/regex types) - `search-text` string: Text searched for extraction (for text/regex types) - `edit-distance` number, double: Edit distance for text matches (for text type) - `groups` string[]: Regex capture groups (for regex type) - `option` string: Entity extraction option (for entity type) - `metadata` VerificationIncludedObjectsItemsDiscriminatorMappingDocumentGenericAttributesExtractionResultsItemsAcceptsItemsMetadata: Additional extraction metadata - `rejects` VerificationIncludedObjectsItemsDiscriminatorMappingDocumentGenericAttributesExtractionResultsItemsRejectsItems[]: Rejected extraction results - `relationships` DocumentSharedRelationships - `inquiry` DocumentSharedRelationshipsInquiry - `data` DocumentSharedRelationshipsInquiryData - `id` string - `type` 'inquiry' - `template` DocumentSharedRelationshipsTemplate - `data` DocumentSharedRelationshipsTemplateData - `id` string - `type` 'template' - `inquiry-template-version` DocumentSharedRelationshipsInquiryTemplateVersion - `data` DocumentSharedRelationshipsInquiryTemplateVersionData - `id` string - `type` 'inquiry-template-version' - `inquiry-template` DocumentSharedRelationshipsInquiryTemplate - `data` DocumentSharedRelationshipsInquiryTemplateData - `id` string - `type` 'inquiry-template' - `transaction` DocumentSharedRelationshipsTransaction - `data` DocumentSharedRelationshipsTransactionData - `type` 'transaction' - `id` string - `document-files` DocumentSharedRelationshipsDocumentFiles - `data` DocumentSharedRelationshipsDocumentFilesDataItems[] - `id` string - `type` 'document-file' - `included` DocumentIncludedObjectsItems[]: Objects that _may_ be returned if specified via the `include` query parameter in the request. - union - 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: An Inquiry Template object - `type` 'inquiry-template', required: Discriminator value: inquiry-template - `id` string - `attributes` VerificationIncludedObjectsItemsDiscriminatorMappingInquiryTemplateAttributes - `name` string: Name of the Inquiry Template - `status` string: Possible values: - active - inactive Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `embedded-flow-domain-allowlist` string[]: List of domains allowed for embedded flows - `hosted-flow-subdomains` string[]: The subdomain that your hosted flow can be hosted on (e.g. "mycompany.withpersona.com") - `hosted-flow-redirect-uri-schemes` string[]: An allowlist that specifies the URI schemes for redirect after completion of a Hosted Flow. This can be used to implement deep linking for mobile integrations. If this list is empty, all URLs with the URI scheme http or https are allowed. - `field-schemas` FieldSchema[] - union - … - `relationships` VerificationIncludedObjectsItemsDiscriminatorMappingInquiryTemplateRelationships - `latest-published-version` VerificationIncludedObjectsItemsDiscriminatorMappingInquiryTemplateRelationshipsLatestPublishedVersion - `data` VerificationIncludedObjectsItemsDiscriminatorMappingInquiryTemplateRelationshipsLatestPublishedVersionData - … - object: An Inquiry Template Version object - `type` 'inquiry-template-version', required: Discriminator value: inquiry-template-version - `id` string - `attributes` VerificationIncludedObjectsItemsDiscriminatorMappingInquiryTemplateVersionAttributes - `name-display` string, nullable - `description` string, nullable: A description of the changes in this version. - `status` string: Possible values: - published - draft Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `live` boolean: Whether this version is deployed in at least one environment. Reflects organization-wide state, so the value is the same for Sandbox and Production API keys. - `version-tag` VerificationIncludedObjectsItemsDiscriminatorMappingInquiryTemplateVersionAttributesVersionTag: The version's tag; null when the version is untagged. Omitted for Sandbox API keys and for API keys without `inquiry_template.read` on the parent Inquiry Template (for example, when this version is included in an Inquiry response). - `name` string, required - `description` string, nullable, required - `created-at` string, date-time, required - `deployments` VerificationIncludedObjectsItemsDiscriminatorMappingInquiryTemplateVersionAttributesDeploymentsItems[]: Deployment routes currently sending traffic to this version, one per environment; rules carry the strategy (constant today, weighted/conditional for partial rollouts) and version references carry each referenced version's token and serialized deployment tag. Omitted under the same conditions as `version-tag`. - `resource-type` string, required: The platform resource type the route targets. Possible values are `inquiry-template`, `workflow`, and `scheduled-run-config`. - `template-id` string, required: The token of the resource template the route targets. - `environment` VerificationIncludedObjectsItemsDiscriminatorMappingInquiryTemplateVersionAttributesDeploymentsItemsEnvironment, required: The environment the route applies to. - … - `rules` VerificationIncludedObjectsItemsDiscriminatorMappingInquiryTemplateVersionAttributesDeploymentsItemsRulesItems[], required: The routing rules evaluated for the environment. Each rule has a strategy and may have a criteria tree with `and`, `or`, and `!` operators over context or resource origins. - … - `last-updater` string, nullable: The email address of the User who last updated this version. - `enabled-locales` string[] - `created-at` string, date-time - `updated-at` string, date-time, nullable - `published-at` string, date-time, nullable - `theme` VerificationIncludedObjectsItemsDiscriminatorMappingInquiryTemplateVersionAttributesTheme - `border-radius` string, nullable - `border-radius-input` string, nullable - `border-radius-modal` string, nullable - `border-width` string, nullable - `border-width-input` string, nullable - `button-background-image` string, nullable - `button-font-weight` string, nullable - `button-position` string, nullable - `button-shadow-strength` string, nullable - `button-text-transform` string, nullable - `color-button-primary` string, nullable - `color-button-secondary` string, nullable - `color-button-secondary-fill` string, nullable - `color-button-primary-fill-disabled` string, nullable - `color-button-secondary-fill-disabled` string, nullable - `color-error` string, nullable - `color-font` string, nullable - `color-font-button-primary` string, nullable - `color-font-button-secondary` string, nullable - `color-font-small` string, nullable - `color-font-title` string, nullable - `color-icon-header` string, nullable - `color-input-background` string, nullable - `color-input-border` string, nullable - `color-link` string, nullable - `color-modal-background` string, nullable - `color-primary` string, nullable - `color-progress-bar` string, nullable - `color-success` string, nullable - `color-warning` string, nullable - `color-divider` string, nullable - `color-dropdown-background` string, nullable - `color-dropdown-option` string, nullable - `font-family` string, nullable - `font-family-title` string, nullable - `font-url` string, nullable - `font-size-body` string, nullable - `font-size-header` string, nullable - `font-size-small` string, nullable - `line-height-body` string, nullable - `line-height-header` string, nullable - `line-height-small` string, nullable - `header-font-weight` string, nullable - `header-margin-bottom` string, nullable - `icon-color-primary` string, nullable - `icon-color-highlight` string, nullable - `icon-color-stroke` string, nullable - `icon-color-background` string, nullable - `icon-color-government-id-type` string, nullable - `icon-style` string, nullable - `input-style` string, nullable - `page-transition` string, nullable - `text-align` string, nullable - `text-decoration-line-link` string, nullable - `us-state-input-method` string, nullable - `vertical-options-style` string, nullable - `government-id-pictograph-position` string, nullable - `id-back-pictograph-height` string, nullable - `id-back-pictograph-url` string, nullable - `id-front-pictograph-height` string, nullable - `id-front-pictograph-url` string, nullable - `passport-front-pictograph-height` string, nullable - `passport-front-pictograph-url` string, nullable - `passport-signature-pictograph-height` string, nullable - `passport-signature-pictograph-url` string, nullable - `government-id-select-pictograph-height` string, nullable - `government-id-select-pictograph-url` string, nullable - `device-handoff-terms-text-position` string, nullable - `selfie-pictograph-url` string, nullable - `selfie-pictograph-height` string, nullable - `selfie-center-pictograph-url` string, nullable - `selfie-center-pictograph-height` string, nullable - `selfie-left-pictograph-url` string, nullable - `selfie-left-pictograph-height` string, nullable - `selfie-right-pictograph-url` string, nullable - `selfie-right-pictograph-height` string, nullable - `document-pictograph-position` string, nullable - `document-pictograph-height` string, nullable - `document-pictograph-url` string, nullable - `camera-support-pictograph-height` string, nullable - `camera-support-pictograph-url` string, nullable - `loading-pictograph-height` string, nullable - `loading-pictograph-url` string, nullable - `navbar-logo-display` string, nullable - `logo-url` string, nullable - `logo` string, nullable - `logo-data` string, nullable - `logo-filename` string, nullable - `relationships` VerificationIncludedObjectsItemsDiscriminatorMappingInquiryTemplateVersionRelationships - `inquiry-template` VerificationIncludedObjectsItemsDiscriminatorMappingInquiryTemplateVersionRelationshipsInquiryTemplate - `data` VerificationIncludedObjectsItemsDiscriminatorMappingInquiryTemplateVersionRelationshipsInquiryTemplateData - … - object: An Template object for legacy inquiries - `type` 'template', required: Discriminator value: template - `id` string - `attributes` VerificationIncludedObjectsItemsDiscriminatorMappingTemplateAttributes - `name` string - object: transaction variant - `type` 'transaction', required: Discriminator value: transaction - `id` string: Unique identifier for this Transaction. Starts with `txn_`. - `attributes` VerificationIncludedObjectsItemsDiscriminatorMappingTransactionAttributes - `status` string - `reference-id` string, nullable - `fields` object: JSON key-value pairs of field name to field value. Exact schema depends on the configuration of the Transaction Type for this Transaction. - `tags` string[] - `signals` object: Risk signals computed for this Transaction, keyed by signal name. Only present for Transactions whose Transaction Type has Sentinel enabled; signals appear once the Sentinel session has been processed. 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. - `created-at` string, date-time - `updated-at` string, date-time, nullable - `relationships` VerificationIncludedObjectsItemsDiscriminatorMappingTransactionRelationships - `reviewer` VerificationIncludedObjectsItemsDiscriminatorMappingTransactionRelationshipsReviewer: The entity that reviewed the transaction - `data` VerificationIncludedObjectsItemsDiscriminatorMappingTransactionRelationshipsReviewerData - … - `transaction-label` VerificationIncludedObjectsItemsDiscriminatorMappingTransactionRelationshipsTransactionLabel - `data` VerificationIncludedObjectsItemsDiscriminatorMappingTransactionRelationshipsTransactionLabelData - … - `transaction-type` VerificationIncludedObjectsItemsDiscriminatorMappingTransactionRelationshipsTransactionType - `data` VerificationIncludedObjectsItemsDiscriminatorMappingTransactionRelationshipsTransactionTypeData - … - `related-objects` VerificationIncludedObjectsItemsDiscriminatorMappingTransactionRelationshipsRelatedObjects: Objects involved in this Transaction's related Workflow runs. - `data` VerificationIncludedObjectsItemsDiscriminatorMappingTransactionRelationshipsRelatedObjectsDataItems[] - … - `sentinel-sessions` VerificationIncludedObjectsItemsDiscriminatorMappingTransactionRelationshipsSentinelSessions: The Sentinel sessions that collected device and network data for this Transaction. Present on every Transaction; `data` is empty unless the Transaction has one or more Sentinel sessions. - `data` VerificationIncludedObjectsItemsDiscriminatorMappingTransactionRelationshipsSentinelSessionsDataItems[] - … - object: document-file variant - `type` 'document-file', required: Discriminator value: document-file - `id` string - `attributes` DocumentIncludedObjectsItemsDiscriminatorMappingDocumentFileAttributes - `name` string, nullable - `capture-method` string: Possible values: - auto - manual - upload - api - live Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `originals` File[] - `filename` string - `url` string - `byte-size` integer ## 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-4.md) - [All operations](https://skmtc.dev/withpersona/apis/withpersona-4/llms.txt) - [OpenAPI document](https://skmtc.dev/withpersona/apis/withpersona-4/revisions/2eddd7dae374?raw)