DocumentationAPI Reference
API ChangelogOpenAPI SpecStatus

Supported Report Types and Examples

Address Lookup

Request Attributes

query.addressesoptional
The name of an individual at this location
query.address-street-1required
Address line 1 (e.g., street, PO Box, or company name)
query.address-street-2optional
Address line 2 (e.g., apartment, suite, unit, or building)
query.address-cityrequired
Address city
query.address-subdivisionrequired
Address province or state
query.address-postal-coderequired
Zip or postal code
query.address-country-coderequired
Two letter country code (ISO 3166)

Example Request Body

{
  "data": {
    "attributes": {
      "report-template-id": "rptp_addresslookuptemplate",
      "query": {
        "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

Request Attributes

query.name-firstoptional
The first name of the individual
query.name-middleoptional
The middle name of the individual
query.name-lastoptional
The last name of the individual
query.termoptional
Custom term instead of separate name parts of the individual. One of the name parts or term is required.
query.birthdateoptional
The birthdate of the individual, formatted as YYYY-MM-DD (ISO 8601)
query.country-codeoptional
Two letter country code (ISO 3166)

Example Request Body

{
  "data": {
    "attributes": {
      "report-template-id": "rptp_adversemediatemplate",
      "query": {
        "name-first": "Sherlock",
        "name-middle": "Scott",
        "name-last": "Holmes",
        "country-code": "GB",
        "birthdate": "1854-01-06"
      }
    }
  }
}

Business Adverse Media

Request Attributes

query.termrequired
The business name to search for

Example Request Body

{
  "data": {
    "attributes": {
      "report-template-id": "rptp_businessadversemediattemplate",
      "query": {
        "term": "Company Name"
      }
    }
  }
}

Business Watchlist

Request Attributes

query.termrequired
The business name to search for
query.country-codeoptional
Two letter country code (ISO 3166)

Example Request Body

{
  "data": {
    "attributes": {
      "report-template-id": "rptp_businesswatchlisttemplate",
      "query": {
        "term": "Company Name",
        "country-code": "US"
      }
    }
  }
}

Business Lookup

Request Attributes

query.business-namerequired
The business name to search for
query.address-street-1optional
Address line 1 (e.g., street, PO Box, or company name)
query.address-street-2optional
Address line 2 (e.g., apartment, suite, unit, or building)
query.address-cityrequired
Address city
query.address-subdivisionrequired
Address province or state
query.address-postal-codeoptional
Zip or postal code
query.associated-people[n].name-firstoptional
The first name of an officer or agent associated with the business
query.associated-people[n].name-lastoptional
The last name of an officer or agent associated with the business

Example Request Body

{
  "data": {
    "attributes": {
      "report-template-id": "rptp_businesslookuptemplate",
      "query": {
        "business-name": "Test Business",
        "address-street-1": "123 Fake Street",
        "address-street-2": "#123",
        "address-city": "Faketown",
        "address-subdivision": "CA",
        "address-postal-code": "94103",
        "associated-people": [{
          "name-first": "Sherlock",
          "name-last": "Holmes"
        }]
      }
    }
  }
}

Crypto Address Watchlist

Request Attributes

query.crypto-addressrequired
The crypto wallet address to search for

Example Request Body

{
  "data": {
    "attributes": {
      "report-template-id": "rptp_cryptoaddresswatchlisttemplate",
      "query": {
        "crypto-address": "1Fz29BQp82pE3vXXcsZoMNQ3KSHfMzfMe3"
      }
    }
  }
}

Email Risk

Request Attributes

query.email-addressrequired
The email address to search for

Example Request Body

{
  "data": {
    "attributes": {
      "report-template-id": "rptp_emailaddresstemplate",
      "query": {
        "email-address": "[email protected]"
      }
    }
  }
}

Response Attributes

email-address
The email address that was provided
email-reputation
The reputation of the email provided. High, medium or low
email-reference-countdeprecated
The number of sources used to determine the reputation
email-domain-reputationdeprecated
The reputation of the email domain provided. High, medium or low
email-first-seen-daysdeprecated
How many days it has been since the email was first seen in an attack
email-last-seen-daysdeprecated
How many days it has been since the email was last seen
email-estimated-age-days
The estimated age of the email in days
email-domain-age-days
The estimated age of the domain in days
email-credentials-leakeddeprecated
Whether the email has ever been detected to have been leaked
email-credentials-leaked-recent
Whether the email has been recently detected as leaked
email-data-breacheddeprecated
Wheter the email was involved in a data breach
email-malicious-activity-detecteddeprecated
Whether the email has ever been detected for suspected malicious activity
email-malicious-activity-detected-recent
Whether the email has recently been detected for suspected malicious activity
email-is-blocklisteddeprecated
Whether the email appears on blocklists
email-is-spam
Whether the email is spam
email-is-free-providerdeprecated
Whether the email was made with a free provider
email-is-disposable
Whether the email is one that is disposable or temporary
email-is-deliverable
Whether the email is deliverable
email-is-valid-mx
Whether the domain has a valid MX record
email-is-spoofabledeprecated
Whether the email can be spoofed. (E.G. not a strict SPF policy or DMARC not enforced)
email-is-spf-strictdeprecated
Whether there is a sufficiently strict SPF record
email-is-dmarc-enforceddeprecated
Whether DMARC is configured correctly and enforced
email-is-suspicious
Whether the email is suspicious or risky
email-domain-exists
Whether the domain of the email exists
email-domain
The domain of the email

Example Response Body

{
  "data": {
    "type": "report/email-address",
    "id": "rep_emailaddressid",
    "attributes": {
      "status": "ready",
      "email-address": "[email protected]",
      "email-reputation": "high",
      "email-reference-count": null,
      "email-domain-reputation": null,
      "email-first-seen-days": null,
      "email-estimated-age-days": 284,
      "email-last-seen-days": null,
      "email-domain-age-days": 1779,
      "email-credentials-leaked": null,
      "email-credentials-leaked-recent": false,
      "email-data-breached": null,
      "email-malicious-activity-detected": null,
      "email-malicious-activity-detected-recent": false,
      "email-is-blocklisted": null,
      "email-is-spam": false,
      "email-is-free-provider": null,
      "email-is-disposable": false,
      "email-is-deliverable": true,
      "email-is-valid-mx": true,
      "email-is-spoofable": null,
      "email-is-spf-strict": null,
      "email-is-dmarc-enforced": null,
      "email-is-suspicious": false,
      "email-domain-exists": true,
      "email-domain": "example.com"
    }
  }
}

FINRA Broker Check

Request Attributes

query.broker-typerequired
Broker type. Possible values: "individual" or "firm"
query.crd-numberoptional
A unique Central Registration Depository (CRD) number given to all licensed brokers and brokerage firms
query.name-fulloptional
Name of the broker; only used when broker type is "individual"
query.firm-nameoptional
Name of the broker; only used when broker type is "firm"
query.address-cityoptional
Address city
query.address-subdivisionoptional
Address province or state

Example Request Body

{
  "data": {
    "attributes": {
      "report-template-id": "rptp_finrabrokerchecktemplate",
      "query": {
        "broker-type": "firm",
        "crd-number": "123456789",
        "firm-name": "Charles Schwab",
        "address-city": "Faketown",
        "address-subdivision": "CA"
      }
    }
  }
}

Politically Exposed Person

Request Attributes

query.name-firstoptional
The first name of the individual
query.name-middleoptional
The middle name of the individual
query.name-lastoptional
The last name of the individual
query.termoptional
Custom term instead of separate name parts of the individual. One of the name parts or term is required.
query.birthdateoptional
The birthdate of the individual, formatted as YYYY-MM-DD (ISO 8601)
query.country-codeoptional
Two letter country code (ISO 3166)

Example Request Body

{
  "data": {
    "attributes": {
      "report-template-id": "rptp_peptemplate",
      "query": {
        "name-first": "Sherlock",
        "name-middle": "Scott",
        "name-last": "Holmes",
        "country-code": "GB",
        "birthdate": "1854-01-06"
      }
    }
  }
}

Phone Risk

Request Attributes

query.phone-numberrequired
The phone number to search for

Example Request Body

{
  "data": {
    "attributes": {
      "report-template-id": "rptp_phonenumbertemplate",
      "query": {
        "phone-number": "+14151231234"        
      }
    }
  }
}

SEC Action Lookup

Request Attributes

query.name-firstoptional
The first name of the individual
query.name-lastoptional
The last name of the individual
query.birthdateoptional
The birthdate of the individual, formatted as YYYY-MM-DD (ISO 8601)

Example Request Body

{
  "data": {
    "attributes": {
      "report-template-id": "rptp_secactionlookuptemplate",
      "query": {
        "name-first": "Sherlock",
        "name-last": "Holmes",
        "birthdate": "1854-01-06"
      }
    }
  }
}

Social Media Lookup

Request Attributes

query.name-firstrequired
The first name of the individual; phone-number or email-address or both first-name and last-name required
query.name-lastrequired
The last name of the individual; phone-number or email-address or both first-name and last-name required
query.birthdateoptional
The birthdate of the individual, formatted as YYYY-MM-DD (ISO 8601)
query.phone-numberrequired
The phone number of the individual; phone-number or email-address or both first-name and last-name required
query.email-addressrequired
The email address of the individual; phone-number or email-address or both first-name and last-name required
query.address-street-1optional
Address line 1 (e.g., street, PO Box, or company name)
query.address-street-2optional
Address line 2 (e.g., apartment, suite, unit, or building)
query.address-cityoptional
Address city
query.address-subdivisionoptional
Address province or state
query.address-postal-codeoptional
Zip or postal code
query.address-country-codeoptional
Two letter country code (ISO 3166)

Example Request Body

{
  "data": {
    "attributes": {
      "report-template-id": "rptp_socialmediatemplate",
      "query": {
        "name-first": "Sherlock",
        "name-last": "Holmes",
        "birthdate": "1854-01-06",
        "email-address": "[email protected]"     
      }
    }
  }
}

Watchlist

Request Attributes

query.name-firstoptional
The first name of the individual
query.name-middleoptional
The middle name of the individual
query.name-lastoptional
The last name of the individual
query.termoptional
Custom term instead of separate name parts of the individual. One of the name parts or term is required.
query.birthdateoptional
The birthdate of the individual, formatted as YYYY-MM-DD (ISO 8601)
query.country-codeoptional
Two letter country code (ISO 3166)

Example Request Body

{
  "data": {
    "attributes": {
      "report-template-id": "rptp_watchlisttemplate",
      "query": {
        "name-first": "Sherlock",
        "name-middle": "Scott",
        "name-last": "Holmes",
        "country-code": "GB",
        "birthdate": "1854-01-06"
      }
    }
  }
}