post https://withpersona.com/api/v1/reports
Prerequisites
Creating a report requires that you already have a Report Template that specifies the configuration of the report you are trying to run. You will use that report template ID when creating reports.
You will be able to find your report template IDs at https://withpersona.com/dashboard/report-templates.
Report Types
You can find a list of supported report types here: Reports
Different report types require different attributes within the input. Examples are provided to the right.
Address Lookup Report Data Body
{
"data": {
"attributes": {
"report-template-id": "rptp_addresslookuptemplate",
"address-street-1": "123 Fake Street",
"address-street-2": "#123",
"address-city": "Faketown",
"address-subdivision": "California",
"address-postal-code": "94107",
"address-country-code": "US"
}
}
}
Adverse Media Report Data Body
Person
{
"data": {
"attributes": {
"report-template-id": "rptp_adversemediatemplate",
"name-first": "Sherlock",
"name-last": "Holmes",
"birthdate": "1854-01-06"
}
}
}
Business
{
"data": {
"attributes": {
"report-template-id": "rptp_businessadversemediattemplate",
"term": "Company Name"
}
}
}
Email Risk Report Data Body
{
"data": {
"attributes": {
"report-template-id": "rptp_emailaddresstemplate",
"email-address": "[email protected]"
}
}
}
FINRA Broker Check Data Body
Individual Broker
{
"data": {
"attributes": {
"report-template-id": "rptp_finrabrokercheckindtemplate",
"broker-type": "individual",
"crd-number": "123456789",
"name-full": "Sherlock Holmes",
"address-city": "Faketown",
"address-subdivision": "CA",
}
}
}
Firm Broker
{
"data": {
"attributes": {
"report-template-id": "rptp_finrabrokercheckfirmtemplate",
"broker-type": "firm",
"crd-number": "123456789",
"firm-name": "Charles Schwab",
"address-city": "Faketown",
"address-subdivision": "CA",
}
}
}
Phone Risk Report Data Body
{
"data": {
"attributes": {
"report-template-id": "rptp_phonenumbertemplate",
"phone-number": "+14151231234"
}
}
}
SEC Action Lookup Report Data Body
{
"data": {
"attributes": {
"report-template-id": "rptp_secactionlookuptemplate",
"name-first": "Sherlock",
"name-last": "Holmes",
"birthdate": "1854-01-06"
}
}
}
Social Media Lookup Report Data Body
{
"data": {
"attributes": {
"report-template-id": "rptp_socialmediatemplate",
"name-first": "Sherlock",
"name-last": "Holmes",
"birthdate": "1854-01-06",
"email-address": "[email protected]"
}
}
}
Watchlist Report Data Body
Person
{
"data": {
"attributes": {
"report-template-id": "rptp_personwatchlisttemplate",
"name-first": "Sherlock",
"name-last": "Holmes",
"birthdate": "1854-01-06"
}
}
}
Business
{
"data": {
"attributes": {
"report-template-id": "rptp_businesswatchlisttemplate",
"term": "Company Name"
}
}
}