|

API

List all risk signals

get/org/risk_signals
Preview
List all possible Footprint Risk Signals.

Request

Response

description·

string

Description of the reason code
note·

string

Short description of the reason code
reason_code·

string

Allowed values:

watchlist_hit_ofac
watchlist_clear_ofac
watchlist_hit_non_sdn
watchlist_clear_non_sdn
watchlist_hit_warning
watchlist_clear_warning
watchlist_hit_pep
watchlist_clear_pep
adverse_media_hit
adverse_media_clear
id_not_located
id_flagged
credit_more_than3_inquiries_in_last30_days
credit_established_before_ssn_date
address_input_is_non_residential
address_located_is_non_residential
address_does_not_match
address_partially_matches
address_zip_code_does_not_match
address_city_does_not_match
address_city_matches
address_street_name_does_not_match
address_street_name_partially_matches
address_street_number_does_not_match
address_state_does_not_match
address_input_is_not_deliverable
address_input_is_po_box
address_input_is_correctional_facility
address_input_is_not_standard_campground
address_input_is_not_standard_college
address_input_is_not_standard_general_delivery
address_input_is_not_standard_hospital
address_input_is_not_standard_hotel
address_input_is_not_standard_mail_drop
address_input_is_not_standard_prison
address_input_is_not_standard_university
address_input_is_not_standard_uspo
address_input_not_on_file
address_located_is_po_box
address_located_is_not_standard_campground
scopes·

array of strings

What the reason code applies to (Name, Document, Business, etc)

Allowed values:

name
dob
ssn
itin
address
street_address
city
state
zip
country
email
phone_number
drivers_license_number
ip_address
device
native_device
document
selfie
behavior
business_address
business_name
business_phone_number
business_website
business_tin
beneficial_owners
business_dba
severity·

string

An indication of importance

Allowed values:

info
low
medium
high
GET /org/risk_signals
1curl https://api.onefootprint.com/org/risk_signals \
2  -u sk_test_xxxxx:
Response example
[
  {
    "description": "Lorem ipsum dolor",
    "note": "Lorem ipsum dolor",
    "reason_code": "watchlist_hit_ofac",
    "scopes": [
      "name",
      "dob"
    ],
    "severity": "info"
  },
  {
    "description": "Lorem ipsum dolor",
    "note": "Lorem ipsum dolor",
    "reason_code": "watchlist_hit_ofac",
    "scopes": [
      "name",
      "dob"
    ],
    "severity": "info"
  }
]