DocumentationAPI Reference
DocumentationAPI ReferenceStatus

Supported Report Types and Examples

Address Lookup

Attributes

query.addresseeoptional
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

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

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

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

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"
        }]
      }
    }
  }
}

Email Risk

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]"
      }
    }
  }
}

FINRA Broker Check

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

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

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

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

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

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"
      }
    }
  }
}