IDV object

AI Tools

This is where you can specify an identity verification check to be completed alongside the signing of documents. This makes use of our identity verification service, more details regarding this can be found here. You will need to specify the configuration for the types of checks that you need, we have predefined configurations but you also have the option to create and use a custom configuration.

"verification": { "idv": { "session_config_name": "Real Estate", "when": "before_viewing", "session_limit": 10, "blocks_signing": ["deadend_errors", "merge_field_not_resolved"] } }

"verification": { "age": { "age_estimation": { "allowed": true } } }

Session_config_name

The name of either a prebuilt configuration or a customised configuration.

"session_config_name": "Real Estate"

Session_config_name	Description
Real Estate	Prebuilt session configuration, the json can be found here.
HR	Prebuilt session configuration, the json can be found here.
Finance	Prebuilt session configuration, the json can be found here.
Adult	Prebuilt session configuration, the json can be found here.
Recruitment	Prebuilt session configuration, the json can be found here.
Liveness Only	Prebuilt session configuration, the json can be found here.
Custom*	A custom configuration that can be created and then named by you.

When

Specifies when the identity verification should take place

Hint currently the only option is "before_viewing"

"when": "before_viewing"

When	Description
before_viewing	Identity verification will take place before the signing process.
after_submitting	The document signing itself will complete independently of the verification. Once the user has signed, the signer can return to the signing link to complete the Id verification at another time. Once they have submitted a verification session they will not be able to return to the signing link

session_limit

This represents the maximum number of identity verification sessions that can be created by a recipient.

The minimum limit is 1.
The maximum limit is 10

blocks_signing

This represents the ability to block the user from signing the document if any errors occur in the identity verification process.

Attribute	Description
deadend_errors	The signer will not be able see/sign the document if any errors occur in the identity verification process.
merge_field_not_resolved	The signer will not be able see/sign the document if the merge field configured in your tags array is not pre-populated.

Last updated on

Was this page helpful?