DocumentationAPI Reference
DocumentationAPI Reference

Reports allow you to enrich your understanding of identity-related entities using key identifiers like email addresses, phone numbers, individuals, businesses, etc. Persona currently supports these report types:

  • Address Lookup
  • Adverse Media
  • Email Risk
  • Phone Risk
  • Social Media
  • Watchlist, Sanctions, and PEP

Getting started: Getting your Report Template

Reports can often be run with different settings. A Report Template is a saved configuration for how you want to run a report. To get started, find your report templates in your organization's dashboard on the reports page.

If you are missing the report template that you need, please contact [email protected] for assistance.

Running your first report

Create your first report by creating a POST request to the reports resource.

API_KEY=YOUR_API_KEY_HERE
curl -X POST -H 'Content-Type: application/json' -H "Authorization: Bearer $API_KEY" -d'{
  "data": {
    "attributes": {
      "report-template-id": YOUR_TEMPLATE_ID,
    }
  }
}' https://withpersona.com/api/v1/reports

After you submit this request to create the report, we'll process it as soon as possible. This usually happens within a second.

The response of this request will include a report ID which you can use to poll for your report.

{
  "data": {
    "type: "report/watchlist",
    "id": "rep_yourfirstreportid",
    "attributes": {
       "status": "pending",
      ...
    }
  }
}

Getting the results of your report

Fetch your report using the report ID from the reports resource.

API_KEY=YOUR_API_KEY_HERE
curl -X GET -H 'Content-Type: application/json' -H "Authorization: Bearer $API_KEY" https://withpersona.com/api/v1/reports/REPORT_ID

Once the status is ready, the results should be available in the response.

{
  "data": {
    "type: "report/watchlist",
    "id": "rep_yourfirstreportid",
    "attributes": {
       "status": "ready",
      ...
    }
  }
}