--- title: "Set status on a Case" method: POST path: "/cases/{case-id}/set-status" tags: ["cases"] --- # Set status on a Case `POST /cases/{case-id}/set-status` ## Request - Base URL: `https://api.withpersona.com/api/v1` - URL: `https://api.withpersona.com/api/v1/cases/{case-id}/set-status` - Auth: HTTP bearer Sets the status of a Case. ## Path parameters - `case-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). ## Request body - object - `meta` CasesCaseIdSetStatusPostRequestBodyContentApplicationJsonSchemaMeta - `status` string, required: Status to update case to ## Response `200` This endpoint returns a Case object and (optionally) its related objects in `included`. - CasesSetStatusForACaseResponse200 - `data` Case, required: A Case object - `type` 'case' - `id` string - `attributes` CaseAttributes - `status` string - `name` string - `resolution` string, nullable - `created-at` string - `updated-at` string, nullable - `assigned-at` string, nullable - `resolved-at` string, nullable - `redacted-at` string, nullable - `sla-expires-at` string, nullable - `creator-id` string, nullable - `creator-type` string, nullable: Possible values: - user - workflow-run Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `assignee-id` string, nullable - `assigner-id` string, nullable - `assigner-type` string, nullable: Possible values: - case-assignment-policy - user - workflow-run Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `resolver-id` string, nullable - `resolver-type` string, nullable: Possible values: - api-key - user - workflow-run Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `updater-id` string, nullable - `updater-type` string, nullable: Possible values: - api-key - case-assignment-policy - user - workflow-run Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `tags` unknown[] - unknown - `fields` object: JSON key-value pairs of field name to field value. Exact schema depends on the configuration of the Case template for this Case. Keys in `fields` are **not** key inflected. - `attachments` CaseAttributesAttachmentsItems[] - `filename` string - `url` string - `byte-size` integer - `relationships` CaseRelationships - `accounts` CaseRelationshipsAccounts - `data` CaseRelationshipsAccountsDataItems[] - `id` string - `type` 'account' - `case-comments` CaseRelationshipsCaseComments - `data` CaseRelationshipsCaseCommentsDataItems[] - `id` string - `type` 'case-comment' - `case-template` CaseRelationshipsCaseTemplate - `data` CaseRelationshipsCaseTemplateData - `id` string - `type` 'case-template' - `case-queue` CaseRelationshipsCaseQueue - `data` CaseRelationshipsCaseQueueData - `id` string - `type` 'case-queue' - `inquiries` CaseRelationshipsInquiries - `data` CaseRelationshipsInquiriesDataItems[] - `id` string - `type` 'inquiry' - `reports` CaseRelationshipsReports - `data` CaseRelationshipsReportsDataItems[] - `id` string - `type` string - `verifications` CaseRelationshipsVerifications - `data` CaseRelationshipsVerificationsDataItems[] - `id` string - `type` string - `txns` CaseRelationshipsTxns - `data` CaseRelationshipsTxnsDataItems[] - `id` string - `type` 'transaction' - `included` CasesIncludedObjectsItems[] - union - object: An Account object. Note that `fields` is **not** key inflected. - `type` 'account', required: Discriminator value: account - `id` string - `attributes` VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributes - `reference-id` string, nullable - `account-type-name` string - `created-at` string, date-time - `updated-at` string, date-time - `redacted-at` string, date-time, nullable - `fields` VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFields: JSON key-value pairs of field name to field value. Exact schema depends on the configuration of the Account Type for this Account. Keys in `fields` are **not** key inflected. - `name` VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsName - … - `address` VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsAddress - … - `identification_numbers` VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsIdentificationNumbers - … - `birthdate` VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsBirthdate - … - `phone_number` VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsPhoneNumber - … - `email_address` VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsEmailAddress - … - `selfie_photo` VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsSelfiePhoto - … - `tags` string[] - `account-status` string - `relationships` VerificationIncludedObjectsItemsDiscriminatorMappingAccountRelationships - `account-type` VerificationIncludedObjectsItemsDiscriminatorMappingAccountRelationshipsAccountType - `data` VerificationIncludedObjectsItemsDiscriminatorMappingAccountRelationshipsAccountTypeData - … - object: Comment on a Case object - `type` 'case-comment', required: Discriminator value: case-comment - `id` string: Unique identifier for the Case Comment - `attributes` CasesIncludedObjectsItemsDiscriminatorMappingCaseCommentAttributes - `message` string, nullable: The comment message. Null once the comment has been redacted. - `created-at` string, date-time: The time the comment was created - `updated-at` string, date-time: The time the comment was last updated - `redacted-at` string, date-time, nullable: The time the comment was redacted, or null if it has not been redacted. A redacted comment keeps its identifiers and timestamps but its message is cleared. - `commenter-id` string: The ID of the user who made the comment - `commenter-type` string: The type of the commenter - object: A Case Template object - `type` 'case-template', required: Discriminator value: case-template - `id` string: Unique identifier for the Case Template - `attributes` CasesIncludedObjectsItemsDiscriminatorMappingCaseTemplateAttributes - `status` string: Possible values: - active - archived Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `name` string - `resolutions` string[] - `created-at` string, date-time: The time the template was created - `updated-at` string, date-time, nullable: The time the template was last updated - `archived-at` string, date-time, nullable: The time the template was archived - `field-schemas` FieldSchema[] - union - … - object: A Case Queue object - `type` 'case-queue', required: Discriminator value: case-queue - `id` string: Unique identifier for the Case Queue - `attributes` CasesIncludedObjectsItemsDiscriminatorMappingCaseQueueAttributes - `status` string: Possible values: - active - archived Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `name` string - `created-at` string, date-time: The time the queue was created - `updated-at` string, date-time, nullable: The time the queue was last updated - `archived-at` string, date-time, nullable: The time the queue was archived - 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. Keys in `fields` are **not** key inflected. - `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 - … - `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 Address Lookup Report - `type` 'report/address-lookup', required: Discriminator value: report/address-lookup - `id` string: The ID of the report - `attributes` ReportDiscriminatorMappingReportAddressLookupAttributes - `status` string: The status of the report Possible values: - pending - ready - errored Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `created-at` string: The time the report was created in ISO 8601 format - `completed-at` string, nullable: The time the report completed processing in ISO 8601 format - `redacted-at` string, nullable: The time the report was redacted in ISO 8601 format - `report-template-version-name` string: The name of the report template version used for this report - `has-match` boolean: Whether or not the report matched - `is-continuous` boolean: Whether or not this report has been run more than once - `is-recurring` boolean: Whether or not this report is scheduled to run in the future - `tags` string[]: Tags on the report - `addressee` string, nullable: The name of an individual at this location. - `address-street-1` string, nullable: Address line 1 (e.g., street, PO Box, or company name). - `address-street-2` string, nullable: Address line 2 (e.g., apartment, suite, unit, or building). - `address-city` string, nullable: City - `address-subdivision` string, nullable: Subnational division of a country, such as a state or province. - `address-postal-code` string, nullable: ZIP or postal code. - `resolved-addressee` string, nullable - `resolved-address-street-1` string, nullable - `resolved-address-street-2` string, nullable - `resolved-address-city` string, nullable - `resolved-address-subdivision` string, nullable - `resolved-address-postal-code` string, nullable - `metadata-record-type` string, nullable - `metadata-zip-type` string, nullable - `metadata-county-fips` string, nullable - `metadata-county-name` string, nullable - `metadata-carrier-route` string, nullable - `metadata-carrier-route-type` string, nullable - `metadata-congressional-district` string, nullable - `metadata-building-default-indicator` string, nullable - `metadata-residential-delivery-indicator` string, nullable - `metadata-latitude` number, double, nullable - `metadata-longitude` number, double, nullable - `metadata-precision` string, nullable - `metadata-time-zone` string, nullable - `metadata-utc-offset` integer, nullable - `metadata-obeys-daylight-savings` boolean, nullable - `analysis-dpv-match-code` string, nullable - `analysis-dpv-match-code-decoded` string, nullable - `analysis-dpv-footnotes` string[], nullable - `analysis-dpv-footnotes-decoded` string[], nullable - `analysis-dpv-cmra` string, nullable - `analysis-dpv-vacant` string, nullable - `analysis-active` string, nullable - `analysis-footnotes` string[], nullable - `analysis-footnotes-decoded` string[], nullable - `analysis-lacs-link-code` string, nullable - `analysis-lacs-link-code-decoded` string, nullable - `analysis-lacs-link-indicator` string, nullable - `analysis-lacs-link-indicator-decoded` string, nullable - `analysis-suite-link-match` string, nullable - `metadata-ews-match` string, nullable - `error-message` string, nullable - `relationships` ReportSharedRelationships: Other Persona objects related to the report - `inquiry` ReportSharedRelationshipsInquiry: The inquiry linked to the report - `data` ReportSharedRelationshipsInquiryData - … - `account` ReportSharedRelationshipsAccount: The report's home account, or the first linked account when it has no home account. It returns only one account and is kept for backwards compatibility; use `accounts` to see every associated account. Including it does not require the `account.read` permission. - `data` ReportSharedRelationshipsAccountData - … - `accounts` ReportSharedRelationshipsAccounts: Every account associated with the report, meaning its home account plus all linked accounts, deduplicated and listed in account creation order. Use this when a report can be linked to more than one account; `account` is kept for backwards compatibility and returns only one. The list is not paginated or capped, and is empty when the report has no accounts. Expanding it with `include=accounts` requires the `account.read` permission; the linkage ids do not. - `data` ReportSharedRelationshipsAccountsDataItems[], required - … - `transaction` ReportSharedRelationshipsTransaction: The transaction linked to the report - `data` ReportSharedRelationshipsTransactionData - … - `report-template` ReportSharedRelationshipsReportTemplate: The report template used to create this report - `data` ReportSharedRelationshipsReportTemplateData - … - object: An Adverse Media Report - `type` 'report/adverse-media', required: Discriminator value: report/adverse-media - `id` string: The ID of the report - `attributes` ReportDiscriminatorMappingReportAdverseMediaAttributes - `status` string: The status of the report Possible values: - pending - ready - errored Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `created-at` string: The time the report was created in ISO 8601 format - `completed-at` string, nullable: The time the report completed processing in ISO 8601 format - `redacted-at` string, nullable: The time the report was redacted in ISO 8601 format - `report-template-version-name` string: The name of the report template version used for this report - `has-match` boolean: Whether or not the report matched - `is-continuous` boolean: Whether or not this report has been run more than once - `is-recurring` boolean: Whether or not this report is scheduled to run in the future - `tags` string[]: Tags on the report - `name-first` string, nullable: The input first name of the search individual - `name-middle` string, nullable: The input middle name of the search individual - `name-last` string, nullable: The input last name of the search individual - `term` string: The input combined term used for searching (first + middle + last name) - `birthdate-year` integer, nullable - `birthdate` string, nullable: The input DOB in YYYY-MM-DD format - `country-code` string, nullable: The input search country in alpha2 format - `related-sources` ReportDiscriminatorMappingReportAdverseMediaAttributesRelatedSourcesItems[]: The sources that matched for the search - `akas` string[] - `birthdates` string[] - `match-types` string[] - `media` ReportDiscriminatorMappingReportAdverseMediaAttributesRelatedSourcesItemsMediaItems[] - … - `name` string - `sources` ReportDiscriminatorMappingReportAdverseMediaAttributesRelatedSourcesItemsSourcesItems[] - … - `entity-id` string - `ignore-list-media` object - `ignore-list-entity` object[] - `relationships` ReportSharedRelationships: Other Persona objects related to the report - `inquiry` ReportSharedRelationshipsInquiry: The inquiry linked to the report - `data` ReportSharedRelationshipsInquiryData - … - `account` ReportSharedRelationshipsAccount: The report's home account, or the first linked account when it has no home account. It returns only one account and is kept for backwards compatibility; use `accounts` to see every associated account. Including it does not require the `account.read` permission. - `data` ReportSharedRelationshipsAccountData - … - `accounts` ReportSharedRelationshipsAccounts: Every account associated with the report, meaning its home account plus all linked accounts, deduplicated and listed in account creation order. Use this when a report can be linked to more than one account; `account` is kept for backwards compatibility and returns only one. The list is not paginated or capped, and is empty when the report has no accounts. Expanding it with `include=accounts` requires the `account.read` permission; the linkage ids do not. - `data` ReportSharedRelationshipsAccountsDataItems[], required - … - `transaction` ReportSharedRelationshipsTransaction: The transaction linked to the report - `data` ReportSharedRelationshipsTransactionData - … - `report-template` ReportSharedRelationshipsReportTemplate: The report template used to create this report - `data` ReportSharedRelationshipsReportTemplateData - … - object: A report detailing adverse media findings for a business entity. - `type` 'report/business-adverse-media', required: Discriminator value: report/business-adverse-media - `id` string, required: A unique identifier for the report. - `attributes` ReportDiscriminatorMappingReportBusinessAdverseMediaAttributes, required - `status` string: The status of the report Possible values: - pending - ready - errored Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `created-at` string: The time the report was created in ISO 8601 format - `completed-at` string, nullable: The time the report completed processing in ISO 8601 format - `redacted-at` string, nullable: The time the report was redacted in ISO 8601 format - `report-template-version-name` string: The name of the report template version used for this report - `has-match` boolean: Whether or not the report matched - `is-continuous` boolean: Whether or not this report has been run more than once - `is-recurring` boolean: Whether or not this report is scheduled to run in the future - `tags` string[]: Tags on the report - `term` string: The search term for the adverse media report, typically the name of the business. - `related-sources` ReportDiscriminatorMappingReportBusinessAdverseMediaAttributesRelatedSourcesItems[]: The sources that matched for the search - `akas` string[] - `birthdates` string[] - `media` ReportDiscriminatorMappingReportBusinessAdverseMediaAttributesRelatedSourcesItemsMediaItems[] - … - `name` string - `sources` ReportDiscriminatorMappingReportBusinessAdverseMediaAttributesRelatedSourcesItemsSourcesItems[] - … - `id` string - `match_types` string[] - `ignore-list-media` ReportBusinessAdverseMediaIgnoreListEntry[]: Media that have been individually dismissed for a matched entity. - `entity-id` string - `ignored-at` string, date-time - `run-history-completed-at` string, date-time, nullable - `match` ReportBusinessAdverseMediaMatch: A match that was found (and may have been dismissed) for a Business Adverse Media report - … - `ignore-reason` string, nullable - `user` string - `ignore-list-entity` ReportBusinessAdverseMediaIgnoreListEntry[]: Entities that have been fully dismissed, and the details of that dismissal. - `entity-id` string - `ignored-at` string, date-time - `run-history-completed-at` string, date-time, nullable - `match` ReportBusinessAdverseMediaMatch: A match that was found (and may have been dismissed) for a Business Adverse Media report - … - `ignore-reason` string, nullable - `user` string - `query` ReportDiscriminatorMappingReportBusinessAdverseMediaAttributesQuery - `business-name` string: The name of the business being queried. - `address-street` string: The street address of the business being queried. - `address-city` string: The city in which the business is located. - `address-state` string: Subnational division of a country (such as a state or province) where the business is located. - `address-country` string: The country in which the business is located. - `incorporation-date` string, date: The date the business was incorporated. - `result` ReportDiscriminatorMappingReportBusinessAdverseMediaAttributesResult - `adverse-media` ReportDiscriminatorMappingReportBusinessAdverseMediaAttributesResultAdverseMediaItems[]: A list of adverse media articles related to the business. - … - `relationships` ReportSharedRelationships: Other Persona objects related to the report - `inquiry` ReportSharedRelationshipsInquiry: The inquiry linked to the report - `data` ReportSharedRelationshipsInquiryData - … - `account` ReportSharedRelationshipsAccount: The report's home account, or the first linked account when it has no home account. It returns only one account and is kept for backwards compatibility; use `accounts` to see every associated account. Including it does not require the `account.read` permission. - `data` ReportSharedRelationshipsAccountData - … - `accounts` ReportSharedRelationshipsAccounts: Every account associated with the report, meaning its home account plus all linked accounts, deduplicated and listed in account creation order. Use this when a report can be linked to more than one account; `account` is kept for backwards compatibility and returns only one. The list is not paginated or capped, and is empty when the report has no accounts. Expanding it with `include=accounts` requires the `account.read` permission; the linkage ids do not. - `data` ReportSharedRelationshipsAccountsDataItems[], required - … - `transaction` ReportSharedRelationshipsTransaction: The transaction linked to the report - `data` ReportSharedRelationshipsTransactionData - … - `report-template` ReportSharedRelationshipsReportTemplate: The report template used to create this report - `data` ReportSharedRelationshipsReportTemplateData - … - object: A report containing information about the Associated Persons of a business entity - `type` 'report/business-associated-persons', required: Discriminator value: report/business-associated-persons - `id` string, required: A unique identifier for the report. - `attributes` ReportDiscriminatorMappingReportBusinessAssociatedPersonsAttributes, required - `status` string: The status of the report Possible values: - pending - ready - errored Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `created-at` string: The time the report was created in ISO 8601 format - `completed-at` string, nullable: The time the report completed processing in ISO 8601 format - `redacted-at` string, nullable: The time the report was redacted in ISO 8601 format - `report-template-version-name` string: The name of the report template version used for this report - `has-match` boolean: Whether or not the report matched - `is-continuous` boolean: Whether or not this report has been run more than once - `is-recurring` boolean: Whether or not this report is scheduled to run in the future - `tags` string[]: Tags on the report - `query` ReportDiscriminatorMappingReportBusinessAssociatedPersonsAttributesQuery, required - `address-country-code` string, required: The country code used for the search - `associated-persons` ReportDiscriminatorMappingReportBusinessAssociatedPersonsAttributesAssociatedPersonsItems[], required: List of persons associated with the business - `names` ReportDiscriminatorMappingReportBusinessAssociatedPersonsAttributesAssociatedPersonsItemsNamesItems[], required: Names associated with the person - … - `positions` ReportDiscriminatorMappingReportBusinessAssociatedPersonsAttributesAssociatedPersonsItemsPositionsItems[], required: Positions held by the person - … - `ownership-information` ReportDiscriminatorMappingReportBusinessAssociatedPersonsAttributesOwnershipInformation, required: Ownership information for the business - `owners` ReportDiscriminatorMappingReportBusinessAssociatedPersonsAttributesOwnershipInformationOwnersItems[], required: List of owners. Empty when no ownership data is available. - … - `relationships` ReportSharedRelationships: Other Persona objects related to the report - `inquiry` ReportSharedRelationshipsInquiry: The inquiry linked to the report - `data` ReportSharedRelationshipsInquiryData - … - `account` ReportSharedRelationshipsAccount: The report's home account, or the first linked account when it has no home account. It returns only one account and is kept for backwards compatibility; use `accounts` to see every associated account. Including it does not require the `account.read` permission. - `data` ReportSharedRelationshipsAccountData - … - `accounts` ReportSharedRelationshipsAccounts: Every account associated with the report, meaning its home account plus all linked accounts, deduplicated and listed in account creation order. Use this when a report can be linked to more than one account; `account` is kept for backwards compatibility and returns only one. The list is not paginated or capped, and is empty when the report has no accounts. Expanding it with `include=accounts` requires the `account.read` permission; the linkage ids do not. - `data` ReportSharedRelationshipsAccountsDataItems[], required - … - `transaction` ReportSharedRelationshipsTransaction: The transaction linked to the report - `data` ReportSharedRelationshipsTransactionData - … - `report-template` ReportSharedRelationshipsReportTemplate: The report template used to create this report - `data` ReportSharedRelationshipsReportTemplateData - … - object: A report containing business registration information from official sources - `type` 'report/business-registrations-lookup', required: Discriminator value: report/business-registrations-lookup - `id` string, required: A unique identifier for the report. - `attributes` ReportDiscriminatorMappingReportBusinessRegistrationsLookupAttributes, required - `status` string: The status of the report Possible values: - pending - ready - errored Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `created-at` string: The time the report was created in ISO 8601 format - `completed-at` string, nullable: The time the report completed processing in ISO 8601 format - `redacted-at` string, nullable: The time the report was redacted in ISO 8601 format - `report-template-version-name` string: The name of the report template version used for this report - `has-match` boolean: Whether or not the report matched - `is-continuous` boolean: Whether or not this report has been run more than once - `is-recurring` boolean: Whether or not this report is scheduled to run in the future - `tags` string[]: Tags on the report - `query` ReportDiscriminatorMappingReportBusinessRegistrationsLookupAttributesQuery, required - `address-country-code` string, required: The country code used for the search - `result` ReportDiscriminatorMappingReportBusinessRegistrationsLookupAttributesResult, required - `business-name` string: The name of the business - `legal-entity-type` string: The type of legal entity - `formation-country` string: The country where the business was formed - `formation-subdivision` string: The subdivision where the business was formed - `formation-date` string, date: The date the business was formed - `registry-records` ReportDiscriminatorMappingReportBusinessRegistrationsLookupAttributesResultRegistryRecordsItems[]: List of business registration records - … - `relationships` ReportSharedRelationships: Other Persona objects related to the report - `inquiry` ReportSharedRelationshipsInquiry: The inquiry linked to the report - `data` ReportSharedRelationshipsInquiryData - … - `account` ReportSharedRelationshipsAccount: The report's home account, or the first linked account when it has no home account. It returns only one account and is kept for backwards compatibility; use `accounts` to see every associated account. Including it does not require the `account.read` permission. - `data` ReportSharedRelationshipsAccountData - … - `accounts` ReportSharedRelationshipsAccounts: Every account associated with the report, meaning its home account plus all linked accounts, deduplicated and listed in account creation order. Use this when a report can be linked to more than one account; `account` is kept for backwards compatibility and returns only one. The list is not paginated or capped, and is empty when the report has no accounts. Expanding it with `include=accounts` requires the `account.read` permission; the linkage ids do not. - `data` ReportSharedRelationshipsAccountsDataItems[], required - … - `transaction` ReportSharedRelationshipsTransaction: The transaction linked to the report - `data` ReportSharedRelationshipsTransactionData - … - `report-template` ReportSharedRelationshipsReportTemplate: The report template used to create this report - `data` ReportSharedRelationshipsReportTemplateData - … - object: A Business Lookup Report - `type` 'report/business-lookup', required: Discriminator value: report/business-lookup - `id` string: The ID of the report - `attributes` ReportDiscriminatorMappingReportBusinessLookupAttributes - `status` string: The status of the report Possible values: - pending - ready - errored Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `created-at` string: The time the report was created in ISO 8601 format - `completed-at` string, nullable: The time the report completed processing in ISO 8601 format - `redacted-at` string, nullable: The time the report was redacted in ISO 8601 format - `report-template-version-name` string: The name of the report template version used for this report - `has-match` boolean: Whether or not the report matched - `is-continuous` boolean: Whether or not this report has been run more than once - `is-recurring` boolean: Whether or not this report is scheduled to run in the future - `tags` string[]: Tags on the report - `query` ReportDiscriminatorMappingReportBusinessLookupAttributesQuery - `business-name` string - `phone-number` string, nullable - `website` string, nullable - `ein` string, nullable - `address-street-1` string - `address-street-2` string, nullable - `address-city` string - `address-subdivision` string: Subnational division of a country such as a US state. - `address-postal-code` string - `address-country-code` string, nullable - `incorporation-state` string, nullable - `associated-people` ReportDiscriminatorMappingReportBusinessLookupAttributesQueryAssociatedPeopleItems[] - … - `result` ReportDiscriminatorMappingReportBusinessLookupAttributesResult - `name` string - `aliases` string[] - `description` string, nullable - `legal-status` string, nullable - `legal-entity-type` string - `date-of-incorporation` ReportDiscriminatorMappingReportBusinessLookupAttributesResultDateOfIncorporation - … - `industry-classifications` ReportDiscriminatorMappingReportBusinessLookupAttributesResultIndustryClassificationsItems[] - … - `identifiers` ReportDiscriminatorMappingReportBusinessLookupAttributesResultIdentifiersItems[] - … - `addresses` ReportDiscriminatorMappingReportBusinessLookupAttributesResultAddressesItems[] - … - `websites` string[] - `phone-numbers` string[] - `agents` ReportDiscriminatorMappingReportBusinessLookupAttributesResultAgentsItems[] - … - `officers` ReportDiscriminatorMappingReportBusinessLookupAttributesResultOfficersItems[] - … - `headcount` string, nullable - `sources` ReportDiscriminatorMappingReportBusinessLookupAttributesResultSourcesItems[] - … - `match-status-strength` string, nullable: Possible values: - not_applicable - match - partial_match - no_match - unavailable - unknown Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `match-status-business-name` string, nullable: Possible values: - not_applicable - match - partial_match - no_match - unavailable - unknown Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `match-status-address` string, nullable: Possible values: - not_applicable - match - partial_match - no_match - unavailable - unknown Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `match-status-address-street` string, nullable: Possible values: - not_applicable - match - partial_match - no_match - unavailable - unknown Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `match-status-address-city` string, nullable: Possible values: - not_applicable - match - partial_match - no_match - unavailable - unknown Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `match-status-address-postal-code` string, nullable: Possible values: - not_applicable - match - partial_match - no_match - unavailable - unknown Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `match-status-address-subdivision` string, nullable: Possible values: - not_applicable - match - partial_match - no_match - unavailable - unknown Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `match-status-phone-number` string, nullable: Possible values: - not_applicable - match - partial_match - no_match - unavailable - unknown Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `match-status-ein` string, nullable: Possible values: - not_applicable - match - partial_match - no_match - unavailable - unknown Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `match-status-associated-person` string, nullable: Possible values: - not_applicable - match - partial_match - no_match - unavailable - unknown Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `match-status-website` string, nullable: Possible values: - not_applicable - match - partial_match - no_match - unavailable - unknown Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `relationships` ReportSharedRelationships: Other Persona objects related to the report - `inquiry` ReportSharedRelationshipsInquiry: The inquiry linked to the report - `data` ReportSharedRelationshipsInquiryData - … - `account` ReportSharedRelationshipsAccount: The report's home account, or the first linked account when it has no home account. It returns only one account and is kept for backwards compatibility; use `accounts` to see every associated account. Including it does not require the `account.read` permission. - `data` ReportSharedRelationshipsAccountData - … - `accounts` ReportSharedRelationshipsAccounts: Every account associated with the report, meaning its home account plus all linked accounts, deduplicated and listed in account creation order. Use this when a report can be linked to more than one account; `account` is kept for backwards compatibility and returns only one. The list is not paginated or capped, and is empty when the report has no accounts. Expanding it with `include=accounts` requires the `account.read` permission; the linkage ids do not. - `data` ReportSharedRelationshipsAccountsDataItems[], required - … - `transaction` ReportSharedRelationshipsTransaction: The transaction linked to the report - `data` ReportSharedRelationshipsTransactionData - … - `report-template` ReportSharedRelationshipsReportTemplate: The report template used to create this report - `data` ReportSharedRelationshipsReportTemplateData - … - object: A Business Media Coverage Report - `type` 'report/business-media-coverage', required: Discriminator value: report/business-media-coverage - `id` string: The ID of the report - `attributes` ReportDiscriminatorMappingReportBusinessMediaCoverageAttributes - `status` string: The status of the report Possible values: - pending - ready - errored Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `created-at` string: The time the report was created in ISO 8601 format - `completed-at` string, nullable: The time the report completed processing in ISO 8601 format - `redacted-at` string, nullable: The time the report was redacted in ISO 8601 format - `report-template-version-name` string: The name of the report template version used for this report - `has-match` boolean: Whether or not the report matched - `is-continuous` boolean: Whether or not this report has been run more than once - `is-recurring` boolean: Whether or not this report is scheduled to run in the future - `tags` string[]: Tags on the report - `query` ReportDiscriminatorMappingReportBusinessMediaCoverageAttributesQuery - `business-name` string, nullable - `website` string, nullable - `address-street-1` string, nullable - `address-street-2` string, nullable - `address-city` string, nullable - `address-subdivision` string, nullable - `address-postal-code` string, nullable - `address-country-code` string, nullable - `result` ReportDiscriminatorMappingReportBusinessMediaCoverageAttributesResult - `homepage` string, nullable: The homepage of the business, if found. - `summary` string, nullable: A summary of the media coverage found for the business. - `topics` ReportDiscriminatorMappingReportBusinessMediaCoverageAttributesResultTopicsItems[]: Media coverage grouped by topic. - … - `irrelevant-articles` ReportBusinessMediaCoverageArticle[]: Articles excluded because they are not about the queried business. - … - `nonreputable-articles` ReportBusinessMediaCoverageArticle[]: Articles excluded because their source is not reputable. - … - `out-of-range-articles` ReportBusinessMediaCoverageArticle[]: Articles excluded because they fall outside the template's article age window. - … - `error-message` string, nullable: Set when the report errored. - `relationships` ReportSharedRelationships: Other Persona objects related to the report - `inquiry` ReportSharedRelationshipsInquiry: The inquiry linked to the report - `data` ReportSharedRelationshipsInquiryData - … - `account` ReportSharedRelationshipsAccount: The report's home account, or the first linked account when it has no home account. It returns only one account and is kept for backwards compatibility; use `accounts` to see every associated account. Including it does not require the `account.read` permission. - `data` ReportSharedRelationshipsAccountData - … - `accounts` ReportSharedRelationshipsAccounts: Every account associated with the report, meaning its home account plus all linked accounts, deduplicated and listed in account creation order. Use this when a report can be linked to more than one account; `account` is kept for backwards compatibility and returns only one. The list is not paginated or capped, and is empty when the report has no accounts. Expanding it with `include=accounts` requires the `account.read` permission; the linkage ids do not. - `data` ReportSharedRelationshipsAccountsDataItems[], required - … - `transaction` ReportSharedRelationshipsTransaction: The transaction linked to the report - `data` ReportSharedRelationshipsTransactionData - … - `report-template` ReportSharedRelationshipsReportTemplate: The report template used to create this report - `data` ReportSharedRelationshipsReportTemplateData - … - object: A Business Nonprofit Report - `type` 'report/business-nonprofit', required: Discriminator value: report/business-nonprofit - `id` string: The ID of the report - `attributes` ReportDiscriminatorMappingReportBusinessNonprofitAttributes - `status` string: The status of the report Possible values: - pending - ready - errored Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `created-at` string: The time the report was created in ISO 8601 format - `completed-at` string, nullable: The time the report completed processing in ISO 8601 format - `redacted-at` string, nullable: The time the report was redacted in ISO 8601 format - `report-template-version-name` string: The name of the report template version used for this report - `has-match` boolean: Whether or not the report matched - `is-continuous` boolean: Whether or not this report has been run more than once - `is-recurring` boolean: Whether or not this report is scheduled to run in the future - `tags` string[]: Tags on the report - `query` ReportDiscriminatorMappingReportBusinessNonprofitAttributesQuery - `ein` string: The Employer Identification Number used to search for the nonprofit. - `result` ReportDiscriminatorMappingReportBusinessNonprofitAttributesResult - `organization-name` string, nullable: The legal name of the nonprofit. - `organization-name-aka` string, nullable: Other names associated with the nonprofit. - `address` ReportDiscriminatorMappingReportBusinessNonprofitAttributesResultAddress - … - `foundation-type-code` string, nullable - `foundation-type-description` string, nullable - `irs-filing-requirement-code` string, nullable - `irs-pub-78-details` ReportDiscriminatorMappingReportBusinessNonprofitAttributesResultIrsPub78Details - … - `irs-bmf-details` ReportDiscriminatorMappingReportBusinessNonprofitAttributesResultIrsBmfDetails - … - `ca-ag-details` ReportDiscriminatorMappingReportBusinessNonprofitAttributesResultCaAgDetails - … - `ca-ftb-details` ReportDiscriminatorMappingReportBusinessNonprofitAttributesResultCaFtbDetails - … - `relationships` ReportSharedRelationships: Other Persona objects related to the report - `inquiry` ReportSharedRelationshipsInquiry: The inquiry linked to the report - `data` ReportSharedRelationshipsInquiryData - … - `account` ReportSharedRelationshipsAccount: The report's home account, or the first linked account when it has no home account. It returns only one account and is kept for backwards compatibility; use `accounts` to see every associated account. Including it does not require the `account.read` permission. - `data` ReportSharedRelationshipsAccountData - … - `accounts` ReportSharedRelationshipsAccounts: Every account associated with the report, meaning its home account plus all linked accounts, deduplicated and listed in account creation order. Use this when a report can be linked to more than one account; `account` is kept for backwards compatibility and returns only one. The list is not paginated or capped, and is empty when the report has no accounts. Expanding it with `include=accounts` requires the `account.read` permission; the linkage ids do not. - `data` ReportSharedRelationshipsAccountsDataItems[], required - … - `transaction` ReportSharedRelationshipsTransaction: The transaction linked to the report - `data` ReportSharedRelationshipsTransactionData - … - `report-template` ReportSharedRelationshipsReportTemplate: The report template used to create this report - `data` ReportSharedRelationshipsReportTemplateData - … - object: A Business Search Report - `type` 'report/business-search', required: Discriminator value: report/business-search - `id` string: The ID of the report - `attributes` ReportDiscriminatorMappingReportBusinessSearchAttributes - `status` string: The status of the report Possible values: - pending - ready - errored Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `created-at` string: The time the report was created in ISO 8601 format - `completed-at` string, nullable: The time the report completed processing in ISO 8601 format - `redacted-at` string, nullable: The time the report was redacted in ISO 8601 format - `report-template-version-name` string: The name of the report template version used for this report - `has-match` boolean: Whether or not the report matched - `is-continuous` boolean: Whether or not this report has been run more than once - `is-recurring` boolean: Whether or not this report is scheduled to run in the future - `tags` string[]: Tags on the report - `query` ReportDiscriminatorMappingReportBusinessSearchAttributesQuery - `country-code` string - `business-name` string, nullable - `registration-number` string, nullable - `address-street-1` string, nullable - `address-street-2` string, nullable - `address-city` string, nullable - `address-subdivision` string, nullable - `address-postal-code` string, nullable - `max-results` integer - `result` ReportDiscriminatorMappingReportBusinessSearchAttributesResult - `error` string, nullable: Set when the search could not be completed. Vendor error detail is not exposed. - `businesses` ReportDiscriminatorMappingReportBusinessSearchAttributesResultBusinessesItems[]: Candidate businesses matching the query, most relevant first. - … - `relationships` ReportSharedRelationships: Other Persona objects related to the report - `inquiry` ReportSharedRelationshipsInquiry: The inquiry linked to the report - `data` ReportSharedRelationshipsInquiryData - … - `account` ReportSharedRelationshipsAccount: The report's home account, or the first linked account when it has no home account. It returns only one account and is kept for backwards compatibility; use `accounts` to see every associated account. Including it does not require the `account.read` permission. - `data` ReportSharedRelationshipsAccountData - … - `accounts` ReportSharedRelationshipsAccounts: Every account associated with the report, meaning its home account plus all linked accounts, deduplicated and listed in account creation order. Use this when a report can be linked to more than one account; `account` is kept for backwards compatibility and returns only one. The list is not paginated or capped, and is empty when the report has no accounts. Expanding it with `include=accounts` requires the `account.read` permission; the linkage ids do not. - `data` ReportSharedRelationshipsAccountsDataItems[], required - … - `transaction` ReportSharedRelationshipsTransaction: The transaction linked to the report - `data` ReportSharedRelationshipsTransactionData - … - `report-template` ReportSharedRelationshipsReportTemplate: The report template used to create this report - `data` ReportSharedRelationshipsReportTemplateData - … - object: A Business Watchlist Report - `type` 'report/business-watchlist', required: Discriminator value: report/business-watchlist - `id` string: The ID of the report - `attributes` ReportDiscriminatorMappingReportBusinessWatchlistAttributes - `status` string: The status of the report Possible values: - pending - ready - errored Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `created-at` string: The time the report was created in ISO 8601 format - `completed-at` string, nullable: The time the report completed processing in ISO 8601 format - `redacted-at` string, nullable: The time the report was redacted in ISO 8601 format - `report-template-version-name` string: The name of the report template version used for this report - `has-match` boolean: Whether or not the report matched - `is-continuous` boolean: Whether or not this report has been run more than once - `is-recurring` boolean: Whether or not this report is scheduled to run in the future - `tags` string[]: Tags on the report - `term` string, nullable: The search term for the business watchlist report, typically the name of the business. - `matched-lists` string[]: A list of slugs identifying the lists on which matches were found. - `sanction-list` ReportDiscriminatorMappingReportBusinessWatchlistAttributesSanctionListItems[]: Detailed information about matches found on sanction lists. - `name` string: The name of the sanction list. - `url` string, uri: A URL with more information about the list. - `fitness-probity-list` ReportDiscriminatorMappingReportBusinessWatchlistAttributesFitnessProbityListItems[]: Detailed information about matches found on fitness and probity lists. - `name` string: The name of the fitness and probity list. - `url` string, uri: A URL with more information about the list. - `warning-list` ReportDiscriminatorMappingReportBusinessWatchlistAttributesWarningListItems[]: Detailed information about matches found on warning lists. - `name` string: The name of the warning list. - `url` string, uri: A URL with more information about the list. - `ignore-list` ReportDiscriminatorMappingReportBusinessWatchlistAttributesIgnoreListItems[]: Matches that have been dismissed, and the details of that dismissal. - `ignored-at` string, date-time - `run-history-completed-at` string, date-time, nullable - `match` ReportDiscriminatorMappingReportBusinessWatchlistAttributesIgnoreListItemsMatch - … - `user` string - `ignore-reason` string, nullable - `run-history` ReportDiscriminatorMappingReportBusinessWatchlistAttributesRunHistoryItems[]: Deprecated and no longer populated. Use the [List Report History](https://docs.withpersona.com/api-reference/reports/list-report-history) endpoint instead. - `scheduled-at` string, date-time, nullable - `completed-at` string, date-time, nullable - `type` string, nullable: The type of report run Possible values: - scheduled - manual Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `report-template-version-id` integer, nullable - `relationships` ReportSharedRelationships: Other Persona objects related to the report - `inquiry` ReportSharedRelationshipsInquiry: The inquiry linked to the report - `data` ReportSharedRelationshipsInquiryData - … - `account` ReportSharedRelationshipsAccount: The report's home account, or the first linked account when it has no home account. It returns only one account and is kept for backwards compatibility; use `accounts` to see every associated account. Including it does not require the `account.read` permission. - `data` ReportSharedRelationshipsAccountData - … - `accounts` ReportSharedRelationshipsAccounts: Every account associated with the report, meaning its home account plus all linked accounts, deduplicated and listed in account creation order. Use this when a report can be linked to more than one account; `account` is kept for backwards compatibility and returns only one. The list is not paginated or capped, and is empty when the report has no accounts. Expanding it with `include=accounts` requires the `account.read` permission; the linkage ids do not. - `data` ReportSharedRelationshipsAccountsDataItems[], required - … - `transaction` ReportSharedRelationshipsTransaction: The transaction linked to the report - `data` ReportSharedRelationshipsTransactionData - … - `report-template` ReportSharedRelationshipsReportTemplate: The report template used to create this report - `data` ReportSharedRelationshipsReportTemplateData - … - object: A Crypto Address Watchlist Report - `type` 'report/crypto-address-watchlist', required: Discriminator value: report/crypto-address-watchlist - `id` string: The ID of the report - `attributes` ReportDiscriminatorMappingReportCryptoAddressWatchlistAttributes - `status` string: The status of the report Possible values: - pending - ready - errored Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `created-at` string: The time the report was created in ISO 8601 format - `completed-at` string, nullable: The time the report completed processing in ISO 8601 format - `redacted-at` string, nullable: The time the report was redacted in ISO 8601 format - `report-template-version-name` string: The name of the report template version used for this report - `has-match` boolean: Whether or not the report matched - `is-continuous` boolean: Whether or not this report has been run more than once - `is-recurring` boolean: Whether or not this report is scheduled to run in the future - `tags` string[]: Tags on the report - `query` ReportDiscriminatorMappingReportCryptoAddressWatchlistAttributesQuery - `crypto-address` string - `result` ReportDiscriminatorMappingReportCryptoAddressWatchlistAttributesResultItems[], nullable - `name` string - `url` string - `list-type` string - `slug` string - `flag-code` string - `entities` ReportDiscriminatorMappingReportCryptoAddressWatchlistAttributesResultItemsEntitiesItems[] - … - `relationships` ReportSharedRelationships: Other Persona objects related to the report - `inquiry` ReportSharedRelationshipsInquiry: The inquiry linked to the report - `data` ReportSharedRelationshipsInquiryData - … - `account` ReportSharedRelationshipsAccount: The report's home account, or the first linked account when it has no home account. It returns only one account and is kept for backwards compatibility; use `accounts` to see every associated account. Including it does not require the `account.read` permission. - `data` ReportSharedRelationshipsAccountData - … - `accounts` ReportSharedRelationshipsAccounts: Every account associated with the report, meaning its home account plus all linked accounts, deduplicated and listed in account creation order. Use this when a report can be linked to more than one account; `account` is kept for backwards compatibility and returns only one. The list is not paginated or capped, and is empty when the report has no accounts. Expanding it with `include=accounts` requires the `account.read` permission; the linkage ids do not. - `data` ReportSharedRelationshipsAccountsDataItems[], required - … - `transaction` ReportSharedRelationshipsTransaction: The transaction linked to the report - `data` ReportSharedRelationshipsTransactionData - … - `report-template` ReportSharedRelationshipsReportTemplate: The report template used to create this report - `data` ReportSharedRelationshipsReportTemplateData - … - object: An Email Address Report - `type` 'report/email-address', required: Discriminator value: report/email-address - `id` string: The ID of the report - `attributes` ReportDiscriminatorMappingReportEmailAddressAttributes - `status` string: The status of the report Possible values: - pending - ready - errored Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `created-at` string: The time the report was created in ISO 8601 format - `completed-at` string, nullable: The time the report completed processing in ISO 8601 format - `redacted-at` string, nullable: The time the report was redacted in ISO 8601 format - `report-template-version-name` string: The name of the report template version used for this report - `has-match` boolean: Whether or not the report matched - `is-continuous` boolean: Whether or not this report has been run more than once - `is-recurring` boolean: Whether or not this report is scheduled to run in the future - `tags` string[]: Tags on the report - `email-address` string: The input email address of the search - `email-reputation` string, nullable: The reputation of the email provided Possible values: - high - medium - low Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `email-reference-count` integer, nullable: The number of sources used to determine the reputation (Deprecated) - `email-domain-reputation` string, nullable: The reputation of the email domain provided (Deprecated) Possible values: - high - medium - low Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `email-first-seen-days` integer, nullable: How many days it has ben since the email was first seen in attack (Deprecated) - `email-last-seen-days` integer, nullable: How many days it has been since the email was last seen (Deprecated) - `email-estimated-age-days` integer, nullable: The estimated age of the email in days - `email-domain-age-days` integer, nullable: The estimated age of the domain in days - `email-credentials-leaked` boolean, nullable: Whether the email has ever been detected to have been leaked (Deprecated) - `email-credentials-leaked-recent` boolean, nullable: Whether the email has been recently detected as leaked - `email-data-breached` boolean, nullable: Whether the email was involved in a data breach (Deprecated) - `email-malicious-activity-detected` boolean, nullable: Whether the email has ever been detected for suspected malicious activity (Deprecated) - `email-malicious-activity-detected-recent` boolean, nullable: Whether the email has recently been detected for suspected malicious activity - `email-is-blocklisted` boolean, nullable: Whether the email appears on blocklists (Deprecated) - `email-is-spam` boolean, nullable: Whether the email is spam or a spam trap - `email-is-free-provider` boolean, nullable: Whether the email was made with a free provider (Deprecated) - `email-is-disposable` boolean, nullable: Whether the email is one that is disposable or temporary - `email-is-deliverable` boolean, nullable: Whether the email is deliverable - `email-is-valid-mx` boolean, nullable: Whether the domain has a valid MX record - `email-is-spoofable` boolean, nullable: Whether the email can be spoofed. (E.G. not a strict SPF policy or DMARC not enforced. Deprecated) - `email-is-spf-strict` boolean, nullable: Whether there is a sufficiently strict SPF record (Deprecated) - `email-is-dmarc-enforced` boolean, nullable: Whether DMARC is configured correctly and enforced (Deprecated) - `age-estimated-13-plus` boolean, nullable: Whether email address user is 13 or older - `age-estimated-15-plus` boolean, nullable: Whether email address user is 15 or older - `age-estimated-16-plus` boolean, nullable: Whether email address user is 16 or older - `age-estimated-18-plus` boolean, nullable: Whether email address user is 18 or older - `email-is-suspicious` boolean, nullable: Whether the email is suspicious or risky - `email-domain-exists` boolean, nullable: Whether the domain of the email exists - `email-domain` string: The domain of the email - `relationships` ReportSharedRelationships: Other Persona objects related to the report - `inquiry` ReportSharedRelationshipsInquiry: The inquiry linked to the report - `data` ReportSharedRelationshipsInquiryData - … - `account` ReportSharedRelationshipsAccount: The report's home account, or the first linked account when it has no home account. It returns only one account and is kept for backwards compatibility; use `accounts` to see every associated account. Including it does not require the `account.read` permission. - `data` ReportSharedRelationshipsAccountData - … - `accounts` ReportSharedRelationshipsAccounts: Every account associated with the report, meaning its home account plus all linked accounts, deduplicated and listed in account creation order. Use this when a report can be linked to more than one account; `account` is kept for backwards compatibility and returns only one. The list is not paginated or capped, and is empty when the report has no accounts. Expanding it with `include=accounts` requires the `account.read` permission; the linkage ids do not. - `data` ReportSharedRelationshipsAccountsDataItems[], required - … - `transaction` ReportSharedRelationshipsTransaction: The transaction linked to the report - `data` ReportSharedRelationshipsTransactionData - … - `report-template` ReportSharedRelationshipsReportTemplate: The report template used to create this report - `data` ReportSharedRelationshipsReportTemplateData - … - object: An IP Address Report. The outcome is exposed through the shared `status` (`ready` or `errored`) and `has-match` attributes; `result.error` describes why an errored report could not complete. - `type` 'report/ip-address', required: Discriminator value: report/ip-address - `id` string: The ID of the report - `attributes` ReportDiscriminatorMappingReportIpAddressAttributes - `status` string: The status of the report Possible values: - pending - ready - errored Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `created-at` string: The time the report was created in ISO 8601 format - `completed-at` string, nullable: The time the report completed processing in ISO 8601 format - `redacted-at` string, nullable: The time the report was redacted in ISO 8601 format - `report-template-version-name` string: The name of the report template version used for this report - `has-match` boolean: Whether or not the report matched - `is-continuous` boolean: Whether or not this report has been run more than once - `is-recurring` boolean: Whether or not this report is scheduled to run in the future - `tags` string[]: Tags on the report - `query` ReportDiscriminatorMappingReportIpAddressAttributesQuery - `ip-address` string: The IP address that was looked up. - `result` ReportDiscriminatorMappingReportIpAddressAttributesResult: IP intelligence for the queried address. Null until the report has been processed. - `service-type` string, nullable: The connection type of the IP address. Known values include RESIDENTIAL, DATACENTER, CORPORATE, MOBILE, EDUCATION, SATELLITE, IN_FLIGHT_WIFI and GOOGLE. Persona may add new values without a versioned update. - `vpn-detected` boolean, nullable: Whether the IP address belongs to a VPN. - `proxy-detected` boolean, nullable: Whether the IP address is a proxy. - `tor-exit-node` string, nullable: Whether the IP address is a Tor exit node. One of MATCHED, CLEARED or ERRORED (the Tor exit list lookup failed). - `datacenter-ip` boolean, nullable: Whether the IP address belongs to a known cloud provider (AWS or GCP). - `isp` string, nullable: The internet service provider of the IP address. - `mobile-ip` boolean, nullable: Whether the IP address belongs to a mobile carrier. - `country-code` string, nullable: The ISO 3166-1 alpha-2 country code of the IP address location. - `country-name` string, nullable: The country name of the IP address location. - `city` string, nullable: The city of the IP address location. - `region-name` string, nullable: The region (subdivision) of the IP address location. - `latitude` string, nullable: The approximate latitude of the IP address location. - `longitude` string, nullable: The approximate longitude of the IP address location. - `error` string, nullable: Set when the IP address lookup could not be completed, in which case the report status is errored. Vendor error detail is not exposed. - `relationships` ReportSharedRelationships: Other Persona objects related to the report - `inquiry` ReportSharedRelationshipsInquiry: The inquiry linked to the report - `data` ReportSharedRelationshipsInquiryData - … - `account` ReportSharedRelationshipsAccount: The report's home account, or the first linked account when it has no home account. It returns only one account and is kept for backwards compatibility; use `accounts` to see every associated account. Including it does not require the `account.read` permission. - `data` ReportSharedRelationshipsAccountData - … - `accounts` ReportSharedRelationshipsAccounts: Every account associated with the report, meaning its home account plus all linked accounts, deduplicated and listed in account creation order. Use this when a report can be linked to more than one account; `account` is kept for backwards compatibility and returns only one. The list is not paginated or capped, and is empty when the report has no accounts. Expanding it with `include=accounts` requires the `account.read` permission; the linkage ids do not. - `data` ReportSharedRelationshipsAccountsDataItems[], required - … - `transaction` ReportSharedRelationshipsTransaction: The transaction linked to the report - `data` ReportSharedRelationshipsTransactionData - … - `report-template` ReportSharedRelationshipsReportTemplate: The report template used to create this report - `data` ReportSharedRelationshipsReportTemplateData - … - object: A Phone Risk Report - `type` 'report/phone-number', required: Discriminator value: report/phone-number - `id` string: The ID of the report - `attributes` ReportDiscriminatorMappingReportPhoneNumberAttributes - `status` string: The status of the report Possible values: - pending - ready - errored Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `created-at` string: The time the report was created in ISO 8601 format - `completed-at` string, nullable: The time the report completed processing in ISO 8601 format - `redacted-at` string, nullable: The time the report was redacted in ISO 8601 format - `report-template-version-name` string: The name of the report template version used for this report - `has-match` boolean: Whether or not the report matched - `is-continuous` boolean: Whether or not this report has been run more than once - `is-recurring` boolean: Whether or not this report is scheduled to run in the future - `tags` string[]: Tags on the report - `phone-number` string: The input phone number of the search - `phone-type` string, nullable: Possible values: - FIXED_LINE - MOBILE - PREPAID - TOLL_FREE - VOIP - PAGER - PAYPHONE - INVALID - RESTRICTED_PREMIUM - PERSONAL - VOICEMAIL - OTHER Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `phone-carrier` string, nullable - `phone-city` string, nullable: City associated with the phone number location. - `phone-subdivision` string, nullable: State or region associated with the phone number location. - `phone-country-code` string, nullable: ISO 3166-1 alpha-2 country code associated with the phone number location. - `phone-risk-level` string, nullable: Assessment of the phone number's risk (low - high) - `phone-risk-recommendation` string, nullable: Possible values: - block - allow - flag Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `phone-risk-score` integer, nullable: Risk score out of 1000 - `phone-risk-sim-swap` string, nullable: The risk of a fraudulent SIM swap Possible values: - very-low - low - medium - high - N/A Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `relationships` ReportSharedRelationships: Other Persona objects related to the report - `inquiry` ReportSharedRelationshipsInquiry: The inquiry linked to the report - `data` ReportSharedRelationshipsInquiryData - … - `account` ReportSharedRelationshipsAccount: The report's home account, or the first linked account when it has no home account. It returns only one account and is kept for backwards compatibility; use `accounts` to see every associated account. Including it does not require the `account.read` permission. - `data` ReportSharedRelationshipsAccountData - … - `accounts` ReportSharedRelationshipsAccounts: Every account associated with the report, meaning its home account plus all linked accounts, deduplicated and listed in account creation order. Use this when a report can be linked to more than one account; `account` is kept for backwards compatibility and returns only one. The list is not paginated or capped, and is empty when the report has no accounts. Expanding it with `include=accounts` requires the `account.read` permission; the linkage ids do not. - `data` ReportSharedRelationshipsAccountsDataItems[], required - … - `transaction` ReportSharedRelationshipsTransaction: The transaction linked to the report - `data` ReportSharedRelationshipsTransactionData - … - `report-template` ReportSharedRelationshipsReportTemplate: The report template used to create this report - `data` ReportSharedRelationshipsReportTemplateData - … - object: A Politically Exposed Person Report - `type` 'report/politically-exposed-person', required: Discriminator value: report/politically-exposed-person - `id` string: The ID of the report - `attributes` ReportDiscriminatorMappingReportPoliticallyExposedPersonAttributes - `status` string: The status of the report Possible values: - pending - ready - errored Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `created-at` string: The time the report was created in ISO 8601 format - `completed-at` string, nullable: The time the report completed processing in ISO 8601 format - `redacted-at` string, nullable: The time the report was redacted in ISO 8601 format - `report-template-version-name` string: The name of the report template version used for this report - `has-match` boolean: Whether or not the report matched - `is-continuous` boolean: Whether or not this report has been run more than once - `is-recurring` boolean: Whether or not this report is scheduled to run in the future - `tags` string[]: Tags on the report - `query` ReportDiscriminatorMappingReportPoliticallyExposedPersonAttributesQuery - `name-first` string, nullable: The input first name of the search individual - `name-middle` string, nullable: The input middle name of the search individual - `name-last` string, nullable: The input last name of the search individual - `term` string: The input combined term used for searching (first + middle + last name). Either the name or the term fields are required. - `birthdate` string: The input DOB in YYYY-MM-DD format - `country-code` string, nullable: The input search country in alpha2 format - `result` ReportDiscriminatorMappingReportPoliticallyExposedPersonAttributesResultItems[], nullable - `entity-id` string - `name` string - `birthdates` string[] - `death-dates` string[] - `locations` string[] - `country` string - `sex` string, nullable - `topics` string[]: The applicable categories of the PEP. - `positions` ReportDiscriminatorMappingReportPoliticallyExposedPersonAttributesResultItemsPositionsItems[] - … - `associates` ReportDiscriminatorMappingReportPoliticallyExposedPersonAttributesResultItemsAssociatesItems[] - … - `affiliations` ReportDiscriminatorMappingReportPoliticallyExposedPersonAttributesResultItemsAffiliationsItems[] - … - `related-urls` ReportDiscriminatorMappingReportPoliticallyExposedPersonAttributesResultItemsRelatedUrlsItems[] - … - `images` string[] - `sources` object: A map of the sources that matched by entity - `match-types` string[] - `pep-type` string, nullable - `ignore-list` ReportDiscriminatorMappingReportPoliticallyExposedPersonAttributesIgnoreListItems[] - `ignored-at` string, date-time: The datetime when the entry was ignored. - `run-history-completed-at` string, date-time: The datetime when the run history was completed. - `match` ReportDiscriminatorMappingReportPoliticallyExposedPersonAttributesIgnoreListItemsMatch - … - `user` string: The user who added the entry to the ignore list. - `ignore-reason` string: The reason why the entry was added to the ignore list. - `is-internal` boolean: Indicates if the ignore list entry is internal. - `run-history` ReportDiscriminatorMappingReportPoliticallyExposedPersonAttributesRunHistoryItems[]: Deprecated and no longer populated. Use the [List Report History](https://docs.withpersona.com/api-reference/reports/list-report-history) endpoint instead. - `scheduled-at` string, date-time, nullable - `completed-at` string, date-time, nullable - `type` string, nullable: The type of report run Possible values: - scheduled - manual Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `report-template-version-id` integer, nullable - `relationships` ReportSharedRelationships: Other Persona objects related to the report - `inquiry` ReportSharedRelationshipsInquiry: The inquiry linked to the report - `data` ReportSharedRelationshipsInquiryData - … - `account` ReportSharedRelationshipsAccount: The report's home account, or the first linked account when it has no home account. It returns only one account and is kept for backwards compatibility; use `accounts` to see every associated account. Including it does not require the `account.read` permission. - `data` ReportSharedRelationshipsAccountData - … - `accounts` ReportSharedRelationshipsAccounts: Every account associated with the report, meaning its home account plus all linked accounts, deduplicated and listed in account creation order. Use this when a report can be linked to more than one account; `account` is kept for backwards compatibility and returns only one. The list is not paginated or capped, and is empty when the report has no accounts. Expanding it with `include=accounts` requires the `account.read` permission; the linkage ids do not. - `data` ReportSharedRelationshipsAccountsDataItems[], required - … - `transaction` ReportSharedRelationshipsTransaction: The transaction linked to the report - `data` ReportSharedRelationshipsTransactionData - … - `report-template` ReportSharedRelationshipsReportTemplate: The report template used to create this report - `data` ReportSharedRelationshipsReportTemplateData - … - object: A Profile Report - `type` 'report/profile', required: Discriminator value: report/profile - `id` string: The ID of the report - `attributes` ReportDiscriminatorMappingReportProfileAttributes - `status` string: The status of the report Possible values: - pending - ready - errored Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `created-at` string: The time the report was created in ISO 8601 format - `completed-at` string, nullable: The time the report completed processing in ISO 8601 format - `redacted-at` string, nullable: The time the report was redacted in ISO 8601 format - `report-template-version-name` string: The name of the report template version used for this report - `has-match` boolean: Whether or not the report matched - `is-continuous` boolean: Whether or not this report has been run more than once - `is-recurring` boolean: Whether or not this report is scheduled to run in the future - `tags` string[]: Tags on the report - `name-first` string, nullable: Given or first name. - `name-last` string, nullable: Family or last name. - `birthdate` string, date, nullable: Birthdate, must be in the format "YYYY-MM-DD". - `social-security-number` string, nullable: Full social security number. - `social-security-number-last-4` string, nullable: Last 4 digits of social security number. - `address-street-1` string, nullable: Primary street address. - `address-street-2` string, nullable: Secondary street address (if any). - `address-city` string, nullable: City of residence. - `address-subdivision` string, nullable: State or subdivision of residence. - `address-subdivision-abbr` string, nullable: State or subdivision abbreviation. - `address-postal-code` string, nullable: ZIP or postal code. - `address-postal-code-abbr` string, nullable: ZIP or postal code abbreviation (if applicable). - `phone-number` string, nullable: Phone number. - `identity-records` ReportDiscriminatorMappingReportProfileAttributesIdentityRecordsItems[]: Detailed identity records which passed matching logic, if available. - `names` ReportDiscriminatorMappingReportProfileAttributesIdentityRecordsItemsNamesItems[] - … - `birthdates` string[] - `addresses` ReportDiscriminatorMappingReportProfileAttributesIdentityRecordsItemsAddressesItems[] - … - `social-security-numbers` string[] - `phone-numbers` string[] - `email-addresses` string[] - `deceased` boolean - `deceased-date` string - `drivers-licenses` ReportDiscriminatorMappingReportProfileAttributesIdentityRecordsItemsDriversLicensesItems[] - … - `omitted-identity-records` ReportDiscriminatorMappingReportProfileAttributesOmittedIdentityRecordsItems[]: Detailed identity records which did not pass matching logic, if available. - `names` ReportDiscriminatorMappingReportProfileAttributesOmittedIdentityRecordsItemsNamesItems[] - … - `birthdates` string[] - `addresses` ReportDiscriminatorMappingReportProfileAttributesOmittedIdentityRecordsItemsAddressesItems[] - … - `social-security-numbers` string[] - `phone-numbers` string[] - `email-addresses` string[] - `deceased` boolean - `deceased-date` string - `drivers-licenses` ReportDiscriminatorMappingReportProfileAttributesOmittedIdentityRecordsItemsDriversLicensesItems[] - … - `relationships` ReportSharedRelationships: Other Persona objects related to the report - `inquiry` ReportSharedRelationshipsInquiry: The inquiry linked to the report - `data` ReportSharedRelationshipsInquiryData - … - `account` ReportSharedRelationshipsAccount: The report's home account, or the first linked account when it has no home account. It returns only one account and is kept for backwards compatibility; use `accounts` to see every associated account. Including it does not require the `account.read` permission. - `data` ReportSharedRelationshipsAccountData - … - `accounts` ReportSharedRelationshipsAccounts: Every account associated with the report, meaning its home account plus all linked accounts, deduplicated and listed in account creation order. Use this when a report can be linked to more than one account; `account` is kept for backwards compatibility and returns only one. The list is not paginated or capped, and is empty when the report has no accounts. Expanding it with `include=accounts` requires the `account.read` permission; the linkage ids do not. - `data` ReportSharedRelationshipsAccountsDataItems[], required - … - `transaction` ReportSharedRelationshipsTransaction: The transaction linked to the report - `data` ReportSharedRelationshipsTransactionData - … - `report-template` ReportSharedRelationshipsReportTemplate: The report template used to create this report - `data` ReportSharedRelationshipsReportTemplateData - … - object: A Profile Non-Authoritative Report - `type` 'report/profile-non-authoritative', required: Discriminator value: report/profile-non-authoritative - `id` string: The ID of the report - `attributes` ReportDiscriminatorMappingReportProfileNonAuthoritativeAttributes - `status` string: The status of the report Possible values: - pending - ready - errored Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `created-at` string: The time the report was created in ISO 8601 format - `completed-at` string, nullable: The time the report completed processing in ISO 8601 format - `redacted-at` string, nullable: The time the report was redacted in ISO 8601 format - `report-template-version-name` string: The name of the report template version used for this report - `has-match` boolean: Whether or not the report matched - `is-continuous` boolean: Whether or not this report has been run more than once - `is-recurring` boolean: Whether or not this report is scheduled to run in the future - `tags` string[]: Tags on the report - `query` ReportDiscriminatorMappingReportProfileNonAuthoritativeAttributesQuery - `name-first` string, nullable: The input first name of the search individual - `name-middle` string, nullable: The input middle name of the search individual - `name-last` string, nullable: The input last name of the search individual - `address-city` string, nullable: The locality of the search individual - `address-subdivision` string, nullable: The subdivision of the search individual - `address-postal-code` string, nullable: The postal code of the search individual - `address-street-1` string, nullable: The street address of the search individual - `address-street-2` string, nullable: The address line 2 of the search individual - `address-country-code` string, nullable: The country code of the search individual - `email-address` string, nullable: The email address of the search individual - `phone-number` string, nullable: The phone number of the search individual - `birthdate` string, nullable: Date of birth in YYYY-MM-DD format - `result` ReportDiscriminatorMappingReportProfileNonAuthoritativeAttributesResult - `name` string, nullable - `birthdate` string, nullable: Date of birth in YYYY-MM-DD format - `emails` ReportDiscriminatorMappingReportProfileNonAuthoritativeAttributesResultEmailsItems[], nullable - … - `phone-numbers` string[], nullable - `location` ReportDiscriminatorMappingReportProfileNonAuthoritativeAttributesResultLocation - … - `education` ReportDiscriminatorMappingReportProfileNonAuthoritativeAttributesResultEducationItems[], nullable - … - `experience` ReportDiscriminatorMappingReportProfileNonAuthoritativeAttributesResultExperienceItems[], nullable - … - `social-media-profiles` ReportDiscriminatorMappingReportProfileNonAuthoritativeAttributesResultSocialMediaProfilesItems[], nullable - … - `relationships` ReportSharedRelationships: Other Persona objects related to the report - `inquiry` ReportSharedRelationshipsInquiry: The inquiry linked to the report - `data` ReportSharedRelationshipsInquiryData - … - `account` ReportSharedRelationshipsAccount: The report's home account, or the first linked account when it has no home account. It returns only one account and is kept for backwards compatibility; use `accounts` to see every associated account. Including it does not require the `account.read` permission. - `data` ReportSharedRelationshipsAccountData - … - `accounts` ReportSharedRelationshipsAccounts: Every account associated with the report, meaning its home account plus all linked accounts, deduplicated and listed in account creation order. Use this when a report can be linked to more than one account; `account` is kept for backwards compatibility and returns only one. The list is not paginated or capped, and is empty when the report has no accounts. Expanding it with `include=accounts` requires the `account.read` permission; the linkage ids do not. - `data` ReportSharedRelationshipsAccountsDataItems[], required - … - `transaction` ReportSharedRelationshipsTransaction: The transaction linked to the report - `data` ReportSharedRelationshipsTransactionData - … - `report-template` ReportSharedRelationshipsReportTemplate: The report template used to create this report - `data` ReportSharedRelationshipsReportTemplateData - … - object: A SentiLink Scores Report - `type` 'report/integration/sentilink-scores', required: Discriminator value: report/integration/sentilink-scores - `id` string: The ID of the report - `attributes` ReportDiscriminatorMappingReportIntegrationSentilinkScoresAttributes - `status` string: The status of the report Possible values: - pending - ready - errored Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `created-at` string: The time the report was created in ISO 8601 format - `completed-at` string, nullable: The time the report completed processing in ISO 8601 format - `redacted-at` string, nullable: The time the report was redacted in ISO 8601 format - `report-template-version-name` string: The name of the report template version used for this report - `has-match` boolean: Whether or not the report matched - `is-continuous` boolean: Whether or not this report has been run more than once - `is-recurring` boolean: Whether or not this report is scheduled to run in the future - `tags` string[]: Tags on the report - `query` ReportDiscriminatorMappingReportIntegrationSentilinkScoresAttributesQuery - `birthdate` string, date: Birthdate, must be in the format "YYYY-MM-DD". - `name-first` string: Given or first name. - `name-last` string: Family or last name. - `address-street-1` string: Street name of residence address. - `address-city` string: City of residence address. Not all international addresses use this attribute. - `address-subdivision` string: 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: ZIP or postal code of residence address. Not all international addresses use this attribute. - `address-country-code` string, nullable: Country code of residence address. - `social-security-number` string: Social security number - `user-id` string: Reference ID of applicant - `phone-number` string, nullable: Phone number. - `email-address` string, nullable: Email address. - `result` ReportDiscriminatorMappingReportIntegrationSentilinkScoresAttributesResult - `application-id` string - `customer-id` string - `environment` string - `notes` string, nullable - `scores` ReportDiscriminatorMappingReportIntegrationSentilinkScoresAttributesResultScoresItems[] - … - `status` string - `transaction-id` string - `relationships` ReportSharedRelationships: Other Persona objects related to the report - `inquiry` ReportSharedRelationshipsInquiry: The inquiry linked to the report - `data` ReportSharedRelationshipsInquiryData - … - `account` ReportSharedRelationshipsAccount: The report's home account, or the first linked account when it has no home account. It returns only one account and is kept for backwards compatibility; use `accounts` to see every associated account. Including it does not require the `account.read` permission. - `data` ReportSharedRelationshipsAccountData - … - `accounts` ReportSharedRelationshipsAccounts: Every account associated with the report, meaning its home account plus all linked accounts, deduplicated and listed in account creation order. Use this when a report can be linked to more than one account; `account` is kept for backwards compatibility and returns only one. The list is not paginated or capped, and is empty when the report has no accounts. Expanding it with `include=accounts` requires the `account.read` permission; the linkage ids do not. - `data` ReportSharedRelationshipsAccountsDataItems[], required - … - `transaction` ReportSharedRelationshipsTransaction: The transaction linked to the report - `data` ReportSharedRelationshipsTransactionData - … - `report-template` ReportSharedRelationshipsReportTemplate: The report template used to create this report - `data` ReportSharedRelationshipsReportTemplateData - … - object: A Social Media Report - `type` 'report/social-media', required: Discriminator value: report/social-media - `id` string: The ID of the report - `attributes` ReportDiscriminatorMappingReportSocialMediaAttributes - `status` string: The status of the report Possible values: - pending - ready - errored Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `created-at` string: The time the report was created in ISO 8601 format - `completed-at` string, nullable: The time the report completed processing in ISO 8601 format - `redacted-at` string, nullable: The time the report was redacted in ISO 8601 format - `report-template-version-name` string: The name of the report template version used for this report - `has-match` boolean: Whether or not the report matched - `is-continuous` boolean: Whether or not this report has been run more than once - `is-recurring` boolean: Whether or not this report is scheduled to run in the future - `tags` string[]: Tags on the report - `name-first` string, nullable - `name-last` string, nullable - `birthdate` string: Date of birth in YYYY-MM-DD format - `phone-number` string, nullable - `email-address` string, nullable - `address-city` string, nullable - `address-subdivision` string, nullable: Sub-national subdivision such as a US state or a Canadian province - `linkedin-url` string, nullable - `linkedin-username` string, nullable - `linkedin-id` string, nullable - `facebook-url` string, nullable - `facebook-username` string, nullable - `facebook-id` string, nullable - `twitter-url` string, nullable - `twitter-username` string, nullable - `github-url` string, nullable - `github-username` string, nullable - `instagram-url` string, nullable - `instagram-username` string, nullable - `relationships` ReportSharedRelationships: Other Persona objects related to the report - `inquiry` ReportSharedRelationshipsInquiry: The inquiry linked to the report - `data` ReportSharedRelationshipsInquiryData - … - `account` ReportSharedRelationshipsAccount: The report's home account, or the first linked account when it has no home account. It returns only one account and is kept for backwards compatibility; use `accounts` to see every associated account. Including it does not require the `account.read` permission. - `data` ReportSharedRelationshipsAccountData - … - `accounts` ReportSharedRelationshipsAccounts: Every account associated with the report, meaning its home account plus all linked accounts, deduplicated and listed in account creation order. Use this when a report can be linked to more than one account; `account` is kept for backwards compatibility and returns only one. The list is not paginated or capped, and is empty when the report has no accounts. Expanding it with `include=accounts` requires the `account.read` permission; the linkage ids do not. - `data` ReportSharedRelationshipsAccountsDataItems[], required - … - `transaction` ReportSharedRelationshipsTransaction: The transaction linked to the report - `data` ReportSharedRelationshipsTransactionData - … - `report-template` ReportSharedRelationshipsReportTemplate: The report template used to create this report - `data` ReportSharedRelationshipsReportTemplateData - … - object: A Synthetic Report - `type` 'report/synthetic', required: Discriminator value: report/synthetic - `id` string: The ID of the report - `attributes` ReportDiscriminatorMappingReportSyntheticAttributes - `status` string: The status of the report Possible values: - pending - ready - errored Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `created-at` string: The time the report was created in ISO 8601 format - `completed-at` string, nullable: The time the report completed processing in ISO 8601 format - `redacted-at` string, nullable: The time the report was redacted in ISO 8601 format - `report-template-version-name` string: The name of the report template version used for this report. - `has-match` boolean: Indicates if the report matched. - `is-continuous` boolean: Indicates if the report is recurring. - `is-recurring` boolean: Whether or not this report is scheduled to run in the future - `tags` string[]: Tags associated with the report. - `sentilink-abuse-score` integer, nullable: Sentilink abuse score. - `sentilink-first-party-synthetic-score` integer, nullable: Sentilink first party synthetic score. - `sentilink-third-party-synthetic-score` integer, nullable: Sentilink third party synthetic score. - `relationships` ReportSharedRelationships: Other Persona objects related to the report - `inquiry` ReportSharedRelationshipsInquiry: The inquiry linked to the report - `data` ReportSharedRelationshipsInquiryData - … - `account` ReportSharedRelationshipsAccount: The report's home account, or the first linked account when it has no home account. It returns only one account and is kept for backwards compatibility; use `accounts` to see every associated account. Including it does not require the `account.read` permission. - `data` ReportSharedRelationshipsAccountData - … - `accounts` ReportSharedRelationshipsAccounts: Every account associated with the report, meaning its home account plus all linked accounts, deduplicated and listed in account creation order. Use this when a report can be linked to more than one account; `account` is kept for backwards compatibility and returns only one. The list is not paginated or capped, and is empty when the report has no accounts. Expanding it with `include=accounts` requires the `account.read` permission; the linkage ids do not. - `data` ReportSharedRelationshipsAccountsDataItems[], required - … - `transaction` ReportSharedRelationshipsTransaction: The transaction linked to the report - `data` ReportSharedRelationshipsTransactionData - … - `report-template` ReportSharedRelationshipsReportTemplate: The report template used to create this report - `data` ReportSharedRelationshipsReportTemplateData - … - object: A Watchlist Report - `type` 'report/watchlist', required: Discriminator value: report/watchlist - `id` string: The ID of the report - `attributes` ReportDiscriminatorMappingReportWatchlistAttributes - `status` string: The status of the report Possible values: - pending - ready - errored Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `created-at` string: The time the report was created in ISO 8601 format - `completed-at` string, nullable: The time the report completed processing in ISO 8601 format - `redacted-at` string, nullable: The time the report was redacted in ISO 8601 format - `report-template-version-name` string: The name of the report template version used for this report - `has-match` boolean: Whether or not the report matched - `is-continuous` boolean: Whether or not this report has been run more than once - `is-recurring` boolean: Whether or not this report is scheduled to run in the future - `tags` string[]: Tags on the report - `name-first` string, nullable: The input first name of the search individual - `name-middle` string, nullable: The input middle name of the search individual - `name-last` string, nullable: The input last name of the search individual - `term` string, nullable: The input combined term used for searching (first + middle + last name) - `birthdate` string, nullable: The input DOB in YYYY-MM-DD format - `country-code` string, nullable: The input search country in alpha2 format - `matched-lists` ReportDiscriminatorMappingReportWatchlistAttributesMatchedListsItems[], nullable: Lists that matched from the search input - `name` string - `url` string - `list-type` string - `list-types` string[] - `match-types` string[], nullable: The types of matching criteria satisfied by the search input. - `slug` string - `flag-code` string - `entities` ReportWatchlistEntity[]: A matched person - … - `ignore-list` ReportDiscriminatorMappingReportWatchlistAttributesIgnoreListItems[] - `ignored-at` string, date-time - `run-history-completed-at` string, date-time - `match` ReportDiscriminatorMappingReportWatchlistAttributesIgnoreListItemsMatch - … - `user` string - `ignore-reason` string - `run-history` ReportDiscriminatorMappingReportWatchlistAttributesRunHistoryItems[]: Deprecated and no longer populated. Use the [List Report History](https://docs.withpersona.com/api-reference/reports/list-report-history) endpoint instead. - `scheduled-at` string, date-time, nullable - `completed-at` string, date-time, nullable - `type` string, nullable: The type of report run Possible values: - scheduled - manual Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `report-template-version-id` integer, nullable - `relationships` ReportSharedRelationships: Other Persona objects related to the report - `inquiry` ReportSharedRelationshipsInquiry: The inquiry linked to the report - `data` ReportSharedRelationshipsInquiryData - … - `account` ReportSharedRelationshipsAccount: The report's home account, or the first linked account when it has no home account. It returns only one account and is kept for backwards compatibility; use `accounts` to see every associated account. Including it does not require the `account.read` permission. - `data` ReportSharedRelationshipsAccountData - … - `accounts` ReportSharedRelationshipsAccounts: Every account associated with the report, meaning its home account plus all linked accounts, deduplicated and listed in account creation order. Use this when a report can be linked to more than one account; `account` is kept for backwards compatibility and returns only one. The list is not paginated or capped, and is empty when the report has no accounts. Expanding it with `include=accounts` requires the `account.read` permission; the linkage ids do not. - `data` ReportSharedRelationshipsAccountsDataItems[], required - … - `transaction` ReportSharedRelationshipsTransaction: The transaction linked to the report - `data` ReportSharedRelationshipsTransactionData - … - `report-template` ReportSharedRelationshipsReportTemplate: The report template used to create this report - `data` ReportSharedRelationshipsReportTemplateData - … - 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. Keys in `fields` are **not** key inflected. - `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. Will include a maximum of 100 related objects. - `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: An AAMVA Verification - `type` 'verification/aamva', required: Discriminator value: verification/aamva - `id` string: The token of the verification - `attributes` VerificationDiscriminatorMappingVerificationAamvaAttributes - `status` string: The status of the verification Possible values: - initiated - submitted - tentatively_passed (only for `verification/document` and `verification/qes-infocert`) - tentatively_failed (only for `verification/database-business` and `verification/database-business-footprint`) - passed - failed - requires_retry - skipped - canceled - confirmed (only for `verification/email-address` and `verification/phone-number`) 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: The time the verification was created in ISO 8601 format - `created-at-ts` integer: The time the verification was created in Unix timestamp format - `submitted-at` string, date-time, nullable: The time the verification was submitted in ISO 8601 format - `submitted-at-ts` integer, nullable: The time the verification was submitted in Unix timestamp format - `completed-at` string, date-time, nullable: The time the verification was completed in ISO 8601 format - `completed-at-ts` integer, nullable: The time the verification was completed in Unix timestamp format - `redacted-at` string, date-time, nullable: The time the verification was redacted in ISO 8601 format - `country-code` string, nullable: ISO 3166-1 alpha 2 country code. - `tags` string[]: Tags on the verification - `checks` VerificationSharedAttributesChecksItems[] - `name` string - `status` string: Possible values: - passed - failed - not_applicable Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `category` string, nullable: The category assigned to the check. Possible values include: - biometrics - fraud - user_action_required - validity This categorizes the check itself, not its outcome. A null category means the check is uncategorized or its category is unknown; it must not be interpreted as non-fraud. Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `reasons` string[]: If applicable, reasons are the list of reasons explaining why the check failed or is not applicable. For some checks, `reasons` is the primary signal carrying the underlying detection results. For example, `business_website_malicious_website_detection` surfaces its IPQS and Google Web Risk signals here (e.g. `malware`, `phishing`, `spam-source`) rather than in `metadata`. - `requirement` string: Possible values: - required - not_required - requires_retry Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `metadata` object: This is a free-form object containing relevant metadata to the processing and result of the check. - `name-first` string, nullable: Given or first name. - `name-last` string, nullable: Family or last name. - `birthdate` string, date: Birthdate, must be in the format "YYYY-MM-DD". - `issue-date` string, date - `expiration-date` string, date - `address-postal-code` string - `issuing-authority` string - `identification-number` string - `relationships` VerificationSharedRelationships - `inquiry` VerificationSharedRelationshipsInquiry: The inquiry linked to the verification - `data` VerificationSharedRelationshipsInquiryData - … - `template` VerificationSharedRelationshipsTemplate - `data` VerificationSharedRelationshipsTemplateData - … - `inquiry-template-version` VerificationSharedRelationshipsInquiryTemplateVersion - `data` VerificationSharedRelationshipsInquiryTemplateVersionData - … - `inquiry-template` VerificationSharedRelationshipsInquiryTemplate - `data` VerificationSharedRelationshipsInquiryTemplateData - … - `transaction` VerificationSharedRelationshipsTransaction - `data` VerificationSharedRelationshipsTransactionData - … - `verification-template` VerificationSharedRelationshipsVerificationTemplate - `data` VerificationSharedRelationshipsVerificationTemplateData - … - `verification-template-version` VerificationSharedRelationshipsVerificationTemplateVersion - `data` VerificationSharedRelationshipsVerificationTemplateVersionData - … - `accounts` VerificationSharedRelationshipsAccounts - `data` VerificationSharedRelationshipsAccountsDataItems[] - … - object: A Database Verification - `type` 'verification/database', required: Discriminator value: verification/database - `id` string: The token of the verification - `attributes` VerificationDiscriminatorMappingVerificationDatabaseAttributes - `status` string: The status of the verification Possible values: - initiated - submitted - tentatively_passed (only for `verification/document` and `verification/qes-infocert`) - tentatively_failed (only for `verification/database-business` and `verification/database-business-footprint`) - passed - failed - requires_retry - skipped - canceled - confirmed (only for `verification/email-address` and `verification/phone-number`) 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: The time the verification was created in ISO 8601 format - `created-at-ts` integer: The time the verification was created in Unix timestamp format - `submitted-at` string, date-time, nullable: The time the verification was submitted in ISO 8601 format - `submitted-at-ts` integer, nullable: The time the verification was submitted in Unix timestamp format - `completed-at` string, date-time, nullable: The time the verification was completed in ISO 8601 format - `completed-at-ts` integer, nullable: The time the verification was completed in Unix timestamp format - `redacted-at` string, date-time, nullable: The time the verification was redacted in ISO 8601 format - `country-code` string, nullable: ISO 3166-1 alpha 2 country code. - `tags` string[]: Tags on the verification - `checks` VerificationSharedAttributesChecksItems[] - `name` string - `status` string: Possible values: - passed - failed - not_applicable Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `category` string, nullable: The category assigned to the check. Possible values include: - biometrics - fraud - user_action_required - validity This categorizes the check itself, not its outcome. A null category means the check is uncategorized or its category is unknown; it must not be interpreted as non-fraud. Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `reasons` string[]: If applicable, reasons are the list of reasons explaining why the check failed or is not applicable. For some checks, `reasons` is the primary signal carrying the underlying detection results. For example, `business_website_malicious_website_detection` surfaces its IPQS and Google Web Risk signals here (e.g. `malware`, `phishing`, `spam-source`) rather than in `metadata`. - `requirement` string: Possible values: - required - not_required - requires_retry Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `metadata` object: This is a free-form object containing relevant metadata to the processing and result of the check. - `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. - `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. - `normalized-address-street-1` string, nullable: Normalized street name of residence address. - `normalized-address-street-2` string, nullable: Normalized extension of residence address, usually apartment or suite number. - `normalized-address-city` string, nullable: Normalized city of residence address. Not all international addresses use this attribute. - `normalized-address-subdivision` string, nullable: Normalized state or subdivision of residence address. In the US, this should be the abbreviated name. Not all international addresses use this attribute. - `normalized-address-postal-code` string, nullable: Normalized ZIP or postal code of residence address. Not all international addresses use this attribute. - `identification-number` string, nullable - `document-number` string, nullable - `document-issuing-date` string, nullable - `document-expiry-date` string, nullable - `document-issuing-subdivision` string, nullable - `relationships` VerificationSharedRelationships - `inquiry` VerificationSharedRelationshipsInquiry: The inquiry linked to the verification - `data` VerificationSharedRelationshipsInquiryData - … - `template` VerificationSharedRelationshipsTemplate - `data` VerificationSharedRelationshipsTemplateData - … - `inquiry-template-version` VerificationSharedRelationshipsInquiryTemplateVersion - `data` VerificationSharedRelationshipsInquiryTemplateVersionData - … - `inquiry-template` VerificationSharedRelationshipsInquiryTemplate - `data` VerificationSharedRelationshipsInquiryTemplateData - … - `transaction` VerificationSharedRelationshipsTransaction - `data` VerificationSharedRelationshipsTransactionData - … - `verification-template` VerificationSharedRelationshipsVerificationTemplate - `data` VerificationSharedRelationshipsVerificationTemplateData - … - `verification-template-version` VerificationSharedRelationshipsVerificationTemplateVersion - `data` VerificationSharedRelationshipsVerificationTemplateVersionData - … - `accounts` VerificationSharedRelationshipsAccounts - `data` VerificationSharedRelationshipsAccountsDataItems[] - … - object: An eCBSV Database Verification - `type` 'verification/database-ecbsv', required: Discriminator value: verification/database-ecbsv - `id` string: The token of the verification - `attributes` VerificationDiscriminatorMappingVerificationDatabaseEcbsvAttributes - `status` string: The status of the verification Possible values: - initiated - submitted - tentatively_passed (only for `verification/document` and `verification/qes-infocert`) - tentatively_failed (only for `verification/database-business` and `verification/database-business-footprint`) - passed - failed - requires_retry - skipped - canceled - confirmed (only for `verification/email-address` and `verification/phone-number`) 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: The time the verification was created in ISO 8601 format - `created-at-ts` integer: The time the verification was created in Unix timestamp format - `submitted-at` string, date-time, nullable: The time the verification was submitted in ISO 8601 format - `submitted-at-ts` integer, nullable: The time the verification was submitted in Unix timestamp format - `completed-at` string, date-time, nullable: The time the verification was completed in ISO 8601 format - `completed-at-ts` integer, nullable: The time the verification was completed in Unix timestamp format - `redacted-at` string, date-time, nullable: The time the verification was redacted in ISO 8601 format - `country-code` string, nullable: ISO 3166-1 alpha 2 country code. - `tags` string[]: Tags on the verification - `checks` VerificationSharedAttributesChecksItems[] - `name` string - `status` string: Possible values: - passed - failed - not_applicable Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `category` string, nullable: The category assigned to the check. Possible values include: - biometrics - fraud - user_action_required - validity This categorizes the check itself, not its outcome. A null category means the check is uncategorized or its category is unknown; it must not be interpreted as non-fraud. Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `reasons` string[]: If applicable, reasons are the list of reasons explaining why the check failed or is not applicable. For some checks, `reasons` is the primary signal carrying the underlying detection results. For example, `business_website_malicious_website_detection` surfaces its IPQS and Google Web Risk signals here (e.g. `malware`, `phishing`, `spam-source`) rather than in `metadata`. - `requirement` string: Possible values: - required - not_required - requires_retry Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `metadata` object: This is a free-form object containing relevant metadata to the processing and result of the check. - `name-first` string, nullable: First name of the individual. - `name-last` string, nullable: Last name of the individual. - `birthdate` string, date, nullable: Birthdate of the individual - `email-address` string, nullable: Email address of the individual. - `identification-number` string, nullable: Social Security Number of the individual. - `signature-timestamp` string, date-time, nullable: Timestamp of the signature - `signature-ip` string, nullable: IP address of the individual - `relationships` VerificationSharedRelationships - `inquiry` VerificationSharedRelationshipsInquiry: The inquiry linked to the verification - `data` VerificationSharedRelationshipsInquiryData - … - `template` VerificationSharedRelationshipsTemplate - `data` VerificationSharedRelationshipsTemplateData - … - `inquiry-template-version` VerificationSharedRelationshipsInquiryTemplateVersion - `data` VerificationSharedRelationshipsInquiryTemplateVersionData - … - `inquiry-template` VerificationSharedRelationshipsInquiryTemplate - `data` VerificationSharedRelationshipsInquiryTemplateData - … - `transaction` VerificationSharedRelationshipsTransaction - `data` VerificationSharedRelationshipsTransactionData - … - `verification-template` VerificationSharedRelationshipsVerificationTemplate - `data` VerificationSharedRelationshipsVerificationTemplateData - … - `verification-template-version` VerificationSharedRelationshipsVerificationTemplateVersion - `data` VerificationSharedRelationshipsVerificationTemplateVersionData - … - `accounts` VerificationSharedRelationshipsAccounts - `data` VerificationSharedRelationshipsAccountsDataItems[] - … - object: A Phone Carrier Database Verification - `type` 'verification/database-phone-carrier', required: Discriminator value: verification/database-phone-carrier - `id` string: The token of the verification - `attributes` VerificationDiscriminatorMappingVerificationDatabasePhoneCarrierAttributes - `status` string: The status of the verification Possible values: - initiated - submitted - tentatively_passed (only for `verification/document` and `verification/qes-infocert`) - tentatively_failed (only for `verification/database-business` and `verification/database-business-footprint`) - passed - failed - requires_retry - skipped - canceled - confirmed (only for `verification/email-address` and `verification/phone-number`) 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: The time the verification was created in ISO 8601 format - `created-at-ts` integer: The time the verification was created in Unix timestamp format - `submitted-at` string, date-time, nullable: The time the verification was submitted in ISO 8601 format - `submitted-at-ts` integer, nullable: The time the verification was submitted in Unix timestamp format - `completed-at` string, date-time, nullable: The time the verification was completed in ISO 8601 format - `completed-at-ts` integer, nullable: The time the verification was completed in Unix timestamp format - `redacted-at` string, date-time, nullable: The time the verification was redacted in ISO 8601 format - `country-code` string, nullable: ISO 3166-1 alpha 2 country code. - `tags` string[]: Tags on the verification - `checks` VerificationSharedAttributesChecksItems[] - `name` string - `status` string: Possible values: - passed - failed - not_applicable Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `category` string, nullable: The category assigned to the check. Possible values include: - biometrics - fraud - user_action_required - validity This categorizes the check itself, not its outcome. A null category means the check is uncategorized or its category is unknown; it must not be interpreted as non-fraud. Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `reasons` string[]: If applicable, reasons are the list of reasons explaining why the check failed or is not applicable. For some checks, `reasons` is the primary signal carrying the underlying detection results. For example, `business_website_malicious_website_detection` surfaces its IPQS and Google Web Risk signals here (e.g. `malware`, `phishing`, `spam-source`) rather than in `metadata`. - `requirement` string: Possible values: - required - not_required - requires_retry Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `metadata` object: This is a free-form object containing relevant metadata to the processing and result of the check. - `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. - `name-first` string, nullable: Given or first name. - `name-last` string, nullable: Family or last name. - `birthdate` string, date, nullable: Birthdate in the format "YYYY-MM-DD". - `phone-number` string, nullable: Phone number. - `relationships` VerificationSharedRelationships - `inquiry` VerificationSharedRelationshipsInquiry: The inquiry linked to the verification - `data` VerificationSharedRelationshipsInquiryData - … - `template` VerificationSharedRelationshipsTemplate - `data` VerificationSharedRelationshipsTemplateData - … - `inquiry-template-version` VerificationSharedRelationshipsInquiryTemplateVersion - `data` VerificationSharedRelationshipsInquiryTemplateVersionData - … - `inquiry-template` VerificationSharedRelationshipsInquiryTemplate - `data` VerificationSharedRelationshipsInquiryTemplateData - … - `transaction` VerificationSharedRelationshipsTransaction - `data` VerificationSharedRelationshipsTransactionData - … - `verification-template` VerificationSharedRelationshipsVerificationTemplate - `data` VerificationSharedRelationshipsVerificationTemplateData - … - `verification-template-version` VerificationSharedRelationshipsVerificationTemplateVersion - `data` VerificationSharedRelationshipsVerificationTemplateVersionData - … - `accounts` VerificationSharedRelationshipsAccounts - `data` VerificationSharedRelationshipsAccountsDataItems[] - … - object: A Serpro Database Verification - `type` 'verification/database-serpro', required: Discriminator value: verification/database-serpro - `id` string: The token of the verification - `attributes` VerificationDiscriminatorMappingVerificationDatabaseSerproAttributes - `status` string: The status of the verification Possible values: - initiated - submitted - tentatively_passed (only for `verification/document` and `verification/qes-infocert`) - tentatively_failed (only for `verification/database-business` and `verification/database-business-footprint`) - passed - failed - requires_retry - skipped - canceled - confirmed (only for `verification/email-address` and `verification/phone-number`) 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: The time the verification was created in ISO 8601 format - `created-at-ts` integer: The time the verification was created in Unix timestamp format - `submitted-at` string, date-time, nullable: The time the verification was submitted in ISO 8601 format - `submitted-at-ts` integer, nullable: The time the verification was submitted in Unix timestamp format - `completed-at` string, date-time, nullable: The time the verification was completed in ISO 8601 format - `completed-at-ts` integer, nullable: The time the verification was completed in Unix timestamp format - `redacted-at` string, date-time, nullable: The time the verification was redacted in ISO 8601 format - `country-code` string, nullable: ISO 3166-1 alpha 2 country code. - `tags` string[]: Tags on the verification - `checks` VerificationSharedAttributesChecksItems[] - `name` string - `status` string: Possible values: - passed - failed - not_applicable Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `category` string, nullable: The category assigned to the check. Possible values include: - biometrics - fraud - user_action_required - validity This categorizes the check itself, not its outcome. A null category means the check is uncategorized or its category is unknown; it must not be interpreted as non-fraud. Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `reasons` string[]: If applicable, reasons are the list of reasons explaining why the check failed or is not applicable. For some checks, `reasons` is the primary signal carrying the underlying detection results. For example, `business_website_malicious_website_detection` surfaces its IPQS and Google Web Risk signals here (e.g. `malware`, `phishing`, `spam-source`) rather than in `metadata`. - `requirement` string: Possible values: - required - not_required - requires_retry Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `metadata` object: This is a free-form object containing relevant metadata to the processing and result of the check. - `birthdate` string, date, nullable: Birthdate of the individual. - `cpf` string: The Cadastro de Pessoas Físicas for the individual. - `name-first` string: First name of the individual. - `name-full` string: Full name of the individual. - `name-last` string: Last name of the individual. - `relationships` VerificationDiscriminatorMappingVerificationDatabaseSerproRelationships - `inquiry` VerificationSharedRelationshipsInquiry: The inquiry linked to the verification - `data` VerificationSharedRelationshipsInquiryData - … - `template` VerificationSharedRelationshipsTemplate - `data` VerificationSharedRelationshipsTemplateData - … - `inquiry-template-version` VerificationSharedRelationshipsInquiryTemplateVersion - `data` VerificationSharedRelationshipsInquiryTemplateVersionData - … - `inquiry-template` VerificationSharedRelationshipsInquiryTemplate - `data` VerificationSharedRelationshipsInquiryTemplateData - … - `transaction` VerificationSharedRelationshipsTransaction - `data` VerificationSharedRelationshipsTransactionData - … - `verification-template` VerificationSharedRelationshipsVerificationTemplate - `data` VerificationSharedRelationshipsVerificationTemplateData - … - `verification-template-version` VerificationSharedRelationshipsVerificationTemplateVersion - `data` VerificationSharedRelationshipsVerificationTemplateVersionData - … - `accounts` VerificationSharedRelationshipsAccounts - `data` VerificationSharedRelationshipsAccountsDataItems[] - … - `selfie` VerificationDiscriminatorMappingVerificationDatabaseSerproRelationshipsSelfie: The selfie linked to the Verification - `data` VerificationDiscriminatorMappingVerificationDatabaseSerproRelationshipsSelfieData - … - object: A Standard Database Verification - `type` 'verification/database-standard', required: Discriminator value: verification/database-standard - `id` string - `attributes` VerificationDiscriminatorMappingVerificationDatabaseStandardAttributes - `status` string: The status of the verification Possible values: - initiated - submitted - tentatively_passed (only for `verification/document` and `verification/qes-infocert`) - tentatively_failed (only for `verification/database-business` and `verification/database-business-footprint`) - passed - failed - requires_retry - skipped - canceled - confirmed (only for `verification/email-address` and `verification/phone-number`) 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: The time the verification was created in ISO 8601 format - `created-at-ts` integer: The time the verification was created in Unix timestamp format - `submitted-at` string, date-time, nullable: The time the verification was submitted in ISO 8601 format - `submitted-at-ts` integer, nullable: The time the verification was submitted in Unix timestamp format - `completed-at` string, date-time, nullable: The time the verification was completed in ISO 8601 format - `completed-at-ts` integer, nullable: The time the verification was completed in Unix timestamp format - `redacted-at` string, date-time, nullable: The time the verification was redacted in ISO 8601 format - `country-code` string, nullable: ISO 3166-1 alpha 2 country code. - `tags` string[]: Tags on the verification - `checks` VerificationSharedAttributesChecksItems[] - `name` string - `status` string: Possible values: - passed - failed - not_applicable Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `category` string, nullable: The category assigned to the check. Possible values include: - biometrics - fraud - user_action_required - validity This categorizes the check itself, not its outcome. A null category means the check is uncategorized or its category is unknown; it must not be interpreted as non-fraud. Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `reasons` string[]: If applicable, reasons are the list of reasons explaining why the check failed or is not applicable. For some checks, `reasons` is the primary signal carrying the underlying detection results. For example, `business_website_malicious_website_detection` surfaces its IPQS and Google Web Risk signals here (e.g. `malware`, `phishing`, `spam-source`) rather than in `metadata`. - `requirement` string: Possible values: - required - not_required - requires_retry Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `metadata` object: This is a free-form object containing relevant metadata to the processing and result of the check. - `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. - `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. - `normalized-address-city` string - `normalized-address-postal-code` string - `normalized-address-street-1` string - `normalized-address-street-2` string - `normalized-address-subdivision` string - `relationships` VerificationSharedRelationships - `inquiry` VerificationSharedRelationshipsInquiry: The inquiry linked to the verification - `data` VerificationSharedRelationshipsInquiryData - … - `template` VerificationSharedRelationshipsTemplate - `data` VerificationSharedRelationshipsTemplateData - … - `inquiry-template-version` VerificationSharedRelationshipsInquiryTemplateVersion - `data` VerificationSharedRelationshipsInquiryTemplateVersionData - … - `inquiry-template` VerificationSharedRelationshipsInquiryTemplate - `data` VerificationSharedRelationshipsInquiryTemplateData - … - `transaction` VerificationSharedRelationshipsTransaction - `data` VerificationSharedRelationshipsTransactionData - … - `verification-template` VerificationSharedRelationshipsVerificationTemplate - `data` VerificationSharedRelationshipsVerificationTemplateData - … - `verification-template-version` VerificationSharedRelationshipsVerificationTemplateVersion - `data` VerificationSharedRelationshipsVerificationTemplateVersionData - … - `accounts` VerificationSharedRelationshipsAccounts - `data` VerificationSharedRelationshipsAccountsDataItems[] - … - object: A TIN Database Verification - `type` 'verification/database-tin', required: Discriminator value: verification/database-tin - `id` string: The token of the verification - `attributes` VerificationDiscriminatorMappingVerificationDatabaseTinAttributes - `status` string: The status of the verification Possible values: - initiated - submitted - tentatively_passed (only for `verification/document` and `verification/qes-infocert`) - tentatively_failed (only for `verification/database-business` and `verification/database-business-footprint`) - passed - failed - requires_retry - skipped - canceled - confirmed (only for `verification/email-address` and `verification/phone-number`) 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: The time the verification was created in ISO 8601 format - `created-at-ts` integer: The time the verification was created in Unix timestamp format - `submitted-at` string, date-time, nullable: The time the verification was submitted in ISO 8601 format - `submitted-at-ts` integer, nullable: The time the verification was submitted in Unix timestamp format - `completed-at` string, date-time, nullable: The time the verification was completed in ISO 8601 format - `completed-at-ts` integer, nullable: The time the verification was completed in Unix timestamp format - `redacted-at` string, date-time, nullable: The time the verification was redacted in ISO 8601 format - `country-code` string, nullable: ISO 3166-1 alpha 2 country code. - `tags` string[]: Tags on the verification - `checks` VerificationSharedAttributesChecksItems[] - `name` string - `status` string: Possible values: - passed - failed - not_applicable Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `category` string, nullable: The category assigned to the check. Possible values include: - biometrics - fraud - user_action_required - validity This categorizes the check itself, not its outcome. A null category means the check is uncategorized or its category is unknown; it must not be interpreted as non-fraud. Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `reasons` string[]: If applicable, reasons are the list of reasons explaining why the check failed or is not applicable. For some checks, `reasons` is the primary signal carrying the underlying detection results. For example, `business_website_malicious_website_detection` surfaces its IPQS and Google Web Risk signals here (e.g. `malware`, `phishing`, `spam-source`) rather than in `metadata`. - `requirement` string: Possible values: - required - not_required - requires_retry Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `metadata` object: This is a free-form object containing relevant metadata to the processing and result of the check. - `tin` string - `tin-type` string, nullable - `name-first` string, nullable - `name-last` string, nullable - `name-business` string, nullable - `relationships` VerificationSharedRelationships - `inquiry` VerificationSharedRelationshipsInquiry: The inquiry linked to the verification - `data` VerificationSharedRelationshipsInquiryData - … - `template` VerificationSharedRelationshipsTemplate - `data` VerificationSharedRelationshipsTemplateData - … - `inquiry-template-version` VerificationSharedRelationshipsInquiryTemplateVersion - `data` VerificationSharedRelationshipsInquiryTemplateVersionData - … - `inquiry-template` VerificationSharedRelationshipsInquiryTemplate - `data` VerificationSharedRelationshipsInquiryTemplateData - … - `transaction` VerificationSharedRelationshipsTransaction - `data` VerificationSharedRelationshipsTransactionData - … - `verification-template` VerificationSharedRelationshipsVerificationTemplate - `data` VerificationSharedRelationshipsVerificationTemplateData - … - `verification-template-version` VerificationSharedRelationshipsVerificationTemplateVersion - `data` VerificationSharedRelationshipsVerificationTemplateVersionData - … - `accounts` VerificationSharedRelationshipsAccounts - `data` VerificationSharedRelationshipsAccountsDataItems[] - … - object: A Document Verification - `type` 'verification/document', required: Discriminator value: verification/document - `id` string: The token of the verification - `attributes` VerificationDiscriminatorMappingVerificationDocumentAttributes - `status` string: The status of the verification Possible values: - initiated - submitted - tentatively_passed (only for `verification/document` and `verification/qes-infocert`) - tentatively_failed (only for `verification/database-business` and `verification/database-business-footprint`) - passed - failed - requires_retry - skipped - canceled - confirmed (only for `verification/email-address` and `verification/phone-number`) 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: The time the verification was created in ISO 8601 format - `created-at-ts` integer: The time the verification was created in Unix timestamp format - `submitted-at` string, date-time, nullable: The time the verification was submitted in ISO 8601 format - `submitted-at-ts` integer, nullable: The time the verification was submitted in Unix timestamp format - `completed-at` string, date-time, nullable: The time the verification was completed in ISO 8601 format - `completed-at-ts` integer, nullable: The time the verification was completed in Unix timestamp format - `redacted-at` string, date-time, nullable: The time the verification was redacted in ISO 8601 format - `country-code` string, nullable: ISO 3166-1 alpha 2 country code. - `tags` string[]: Tags on the verification - `checks` VerificationSharedAttributesChecksItems[] - `name` string - `status` string: Possible values: - passed - failed - not_applicable Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `category` string, nullable: The category assigned to the check. Possible values include: - biometrics - fraud - user_action_required - validity This categorizes the check itself, not its outcome. A null category means the check is uncategorized or its category is unknown; it must not be interpreted as non-fraud. Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `reasons` string[]: If applicable, reasons are the list of reasons explaining why the check failed or is not applicable. For some checks, `reasons` is the primary signal carrying the underlying detection results. For example, `business_website_malicious_website_detection` surfaces its IPQS and Google Web Risk signals here (e.g. `malware`, `phishing`, `spam-source`) rather than in `metadata`. - `requirement` string: Possible values: - required - not_required - requires_retry Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `metadata` object: This is a free-form object containing relevant metadata to the processing and result of the check. - `fields` VerificationDiscriminatorMappingVerificationDocumentAttributesFields: JSON key-value pairs of field name to field value. - `files` File[]: The files uploaded to the associated 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. - … - `document-type` string, nullable: Document classification assignment based on document content. - `relationships` VerificationDiscriminatorMappingVerificationDocumentRelationships - `inquiry` VerificationSharedRelationshipsInquiry: The inquiry linked to the verification - `data` VerificationSharedRelationshipsInquiryData - … - `template` VerificationSharedRelationshipsTemplate - `data` VerificationSharedRelationshipsTemplateData - … - `inquiry-template-version` VerificationSharedRelationshipsInquiryTemplateVersion - `data` VerificationSharedRelationshipsInquiryTemplateVersionData - … - `inquiry-template` VerificationSharedRelationshipsInquiryTemplate - `data` VerificationSharedRelationshipsInquiryTemplateData - … - `transaction` VerificationSharedRelationshipsTransaction - … truncated; see the full OpenAPI document linked below ## 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. - `409`: The request conflicts with another request, often due to attempting to create a duplicate resource. - `422`: The request modifies the resource in an unacceptable way, often due to an invalid action or parameter. - `429`: Your organization’s rate limit has been exceeded. We recommend an exponential backoff on requests. ## Changes - **2026-10-29** `69a6b8d2bd8f`: 1 info - added the optional property `included/items/oneOf[subschema #17]/attributes/age-estimated-15-plus` to the response with the `200` status - **2026-10-28** `7b07aa97c04d`: 1 breaking - added `subschema #12` to the `included/items/` response property `oneOf` list for the response status `200` - **2026-10-24** `c03de313f52b`: 1 breaking - added `subschema #17` to the `included/items/` response property `oneOf` list for the response status `200` - **2026-10-23** `e7f1dee4c998`: 1 info - added the optional property `included/items/oneOf[subschema #12]/attributes/result/oneOf[subschema #1: ReportDiscriminatorMappingReportBusinessNonprofitAttributesResult]/ca-ag-details/oneOf[subschema #1: ReportDiscriminatorMappingReportBusinessNonprofitAttributesResultCaAgDetails]/initial-registration-date` to the response with the `200` status - …earlier changes not shown [Operation history](https://skmtc.dev/withpersona/apis/withpersona-5/changes/cases/:case-id/set-status/post.md) --- [API](https://skmtc.dev/withpersona/apis/withpersona-5.md) - [All operations](https://skmtc.dev/withpersona/apis/withpersona-5/llms.txt) - [OpenAPI document](https://skmtc.dev/withpersona/apis/withpersona-5/revisions/0281de74819e?raw)