--- title: "Screening report matched" method: POST path: "reportEvents_webhook-report-screening-matched" --- # Screening report matched `POST reportEvents_webhook-report-screening-matched` (webhook) Webhook for the `report/screening.matched` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks). Sent when a screening report surfaces one or more matched records (`has-match` becomes `true`). For continuously-monitored reports this fires on the run that introduces a new match. The payload is the polymorphic report object. Inspect `payload.data.type` (`report/screening`) to identify the report, and `payload.data.attributes` for its inputs and results. ## Headers - `Persona-Signature` string - `Persona-Webhook-Attempts-Made` integer - `Persona-Webhook-Attempts-Left` integer - `Persona-Webhook-First-Attempted-At` integer ## Payload - object - `data` WebhooksWebhookReportScreeningMatchedPayloadContentApplicationJsonSchemaData - `type` 'event' - `id` string: Unique identifier for this Event. Starts with `evt_`. - `attributes` WebhooksWebhookReportScreeningMatchedPayloadContentApplicationJsonSchemaDataAttributes - `created-at` string, date-time: Datetime when the event was created. - `name` 'report/screening.matched' - `context` WebhookBodyEmptyContext: Unused for this event; always an empty object. - `payload` WebhooksWebhookReportScreeningMatchedPayloadContentApplicationJsonSchemaDataAttributesPayload - `data` ReportScreening: A Screening Report - `id` string: The ID of the report - `attributes` ReportDiscriminatorMappingReportScreeningAttributes - `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` ReportDiscriminatorMappingReportScreeningAttributesQuery: The input search parameters used for this report - … - `matched-screening-types` string[], nullable: The types of screening (e.g. sanction, warning, PEP, adverse media) that produced at least one matched record on this report. Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `matched-records` ReportDiscriminatorMappingReportScreeningAttributesMatchedRecordsItems[], nullable: The records that matched from the search input, across all configured screening types - … - `relationships` ReportSharedRelationships: Other Persona objects related to the report - `inquiry` ReportSharedRelationshipsInquiry: The inquiry linked to the report - … - `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. - … - `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. - … - `transaction` ReportSharedRelationshipsTransaction: The transaction linked to the report - … - `report-template` ReportSharedRelationshipsReportTemplate: The report template used to create this report - … - `included` ReportsIncludedObjectsItems[] - union - object: An Inquiry object - … - object: An Account object. Note that `fields` is **not** key inflected. - … - object: An Address Lookup Report Template - … - object: An Adverse Media Report Template - … - object: A Business Adverse Media Report Template - … - object: A Business Associated Persons Report Template - … - object: A Business Lookup Report Template - … - object: A Business Media Coverage Report Template - … - object: A Business Nonprofit Report Template - … - object: A Business Registrations Lookup Report Template - … - object: A Business Watchlist Report Template - … - object: A Crypto Address Watchlist Report Template - … - object: An Email Address Report Template - … - object: A Phone Risk Report Template - … - object: A Politically Exposed Person Report Template - … - object: A Profile Report Template - … - object: A Screening Report Template - … - object: A SentiLink Report Template - … - object: A Social Media Report Template - … - object: A Synthetic Template - … - object: A Watchlist Report Template - … - object: transaction variant - … ## Acknowledgement `200` Webhook received successfully --- [API](https://skmtc.dev/withpersona/apis/withpersona-6.md) - [All operations](https://skmtc.dev/withpersona/apis/withpersona-6/llms.txt) - [OpenAPI document](https://skmtc.dev/withpersona/apis/withpersona-6/revisions/b2a170061bd9?raw)