{ "openapi": "3.0.4", "info": { "title": "Documents and Biometrics Endpoints Overview", "description": "GBG's Documents and Biometrics is our RESTful API offering for GBG's core document verification services including Document Verification, Passive Liveness, and Facematch. These API's empower our customers to have complete control of their desired user experience and user interfaces. Documents and Biometrics Core allows our Customers to make decisions that best suit their business needs. Customers have full control over how they build their business logic and how they interpret the API results. Documents and Biometrics Core is built with a strong emphasis on scalability, enabling our customers to scale as quickly as they need to achieve their business goals. Documents and Biometrics Core is perfectly positioned to enable our customer's on-boarding success.", "version": "v1" }, "paths": { "/AgeEstimation": { "post": { "tags": [ "AgeEstimation" ], "summary": "Performs age estimation from an encrypted packet.", "description": "Age Estimation endpoint allows for an encrypted packet containing photograph to be uploaded for processing to estimate the age of the person in the image.", "parameters": [ { "name": "x-correlation-id", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "FaceImage": { "type": "string", "description": "The face image containing the image data.\nSupported formats: JPEG, PNG. Maximum size: 4 MB.", "format": "binary" }, "AdditionalDetails": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Additional metadata for the request." }, "RequestId": { "type": "string", "readOnly": true }, "CorrelationId": { "type": "string", "readOnly": true } } }, "encoding": { "FaceImage": { "style": "form" }, "AdditionalDetails": { "style": "form" }, "RequestId": { "style": "form" }, "CorrelationId": { "style": "form" } } } } }, "responses": { "200": { "description": "Returns the age estimation result.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AgeEstimationResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AgeEstimationResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AgeEstimationResponse" } } } }, "400": { "description": "Error with the provided parameters.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal error during processing.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/AgeEstimation/id": { "post": { "tags": [ "AgeEstimation" ], "summary": "Performs age estimation using a packet ID.", "description": "Age Estimation by ID endpoint allows for age estimation using a previously uploaded face image ID.", "parameters": [ { "name": "x-correlation-id", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "FaceImageId": { "type": "string", "description": "The ID of the face image." }, "AdditionalDetails": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Additional metadata for the request." }, "RequestId": { "type": "string", "readOnly": true }, "CorrelationId": { "type": "string", "readOnly": true } } }, "encoding": { "FaceImageId": { "style": "form" }, "AdditionalDetails": { "style": "form" }, "RequestId": { "style": "form" }, "CorrelationId": { "style": "form" } } } } }, "responses": { "200": { "description": "Returns the age estimation result.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AgeEstimationResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AgeEstimationResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AgeEstimationResponse" } } } }, "400": { "description": "Error with the provided parameters.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Packet not found.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal error during processing.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/Biometrics": { "post": { "tags": [ "Biometrics" ], "summary": "Biometric check Endpoint detects biometric spoofing from the encrypted liveness packet and the selfie image, without introducing friction or bias.", "description": "Documents and Biometrics Core BiometricCheck endpoint allows for an encrypted packet containing photograph and the environment metadata to be uploaded for processing to determine the probability that the end user was present at the time of capture, and also detect any threatening injection attacks. An anchor Selfie image is uploaded to compare the face match with the image extracted from the liveness packet. (Please reach out to your support representative for the \"Documents Biometrics Liveness Guide\" for further guidance on authentication). The endpoint will return a result after processing. The response contains EnhancedLivenessScore, in the range of 0 to 1, PassiveLivenessScore in the range of 0 to 100, and FacematchScore in the range of 0 to 1. The results is either a PASS (EnhancedLiveness Probability > 0.8 and Facematch result is a Matched) or FAIL based on the validation.", "parameters": [ { "name": "x-correlation-id", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "EnhancedLivenessPacket": { "type": "string", "description": "Gets or sets the enhanced liveness packet.", "format": "binary" }, "ComparisonSelfie": { "type": "string", "description": "Gets or sets the comparison selfie.", "format": "binary" }, "AdditionalData": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "description": "Key value pair to include any additional metadata for the request." }, "RequestId": { "type": "string", "readOnly": true }, "CorrelationId": { "type": "string", "readOnly": true } } }, "encoding": { "EnhancedLivenessPacket": { "style": "form" }, "ComparisonSelfie": { "style": "form" }, "AdditionalData": { "style": "form" }, "RequestId": { "style": "form" }, "CorrelationId": { "style": "form" } } } } }, "responses": { "200": { "description": "Returns a success on the Endpoint after processing the biometric check.This code\ndoes not indicate a success on the Biometric validation but rather a success on the call to the\nEndpoint.The BiometricCheckResponse is in the response body (See Response Body section below).", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BiometricCheckResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BiometricCheckResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BiometricCheckResponse" } } } }, "400": { "description": "Error with the provided parameters, please, check the response provided to get more insights on\nthe problem.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BiometricCheckErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BiometricCheckErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BiometricCheckErrorResponse" } } } }, "500": { "description": "Internal error during our processing, please, get in touch with support so we can help you.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/Biometrics/id": { "post": { "tags": [ "Biometrics" ], "summary": "Biometric check Endpoint detects biometric spoofing from the encrypted liveness packet id and the selfie image id, without introducing friction or bias.", "description": "Documents and Biometrics Core BiometricCheckById endpoint allows for an encrypted packet containing photograph and the environment metadata to be uploaded for processing to determine the probability that the end user was present at the time of capture, and also detect any threatening injection attacks. An anchor Selfie image id is uploaded to compare the face match with the image extracted from the liveness packet. (Please reach out to your support representative for the \"Documents Biometrics Liveness Guide\" for further guidance on authentication). The endpoint will return a result after processing. The response contains EnhancedLivenessScore, in the range of 0 to 1, PassiveLivenessScore in the range of 0 to 100, and FacematchScore in the range of 0 to 1. The results is either a PASS (EnhancedLiveness Probability > 0.8 and Facematch result is a Matched) or FAIL based on the validation.", "parameters": [ { "name": "x-correlation-id", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "EnhancedLivenessPacketId": { "type": "string", "description": "Gets or sets the enhanced liveness packet." }, "ComparisonSelfieId": { "type": "string", "description": "Gets or sets the comparison selfie." }, "AdditionalData": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "description": "Key value pair to include any additional metadata for the request." }, "RequestId": { "type": "string", "readOnly": true }, "CorrelationId": { "type": "string", "readOnly": true } } }, "encoding": { "EnhancedLivenessPacketId": { "style": "form" }, "ComparisonSelfieId": { "style": "form" }, "AdditionalData": { "style": "form" }, "RequestId": { "style": "form" }, "CorrelationId": { "style": "form" } } } } }, "responses": { "200": { "description": "Returns a success on the Endpoint after processing the biometric check.This code\ndoes not indicate a success on the Biometric validation but rather a success on the call to the\nEndpoint.The BiometricCheckByIdResponse is in the response body (See Response Body section below).", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BiometricCheckByIdResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BiometricCheckByIdResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BiometricCheckByIdResponse" } } } }, "400": { "description": "Error with the provided parameters, please, check the response provided to get more insights on\nthe problem.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BiometricCheckErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BiometricCheckErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BiometricCheckErrorResponse" } } } }, "500": { "description": "Internal error during our processing, please, get in touch with support so we can help you.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/CelebrityCheck": { "post": { "tags": [ "CelebrityCheck" ], "summary": "Performs celebrity check from an image.", "description": "Celebrity Check endpoint allows for an image containing a face to be uploaded for processing to detect if the person in the image is a known celebrity.", "parameters": [ { "name": "x-correlation-id", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "FaceImage": { "type": "string", "description": "The face image containing the image data.\nSupported formats: JPEG, PNG. Maximum size: 4 MB.", "format": "binary" }, "AdditionalDetails": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Additional metadata for the request." }, "RequestId": { "type": "string", "readOnly": true }, "CorrelationId": { "type": "string", "readOnly": true } } }, "encoding": { "FaceImage": { "style": "form" }, "AdditionalDetails": { "style": "form" }, "RequestId": { "style": "form" }, "CorrelationId": { "style": "form" } } } } }, "responses": { "200": { "description": "Returns the celebrity check result.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CelebrityCheckResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CelebrityCheckResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CelebrityCheckResponse" } } } }, "400": { "description": "Error with the provided parameters.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal error during processing.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/CelebrityCheck/id": { "post": { "tags": [ "CelebrityCheck" ], "summary": "Performs celebrity check using a face image ID.", "description": "Celebrity Check by ID endpoint allows for celebrity detection using a previously uploaded face image ID.", "parameters": [ { "name": "x-correlation-id", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "FaceImageId": { "type": "string", "description": "The ID of the face image." }, "AdditionalDetails": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Additional metadata for the request." }, "RequestId": { "type": "string", "readOnly": true }, "CorrelationId": { "type": "string", "readOnly": true } } }, "encoding": { "FaceImageId": { "style": "form" }, "AdditionalDetails": { "style": "form" }, "RequestId": { "style": "form" }, "CorrelationId": { "style": "form" } } } } }, "responses": { "200": { "description": "Returns the celebrity check result.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CelebrityCheckResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CelebrityCheckResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CelebrityCheckResponse" } } } }, "400": { "description": "Error with the provided parameters.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Image not found.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal error during processing.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/EnhancedLiveness": { "post": { "tags": [ "EnhancedLiveness" ], "summary": "The Enhanced Liveness service detects the most threatening attack vectors: virtual cameras, external devices, browser attacks, network attacks. The service is able to stop a variety of attack content: 3D rendering, face morphing, face swap, cheap fake, deep fake.", "description": "Documents and Biometrics Core Enhanced Liveness endpoint allows for an encrypted packet containing photograph and the environment metadata to be uploaded for processing to determine the probability that the end user was present at the time of capture, and also detect any threatening injection attacks (Please reach out to your support representative for the \"Documents Biometrics Liveness Guide\" for further guidance on authentication). The endpoint will return a result after processing. The response contains CaptureScore, in the range of 0 to 1 and LivenessScore in the range of 0 to 100. The results is a score value between 0 and 100, with a score of 50 and above been considered a pass.", "parameters": [ { "name": "x-correlation-id", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "Packet": { "type": "string", "description": "The generated encrypted packet contains image and other metadata to detect the enhanced liveness.", "format": "binary" }, "AdditionalDetails": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "description": "Key value pair to include any additional metadata for the request." }, "RequestId": { "type": "string", "readOnly": true }, "CorrelationId": { "type": "string", "readOnly": true } } }, "encoding": { "Packet": { "style": "form" }, "AdditionalDetails": { "style": "form" }, "RequestId": { "style": "form" }, "CorrelationId": { "style": "form" } } } } }, "responses": { "200": { "description": "Returns a success on the Endpoint after processing the submitted Encrypted packet.This code\ndoes not indicate a success on the enhanced liveness detection of the request packet itself but rather a success on the call to the\nendpoint.The Enhanced Liveness detection result is in the response body (See Response Body section below).", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/VerifyEnhancedLivenessResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/VerifyEnhancedLivenessResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/VerifyEnhancedLivenessResponse" } } } }, "400": { "description": "Error with the provided parameters, please, check the response provided to get more insights on\nthe problem.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal error during our processing, please, get in touch with support so we can help you.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/EnhancedLiveness/id": { "post": { "tags": [ "EnhancedLiveness" ], "summary": "The Enhanced Liveness service detects the most threatening attack vectors: virtual cameras, external devices, browser attacks, network attacks. The service is able to stop a variety of attack content: 3D rendering, face morphing, face swap, cheap fake, deep fake.", "description": "Documents and Biometrics Core Enhanced Liveness endpoint allows for an encrypted packet containing photograph and the environment metadata to be uploaded for processing to determine the probability that the end user was present at the time of capture, and also detect any threatening injection attacks (Please reach out to your support representative for the \"Documents Biometrics Liveness Guide\" for further guidance on authentication). The endpoint will return a result after processing. The response contains CaptureScore, in the range of 0 to 1 and LivenessScore in the range of 0 to 100. The results is a score value between 0 and 100, with a score of 50 and above been considered a pass.", "parameters": [ { "name": "x-correlation-id", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "PacketId": { "type": "string", "description": "Gets and sets the id of cached Packet ID." }, "AdditionalDetails": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "description": "Key value pair to include any additional metadata for the request." }, "RequestId": { "type": "string", "readOnly": true }, "CorrelationId": { "type": "string", "readOnly": true } } }, "encoding": { "PacketId": { "style": "form" }, "AdditionalDetails": { "style": "form" }, "RequestId": { "style": "form" }, "CorrelationId": { "style": "form" } } } } }, "responses": { "200": { "description": "Returns a success on the Endpoint after processing the submitted Encrypted packet.This code\ndoes not indicate a success on the enhanced liveness detection of the request packet itself but rather a success on the call to the\nendpoint.The Enhanced Liveness detection result is in the response body (See Response Body section below).", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/VerifyEnhancedLivenessByIdResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/VerifyEnhancedLivenessByIdResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/VerifyEnhancedLivenessByIdResponse" } } } }, "400": { "description": "Error with the provided parameters, please, check the response provided to get more insights on\nthe problem.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal error during our processing, please, get in touch with support so we can help you.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/ExtractImage": { "post": { "tags": [ "ExtractImage" ], "summary": "Extracts the JPG portrait captured inside an encrypted enhanced liveness packet.", "description": "Documents and Biometrics Core Extract Image endpoint provides the JPG portrait captured inside an encrypted enhanced liveness packet, allowing it to be used independently (e.g. as an anchor for a subsequent Facematch call) without waiting on a combined Biometrics check.", "parameters": [ { "name": "x-correlation-id", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "EncryptedPacket": { "type": "string", "format": "binary" }, "Configurations": { "type": "object", "additionalProperties": { "type": "string", "nullable": true } }, "RequestId": { "type": "string", "readOnly": true }, "CorrelationId": { "type": "string", "readOnly": true } } }, "encoding": { "EncryptedPacket": { "style": "form" }, "Configurations": { "style": "form" }, "RequestId": { "style": "form" }, "CorrelationId": { "style": "form" } } } } }, "responses": { "200": { "description": "Returns a success on the Endpoint after processing the submitted encrypted packet. This code\ndoes not indicate a success on the extraction of a face from the packet itself but rather a success on the call\nto the endpoint. The extracted image is in the response body (See Response Body section below).", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ExtractImageResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ExtractImageResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ExtractImageResponse" } } } }, "204": { "description": "No Content" }, "400": { "description": "Error with the provided parameters, please, check the response provided to get more insights on\nthe problem.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal error during our processing, please, get in touch with support so we can help you.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/ExtractImage/id": { "post": { "tags": [ "ExtractImage" ], "summary": "Extracts the JPG portrait captured inside a previously cached encrypted enhanced liveness packet.", "description": "Documents and Biometrics Core Extract Image by Id endpoint provides the id of the JPG portrait captured inside a previously cached encrypted enhanced liveness packet, stored in the image cache for later use (e.g. as an anchor for a subsequent Facematch by Id call) without waiting on a combined Biometrics check.", "parameters": [ { "name": "x-correlation-id", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "EncryptedPacketId": { "type": "string" }, "Configurations": { "type": "object", "additionalProperties": { "type": "string", "nullable": true } }, "RequestId": { "type": "string", "readOnly": true }, "CorrelationId": { "type": "string", "readOnly": true } } }, "encoding": { "EncryptedPacketId": { "style": "form" }, "Configurations": { "style": "form" }, "RequestId": { "style": "form" }, "CorrelationId": { "style": "form" } } } } }, "responses": { "200": { "description": "Returns a success on the Endpoint after processing the submitted encrypted packet id. This code\ndoes not indicate a success on the extraction of a face from the packet itself but rather a success on the call\nto the endpoint. The id of the extracted image, stored in the image cache, is in the response body (See\nResponse Body section below).", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ExtractImageByIdResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ExtractImageByIdResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ExtractImageByIdResponse" } } } }, "204": { "description": "No Content" }, "400": { "description": "Error with the provided parameters, please, check the response provided to get more insights on\nthe problem.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "The provided packet id was not found in the cache.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal error during our processing, please, get in touch with support so we can help you.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/Liveness": { "post": { "tags": [ "Liveness" ], "summary": "Facial Passive liveness Endpoint detects biometric spoofing from a single selfie image, without introducing friction or bias.", "description": "Documents and Biometrics Core Passive Liveness Service endpoint allows for a single portrait facial image (selfie/face image) to be uploaded for processing to determine the probability that the end user was present at the time of capture (Please reach out to your support representative for the \"Documents Biometrics Liveness Guide\" for further guidance on authentication). The endpoint will return a result after processing. The results is a score value between 0 and 100, with a score of 50 and above been considered a pass.", "parameters": [ { "name": "x-correlation-id", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "Selfie": { "type": "string", "description": "Selfie image to verify the liveness.\nNote: the supported images format are JPG and PNG, the image size should be less than 7MB.", "format": "binary" }, "AdditionalData": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "description": "Key value pair to include any additional metadata for the request." }, "RequestId": { "type": "string", "readOnly": true }, "CorrelationId": { "type": "string", "readOnly": true } } }, "encoding": { "Selfie": { "style": "form" }, "AdditionalData": { "style": "form" }, "RequestId": { "style": "form" }, "CorrelationId": { "style": "form" } } } } }, "responses": { "200": { "description": "Returns a success on the Endpoint after processing the submitted selfie image.This code\ndoes not indicate a success on the Liveness validation of the selfie itself but rather a success on the call to the\nEndpoint.The Liveness validation result is in the response body (See Response Body section below).", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/VerifyLivenessResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/VerifyLivenessResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/VerifyLivenessResponse" } } } }, "400": { "description": "Error with the provided parameters, please, check the response provided to get more insights on\nthe problem.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal error during our processing, please, get in touch with support so we can help you.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/Liveness/id": { "post": { "tags": [ "Liveness" ], "summary": "Facial Passive liveness Endpoint detects biometric spoofing from a single selfie image, without introducing friction or bias.", "description": "Documents and Biometrics Core Passive Liveness Service endpoint allows for a single portrait facial image (selfie/face image) to be uploaded (by caching process) for processing to determine the probability that the end user was present at the time of capture (Please reach out to your support representative for the \"Documents Biometrics Liveness Guide\" for further guidance on authentication). The endpoint will return a result after processing. The results is a score value between 0 and 100, with a score of 50 and above been considered a pass.", "parameters": [ { "name": "x-correlation-id", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "ImageId": { "type": "string", "description": "Gets or sets the identifier of the liveness verification request." }, "AdditionalData": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "description": "Key value pair to include any additional metadata for the request." }, "RequestId": { "type": "string", "readOnly": true }, "CorrelationId": { "type": "string", "readOnly": true } } }, "encoding": { "ImageId": { "style": "form" }, "AdditionalData": { "style": "form" }, "RequestId": { "style": "form" }, "CorrelationId": { "style": "form" } } } } }, "responses": { "200": { "description": "Returns a success on the Endpoint after processing the submitted selfie image.This code\ndoes not indicate a success on the Liveness validation of the selfie itself but rather a success on the call to the\nEndpoint.The Liveness validation result is in the response body (See Response Body section below).", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/VerifyLivenessResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/VerifyLivenessResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/VerifyLivenessResponse" } } } }, "400": { "description": "Error with the provided parameters, please, check the response provided to get more insights on\nthe problem.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal error during our processing, please, get in touch with support so we can help you.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } } }, "components": { "schemas": { "AgeEstimationResponse": { "type": "object", "properties": { "correlationId": { "type": "string", "nullable": true, "readOnly": true }, "low": { "type": "integer", "description": "The low end of the estimated age range in years.", "format": "int32" }, "high": { "type": "integer", "description": "The high end of the estimated age range in years.", "format": "int32" }, "errorCode": { "type": "string", "description": "Error code if any.", "nullable": true }, "error": { "type": "string", "description": "Error message if any.", "nullable": true }, "additionalDetails": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "description": "Additional details.", "nullable": true } }, "additionalProperties": false, "description": "Response from age estimation service." }, "BaseError": { "type": "object", "properties": { "errorCode": { "type": "string", "description": "Gets or sets the error code, if returned by the provider.", "nullable": true }, "error": { "type": "string", "description": "Details on any error if returned by the provider.>", "nullable": true } }, "additionalProperties": false, "description": "Represents an error response object, providing information about the error code and its description." }, "BiometricCheckByIdResponse": { "type": "object", "properties": { "correlationId": { "type": "string", "nullable": true, "readOnly": true }, "enhancedLivenessError": { "$ref": "#/components/schemas/BaseError" }, "facematchError": { "$ref": "#/components/schemas/BaseError" }, "enhancedLivenessScore": { "type": "number", "description": "Captures the Liveness score.\nAccepted values are in the range between 0 - 1.", "format": "double" }, "passiveLivenessScore": { "type": "integer", "description": "Validation result score from the liveness provider.\nAccepted values are in the range of 0 - 100.\nThe value is unbounded, the bigger the score the higher the image's liveness.\nScore of 50 and above is considered a pass.", "format": "int32" }, "facematchScore": { "type": "number", "description": "Facematch score from the comparison of the selfie image with the extracted image from the Enhanced Liveness packet.", "format": "float" }, "result": { "type": "string", "description": "Biometric validation result as PASS or FAIL based on the EnhancedLiveness probability and Facematch score.", "nullable": true }, "enhancedLivenessResult": { "type": "string", "description": "Enhanced Liveness result as PASS or FAIL based on the IAD probability score (threshold: 0.5).", "nullable": true }, "extractedImageId": { "type": "string", "description": "Image id of the extracted image.", "nullable": true } }, "additionalProperties": false, "description": "Biometric Api response combining results of Enhanced Liveness and Facematch scores." }, "BiometricCheckErrorResponse": { "type": "object", "properties": { "correlationId": { "type": "string", "nullable": true, "readOnly": true }, "enhancedLivenessError": { "$ref": "#/components/schemas/BaseError" }, "facematchError": { "$ref": "#/components/schemas/BaseError" } }, "additionalProperties": false, "description": "Represents an error response object for biometric validation, providing information about the error code and its description." }, "BiometricCheckResponse": { "type": "object", "properties": { "correlationId": { "type": "string", "nullable": true, "readOnly": true }, "enhancedLivenessError": { "$ref": "#/components/schemas/BaseError" }, "facematchError": { "$ref": "#/components/schemas/BaseError" }, "enhancedLivenessScore": { "type": "number", "description": "Captures the Liveness score.\nAccepted values are in the range between 0 - 1.", "format": "double" }, "passiveLivenessScore": { "type": "integer", "description": "Validation result score from the liveness provider.\nAccepted values are in the range of 0 - 100.\nThe value is unbounded, the bigger the score the higher the image's liveness.\nScore of 50 and above is considered a pass.", "format": "int32" }, "facematchScore": { "type": "number", "description": "Facematch score from the comparison of the selfie image with the extracted image from the Enhanced Liveness packet.", "format": "float" }, "result": { "type": "string", "description": "Biometric validation result as PASS or FAIL based on the EnhancedLiveness probability and Facematch score.", "nullable": true }, "enhancedLivenessResult": { "type": "string", "description": "Enhanced Liveness result as PASS or FAIL based on the IAD probability score (threshold: 0.5).", "nullable": true }, "extractedImage": { "type": "string", "description": "Byte array of the extracted image from the Enhanced Liveness packet.", "format": "byte", "nullable": true } }, "additionalProperties": false, "description": "Biometric Api response combining results of Enhanced Liveness and Facematch scores." }, "CelebrityCheckResponse": { "type": "object", "properties": { "correlationId": { "type": "string", "nullable": true, "readOnly": true }, "isCelebrity": { "type": "boolean", "description": "Indicates whether a celebrity was detected in the image." }, "celebrityName": { "type": "string", "description": "The name of the detected celebrity, if any.", "nullable": true }, "errorCode": { "type": "string", "description": "Error code if any.", "nullable": true }, "error": { "type": "string", "description": "Error message if any.", "nullable": true }, "additionalDetails": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "description": "Additional details.", "nullable": true } }, "additionalProperties": false, "description": "Response from celebrity check service." }, "ErrorResponse": { "type": "object", "properties": { "correlationId": { "type": "string", "nullable": true, "readOnly": true }, "errorMessage": { "type": "string", "nullable": true }, "errors": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "ExtractImageByIdResponse": { "type": "object", "properties": { "correlationId": { "type": "string", "nullable": true, "readOnly": true }, "imageDataId": { "type": "string", "nullable": true }, "error": { "$ref": "#/components/schemas/ExtractImageResponseError" } }, "additionalProperties": false }, "ExtractImageResponse": { "type": "object", "properties": { "correlationId": { "type": "string", "nullable": true, "readOnly": true }, "imageData": { "type": "string", "format": "byte", "nullable": true }, "error": { "$ref": "#/components/schemas/ExtractImageResponseError" } }, "additionalProperties": false }, "ExtractImageResponseError": { "type": "object", "properties": { "error": { "type": "string", "nullable": true }, "errorCode": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "statusCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "VerifyEnhancedLivenessByIdResponse": { "type": "object", "properties": { "correlationId": { "type": "string", "nullable": true, "readOnly": true }, "captureScore": { "type": "number", "description": "Captures the Liveness score.\nAccepted values are in the range between 0 - 1.", "format": "double" }, "livenessScore": { "type": "integer", "description": "Validation result score from the liveness provider.\nAccepted values are in the range of 0 - 100.\nThe value is unbounded, the bigger the score the higher the image's liveness.\nScore of 50 and above is considered a pass.", "format": "int32" }, "result": { "type": "string", "description": "Enhanced Liveness result as pass or fail based on the attack probability.\nScore of 50 and above is considered a pass.", "nullable": true }, "additionalDetails": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "description": "Additional details provided by the liveness provider.\nIt might contain information such as extracted image ID or other metadata.", "nullable": true }, "extractedImageId": { "type": "string", "description": "GUID representing the extracted image ID.", "nullable": true } }, "additionalProperties": false, "description": "Enhanced Liveness by ID response from the service." }, "VerifyEnhancedLivenessResponse": { "type": "object", "properties": { "correlationId": { "type": "string", "nullable": true, "readOnly": true }, "captureScore": { "type": "number", "description": "Captures the Liveness score.\nAccepted values are in the range between 0 - 1.", "format": "double" }, "livenessScore": { "type": "integer", "description": "Validation result score from the liveness provider.\nAccepted values are in the range of 0 - 100.\nThe value is unbounded, the bigger the score the higher the image's liveness.\nScore of 50 and above is considered a pass.", "format": "int32" }, "result": { "type": "string", "description": "Enhanced Liveness result as pass or fail based on the attack probability.\nScore of 50 and above is considered a pass.", "nullable": true }, "additionalDetails": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "description": "Additional details provided by the liveness provider.\nIt might contain information such as extracted image ID or other metadata.", "nullable": true }, "extractedImage": { "type": "string", "description": "Contains the image extracted from the liveness verification process.", "format": "byte", "nullable": true } }, "additionalProperties": false, "description": "Represents the response returned by the enhanced liveness verification service.\nInherits from DocsBio.Liveness.Facade.Contracts.BaseVerifyEnhancedLiveness." }, "VerifyLivenessResponse": { "type": "object", "properties": { "correlationId": { "type": "string", "nullable": true, "readOnly": true }, "score": { "type": "integer", "description": "Validation result score from the liveness provider.\nAccepted values are in the range of 0 - 100.\nThe value is unbounded, the bigger the score the higher the image's liveness.\nScore of 50 and above is considered a pass.", "format": "int32" }, "result": { "type": "string", "description": "Validation pass or fail result from the score.\nScore of 50 and above is considered a pass.", "nullable": true } }, "additionalProperties": false, "description": "Response from the liveness validation." } }, "securitySchemes": { "Bearer": { "type": "http", "description": "JWT Authorization header using the Bearer scheme.", "scheme": "bearer" } } }, "security": [ { "Bearer": [] } ], "tags": [ { "name": "AgeEstimation" }, { "name": "Biometrics" }, { "name": "CelebrityCheck" }, { "name": "EnhancedLiveness" }, { "name": "ExtractImage" }, { "name": "Liveness" } ] }