Skip to main content

Core API concepts

The API is completely stateless and synchronous. You send a request, wait up to a few seconds, and get a response.

The underlying verification service is very configurable, and both the request and response are designed in a layered way. You should be able to use very few options to get a configuration that matches your needs broadly, and then optionally more detailed, lower-level options to fine-tune it.

Similarly, you should be able to look at very few fields in the response to understand the verification result at a high level, and then optionally more detailed, lower-level fields to understand exactly what happened in more detail.

Layered API Design

Progressive complexity and detail

Request

Simple
↓
Detailed
UseCase
MatchLevels
Additional Settings

Response

High-level
↓
Granular
Recommended Outcome
Overall Fraud Check
High-Level Check Results
Individual Check Results
Additional Info
💡 Start at the top, only drill down as needed

Learn more about core concepts​

  • Check - The basic building block of verification
  • Use Case - A powerful tool for customizing Verify
  • Recommended Outcome - A simple way to interpret the results
  • Match Level - The strictness level for a single check
  • Options - More granular control over the verification process
Last updated on