Incode

Verify a customer’s identity using a government-issued ID and a live selfie.

This action starts an Incode identity verification workflow. The customer is guided through a selfie capture and government-issued ID upload. Incode performs liveness checks, validates the ID document, extracts ID data, and compares the selfie with the ID photo for biometric matching.

This workflow can help support KYC/AML requirements, reduce fraud, and improve customer onboarding, account recovery, or transaction authentication experiences.

Union

unioned: When unioned, this action waits for another action to complete before processing.
not unioned: When not unioned, this action runs independently and resolves once verification is complete.

Determines the behavior of the action:

When unioned, the document verification will
be processed automatically when the unioned action resolves.
When not unioned,the action resolves automatically once document verification is completed.

Macro level details for how union attribute behaves can be found within the Union documentation.

Features

Name	Type	Description	Rules
redirectionUrl	string	URL where the user is redirected after successful verification. Examples: "https://example.com".
demoMode	boolean	Set `demoMode` to `true` to use the sandbox environment. Set it to `false` to use production. Examples: true.
language	string	Language code used for the Incode verification session. Defaults to 'en-US' when not provided. Examples: "en-US", "es-MX".
submitLabel	string	Label used for the verification submit button on the GUI. Defaults to 'Verify' when not provided. Examples: "Verify".	MaxLength: 50 MinLength: 3
resolvedMessage	string	Message shown on the GUI for the resolved state of the action. Examples: "Documents verified successfully".	MinLength: 3

Context (required)

Name	Type	Description	Rules
configurationId	string	(required) Flow ID used for the Incode verification session. Examples: "xxxx-xxxx-xxxx-xxxx".	MinLength: 1

Example

Below is an example payload for adding an Incode action to a business process or blueprint.

{
    "type": "incode",
    "union": 1,
    "features": {
        "redirectionUrl": "https://example.com",
        "demoMode": true,
        "language": "es-MX",
        "submitLabel": "Verify",
        "resolvedMessage": "Documents verified successfully"
    },
    "context": {
        "configurationId": "xxxx-xxxx-xxxx-xxxx"
    }
}