{ "openapi": "3.0.4", "info": { "title": "IDSCore Endpoints Overview", "description": "GBG's IDscan Core 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. IDscan 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. IDscan Core is built with a strong emphasis on scalability, enabling our customers to scale as quickly as they need to achieve their business goals. IDscan Core is perfectly positioned to enable our customer's onboarding success.", "version": "v1" }, "paths": { "/ClassifyDocument/id": { "post": { "tags": [ "ClassifyDocument" ], "summary": "Get the classification response of the processed document using an image cache ID.", "description": "IDscan Core Document Classification Service endpoint allows a document to be classified using an image cache ID from Imagebase (Please reach out to your support representative for the \"IDscan Core Authentication Guide\"). The document classification details will be provided.", "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": { "DocumentImageId": { "type": "string" }, "Side": { "$ref": "#/components/schemas/Classification.Common.Requests.DocumentSide" }, "ImageSource": { "$ref": "#/components/schemas/Classification.Common.Requests.ImageSource" }, "Configurations": { "type": "object", "additionalProperties": { "type": "string", "nullable": true } }, "RequestId": { "type": "string", "readOnly": true }, "CorrelationId": { "type": "string", "readOnly": true } } }, "encoding": { "DocumentImageId": { "style": "form" }, "Side": { "style": "form" }, "ImageSource": { "style": "form" }, "Configurations": { "style": "form" }, "RequestId": { "style": "form" }, "CorrelationId": { "style": "form" } } } } }, "responses": { "200": { "description": "Returns a success on the Endpoint after processing the submitted identity document/s. This code\ndoes not indicate a success on the validation of the document itself but rather a success on the call to the\nEndpoint. The document result is in the response body (See Response Body section below).", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Classification.Common.Responses.ClassificationByIdResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Classification.Common.Responses.ClassificationByIdResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Classification.Common.Responses.ClassificationByIdResponse" } } } }, "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/Common.Responses.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Common.Responses.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Common.Responses.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/Common.Responses.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Common.Responses.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Common.Responses.ErrorResponse" } } } }, "503": { "description": "A downstream service is temporarily out of capacity, please, retry later.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Common.Responses.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Common.Responses.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Common.Responses.ErrorResponse" } } } } } } }, "/ClassifyDocument": { "post": { "tags": [ "ClassifyDocument" ], "summary": "Get the classification response of the processed document using an uploaded image.", "description": "IDscan Core Document Classification Service endpoint allows a document to be classified (Please reach out to your support representative for the \"IDscan Core Authentication Guide\"). The document classification details will be provided.", "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": { "DocumentImage": { "type": "string", "format": "binary" }, "Side": { "$ref": "#/components/schemas/Classification.Common.Requests.DocumentSide" }, "ImageSource": { "$ref": "#/components/schemas/Classification.Common.Requests.ImageSource" }, "Configurations": { "type": "object", "additionalProperties": { "type": "string", "nullable": true } }, "RequestId": { "type": "string", "readOnly": true }, "CorrelationId": { "type": "string", "readOnly": true } } }, "encoding": { "DocumentImage": { "style": "form" }, "Side": { "style": "form" }, "ImageSource": { "style": "form" }, "Configurations": { "style": "form" }, "RequestId": { "style": "form" }, "CorrelationId": { "style": "form" } } } } }, "responses": { "200": { "description": "Returns a success on the Endpoint after processing the submitted identity document/s. This code\ndoes not indicate a success on the validation of the document itself but rather a success on the call to the\nEndpoint. The document result is in the response body (See Response Body section below).", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Classification.Common.Responses.ClassificationResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Classification.Common.Responses.ClassificationResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Classification.Common.Responses.ClassificationResponse" } } } }, "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/Common.Responses.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Common.Responses.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Common.Responses.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/Common.Responses.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Common.Responses.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Common.Responses.ErrorResponse" } } } }, "503": { "description": "A downstream service is temporarily out of capacity, please, retry later.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Common.Responses.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Common.Responses.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Common.Responses.ErrorResponse" } } } } } } }, "/ProofOfAddress": { "post": { "tags": [ "ProofOfAddress" ], "summary": "Get the verification response of the Proof of Address A4 processed document.", "description": "IDscan Core Document Verification Service endpoint allows a Proof of Address A4 document to be uploaded (Please reach out to your support representative for the \"IDscan Core Authentication Guide\"). The document details will be extracted.", "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": { "DocumentImage": { "type": "string", "description": "A4 Document Image to be verified. (White image in normal light).", "format": "binary" }, "CountryCode": { "pattern": "^[A-Za-z]{3}$", "type": "string", "description": "Accepts first 3 letters of the country code. Eg:- GBR" }, "TenantName": { "type": "string", "description": "Accepts any valid string for the tenant configuration." }, "AdditionalDetails": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "description": "Pass any additional details, if required." }, "RequestId": { "type": "string", "readOnly": true }, "CorrelationId": { "type": "string", "readOnly": true } } }, "encoding": { "DocumentImage": { "style": "form" }, "CountryCode": { "style": "form" }, "TenantName": { "style": "form" }, "AdditionalDetails": { "style": "form" }, "RequestId": { "style": "form" }, "CorrelationId": { "style": "form" } } } } }, "responses": { "200": { "description": "Returns a success on the Endpoint after processing the submitted address identity document/s.This code\ndoes not indicate a success on the validation of the document itself but rather a success on the call to the\nEndpoint.The document result is in the response body (See Response Body section below).", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Verify.Facade.Contracts.VerifyPoADocumentResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Verify.Facade.Contracts.VerifyPoADocumentResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Verify.Facade.Contracts.VerifyPoADocumentResponse" } } } }, "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/Common.Responses.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Common.Responses.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Common.Responses.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/Common.Responses.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Common.Responses.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Common.Responses.ErrorResponse" } } } }, "503": { "description": "A downstream service is temporarily out of capacity, please, retry later.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Common.Responses.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Common.Responses.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Common.Responses.ErrorResponse" } } } } } } }, "/ProofOfAddress/id": { "post": { "tags": [ "ProofOfAddress" ], "summary": "Get the verification response of the Proof of Address A4 processed document using id of the image stored in cache/store.", "description": "IDscan Core Document Verification Service endpoint allows a Proof of Address A4 document ID to be uploaded (Please reach out to your support representative for the \"IDscan Core Authentication Guide\"). The document details will be extracted.", "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": { "DocumentImageId": { "type": "string", "description": "A4 Document Image ID to be verified. (White image in normal light)." }, "CountryCode": { "pattern": "^[A-Za-z]{3}$", "type": "string", "description": "Accepts first 3 letters of the country code. Eg:- GBR" }, "TenantName": { "type": "string", "description": "Accepts any valid string for the tenant configuration." }, "AdditionalDetails": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "description": "Pass any additional details, if required." }, "RequestId": { "type": "string", "readOnly": true }, "CorrelationId": { "type": "string", "readOnly": true } } }, "encoding": { "DocumentImageId": { "style": "form" }, "CountryCode": { "style": "form" }, "TenantName": { "style": "form" }, "AdditionalDetails": { "style": "form" }, "RequestId": { "style": "form" }, "CorrelationId": { "style": "form" } } } } }, "responses": { "200": { "description": "Returns a success on the Endpoint after processing the submitted address identity document/s.This code\ndoes not indicate a success on the validation of the document itself but rather a success on the call to the\nEndpoint.The document result is in the response body (See Response Body section below).", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Verify.Facade.Contracts.VerifyDocumentByIdResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Verify.Facade.Contracts.VerifyDocumentByIdResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Verify.Facade.Contracts.VerifyDocumentByIdResponse" } } } }, "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/Common.Responses.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Common.Responses.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Common.Responses.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/Common.Responses.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Common.Responses.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Common.Responses.ErrorResponse" } } } }, "503": { "description": "A downstream service is temporarily out of capacity, please, retry later.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Common.Responses.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Common.Responses.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Common.Responses.ErrorResponse" } } } } } } }, "/ProofOfAddress/lite": { "post": { "tags": [ "ProofOfAddress" ], "summary": "External endpoint to get the verification response of the Proof of Address A4 processed document.", "description": "IDscan Core Document POA Extraction Service endpoint allows a document to be uploaded (Please reach out to your support representative for the \"IDscan Core Authentication Guide\"). The document details will be extracted.", "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": { "DocumentImage": { "type": "string", "description": "A4 Document Image to be verified. (White image in normal light).", "format": "binary" }, "Side": { "type": "string", "description": "The side of the document to be extracted." }, "CountryCode": { "type": "string", "description": "The country code of the document (Mandatory for IDES provider)." }, "AdditionalDetails": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "description": "Pass any additional details, if required." }, "RequestId": { "type": "string", "readOnly": true }, "CorrelationId": { "type": "string", "readOnly": true } } }, "encoding": { "DocumentImage": { "style": "form" }, "Side": { "style": "form" }, "CountryCode": { "style": "form" }, "AdditionalDetails": { "style": "form" }, "RequestId": { "style": "form" }, "CorrelationId": { "style": "form" } } } } }, "responses": { "200": { "description": "Returns a success on the Endpoint after processing the submitted identity document/s.This code\ndoes not indicate a success on the validation of the document itself but rather a success on the call to the\nEndpoint.The document result is in the response body (See Response Body section below).", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Verify.Facade.Contracts.ExtractPoADocumentResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Verify.Facade.Contracts.ExtractPoADocumentResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Verify.Facade.Contracts.ExtractPoADocumentResponse" } } } }, "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/Common.Responses.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Common.Responses.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Common.Responses.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/Common.Responses.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Common.Responses.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Common.Responses.ErrorResponse" } } } }, "503": { "description": "A downstream service is temporarily out of capacity, please, retry later.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Common.Responses.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Common.Responses.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Common.Responses.ErrorResponse" } } } } } } }, "/ProofOfAddress/lite/id": { "post": { "tags": [ "ProofOfAddress" ], "summary": "External endpoint to get the verification response of the Proof of Address A4 processed document using id of the image stored in cache/store.", "description": "IDscan Core Document POA Extraction Service endpoint allows a document to be uploaded (Please reach out to your support representative for the \"IDscan Core Authentication Guide\"). The document details will be extracted.", "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": { "DocumentImageId": { "type": "string", "description": "A4 Document Image ID to be verified. (White image in normal light)." }, "Side": { "type": "string", "description": "The side of the document to be extracted." }, "CountryCode": { "type": "string", "description": "The country code of the document (Mandatory for IDES provider)." }, "AdditionalDetails": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "description": "Pass any additional details, if required." }, "RequestId": { "type": "string", "readOnly": true }, "CorrelationId": { "type": "string", "readOnly": true } } }, "encoding": { "DocumentImageId": { "style": "form" }, "Side": { "style": "form" }, "CountryCode": { "style": "form" }, "AdditionalDetails": { "style": "form" }, "RequestId": { "style": "form" }, "CorrelationId": { "style": "form" } } } } }, "responses": { "200": { "description": "Returns a success on the Endpoint after processing the submitted identity document/s.This code\ndoes not indicate a success on the validation of the document itself but rather a success on the call to the\nEndpoint.The document result is in the response body (See Response Body section below).", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Verify.Facade.Contracts.ExtractPoADocumentResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Verify.Facade.Contracts.ExtractPoADocumentResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Verify.Facade.Contracts.ExtractPoADocumentResponse" } } } }, "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/Common.Responses.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Common.Responses.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Common.Responses.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/Common.Responses.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Common.Responses.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Common.Responses.ErrorResponse" } } } }, "503": { "description": "A downstream service is temporarily out of capacity, please, retry later.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Common.Responses.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Common.Responses.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Common.Responses.ErrorResponse" } } } } } } }, "/ProofOfAddress/verify": { "post": { "tags": [ "ProofOfAddress" ], "summary": "Get the authentication response of the Proof of Address A4 processed document.", "description": "IDscan Core Document POA Authentication Service endpoint allows a Proof of Address A4 document to be uploaded (Please reach out to your support representative for the \"IDscan Core Authentication Guide\"). The document details will be authenticated.", "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": { "DocumentImage": { "type": "string", "description": "A4 Document Image to be authenticated. (White image in normal light).", "format": "binary" }, "Configurations": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "description": "Key value pair for additional request configurations if needed." }, "AdditionalData": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "description": "Key value pair for any additional data." }, "RequestId": { "type": "string", "readOnly": true }, "CorrelationId": { "type": "string", "readOnly": true } } }, "encoding": { "DocumentImage": { "style": "form" }, "Configurations": { "style": "form" }, "AdditionalData": { "style": "form" }, "RequestId": { "style": "form" }, "CorrelationId": { "style": "form" } } } } }, "responses": { "200": { "description": "Returns a success on the Endpoint after processing the submitted address identity document/s.This code\ndoes not indicate a success on the validation of the document itself but rather a success on the call to the\nEndpoint.The document result is in the response body (See Response Body section below).", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Verify.Facade.Contracts.AuthenticatePoADocumentResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Verify.Facade.Contracts.AuthenticatePoADocumentResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Verify.Facade.Contracts.AuthenticatePoADocumentResponse" } } } }, "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/Common.Responses.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Common.Responses.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Common.Responses.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/Common.Responses.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Common.Responses.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Common.Responses.ErrorResponse" } } } }, "503": { "description": "A downstream service is temporarily out of capacity, please, retry later.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Common.Responses.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Common.Responses.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Common.Responses.ErrorResponse" } } } } } } }, "/ProofOfAddress/verify/id": { "post": { "tags": [ "ProofOfAddress" ], "summary": "Get the authentication response of the Proof of Address A4 processed document using id of the image stored in cache/store.", "description": "IDscan Core Document POA Authentication Service endpoint allows a Proof of Address A4 document ID to be uploaded (Please reach out to your support representative for the \"IDscan Core Authentication Guide\"). The document details will be authenticated.", "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": { "DocumentImageId": { "type": "string", "description": "A4 Document Image ID to be authenticated. (White image in normal light)." }, "Configurations": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "description": "Key value pair for additional request configurations if needed." }, "AdditionalData": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "description": "Key value pair for any additional data." }, "RequestId": { "type": "string", "readOnly": true }, "CorrelationId": { "type": "string", "readOnly": true } } }, "encoding": { "DocumentImageId": { "style": "form" }, "Configurations": { "style": "form" }, "AdditionalData": { "style": "form" }, "RequestId": { "style": "form" }, "CorrelationId": { "style": "form" } } } } }, "responses": { "200": { "description": "Returns a success on the Endpoint after processing the submitted address identity document/s.This code\ndoes not indicate a success on the validation of the document itself but rather a success on the call to the\nEndpoint.The document result is in the response body (See Response Body section below).", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Verify.Facade.Contracts.AuthenticatePoADocumentByIdResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Verify.Facade.Contracts.AuthenticatePoADocumentByIdResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Verify.Facade.Contracts.AuthenticatePoADocumentByIdResponse" } } } }, "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/Common.Responses.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Common.Responses.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Common.Responses.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/Common.Responses.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Common.Responses.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Common.Responses.ErrorResponse" } } } }, "503": { "description": "A downstream service is temporarily out of capacity, please, retry later.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Common.Responses.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Common.Responses.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Common.Responses.ErrorResponse" } } } } } } }, "/VerifyDocument": { "post": { "tags": [ "VerifyDocument" ], "summary": "Get the verification response of the processed document.", "description": "IDscan Core Document Verification Service endpoint allows a document to be uploaded (Please reach out to your support representative for the \"IDscan Core Authentication Guide\"). The document details will be extracted.", "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": { "DocumentImage": { "type": "string", "description": "Document Image to be verified. (White image in normal light).", "format": "binary" }, "IRImage": { "type": "string", "description": "Document Image to be verified. (Infra Red).", "format": "binary" }, "UVImage": { "type": "string", "description": "Document Image to be verified. (Ultraviolet).", "format": "binary" }, "Side": { "$ref": "#/components/schemas/Verify.Facade.Contracts.DocumentSide" }, "HasChip": { "type": "boolean", "description": "Is this a request for NFC and not image only flow." }, "SensorType": { "type": "string", "description": "Source of the image.\nAllowed Values are SCANNER, CAMERA, A4SCANNER.\nDefault value is Camera." }, "NfcData": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "description": "Key value pair to provide NFC data for extracted fields from chip like MRZ RFID data." }, "PreDeterminedChecks": { "type": "array", "items": { "$ref": "#/components/schemas/Verify.Facade.Contracts.ValidationCheck" }, "description": "Information about the list of validation checks that run previously." }, "HlrCustomizations": { "type": "array", "items": { "$ref": "#/components/schemas/Verify.Facade.Contracts.HlrConfigCustomization" }, "description": "Information about the overriding HLR configurations per check." }, "Configurations": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "description": "Any configuration needed for this request.\nAllowed configurations are :- \"TENANT_NAME\", \"EXTRACT_MIDDLE_NAME\", \"AUTHENTICATION_LEVEL\", \"AUTHENTICATION_POLICY\", \"DISABLED_CHECKS\", \"IGNORE_BACK_SIDE_RESULT\", \"ADDRESS_CORRECTION_COUNTRIES\", \"PROVIDER_NAME\"\n\nTENANT_NAME accepts any valid string for the Tenant configuration. For eg:- {\"TENANT_NAME\" : \"GBG\"}\nEXTRACT_MIDDLE_NAME accepts boolean values to indicate if the middle name should be extracted or not. For eg:- {\"EXTRACT_MIDDLE_NAME\" : \"TRUE\"}\nAllowed values for \"AUTHENTICATION_LEVEL\" are :- \n \"LOW\" // authentication level allow for 1 critical, 5 moderates and 9 insignificant failures\n \"MEDIUM\" // (default) medium authentication level allow for 0 critical, 3 moderates and 5 insignificant failures\n \"STRICT\" // strict authentication level allow for 0 critical, 1 moderates and 5 insignificant failures\nAUTHENTICATION_POLICY accepts any string value.\nDISABLED_CHECKS accepts list of validations to be disabled or not run. For eg:- {\"DISABLED_CHECKS\" : \"DTCHK, ARCHK, IRPTR, RCCHK, PHPRS\"}\nIGNORE_BACK_SIDE_RESULT accepts boolean values to ignore back side fields for cross match validations. For eg:- {\"IGNORE_BACK_SIDE_RESULT\" : \"TRUE\"}\nADDRESS_CORRECTION_COUNTRIES accepts list of ISO code countries. For eg:- {\"ADDRESS_CORRECTION_COUNTRIES\" : \"GBR, DEU\"}\nPROVIDER_NAME accepts any valid string for the provider to be chosen. For eg:- {\"PROVIDER_NAME\" : \"IDES\"}" }, "PreviousContext": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "description": "Contextual Information from previous API calls(Front side/back side etc)\nUse key as \"CONTEXT\" to pass any previous context information for back side and NFC workflows." }, "AdditionalDetails": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "description": "Pass any additional details, if required." }, "RequestId": { "type": "string", "readOnly": true }, "CorrelationId": { "type": "string", "readOnly": true } } }, "encoding": { "DocumentImage": { "style": "form" }, "IRImage": { "style": "form" }, "UVImage": { "style": "form" }, "Side": { "style": "form" }, "HasChip": { "style": "form" }, "SensorType": { "style": "form" }, "NfcData": { "style": "form" }, "PreDeterminedChecks": { "style": "form" }, "HlrCustomizations": { "style": "form" }, "Configurations": { "style": "form" }, "PreviousContext": { "style": "form" }, "AdditionalDetails": { "style": "form" }, "RequestId": { "style": "form" }, "CorrelationId": { "style": "form" } } } } }, "responses": { "200": { "description": "Returns a success on the Endpoint after processing the submitted identity document/s.This code\ndoes not indicate a success on the validation of the document itself but rather a success on the call to the\nEndpoint.The document result is in the response body (See Response Body section below).", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Verify.Facade.Contracts.VerifyDocumentResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Verify.Facade.Contracts.VerifyDocumentResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Verify.Facade.Contracts.VerifyDocumentResponse" } } } }, "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/Common.Responses.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Common.Responses.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Common.Responses.ErrorResponse" } } } }, "409": { "description": "Error with the provider chosen for document verification. The chosen provider is not supported for document verification.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Common.Responses.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Common.Responses.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Common.Responses.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/Common.Responses.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Common.Responses.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Common.Responses.ErrorResponse" } } } }, "503": { "description": "A downstream service is temporarily out of capacity, please, retry later.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Common.Responses.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Common.Responses.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Common.Responses.ErrorResponse" } } } } } } }, "/VerifyDocument/Id": { "post": { "tags": [ "VerifyDocument" ], "summary": "Get the verification response of the processed document.", "description": "IDscan Core Document Verification Service endpoint allows a document to be uploaded (Please reach out to your support representative for the \"IDscan Core Authentication Guide\"). The document details will be extracted.", "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": { "DocumentImageId": { "type": "string", "description": "Image cache Id of the document image to be verified. (White image in normal light)." }, "IRImageId": { "type": "string", "description": "Image cache Id of the document image to be verified. (Infra Red)." }, "UVImageId": { "type": "string", "description": "Image cache Id of the document image to be verified. (Ultraviolet)." }, "Side": { "$ref": "#/components/schemas/Verify.Facade.Contracts.DocumentSide" }, "HasChip": { "type": "boolean", "description": "Is this a request for NFC and not image only flow." }, "SensorType": { "type": "string", "description": "Source of the image.\nAllowed Values are SCANNER, CAMERA, A4SCANNER.\nDefault value is Camera." }, "NfcData": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "description": "Key value pair to provide NFC data for extracted fields from chip like MRZ RFID data." }, "PreDeterminedChecks": { "type": "array", "items": { "$ref": "#/components/schemas/Verify.Facade.Contracts.ValidationCheck" }, "description": "Information about the list of validation checks that run previously." }, "HlrCustomizations": { "type": "array", "items": { "$ref": "#/components/schemas/Verify.Facade.Contracts.HlrConfigCustomization" }, "description": "Information about the overriding HLR configurations per check." }, "Configurations": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "description": "Any configuration needed for this request.\nAllowed configurations are :- \"TENANT_NAME\", \"EXTRACT_MIDDLE_NAME\", \"AUTHENTICATION_LEVEL\", \"AUTHENTICATION_POLICY\", \"DISABLED_CHECKS\", \"IGNORE_BACK_SIDE_RESULT\", \"ADDRESS_CORRECTION_COUNTRIES\", \"PROVIDER_NAME\"\n\nTENANT_NAME accepts any valid string for the Tenant configuration. For eg:- {\"TENANT_NAME\" : \"GBG\"}\nEXTRACT_MIDDLE_NAME accepts boolean values to indicate if the middle name should be extracted or not. For eg:- {\"EXTRACT_MIDDLE_NAME\" : \"TRUE\"}\nAllowed values for \"AUTHENTICATION_LEVEL\" are :- \n \"LOW\" // authentication level allow for 1 critical, 5 moderates and 9 insignificant failures\n \"MEDIUM\" // (default) medium authentication level allow for 0 critical, 3 moderates and 5 insignificant failures\n \"STRICT\" // strict authentication level allow for 0 critical, 1 moderates and 5 insignificant failures\nAUTHENTICATION_POLICY accepts any string value.\nDISABLED_CHECKS accepts list of validations to be disabled or not run. For eg:- {\"DISABLED_CHECKS\" : \"DTCHK, ARCHK, IRPTR, RCCHK, PHPRS\"}\nIGNORE_BACK_SIDE_RESULT accepts boolean values to ignore back side fields for cross match validations. For eg:- {\"IGNORE_BACK_SIDE_RESULT\" : \"TRUE\"}\nADDRESS_CORRECTION_COUNTRIES accepts list of ISO code countries. For eg:- {\"ADDRESS_CORRECTION_COUNTRIES\" : \"GBR, DEU\"}\nPROVIDER_NAME accepts any valid string for the provider to be chosen. For eg:- {\"PROVIDER_NAME\" : \"IDES\"}" }, "PreviousContext": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "description": "Contextual Information from previous API calls(Front side/back side etc)\nUse key as \"CONTEXT\" to pass any previous context information for back side and NFC workflows." }, "AdditionalDetails": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "description": "Pass any additional details, if required." }, "RequestId": { "type": "string", "readOnly": true }, "CorrelationId": { "type": "string", "readOnly": true } } }, "encoding": { "DocumentImageId": { "style": "form" }, "IRImageId": { "style": "form" }, "UVImageId": { "style": "form" }, "Side": { "style": "form" }, "HasChip": { "style": "form" }, "SensorType": { "style": "form" }, "NfcData": { "style": "form" }, "PreDeterminedChecks": { "style": "form" }, "HlrCustomizations": { "style": "form" }, "Configurations": { "style": "form" }, "PreviousContext": { "style": "form" }, "AdditionalDetails": { "style": "form" }, "RequestId": { "style": "form" }, "CorrelationId": { "style": "form" } } } } }, "responses": { "200": { "description": "Returns a success on the Endpoint after processing the submitted identity document/s.This code\ndoes not indicate a success on the validation of the document itself but rather a success on the call to the\nEndpoint.The document result is in the response body (See Response Body section below).", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Verify.Facade.Contracts.VerifyDocumentResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Verify.Facade.Contracts.VerifyDocumentResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Verify.Facade.Contracts.VerifyDocumentResponse" } } } }, "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/Common.Responses.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Common.Responses.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Common.Responses.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/Common.Responses.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Common.Responses.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Common.Responses.ErrorResponse" } } } }, "503": { "description": "A downstream service is temporarily out of capacity, please, retry later.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Common.Responses.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Common.Responses.ErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Common.Responses.ErrorResponse" } } } } } } } }, "components": { "schemas": { "Classification.Common.Requests.DocumentSide": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "Classification.Common.Requests.ImageSource": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "format": "int32" }, "Classification.Common.Responses.ClassificationByIdResponse": { "type": "object", "properties": { "correlationId": { "type": "string", "nullable": true, "readOnly": true }, "classifiedDocument": { "$ref": "#/components/schemas/Classification.Common.Responses.DocumentClassificationInfo" }, "properties": { "$ref": "#/components/schemas/Classification.Common.Responses.DocumentProperties" }, "additionalDetails": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "extractedImageId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Classification.Common.Responses.ClassificationResponse": { "type": "object", "properties": { "correlationId": { "type": "string", "nullable": true, "readOnly": true }, "classifiedDocument": { "$ref": "#/components/schemas/Classification.Common.Responses.DocumentClassificationInfo" }, "properties": { "$ref": "#/components/schemas/Classification.Common.Responses.DocumentProperties" }, "additionalDetails": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "extractedImage": { "type": "string", "format": "byte", "nullable": true } }, "additionalProperties": false }, "Classification.Common.Responses.DocumentClassificationInfo": { "type": "object", "properties": { "isDocumentClassified": { "type": "boolean" }, "isIcao": { "type": "boolean" }, "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "category": { "type": "string", "nullable": true }, "subtype": { "type": "string", "nullable": true }, "year": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "side": { "type": "string", "nullable": true }, "countryCode": { "type": "string", "nullable": true }, "countryName": { "type": "string", "nullable": true }, "stateCode": { "type": "string", "nullable": true }, "stateName": { "type": "string", "nullable": true }, "issueYear": { "type": "string", "nullable": true }, "issuingCountryCode": { "type": "string", "nullable": true }, "issuingCountryName": { "type": "string", "nullable": true }, "issuingStateCode": { "type": "string", "nullable": true }, "issuingStateName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Classification.Common.Responses.DocumentProperties": { "type": "object", "properties": { "nfc": { "type": "boolean" }, "otherSide": { "type": "boolean" } }, "additionalProperties": false }, "Common.Responses.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 }, "KeyValuePairOfStringAndByteArray": { "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "value": { "type": "string", "format": "byte", "nullable": true } }, "additionalProperties": false }, "KeyValuePairOfStringAndString": { "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Verify.Facade.Contracts.AuthenticatePoADocumentByIdResponse": { "type": "object", "properties": { "correlationId": { "type": "string", "nullable": true, "readOnly": true }, "extractedFields": { "type": "array", "items": { "$ref": "#/components/schemas/Verify.Facade.Contracts.ExtractedField" }, "description": "Extracted fields from query document like first name, last name, birth date etc.", "nullable": true }, "additionalDetails": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "description": "Contains any additional details.", "nullable": true }, "result": { "type": "string", "description": "Overall fraud verdict for the document (e.g. \"Acceptable\", \"Consider\", \"High Risk\", \"Inconclusive\").", "nullable": true }, "indicators": { "type": "array", "items": { "$ref": "#/components/schemas/Verify.Facade.Contracts.PoAVerificationIndicator" }, "description": "Per-indicator breakdown behind IDSCore.Verify.Facade.Contracts.BaseAuthenticatePoAResponse.Result.", "nullable": true } }, "additionalProperties": false, "description": "The response of the Proof of Address A4 document authentication journey by id." }, "Verify.Facade.Contracts.AuthenticatePoADocumentResponse": { "type": "object", "properties": { "correlationId": { "type": "string", "nullable": true, "readOnly": true }, "extractedFields": { "type": "array", "items": { "$ref": "#/components/schemas/Verify.Facade.Contracts.ExtractedField" }, "description": "Extracted fields from query document like first name, last name, birth date etc.", "nullable": true }, "additionalDetails": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "description": "Contains any additional details.", "nullable": true }, "result": { "type": "string", "description": "Overall fraud verdict for the document (e.g. \"Acceptable\", \"Consider\", \"High Risk\", \"Inconclusive\").", "nullable": true }, "indicators": { "type": "array", "items": { "$ref": "#/components/schemas/Verify.Facade.Contracts.PoAVerificationIndicator" }, "description": "Per-indicator breakdown behind IDSCore.Verify.Facade.Contracts.BaseAuthenticatePoAResponse.Result.", "nullable": true } }, "additionalProperties": false, "description": "The response of the Proof of Address A4 document authentication journey." }, "Verify.Facade.Contracts.ClassificationInfo": { "type": "object", "properties": { "classifiedDocument": { "$ref": "#/components/schemas/Verify.Facade.Contracts.ClassifiedDocument" }, "documentInfo": { "$ref": "#/components/schemas/Verify.Facade.Contracts.DocumentInfo" } }, "additionalProperties": false, "description": "Details of the classified document." }, "Verify.Facade.Contracts.ClassifiedDocument": { "type": "object", "properties": { "isDocumentClassified": { "type": "boolean", "description": "Has the document been classified or not." }, "isIcao": { "type": "boolean", "description": "Gets whether the recognised document is ICAO compliant." }, "id": { "type": "string", "description": "Document type identifier.", "nullable": true }, "name": { "type": "string", "description": "Returns document name which is a friendly name that represents the issuer\nand type or subtype of the document(e.g. 'United Kingdom Provisional\nDriving License').", "nullable": true }, "category": { "type": "string", "description": "Returns the document type high level category (e.g. 'Identification Card'\nwhich covers both National and Foreigner Identification Cards types). This\nis the top level of document type hierarchy", "nullable": true }, "subtype": { "type": "string", "description": "Returns the document subtype. Subtype is the third level of document type\nhierarchy and it identities the document more specifically and usually\ndiffers from one issuer to another(E.g. 'Full Driving Licence',\n'Provisional Driving Licence', 'Probationary Driving Licence' etc.).", "nullable": true }, "year": { "type": "string", "description": "Returns the identifying year of issue or a proprietary code representation this\nissue is known with.", "nullable": true }, "type": { "type": "string", "description": "Document type, second level of type hierarchy used for distinguishing document types.", "nullable": true }, "side": { "type": "string", "description": "Returns document side (E.g. Front, Back).", "nullable": true }, "countryCode": { "type": "string", "description": "Returns document issuing country code. This field uses standard three\nletter ISO 3166-1 country codes(e.g. 'GBR' for United Kingdom).", "nullable": true }, "countryName": { "type": "string", "description": "Returns document issuing country name (E.g. United Kingdom).", "nullable": true }, "stateCode": { "type": "string", "description": "Returns document issuing state code as it is recognized in the issuing\ncountry.This field should always be used along with issuing_country_code\nfield. (e.g 'WA' for either Western Australia in Australia or Washington\nin United States of America).", "nullable": true }, "stateName": { "type": "string", "description": "Returns document issuing state name (E.g. Washington).", "nullable": true } }, "additionalProperties": false, "description": "Represents the document classification results." }, "Verify.Facade.Contracts.DocumentInfo": { "type": "object", "properties": { "nfc": { "type": "boolean", "description": "Indicates whether document type support NFC journey." }, "otherSide": { "type": "boolean", "description": "Indicates whether document type support other side journey." } }, "additionalProperties": false, "description": "Represents the document classification properties." }, "Verify.Facade.Contracts.DocumentScore": { "type": "object", "properties": { "baseScore": { "type": "integer", "description": "Base score of the document.", "format": "int32" }, "achievedScore": { "type": "integer", "description": "Achieved score of the document.", "format": "int32" } }, "additionalProperties": false, "description": "IDSCore.Verify.Facade.Contracts.DocumentScore class represents GBG score of a document." }, "Verify.Facade.Contracts.DocumentSide": { "enum": [ 0, 1, 2 ], "type": "integer", "description": "Enumeration for side of the document to be processed.", "format": "int32" }, "Verify.Facade.Contracts.ExtractPoADocumentResponse": { "type": "object", "properties": { "correlationId": { "type": "string", "nullable": true, "readOnly": true }, "extractedFields": { "type": "array", "items": { "$ref": "#/components/schemas/Verify.Facade.Contracts.ExtractedField" }, "description": "Extracted fields from query document like first name, last name, birth date etc.", "nullable": true }, "additionalDetails": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "description": "Contains any additional details.", "nullable": true }, "extractedImage": { "type": "string", "description": "Base64 encoded image of the extracted document.", "format": "byte", "nullable": true } }, "additionalProperties": false, "description": "The response of the Proof of Address A4 document journey." }, "Verify.Facade.Contracts.ExtractedDocument": { "type": "object", "properties": { "aggregatedFields": { "type": "array", "items": { "$ref": "#/components/schemas/Verify.Facade.Contracts.FieldDetails" }, "description": "Extracted field aggregation of the processed document and any previous requests.", "nullable": true }, "extractedFields": { "type": "array", "items": { "$ref": "#/components/schemas/Verify.Facade.Contracts.ExtractedField" }, "description": "Extracted fields from query document like first name, last name, birth date etc.", "nullable": true } }, "additionalProperties": false, "description": "Details of the document extraction." }, "Verify.Facade.Contracts.ExtractedField": { "type": "object", "properties": { "label": { "type": "string", "description": "Extracted field name which is used to identify the field.", "nullable": true }, "details": { "type": "array", "items": { "$ref": "#/components/schemas/Verify.Facade.Contracts.FieldDetails" }, "description": "Field information about each source where the fields was located (viz, mrz, barcode).", "nullable": true } }, "additionalProperties": false, "description": "Represents an information element that is extracted or deducted from the document." }, "Verify.Facade.Contracts.FieldDetails": { "type": "object", "properties": { "label": { "type": "string", "description": "Extracted field name which is used to identify the field.", "nullable": true }, "source": { "type": "string", "description": "Source for field value (viz, pdf417_barcode, mrz, rfid, hybrid, barcode or viz).", "nullable": true }, "value": { "type": "string", "description": "Extracted field string value.", "nullable": true }, "isNonLatin": { "type": "boolean", "description": "Sets to true if the value is in Non Latin language, false otherwise." }, "regionOfInterest": { "$ref": "#/components/schemas/Verify.Facade.Contracts.RegionOfInterest" } }, "additionalProperties": false, "description": "Field information about each source where the fields was located (viz, mrz, barcode)." }, "Verify.Facade.Contracts.HlrConfigCustomization": { "type": "object", "properties": { "authenticationCheckId": { "type": "string", "description": "Unique authentication check ID.", "nullable": true }, "country": { "type": "string", "description": "Country name.", "nullable": true }, "countryCode": { "type": "string", "description": "Country code.", "nullable": true }, "countryState": { "type": "string", "description": "State name.", "nullable": true }, "documentType": { "type": "string", "description": "Document type.", "nullable": true }, "documentSubType": { "type": "string", "description": "Document sub type.", "nullable": true }, "overrideType": { "$ref": "#/components/schemas/Verify.Facade.Contracts.ValidationOverrideType" } }, "additionalProperties": false, "description": "Information about the overriding HLR configurations per check." }, "Verify.Facade.Contracts.ImageBoundingBox": { "type": "object", "properties": { "x": { "type": "integer", "description": "X coordinate of the top left of the rectangle forming the bounding box.", "format": "int32" }, "y": { "type": "integer", "description": "Y coordinate of the top left of the rectangle forming the bounding box.", "format": "int32" }, "width": { "type": "integer", "description": "Represents the width of the bounding box.", "format": "int32" }, "height": { "type": "integer", "description": "Represents the height of the bounding box.", "format": "int32" } }, "additionalProperties": false, "description": "Surrounding box around the extracted field." }, "Verify.Facade.Contracts.PoAVerificationIndicator": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the indicator (e.g. \"Scan\", \"Software\", \"Timestamp\").", "nullable": true }, "result": { "type": "string", "description": "Verdict for this indicator (e.g. \"Acceptable\", \"Consider\", \"High Risk\", \"Inconclusive\").", "nullable": true }, "description": { "type": "string", "description": "Human-readable explanation of the indicator's verdict.", "nullable": true } }, "additionalProperties": false, "description": "A single named fraud indicator behind a PoA authentication result." }, "Verify.Facade.Contracts.RegionOfInterest": { "type": "object", "properties": { "boundingBox": { "$ref": "#/components/schemas/Verify.Facade.Contracts.ImageBoundingBox" }, "side": { "type": "string", "description": "Document side where the validation check was applied.", "nullable": true }, "spectrum": { "type": "string", "description": "Image type where the validation check was applied.", "nullable": true } }, "additionalProperties": false, "description": "area of the document where the validation check was applied." }, "Verify.Facade.Contracts.ValidatedDocument": { "type": "object", "properties": { "validationChecks": { "type": "array", "items": { "$ref": "#/components/schemas/Verify.Facade.Contracts.ValidationCheck" }, "description": "List of validations that ran against the scanned document side.", "nullable": true }, "validationResult": { "type": "string", "description": "The final validation result for scanned document.\nValues are : \nUndetermined If state is undetermined.\nPassed If AuthenticationCheck passed.\nFailed If AuthenticationCheck failed.\nSkipped If AuthenticationCheck skipped.", "nullable": true }, "documentQuality": { "type": "string", "description": "The quality result for scanned document.\nValues are : \nUndetermined If state is undetermined.\nGood If document quality good.\nBad If document quality bad.", "nullable": true }, "documentQualityScore": { "type": "number", "description": "Quality sore for scanned document value between 0 and 1.", "format": "double" }, "aggregatedValidationChecks": { "type": "array", "items": { "$ref": "#/components/schemas/Verify.Facade.Contracts.ValidationCheck" }, "description": "The validations that ran against both document sides and nfc like cross-checks.", "nullable": true }, "aggregatedValidationResult": { "type": "string", "description": "The over all validation result for both document's sides and nfc.\nValues are : \nUndetermined If state is undetermined.\nPassed If AuthenticationCheck passed.\nFailed If AuthenticationCheck failed.\nSkipped If AuthenticationCheck skipped.", "nullable": true } }, "additionalProperties": false, "description": "Details of the validation." }, "Verify.Facade.Contracts.ValidationCheck": { "type": "object", "properties": { "name": { "type": "string", "description": "Returns a value representing the identifier of this AuthenticationCheck.\nThis identifier should be used to uniquely identify the check and refer to it\nprogramatically if needed.\nAuthentication check Id is unique for a specific AuthenticationCheck.", "nullable": true }, "title": { "type": "string", "description": "Returns a value specifying the title of the AuthenticationCheck.\nThis value can be used for friendly representation of the check to the\nuser.For identification purposes not related with friendly\nrepresentation, id field should be used", "nullable": true }, "info": { "type": "string", "description": "Returns a value specifying description of the AuthenticationCheck.", "nullable": true }, "validationResult": { "type": "string", "description": "Returns state of the AuthenticationCheck. This indicates whether the check was Passed, Failed,\ninconclusive or was not able to run due to some pre-conditions that are not met.\nAuthenticationCheck return state Possible values undetermined, passed, failed or skipped.\nDefault is undetermined.\n\nUndetermined If state is undetermined.\nPassed = If AuthenticationCheck passed.\nFailed = If AuthenticationCheck failed.\nSkipped = If AuthenticationCheck skipped.", "nullable": true }, "resultInfo": { "type": "string", "description": "Information about the result of validation check.", "nullable": true }, "weight": { "type": "string", "description": "Score of the validation result.\nAuthenticationCheck return state Possible values undetermined, passed, failed or skipped.\nDefault is Critical.\n\nIgnore If weight is ignored.\nInsignificant = If weight is insignificant.\nModerate = If weight is moderate.\nCritical = If weight is critical.", "nullable": true }, "regionOfInterests": { "type": "array", "items": { "$ref": "#/components/schemas/Verify.Facade.Contracts.RegionOfInterest" }, "description": "List of areas of the document where the validation check was applied.", "nullable": true }, "type": { "type": "string", "description": "Validation check type.\nAuthenticationCheck return state Possible values unspecified or imagequality.\nDefault is unspecified.\n\nUnspecified = If type is not specified.\nImageQuality = If type is image quality.", "nullable": true } }, "additionalProperties": false, "description": "Applied validity checks on each supported document type.\nAuthentication helps discover many cases of fake documents or genuine documents that have been manipulated.\nAn example of an AuthenticationCheck is cross-matching information elements that are represented in many parts of the\ndocument like a DocumentNumber that is both represented as a printed human-readable text and also encoded in a barcode.\nThe range of checks performed will vary based on few factors.One of them depends on the document being captured, as the\nsecurity features vary from one document to another.\nAnother factor is the images that were provided, as IDES is able to validate many visible and non-visible security features\nbut non-visible security features validation requires providing the Infrared and Ultraviolet response images." }, "Verify.Facade.Contracts.ValidationOverrideType": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "description": "Override type for the validation HLR config check.", "format": "int32" }, "Verify.Facade.Contracts.VerifyDocumentByIdResponse": { "type": "object", "properties": { "correlationId": { "type": "string", "nullable": true, "readOnly": true }, "classificationInfo": { "$ref": "#/components/schemas/Verify.Facade.Contracts.ClassificationInfo" }, "extractionInfo": { "$ref": "#/components/schemas/Verify.Facade.Contracts.ExtractedDocument" }, "validationInfo": { "$ref": "#/components/schemas/Verify.Facade.Contracts.ValidatedDocument" }, "documentScore": { "$ref": "#/components/schemas/Verify.Facade.Contracts.DocumentScore" }, "additionalDetails": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "description": "Contains previous processing information for front side and backside.\nContains the engine used for processing under \"Engine\" key.", "nullable": true }, "extractedImageId": { "type": "string", "description": "Image id of the extracted document that is stored in cache/store.", "nullable": true }, "includedImageIds": { "type": "array", "items": { "$ref": "#/components/schemas/KeyValuePairOfStringAndString" }, "description": "Contains information on any additional image ids after processing, where the images will be stored in cache/store.\nEg:- { { \"Key\": \"TAMPERED_IMAGE\", Value : \"image id of the digital tampered heat map image\"},\n { \"Key\": \"EXTRACTED_UV_IMAGE\", Value : \"image id of the extracted UV image\"},\n { \"Key\": \"EXTRACTED_IR_IMAGE\", Value : \"image id of the extracted IR image\"}}.", "nullable": true } }, "additionalProperties": false, "description": "Verification response after verifying the processed image." }, "Verify.Facade.Contracts.VerifyDocumentResponse": { "type": "object", "properties": { "correlationId": { "type": "string", "nullable": true, "readOnly": true }, "classificationInfo": { "$ref": "#/components/schemas/Verify.Facade.Contracts.ClassificationInfo" }, "extractionInfo": { "$ref": "#/components/schemas/Verify.Facade.Contracts.ExtractedDocument" }, "validationInfo": { "$ref": "#/components/schemas/Verify.Facade.Contracts.ValidatedDocument" }, "documentScore": { "$ref": "#/components/schemas/Verify.Facade.Contracts.DocumentScore" }, "additionalDetails": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "description": "Contains previous processing information for front side and backside.\nContains the engine used for processing under \"Engine\" key.", "nullable": true }, "extractedImage": { "type": "string", "description": "Base64 encoded image of the extracted document.", "format": "byte", "nullable": true }, "includedImages": { "type": "array", "items": { "$ref": "#/components/schemas/KeyValuePairOfStringAndByteArray" }, "description": "Contains information on any additional images after processing.\nEg:- { { \"Key\": \"TAMPERED_IMAGE\", Value : \"byte array of the digital tampered heat map image\"},\n { \"Key\": \"EXTRACTED_UV_IMAGE\", Value : \"byte array of the extracted UV image\"},\n { \"Key\": \"EXTRACTED_IR_IMAGE\", Value : \"byte array of the extracted IR image\"}}.", "nullable": true } }, "additionalProperties": false, "description": "Verification response after verifying the processed image." }, "Verify.Facade.Contracts.VerifyPoADocumentResponse": { "type": "object", "properties": { "correlationId": { "type": "string", "nullable": true, "readOnly": true }, "extractedFields": { "type": "array", "items": { "$ref": "#/components/schemas/Verify.Facade.Contracts.ExtractedField" }, "description": "Extracted fields from query document like first name, last name, birth date etc.", "nullable": true }, "additionalDetails": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "description": "Contains any additional details.", "nullable": true }, "classificationInfo": { "$ref": "#/components/schemas/Verify.Facade.Contracts.ClassifiedDocument" }, "extractedImage": { "type": "string", "description": "Base64 encoded image of the extracted document.", "format": "byte", "nullable": true } }, "additionalProperties": false, "description": "Verification response after verifying the Proof of Address A4 document." } }, "securitySchemes": { "Bearer": { "type": "http", "description": "JWT Authorization header using the Bearer scheme.", "scheme": "bearer" } } }, "security": [ {} ], "tags": [ { "name": "ClassifyDocument" }, { "name": "ProofOfAddress" }, { "name": "VerifyDocument" } ] }