User Object Details

User Schema

Possible Flag Codes

Possible User Permissions

Possible Permission Codes

Please note that the user will be cashed out automatically from the system if any one of the codes are picked:

  • UNUSUAL_ACTIVITY|COMPLIANCE_SUSPICIOUS

  • BLOCKED_INDUSTRY

  • PLATFORM_REQUEST

  • USER_REQUEST

  • PLATFORM_TERMINATED

  • NO_ACTIVITY

  • PERMANENT_CLOSURE

When a user is auto cashed out, we will issue a check to their mailing address, if avaliable or else to the base document address on file.

Possible Watchlists Values

Unless your program is configured differently, all values except NO_MATCH and FALSE_POSITIVE will impact user permissions and will keep the permission as UNVERIFIED until further review.

Base Document Schema

Screenings Results Details

Please note that not all sanctions lists will be appropriate for your use-case. Your spec sheet dictates which sanctions lists affect the Possible Watchlists Values. Go to Intro to Spec Sheet to learn more.

Here is an example object for screening_results object:

{
   "ofac_sdn": "MATCH",
   "ofac_ssi_list": "MATCH",
   "ofac_ukraine-eo13662": "MATCH",
   "usa_csl_list": "MATCH",
   "hm_treasury_sanctions": "NO_MATCH",
   "futures_sanctions": "NO_MATCH",
   "fincen_311_sanctions": "NO_MATCH",
   "mas_sanctions": "NO_MATCH",
   "ofac_fse_list": "NO_MATCH",
   "ofac_iran": "NO_MATCH",
   "usa_tel_list": "NO_MATCH",
   "ofac_ns-plc": "NO_MATCH",
   "ofac_sdgt": "NO_MATCH",
   "ofac_561_list": "NO_MATCH",
   "ofac_syria": "NO_MATCH",
   "ofac_fse-sy": "NO_MATCH",
   "osfi": "NO_MATCH",
   "fbi_counter_intelligence": "NO_MATCH",
   "fbi_domestic": "NO_MATCH",
   "fbi_cyber": "NO_MATCH",
   "fbi_white_collar": "NO_MATCH",
   "fbi_crimes_against_children": "NO_MATCH",
   "fbi_bank_robbers": "NO_MATCH",
   "fbi_wanted_terrorists": "NO_MATCH",
   "bis_dpl_sanctions": "NO_MATCH",
   "fbi_violent_crimes": "NO_MATCH",
   "fbi_domestic_terrorism": "NO_MATCH",
   "fbi_human_trafficking": "NO_MATCH",
   "fbi_criminal_enterprise_investigations": "NO_MATCH",
   "fbi_terrorism": "NO_MATCH",
   "fbi_murders": "NO_MATCH",
   "pep": "NO_MATCH",
   "aucl": "NO_MATCH",
   "eucl": "NO_MATCH",
   "uk_sanctions": "NO_MATCH",
   "switzerland_sanctions": "NO_MATCH",
   "dtc_list": "NO_MATCH",
   "cftc_sanctions": "NO_MATCH",
   "finra_sanctions": "NO_MATCH",
   "euro": "NO_MATCH",
   "fto_sanctions": "NO_MATCH",
   "hardcode_list": "NO_MATCH",
   "russian_sanctions": "NO_MATCH",
   "singapore_sanctions": "NO_MATCH",
   "nk_sanctions": "NO_MATCH",
   "cftc_reparations_sanctions": "NO_MATCH",
   "interpol": "NO_MATCH",
   "usa_rfj": "NO_MATCH",
   "belgian_list": "NO_MATCH",
   "canada_sema": "NO_MATCH",
   "canada_rcmp": "NO_MATCH",
   "cftc_red": "NO_MATCH",
   "ice_sanctions": "NO_MATCH",
   "unsc_cons": "NO_MATCH",
   "cons_sdn": "NO_MATCH"
}

Here are all the possible values for individual screenings lists:

Virtual Document Schema

Social Document Schema

Physical Document Schema

Possible Invalid Reasons Values for Physical Docs

Possible Sub-Document Status Values

[1] In some instances, if we are unable to automatically verify a document. In those instances the document is queued to be reviewed manually by an agent on our side. This review is completed in 2 business days or less.

Additional Details

Passports

The following details will help assist on proper setup when submitting passports.

  • Passport Document Types

    • document_type = GOVT_ID, used when submitting a passport issued by the United States of America.

    • document_type = PASSPORT_BIODATA, used when submitting a passport issued by a country other then the United States of America.

  • When submitting a passport, the country code will be validated based on the value being US or not if you submit the incorrect document_type. document_types that will fail this check, including PASSPORT_BIODATA, are:

    • NATIONAL_ID

    • DRIVER_LICENSE

    • VOTER_REGISTRATION_CARD

    • PERMANENT_RESIDENT_CARD

    • PASSPORT_BIODATA

  • For users submitting passports issued in the United States of America, verification of a Social Security Number is also required. This is regardless of the user's country of residence.

Last updated