How to Enable Identity Verification

Problem

You need to confirm a recipient's identity before they can view or sign a document -- for compliance, security, or audit requirements.

Prerequisites

Authenticated via OAuth or API key
A template with at least one recipient role, or an existing document with recipients

Solution

Add verification_settings to a recipient either at document creation (Create Document) or on an existing document (Update Recipient).

Choose a verification method

Passcode

The recipient must enter a passcode you define. It must be 6-100 characters with at least one letter and one digit.

"verification_settings": {
    "verification_place": "before_open",
    "passcode_verification": {
        "passcode": "SimpleCode1"
    }
}

SMS one-time password

A one-time code is sent to the recipient's phone. The number must be in international format (e.g., +1555667890).

"verification_settings": {
    "verification_place": "before_open",
    "phone_verification": {
        "phone_number": "+48123456789"
    }
}

Knowledge-based authentication (KBA)

The recipient answers identity questions generated from public records.

"verification_settings": {
    "verification_place": "before_open",
    "kba_verification": {
        "enabled": true
    }
}

ID check

The recipient verifies identity with a government-issued ID.

"verification_settings": {
    "verification_place": "before_open",
    "id_verification": {
        "enabled": true
    }
}

Choose when to verify

Set verification_place to control when the check occurs:

Value	When	Available for
`before_open`	Before the recipient can view the document	All recipients
`before_sign`	Before the recipient can sign	Signers only

Full example: create a document with passcode verification

{
    "name": "One Signer with Recipient Verification",
    "template_uuid": "Pw3syYYAvTU2h3Tx6vqatG",
    "recipients": [
        {
            "role": "Client",
            "first_name": "Signer",
            "last_name": "One",
            "email": "[email protected]",
            "verification_settings": {
                "verification_place": "before_open",
                "passcode_verification": {
                    "passcode": "SimpleCode1"
                }
            }
        }
    ]
}

Replace template_uuid and role with values from your workspace.