Verify & Enroll User
Validate and authenticate users with Face Match
Once a Face Match session is complete, use the Verisoul API to verify or authenticate the user.
Verify
Verify the authenticity of the session by calling the /verify-face endpoint. The endpoint provides three values to help interpret the risk of the user:
- Decision -> an overall decision; Real, Suspicious, or Fake
- Risk Score -> a 0-1 number score representing the overall risk of the user
- Risk Flags -> an array of string flags that summarize the risky aspects of the user’s session
See here for the full set of risk flags
For more nuanced decisioning you can also interpret the other risk signals captured in the session.
Device and Network Signals
Device and network Signals are information about the user’s exact device and connecting network.
| Name | Description |
|---|---|
| ip_document_country_mismatch | Current IP geolocation country does not match document geolocation |
| device_risk | Device likely emulator, VM |
| proxy | Face Match on a proxy IP |
| vpn | Face Match on a VPN IP |
| datacenter | Face Match on a datacenter |
| tor | Face Match on a TOR IP |
| recent_fraud_ip | Face Match on an IP reported as fraud |
| device_network_mismatch | Device user agent is inconsistent with connecting network fingerprint |
Referring Session Signals
Referring Session Signals will only be present if you initialized the session with a referring_session_id parameter.
| Name | Description |
|---|---|
| impossible_travel | Referring session geolocation is far from Face Match geolocation relative to timespan |
| ip_mismatch | Referring session IP different than Face Match session IP |
| user_agent_mismatch | Referring session user agent different than Face Match session user agent |
Multi Accounting
Face Match will calculate any potential matches based on three identifiers captured during all sessions.
| Match Type | Description |
|---|---|
| browser | Face Match session was completed on the same browser session |
| ip_address | Face Match session shares the same ip address |
| face | Face Match session shares the same face |
Enroll
Use Enroll to tie the session to your account identifier. You must do this to detect multi-accounting. By enrolling an account, Verisoul will know to match future sessions against enrolled accounts to help you prevent repeat devices and repeat faces from signing up.
API Reference
For complete details on all available endpoints and parameters, see the Face Match API Reference.