ConsenzAI

Revolutionizing Consent Recording and Liveness Verification

Introduction

ConsenzAI is the ultimate solution for organizations looking to streamline consent recording and liveness verification, ensuring security, compliance, and user satisfaction.

Key features

Intelligent Consent Recording: Utilizing AI, ConsenzAI records consent seamlessly and intelligently, ensuring the user's understanding and agreement.

Active Liveness Verification: Through advanced algorithms, ConsenzAI verifies the user's liveliness actively during the recording process.

Multi-language Support: Users can navigate the process in their preferred language, enhancing accessibility and user comfort.

Efficient Process: The entire journey takes less than 2 minutes, ensuring a swift and convenient experience.

User-friendly Interface: With clear instructions, users are guided to align themselves properly in the camera for optimal recording.

Secure OTP Verification: Users are prompted to speak a specific script along with a randomly generated OTP, ensuring the authenticity of the recording.

Real-time Liveness Checks: Throughout the recording, ConsenzAI performs liveness tests, stopping recording if the user is out of frame or in a noisy environment.

Script Matching: Extracting text from the video, ConsenzAI matches it with the given script, ensuring accuracy and completeness.

Passive Liveness Test: Along with active verification, ConsenzAI conducts passive liveness tests (iBeta certified), enhancing security measures.

Face Match Score: Users receive a face match score, adding an extra layer of security and identity verification.

Benefits

Fraud Prevention: By actively verifying liveliness and matching the script, ConsenzAI helps prevent identity fraud and ensures authentic consent.

User Convenience: The efficient and user-friendly process makes consent recording and liveness verification quick and hassle-free.

Compliance: ConsenzAI helps institutions meet regulatory requirements by providing secure and accurate verification.

Enhanced Security: With real-time liveness checks and face match scores, ConsenzAI offers advanced security measures.

Global Accessibility: Supporting multiple languages, ConsenzAI can be used worldwide, catering to diverse user bases.

Personalization: The option to select an accent color allows for a personalized touch, enhancing user engagement and brand loyalty.

Customization

Accent Color: Configure a single color to apply throughout the interface for consistent branding

Language

Timer

Script

Output

The output of ConsenzAI( async api) includes captured video url, audio to text conversion with matching percentage with the given script, passive liveness score, face match score and data from the passive liveness API.

Prerequisites

To use ConsenzAI, you need to obtain an access token from Signzy's systems. Follow this document for setup instructions.

When integrating the video URL in the iframe, ensure the "camera, microphone and location" attribute is allowed in the iframe tag, e.g., allow="camera"

After integration, you can listen to an event with message "Verification Done" in your parent window to know exactly when the whole liveness process has been completed. Below is the code for listening to the event

window.addEventListener('message', function(event) {
  if (event.data== 'Verification Done') {
  }
}, false);

For react native

<WebView
      source={{
        uri: url,
      }}
      allowsFullscreenVideo={false}
      playsinline
      onMessage={(event) => console.log(event.nativeEvent.data)}
      allowsInlineMediaPlayback={true}
      javaScriptEnabled={true}
      domStorageEnabled={true}
    />

Understanding Iframes

An iframe is a special window within a webpage that can display content from another website, such as a video, map, or social media post. It allows you to bring different types of content together on your webpage, enhancing user interaction and information accessibility without leaving the main page.

For more information on iframe , read more.

Endpoint Details

Request type - POST

Preproduction Environment ->

https://api-preproduction.signzy.app/api/v3/consenzAI/createUrl

Request Body Parameters

Parameter	Data Type	Description	Required
languageCode	String	The language in which you want the liveness verification to be done by the consumer. Possible values include: "hi" - Hindi "en" - English "es" - Spanish "kn" - Kannada "te" - Telugu "gu" - Gujarati "as" - Assamese "ta" - Tamil "pa" - Punjabi "bn" - Bengali "ml" - Malayalam "mr" - Marathi "or" - Odia (Oriya) "mni-Mtei" - Manipuri "ur" - Urdu Upcoming languages : Arabic, Portuguese, Russian, Japanese, Vietnamese, Turkish, Korean, German, French	No
matchImage	Array	Publically accessible URLs of ID document image/Face image of the individual which is to be matched with the face in the video. e.g: https://example.com/hosted_img.jpg	No
hideBottomLogo	String	By default, Signzy's logo will be rendered with the iframe but can be removed by passing the value of this field as "true".	No
callbackUrl	String	This URL will be used for posting the results from the video verification process.	No
redirectUrl	String	Redirection URL to redirect user post verification process successfully	No
accentColor	String	This property can be used to define the colors of the iframe screen.	No
script	String	A custom text provided by client which the user has to speak out while recording. Clients can provide the script of maximum 5000 characters.	No
timer	Integer	You can specify the recording time, or it will default to 12 seconds. Max- 90 seconds	No
backgroundColor	String	Sets the page background color , accepts color names, hex codes, or "transparent". Default is light grey ; unexpected values is taken as white.	No

JSON

{
     "languageCode":"hi", // The language in which you want the custom text to be rendered for customer
     "matchImage": [ "https://domain/hosted_image.jpg” ],
     "hideBottomLogo": "true",
     "callbackUrl": "https://webhook_URL.com", // The verification results will be posted on this URL
     "redirectUrl": "https://www.thank_you_page.com", // After the journey where you want your customer to be taken
     “accentColor” : “... the property that will define the color of the iframe”,
     "script" : "My name is Utkarsh Rai. My employee id is ABCD",
     "timer" : 12
}

Request Headers

Name	Value
Content-Type	application/json
Authorization	XXXXXXXXXXX - Reach out to the Signzy support team to get one created.

Code Sample:-

curl --location 'https://api-preproduction.signzy.app/api/v3/consenzAI/createUrl' \
--header 'Content-Type: application/json' \
--header 'Authorization: XXXXXXXXXX' \
--data '{
      "languageCode":"hi", 
      "matchImage": [ "https://domain/hosted_image.jpg” ],
      "hideBottomLogo": "true",
      "callbackUrl": "https:
      "redirectUrl": "https://www.thank_you_page.com", 
      “accentColor” : "#1F57E7”,
      "script" : "I Utkarsh Rai consent to verify my identity and confirm my acceptance of the terms of the insurance policy including the interest rate and all associated terms and conditions",
      "timer" : 12
}

Response Body Parameters

Parameters	Data Type	Description
consumerId	String	Unique identifier of the business
Token	String	Unique ID for each liveliness verification session transaction. You would need this if you want to fetch video verification results via an API call.
videoUrl	String	The unique URL generated in response of CreateURL request which should be loaded in the iframe.
hideBottomLogo	String	By default, Signzy's logo will be rendered with the iframe but can be removed by passing the value of this field as "true".
matchImage	Array	Publically accessible URLs of ID document image/Face image of the individual which is to be matched with the face in the video. Accepted format: [ .png, .jpg, .tiff ]
languageCode	String	The language in which you want the video verification to be done by the customer.
accentColor	String	This property can be used to define the colors of the iframe screen.
callbackUrl	String	This URL will be used for posting the results from the liveliness verification process.
redirectUrl	String	Redirection URL to redirect user posts successfully recording the video.
script	String	Custom text provided the client Maximum length that can be given is 300 characters
timer	Integer	Custom recording length of video

JSON

{
       "languageCode": "hi",
       "matchImage": [ "https://domain/hosted_image.jpg” ],
       "hideBottomLogo": "true",
       "accentColor": "#1F57E7",
       "token": "<unique_id_for_liveness_verification_session>",
       "consumerId": "<consumer-id>",
       "videoUrl": "http://liveliness.test/consumer/<consumer-id>/token/<token-id>",
       "callbackUrl": "http://callback_URL.com",
       "redirectUrl": "http://redirect_URL.com",
      "script" : "I Utkarsh Rai consent to verify my identity and confirm my acceptance of the terms of the insurance policy including the interest rate and all associated terms and conditions",
   	"timer": 12
}

Getting the results

Approach 1(Automatic)

If a callback URL is provided then the whole response/error in JSON format will be posted to that URL.

Approach 2(Manual) -

Request type - POST

Preproduction Environment ->

https://api-preproduction.signzy.app/api/v3/consenzAI/getData

Request body parameters

Parameter	Data Type	Description	Required
token	String	Token received in the video URL Generation Request.	Yes

JSON

{
   "token":"__token__"
}

Request headers

Name	Value
Content-Type	application/json
Authorization	XXXXXXXXXXX - Reach out to the Signzy support team to get one created.

Code Sample

curl --location 'https://api-preproduction.signzy.app/api/v3/consenzAI/getData' \
--header 'Content-Type: application/json' \
--header 'Authorization: XXXXXXXXXX' \
--data '{
    "token": "__token__"
}'

Response body parameters

Parameter	Data type	Description
result	Object	Contains the result of the verification
result.consumerId	String	Unique identifier for the consumer
result.token	String	Token received in the video URL Generation Request.
result.isUsed	String	If value is 1 , it means the journey has been completed for the given consumer and token.
result.capturedImage	String	The image of the user clicked during the liveness check
result.video	String	URL of the recorded video of the user
result.geoLocation	Object	The object gives the geo-location of the user
result.geoLocation.latitude	String	Latitude of the geo-location
result.geoLocation.longitude	String	Longitude of the geo-location
result.faceMatch	Object	Contains the face match result
result.faceMatch.verified	Boolean	Indicates whether the verification was successful (true or false).
result.faceMatch.message	String	A message describing the result of the verification process.
result.faceMatch.matchPercentage	String	The percentage indicating the level of match or similarity.
result.passiveLiveliness	Object	Contains the liveliness result of the input image.
result.passiveLiveliness.liveness	Boolean	"true" if the image is live else "false"
result.passiveLiveliness.score	String	LIveliness score of the input image. The value can be between 0 and 1.
audioTextMatch	Object	Contains the result of match score of speech to text and the script provided by client
matchAudioScore	String	Gives the result in percentage about the match score of speech to text and the script provided by the client.
ipAddress	String	ipAddress of the user
date	String	Date on which the journey took place in DD/MM/YYYY format.
timestamp	String	Time at which the recording of the user took place in HH:MM:SS format.
essentials	Object	Contains the data sent as part of the request.
essentials.matchImage	Array	URL of the image, which is to be matched with the face in the video
essentials.callbackUrl	String	This URL will be used for posting the results from the video verification process.
essentials.redirectUrl	String	Redirection URL to redirect user posts successfully recording the video.
essentials.languageCode	String	The language in which you want the video verification to be done by the customer.
essentials.hideBottomLogo	String	By default, Signzy's logo will be rendered with the iframe but can be removed by passing the value of this field as "true".
script	String	Custom text provided the client with OTP.
timer	String	Custom recording length of video in seconds
id	String	Unique identifier for the request

JSON

{
   "result": {
       "result": {
           "consumerId": "<consumer-id>",
           "token": "<token>",
           "isUsed": 1,
           "capturedImage": "https://capturedImage.png",
           "video": "https://videoUrl.webm",
           "geoLocation": {
               "latitude": 32.012,
               "longitude": 82.41
           },
           "passiveLiveliness": {
                   "liveness": false,
                   "score": 0
           },
           "faceMatch": {
                   "verified": false,
                   "message": "Verification completed with negative result",
                   "matchPercentage": "0.00%"           },
           "audioTextMatch": {
               "matchAudioScore": "77.27%"
           },
           "ipAddress": "192.0.0.0",
           "date": "12/11/22",
           "timestamp": "14:02:35"
       },
       "essentials": {
           "matchImage": [
               "https://matchImage.jpg"
           ],
           "callbackUrl": "https://callbackURL",
           "languageCode": "en",
           "accentColor": "#1F57E7",
           "hideBottomLogo": "true",
           "script": "My name is Utkarsh Rai. My employee id is ABCD 435489",
           "timer": 12
       },
       "id": "663358cfa0e3543de6fa8ca2"
   }
}