API Reference

Verifies consumer-provided information

Log in to see full request history

📘

All users require basic verification

All users must complete our basic verification to protect them from fraud and ensure that we operate within government regulations. For US users, this endpoint is all that is required to complete all proper Know Your Customer checks:

  • Sanctions Screening
  • Politically Exposed Person Screening
  • Identity Verification
  • Social Security Verification
  • Fraud Risk Scoring

Since non-US residents do not have a social security number, an additional verification step is required via the Document Verification endpoint.

👍

Recommended UI for basic verification

We recommend collecting the inputs for this endpoint via two separate screens, grouped as follows:

  • Screen #1:

    • Address
      • Street 1 (required)
      • Street 2 (optional)
      • Country
      • State
      • City
      • Postal Code
  • Screen #2

    • First Name
    • Last Name
    • Date of Birth
    • Social Security Number (For US users only)

🚧

Don't forget to include the sessionKey created at the start of the user flow

The sessionKey parameter must be included to ensure we link all of the session data into one check. This helps us avoid false positives, which helps you increase conversion rates.

Query Params
string
required
Body Params
string
required
string
required
address
object
required
string
string
required

Date of birth in format YYYY-MM-DD

nationalID
object
Headers
string
required
string
string

Timestamp in milliseconds, use: new Date().getTime().toString()

Responses

400

Invalid request parameters

Language
Credentials
Click Try It! to start a request and see the response here! Or choose an example:
application/json