Creating a contact verification (API)

You can create a verification directly on a contact from the workspace address book — independently of any document. This is handy for verifications created "in advance": as long as it's valid, it is applied automatically to documents you later create with that contact.

Creating

Specify the contact using either contactUuid or contactEmail — exactly one of them:

curl -X POST -H "x-api-key: YOUR_API_KEY" -H "Content-Type: application/json" \
  https://api.signi.com/api/v2/verifications \
  -d '{
    "contactEmail": "jan.novak@email.cz",
    "offeredGroups": ["11111111-2222-3333-4444-555555555555"]
  }'

{
    "uuid": "aaaa1111-bbbb-2222-cccc-333344445555",
    "verificationUrl": "https://app.signi.com/…",
    "tokenExpiresAt": "2027-02-01T12:00:00+01:00"
}

• offeredGroups — 1–2 UUIDs of verification groups from which the person being verified will choose.
• verificationUrl — the welcome link through which the person being verified completes the verification.
• notify — whether Signi should send the person being verified an email with the link (default true); you can also hand them the link yourself.
• redirectUrl — where to redirect the person being verified after completion.
• webhooks — notifications of status changes for this verification, see Verification webhooks.

Each call creates a new verification run — existing ones are not recycled here (that only happens when linking to a document).

Verification detail

curl -H "x-api-key: YOUR_API_KEY" https://api.signi.com/api/v2/verifications/VERIFICATION_UUID

Returns the status, the offered and chosen group, the times of individual steps, and results per component:

{
    "uuid": "aaaa1111-bbbb-2222-cccc-333344445555",
    "status": "approved",
    "group": "11111111-2222-3333-4444-555555555555",
    "expiresAt": "2028-02-01T12:00:00+01:00",
    "results": [
        {
            "component": "document",
            "result": "success",
            "extractedData": { "…": "extracted personal data, if extraction is enabled" },
            "statusData": { "…": "technical provider metadata" },
            "files": { "…": "signed, time-limited links to stored files" }
        }
    ]
}

Contact verification history

All verifications of a contact, newest first — by contact UUID or by email:

curl -H "x-api-key: YOUR_API_KEY" https://api.signi.com/api/v2/verifications/contact/CONTACT_UUID
curl -H "x-api-key: YOUR_API_KEY" "https://api.signi.com/api/v2/verifications/contact?email=jan.novak@email.cz"

Each item carries the status, times, the reason for any rejection or refusal, and the group name.

Where to go next

• Signi verification — how it works
• Approving and rejecting a verification