Authentic-id

You can verify a customer’s identity using a government-issued ID and a live selfie capture.

This document describes the ID verification workflow powered by AuthenticID, combining biometric facial recognition with secure document validation. Customers are guided through a selfie capture process and prompted to upload a government-issued ID. AuthenticID’s system performs real-time liveness checks, extracts and validates ID data, and compares the selfie to the ID photo for biometric matching.

By integrating this workflow, platforms can ensure regulatory compliance, reduce fraud, and deliver a seamless customer experience. This solution supports KYC/AML standards and is adaptable for onboarding, account recovery, or transaction authentication flows.

No products are required to use this action.

Union

Determines the behavior of the action:

  • When unioned, the document verification will be processed automatically when the unioned action resolves.
  • When not unioned,Once documents verification completed action will be resolved itself.

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

Features (required)

NameTypeDescriptionRules
titlestring(required) A short description for what document required for verification
Examples: "Verify Documents", "Verify Driving License".
MaxLength: 50
MinLength: 3
desktopOnlyMessagestringA message displayed when the experience is best suited for mobile devices.
Examples: "The experience works best on a mobile device.".
MaxLength: 500
MinLength: 10
documentVerificationInfostringInformation provided to users about document verification steps.
Examples: "You will be asked to upload a clear image of your document and follow the on-screen instructions for verification.".
MaxLength: 500
MinLength: 20
configurationobject objectConfiguration settings for the Web SDK.See configuration
accountCodestringMerchant account code.
Examples: "999", "123".
MinLength: 3
redirectURLstringRedirect URL where merhcant can request additional information.
Examples: "https://example.com".
postbackURLstringAuthenticID will provide transaction details using a postback as soon as the transaction is complete. Merchant needs to configure this server.
Examples: "https://example.com".
documentTypestringMerchant can define specific document type that need to get verified. Document codes: ('00': 'License Only','01': 'License/Passport', '11': 'Passport Only')
Examples: "00", "01", "11".
Possible values: 00, 01, 11.
demoModebooleanMerchant can define demoMode flag to define AuthenticID envrionment. For 'true' sandbox envrionment will be used otherwise production envrionment will be used.
Examples: true.

configuration

NameTypeDescriptionRules
frontCaptureModestringMode for front document capture.Possible values: Auto, Manual.
backCaptureModestringMode for back document capture.Possible values: Auto, Manual.
selfieCaptureModestringMode for selfie capture.Possible values: Auto, Manual.
enableSelfieCapturebooleanFlag to enable selfie capture.
enableFarSelfiebooleanFlag to enable far selfie capture.
backIsBarcodeDetectedEnabledbooleanFlag to enable far back side barcode.
transactionAttemptsnumberNumber of transaction attempts allowed.
frontCaptureAttemptnumberNumber of front document capture attempts.
backCaptureAttemptnumberNumber of back document capture attempts.
enableLocationDetectionbooleanFlag to enable location detection.
requestExpiryTimeInMinnumberRequest expiry time in minutes.
transactionExpiryTimeInMinnumberTransaction expiry time in minutes.
showConsentbooleanIf this value is set to true, the consent screen will be shown.
consentNoticeHeadingstringThe heading displayed on the consent notice screen.
consentCheckboxstringThe checkbox text displayed on the consent notice screen.
consentNoticeLinkHeadingstringThis is the Terms and Conditions link text on the consent notice screen.
consentAgreeStatementstringThe agreement statement displayed on the consent notice screen.
consentNoticestringThis is the consent text on the consent notice screen.
customColorstringThis value is used to color all the buttons in the application. The value should be in CSS3 Hex format.
logostringThis value displays as the logo on the welcome screen. The value in this field should be a Base64 encoded image file.
homeScreenstringThis value is used to show the background image on the welcome and consent screen. The value in this field should be a Base64 encoded image file.

Example

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

{
    "type": "authentic-id",
    "union": 1,
    "features": {
        "title": "Verify Driving License",
        "desktopOnlyMessage": "The experience works best on a mobile device.",
        "documentVerificationInfo": "You will be asked to upload a clear image of your document and follow the on-screen instructions for verification.",
        "configuration": {},
        "accountCode": "123",
        "redirectURL": "https://example.com",
        "postbackURL": "https://example.com",
        "documentType": "11",
        "demoMode": true
    }
}