Skip to main content

​
Configuration

{
    "id": "6797df4ca4c4910bc0f1d48f",
    "name": "ID_VERIFICATION",
    "options": {
        "require_selfie": true,
        "enable_liveness_detection": true,
        "require_id_back_side": false,
        "run_background_check": {
            "watchlist_check": true,
            "sanctions_check": true
        }
    },
    "control_flow": {
        "condition": {
            "condition_operator": "==",
            "condition_field": "id_valid",
            "condition_value": true
        },
        "if_goto": "6797dfe7a4c4910bc0f1d492",
        "else_goto": "6797fd5e683fb54e8abe7d852"
    },
    "provider": ["Persona"]
}

​
Config Fields

​
Required Fields

  • id: Unique identifier for the verification step
  • name: Step type identifier (ID_VERIFICATION)

​
Options

  • require_selfie: Whether to require a selfie photo for identity verification
  • enable_liveness_detection: Whether to enable liveness detection during the verification process
  • require_id_back_side: Whether to require the back side of the ID
  • run_background_check: Options for running background checks

​
Control Flow

Determines the next step based on ID validity:
  • If id_valid is true, proceeds to step 6797dfe7a4c4910bc0f1d492

​
Example Response

{
    "id_verification": {
        "status": "COMPLETED",
        "id_valid": true,
        "identity": {
            "firstName": "Jane",
            "lastName": "Doe",
            "dateOfBirth": "1992-05-20T00:00:00Z",
            "id_number": "A123456789",
            "expiration_date": "2025-12-31T00:00:00Z",
            "address": "456 Elm Street",
            "city": "Toronto",
            "state": "ON",
            "postalCode": "M5V 2T6",
            "country": "CA"
        },
        "verification": {
            "provider": "Persona",
            "verified_at": "2025-02-03T20:25:05-05:00"
        },
        "background_checks": {
            "watchlist_check": {
                "result": "CLEAR",
                "details": "No matches found"
            },
            "sanctions_check": {
                "result": "CLEAR",
                "details": "No matches found"
            }
        }
    }
}

​
Output Fields

​
Status Information

  • status: Current status of the verification (e.g., “COMPLETED”)
  • id_valid: Whether the ID was successfully verified

​
Identity Information

  • identity: Personal identification details
    • Basic information like name, date of birth, ID number, and expiration date
    • Current address information

​
Verification Details

  • verification: Information about the verification process
    • provider: Which provider performed the verification
    • verified_at: When verification was completed

​
Background Check Results

  • background_checks: Results of background checks performed
    • watchlist_check: Result of the watchlist check
    • sanctions_check: Result of the sanctions check