Skip to main content

​
Overview

Identity verification can be enabled when adding a package by setting the required identity verification policyCode and enabling the verify option on each signer that requires their identity to be verified.
Identity verification policies must be enabled on your account before they can be used in signing packages.Request IDV to be enabled on your account

​
Policies

Policy CodePass-To-SignRegionRetries
trulioo3_documentfalseAny2
trulioo3_document_requiredtrueAny2
trulioo3_document_ca_strictfalseCA2
trulioo3_document_ca_strict_requiredtrueCA2
Pass-To-Sign indicates whether the signer must successfully complete identity verification before they can sign their documents.

​
Add package with IDV

To create a signing package with identity verification enabled:
1

Set policy

Set the verificationOptions.policyCode to the desired verification policy under package options.
2

Enable signer verification

Set the verify property to true for each signer that needs to complete identity verification.
Request
POST /packages/add
{
  "name": "New Package with IDV",
  "type": "concurrent",
  "state": "open",
  "options": {
    "verificationOptions": {
      "policyId": null,
      "policyCode": "trulioo3_document"
    }
  },
  "signers": [
    {
      "firstName": "signer",
      "lastName": "one",
      "email": "signer.one@syngrafii.com",
      "verify": true
    }
  ],
  "documents": [
    {
      "fileName": "document.pdf",
      "fileId": "682f1158-e3f5-4329-8f88-c52cb5447d8c"
    }
  ]
}
See the Packages add API for more information.

​
Signer experience

When the signer opens the signing session, they will be prompted to complete the identity verification process before they can proceed to sign the documents. The verification process will follow the rules defined in the selected verification policy.

​
Verification status

You can check the identity verification status of each signer by calling the /packages/{packageId}/status endpoint. The signer’s verification state and verificationId will be included in the response.
Response
{
    "packageId": "08aba360-4466-4463-8b4b-9585d3de4b33",
    ...
    "signers": [
        {
            "signerId": "dff8f8cc-fe2d-428e-9a8c-bcf1a2b187ce",
            "verification": {
                "verificationId": "6297e62f-d49d-4f2e-8369-e24ce4316e73",
                "state": "passed"
            }
        }
    ]
}
See the Packages status API for more information.

​
Verification results

You can retrieve detailed verification results for a signer by calling /packages/{packageId}/signers/{signerId}/verification endpoint.
Response
{
    "verificationId": "6297e62f-d49d-4f2e-8369-e24ce4316e73",
    "packageId": "08aba360-4466-4463-8b4b-9585d3de4b33",
    "signerId": "dff8f8cc-fe2d-428e-9a8c-bcf1a2b187ce",
    "state": "passed",
    "results": [
        ...
    ]
}
The verification results provide detailed information about the identity verification process, including any documents submitted and their verification outcomes.
See the Verifications signer API for more information.