{ "openapi": "3.1.0", "info": { "title": "ID Document and Biometric Verification: Assure API", "description": "- **Base URL**: `https://api.signicat.com/assure/`\n- **Documentation**: See the [ID Document and Biometric Verification](/docs/id-document-and-biometric-verification/) developer documentation.\n- **Support**: [Create a support ticket](https://dashboard.signicat.com/contact-us/tickets/) in the Signicat Dashboard.\n\n# Introduction\n\nThe Assure API is a RESTful service that you can use to perform electronic identity verification (eIDV) of your customers during onboarding. This means you can scan and verify identity documents using one or more of the supported eIDV services. It also allows you to obtain identity information from eIDs and match and corroborate the data from these sources.\n\nThe purpose of the Assure API is to provide a unique and simple way of integrating these identification services, working both in a browser and native mobile contexts and supporting asynchronous operations.\n\nThis REST API uses the OAuth 2.0 protocol for authorisation. All request and response bodies are formatted in JSON.\n\n# Get started\n\nBefore you can start making requests to this API, you need to learn how to connect to it. To do this, see the **Connect to Signicat APIs** [Quick start guide](/docs/connect-to-signicat-apis/quick-start-guide/).\n\n## Audit logs\n\nUse the Signicat **Audit logs** service to see documented evidence of the sequence of activities that have affected a system.\n\n- Access it: **Signicat Dashboard** > **Settings** > [**Audit logs**](https://dashboard.signicat.com/audit)\n- For information generic to all Signicat audit logs, see the general [Audit logs](/docs/audit-logs/) documentation.\n\n## Errors\n\nWhen you make an API call to Signicat and an error occurs, you will receive a response message with an error code.\n\n- For errors generic to all Signicat APIs, see the general [Error codes](/docs/error-codes/) documentation.\n\n## Events (callback)\n\nUse the Signicat **Events** service to automatically receive information about when something happens in one of our services into your system.\n\n- Access it: Go to **Signicat Dashboard** > **Settings** > [**Events**](https://dashboard.signicat.com/events)\n- For information generic to all Signicat events, see the general [Events](/docs/events/) documentation.\n- For information about Assure API specific events, see [Events](/docs/id-document-and-biometric-verification/services/callbacks).\n\n> **Note**: This is often referred to as callback.\n", "contact": "", "license": "", "version": "1.0.0", "termsOfService": "" }, "servers": [ { "url": "https://api.signicat.com/assure", "description": "Generated server url" } ], "security": [ { "basicAuth": [] } ], "tags": [ { "name": "Assure" }, { "name": "Matching" }, { "name": "Dossiers" }, { "name": "Processes" }, { "name": "Capture" } ], "externalDocs": { "description": "See also the user docs on how to get started with the Assure API.", "url": "https://developer.signicat.com/docs/id-document-and-biometric-verification/guides/#set-up-an-api-integration" }, "paths": { "/matching/configurations/{configurationId}": { "get": { "tags": [ "Matching" ], "summary": "Get matching configuration", "description": "Gets an existing matching configuration in JSON format.", "operationId": "getConfiguration", "parameters": [ { "name": "configurationId", "in": "path", "description": "The ID of a matching configuration.", "required": true, "schema": { "type": "string" }, "example": "Configuration1" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MatchingConfigurationResponse" } } } }, "404": { "description": "The resource requested cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardExceptionNotFound" } } } } }, "x-code-samples": [ { "lang": "curl", "source": "curl -X GET 'https://api.signicat.com/assure/matching/configurations/“';" } ] }, "put": { "tags": [ "Matching" ], "summary": "Update matching configuration", "description": "Updates an existing matching configuration.", "operationId": "updateConfiguration", "parameters": [ { "name": "configurationId", "in": "path", "description": "The ID of a matching configuration.", "required": true, "schema": { "type": "string" }, "example": "Configuration1" } ], "requestBody": { "description": "Matching configuration payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MatchingConfiguration" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MatchingConfigurationResponse" } } } }, "400": { "description": "The request cannot be fulfilled due to bad syntax", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardExceptionBadRequest" } } } }, "409": { "description": "Conflict found while processing the request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardExceptionConflict" } } } } }, "x-code-samples": [ { "lang": "curl", "source": "curl -X PUT 'https://api.signicat.com/assure/matching/configurations/' -H 'Authorization: Bearer -d '';" } ] }, "post": { "tags": [ "Matching" ], "summary": "Create matching configuration", "description": "Creates a new matching configuration.", "operationId": "setConfiguration", "parameters": [ { "name": "configurationId", "in": "path", "description": "The ID of a matching configuration.", "required": true, "schema": { "type": "string", "maxLength": 100, "minLength": 0 }, "example": "Configuration1" } ], "requestBody": { "description": "Matching configuration payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MatchingConfiguration" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MatchingConfigurationResponse" } } } }, "400": { "description": "The request cannot be fulfilled due to bad syntax", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardExceptionBadRequest" } } } }, "404": { "description": "The resource requested cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardExceptionNotFound" } } } } }, "x-code-samples": [ { "lang": "curl", "source": "curl -X POST 'https://api.signicat.com/assure/matching/configurations/' -H 'Authorization: Bearer -d '';" } ] }, "delete": { "tags": [ "Matching" ], "summary": "Delete a matching configuration", "description": "Deletes a matching configuration.", "operationId": "deleteConfiguration", "parameters": [ { "name": "configurationId", "in": "path", "description": "The ID of a matching configuration.", "required": true, "schema": { "type": "string" }, "example": "Configuration1" } ], "responses": { "204": { "description": "Deletes a matching configuration." }, "400": { "description": "The request cannot be fulfilled due to bad syntax", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardExceptionBadRequest" } } } }, "404": { "description": "The resource requested cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardExceptionNotFound" } } } } }, "x-code-samples": [ { "lang": "curl", "source": "curl -X DELETE 'https://api.signicat.com/assure/matching/configurations/' -H 'Authorization: Bearer ;" } ] } }, "/dossiers/{dossierId}/userdata": { "get": { "tags": [ "Dossiers" ], "summary": "Get user data", "description": "Use this service to get the existing data in the dossier about the end-user. You will also get information about when this data was last updated.", "operationId": "getUserData", "parameters": [ { "name": "dossierId", "in": "path", "description": "This ID is obtained from the \"Create dossier\" response body.", "required": true, "schema": { "type": "string" }, "example": "37191afe-25b3-4c30-b42a-b0ab64aa1d64" } ], "responses": { "200": { "description": "The user data in the dossier was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDataResponse" } } } }, "401": { "description": "The Bearer token provided in the Authorization header was not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardExceptionUnauthorized" } } } }, "404": { "description": "The user data in the dossier was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardExceptionNotFound" } } } } }, "x-code-samples": [ { "lang": "curl", "source": "curl -X GET https://api.signicat.com/assure/dossiers//userdata -H 'Accept: application/json' -H 'Authorization: Bearer ' -H 'Content-Type: application/json';" } ] }, "put": { "tags": [ "Dossiers" ], "summary": "Update user data", "description": "Use this service to update the data about the end-user in the dossier. This service will update existing fields and add new fields if they don't exist in the user data. If you want to delete some information from the user data, you must send that field as an empty string.", "operationId": "updateUserData", "parameters": [ { "name": "dossierId", "in": "path", "description": "This ID is obtained from the \"Create dossier\" response body.", "required": true, "schema": { "type": "string" }, "example": "37191afe-25b3-4c30-b42a-b0ab64aa1d64" } ], "requestBody": { "description": "Userdata payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDataRequest" } } }, "required": true }, "responses": { "204": { "description": "The user data in the dossier was successfully updated." }, "400": { "description": "The user data does not provide a valid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardExceptionBadRequest" } } } }, "401": { "description": "The Bearer token provided in the Authorization header was not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardExceptionUnauthorized" } } } }, "404": { "description": "The user data in the dossier was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardExceptionNotFound" } } } } }, "x-code-samples": [ { "lang": "curl", "source": "curl -X PUT https://api.signicat.com/assure/dossiers//userdata -H 'Authorization: Bearer ' -H 'Content-Type: application/json' -d '';" } ] }, "post": { "tags": [ "Dossiers" ], "summary": "Set user data", "description": "Use this service to add data about the end-user into the dossier (e.g. data the end-user entered in a form).", "operationId": "setUserData", "parameters": [ { "name": "dossierId", "in": "path", "description": "This ID is obtained from the \"Create dossier\" response body.", "required": true, "schema": { "type": "string" }, "example": "37191afe-25b3-4c30-b42a-b0ab64aa1d64" } ], "requestBody": { "description": "Userdata payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDataRequest" } } }, "required": true }, "responses": { "201": { "description": "The user data was successfully added to the dossier." }, "400": { "description": "The user data does not provide a valid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardExceptionBadRequest" } } } }, "401": { "description": "The Bearer token provided in the Authorization header was not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardExceptionUnauthorized" } } } }, "404": { "description": "The user data in the dossier was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardExceptionNotFound" } } } }, "409": { "description": "The user data in the dossier has already been created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardExceptionConflict" } } } } }, "x-code-samples": [ { "lang": "curl", "source": "curl -X POST https://api.signicat.com/assure/dossiers//userdata -H 'Authorization: Bearer ' -H 'Content-Type: application/json' -d '';" } ] }, "delete": { "tags": [ "Dossiers" ], "summary": "Delete user data", "description": "Use this service to delete all data about the end-user from the dossier.", "operationId": "deleteUserData", "parameters": [ { "name": "dossierId", "in": "path", "description": "This ID is obtained from the \"Create dossier\" response body.", "required": true, "schema": { "type": "string" }, "example": "37191afe-25b3-4c30-b42a-b0ab64aa1d64" } ], "responses": { "204": { "description": "The userdata in the dossier was successfully deleted." }, "401": { "description": "The Bearer token provided in the Authorization header was not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardExceptionUnauthorized" } } } }, "404": { "description": "The user data in the dossier was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardExceptionNotFound" } } } } }, "x-code-samples": [ { "lang": "curl", "source": "curl -X DELETE https://api.signicat.com/assure/dossiers//userdata -H 'Accept: application/json' -H 'Authorization: Bearer ' -H 'Content-Type:application/json';" } ] } }, "/capture/configurations/{configurationId}": { "get": { "tags": [ "Capture" ], "summary": "Get capture configuration", "description": "This service returns an existing capture configuration in JSON format.
Capture configurations section in the integration documentation.", "operationId": "getConfiguration_1", "parameters": [ { "name": "configurationId", "in": "path", "description": "The ID of a capture configuration.", "required": true, "schema": { "type": "string" }, "example": "Configuration1" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaptureConfiguration" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardExceptionNotFound" } } } } }, "x-code-samples": [ { "lang": "curl", "source": "curl -X GET https://api.signicat.com/assure/capture/configurations/ -H 'Authorization: Bearer ';" } ] }, "put": { "tags": [ "Capture" ], "summary": "Update capture configuration", "description": "This service updates an existing capture configuration.The capture configuration impacts the frontend workflow and the graphical interface. Capture configurations section in the integration documentation.", "operationId": "updateConfiguration_1", "parameters": [ { "name": "configurationId", "in": "path", "description": "The ID of a capture configuration.", "required": true, "schema": { "type": "string" }, "example": "Configuration1" } ], "requestBody": { "description": "Capture configuration payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaptureConfiguration" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaptureConfigurationResponse" } } } }, "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardExceptionBadRequest" } } } } }, "x-code-samples": [ { "lang": "curl", "source": "curl -X PUT https://api.signicat.com/assure/capture/configurations/ -H 'Authorization: Bearer ' -d '';" } ] }, "post": { "tags": [ "Capture" ], "summary": "Create capture configuration", "description": "This service creates a new configuration to be used with the “Start capture flow” service. This configuration specifies the frontend workflow and graphical interface. For details about the configuration options, see the Capture configurations section in the integration documentation.", "operationId": "setConfiguration_1", "parameters": [ { "name": "configurationId", "in": "path", "description": "The ID of a capture configuration.", "required": true, "schema": { "type": "string", "maxLength": 100, "minLength": 0 }, "example": "Configuration1" } ], "requestBody": { "description": "Capture configuration payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaptureConfiguration" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaptureConfigurationResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": {} } }, "409": { "description": "Conflict", "content": { "application/json": {} } } }, "x-code-samples": [ { "lang": "curl", "source": "curl -X POST https://api.signicat.com/assure/capture/configurations/ -H 'Authorization: Bearer ' -d '';" } ] }, "delete": { "tags": [ "Capture" ], "summary": "Delete capture configuration", "description": "This service deletes an existing capture configuration.The capture configuration impacts the frontend workflow and the graphical interface. For details about the configuration options, see the Capture configurations section in the integration documentation.", "operationId": "deleteConfiguration_1", "parameters": [ { "name": "configurationId", "in": "path", "description": "The ID of a capture configuration.", "required": true, "schema": { "type": "string" }, "example": "Configuration1" } ], "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardExceptionNotFound" } } } } }, "x-code-samples": [ { "lang": "curl", "source": "curl -X DELETE https://api.signicat.com/assure/capture/configurations/ -H 'Authorization: Bearer ';" } ] } }, "/watermark": { "post": { "tags": [ "Assure" ], "summary": "Watermark", "description": "Apply a watermark on an image with a selected title, text and date. You can apply the watermark directly on an image sent in the request or on an image from a dossier or process. See also the \"general documentation on how to use the Watermark service.", "operationId": "watermark", "requestBody": { "description": "Watermark payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WatermarkAssureRequest" } } }, "required": true }, "responses": { "200": { "description": "Watermark successfully applied to image.", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "The request cannot be fulfilled due to bad syntax", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardExceptionBadRequest" } } } }, "401": { "description": "The Bearer token provided in the Authorization header was not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardExceptionUnauthorized" } } } } }, "x-code-samples": [ { "lang": "curl", "source": "curl -X POST https://api.signicat.com/assure/watermark -H 'Authorization: Bearer ' -H 'Content-Type:application/json' -d '';" } ] } }, "/redact": { "post": { "tags": [ "Assure" ], "summary": "Redact", "description": "Redact selected fields in document images. You can apply the redaction directly on an image sent in the request or on an image from a dossier or process. See also the \"general documentation on how to use the Redaction service.", "operationId": "redact", "requestBody": { "description": "Redaction payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RedactionAssureRequest" } } }, "required": true }, "responses": { "200": { "description": "Image(s) redacted successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RedactionResponse" } } } }, "400": { "description": "The request cannot be fulfilled due to bad syntax", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardExceptionBadRequest" } } } }, "401": { "description": "The Bearer token provided in the Authorization header was not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardExceptionUnauthorized" } } } } }, "x-code-samples": [ { "lang": "curl", "source": "curl -X POST https://api.signicat.com/assure/redact -H 'Authorization: Bearer ' -H 'Content-Type:application/json' -d '';" } ] } }, "/dossiers": { "get": { "tags": [ "Dossiers" ], "summary": "Get all dossiers", "description": "You can use this service to check the last 100 dossiers you have created (and that have not yet been deleted).", "operationId": "getDossiers", "responses": { "200": { "description": "The dossier information was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Dossier" } } } } }, "401": { "description": "The Bearer token provided in the Authorization header was not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardExceptionUnauthorized" } } } } }, "x-code-samples": [ { "lang": "curl", "source": "curl -X GET https://api.signicat.com/assure/dossiers -H 'Accept: application/json' -H 'Authorization: Bearer ';" } ] }, "post": { "tags": [ "Dossiers" ], "summary": "Create dossier", "description": "You should create a new dossier for each new end-user to perform identity verification for that user. A dossier can have more than one process inside and each process can use a different provider (e.g. Onfido, ReadID etc).", "operationId": "createDossier", "requestBody": { "description": "Dossier payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DossierRequest" } } } }, "responses": { "201": { "description": "The dossier was successfully created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Dossier" } } } }, "401": { "description": "The Bearer token provided in the Authorization header was not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardExceptionUnauthorized" } } } } }, "x-code-samples": [ { "lang": "curl", "source": "curl -X POST https://api.signicat.com/assure/dossiers -H 'Authorization: Bearer ACCESS_TOKEN' -H 'Content-Type: application/json';" } ] } }, "/dossiers/{dossierId}/processes": { "post": { "tags": [ "Processes" ], "summary": "Create process", "description": "This service creates a new process in the dossier, using a given provider. You use this service in most flows, unless you integrate through the eIDV alternative flow for the web.
The request can accept several parameters. However, which parameters to use, depends on the provider and type of process. For more details, see the parameter descriptions below.
After you have created the process, you cannot change the information you sent in its request. This means, if you need to change any of the information sent in its parameter, you must create a new process. Alternatively, you can delete the old process.", "operationId": "createProcess", "parameters": [ { "name": "dossierId", "in": "path", "description": "This ID is obtained from the \"Create dossier\" response body.", "required": true, "schema": { "type": "string" }, "example": "37191afe-25b3-4c30-b42a-b0ab64aa1d64" } ], "requestBody": { "description": "Process payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessRequest" }, "examples": { "Example using onfido provider": { "summary": "Onfido request", "description": "Example using onfido provider", "value": { "provider": "onfido", "processType": "documentSelfie", "documentType": "passport", "processParameters": { "location": { "countryOfResidence": "PRT" } }, "eventTags": [ "customTag-123" ] } }, "Example using onfido provider with extra dl information": { "summary": "Onfido request with extra information from driving license", "description": "Example using onfido provider with extra dl information", "value": { "provider": "onfido", "processType": "documentSelfie", "documentType": "passport", "processParameters": { "requestExtraDataFromDrivingLicense": true, "location": { "countryOfResidence": "PRT" } }, "eventTags": [ "customTag-123" ] } }, "Example using signicatvideoid provider": { "summary": "Signicat VideoID request", "description": "Example using signicatvideoid provider", "value": { "provider": "signicatvideoid", "processType": "substantial" } }, "Example using signicatpaper provider": { "summary": "Signicat Paper request", "description": "Example using signicatpaper provider", "value": { "provider": "signicatpaper", "documentType": "passport", "documentCountry": "NLD" } }, "Example using readid provider": { "summary": "ReadID request", "description": "Example using readid provider", "value": { "provider": "readid", "processType": "sdk" } }, "Example using facetec provider": { "summary": "Facetec request", "description": "Example using facetec provider", "value": { "provider": "facetec" } }, "Example using webid provider": { "summary": "WebID request", "description": "Example using webid provider", "value": { "provider": "webid", "processType": "videoid", "processParameters": { "webid": { "preferredLanguage": "en", "user": { "firstName": "John", "lastName": "Smith", "dateOfBirth": "1986-07-24", "contact": { "email": "test@signicat.com", "mobile": "+4790511734" } }, "userActionParameters": { "redirectCancelUrl": "https://en.wikipedia.org/wiki/cancel", "redirectMismatchUrl": "https://en.wikipedia.org/wiki/mismatch", "redirectDeclineUrl": "https://en.wikipedia.org/wiki/decline", "redirectUrl": "https://en.wikipedia.org/wiki/redirect", "productType": "loan", "clientName": "Bank of the Internet" }, "idDocument": { "nationality": "PRT" } } } } }, "Example using signicatpictureid provider": { "summary": "Signicat PictureID request", "description": "Example using signicatpictureid provider", "value": { "provider": "signicatpictureid", "processType": "document" } } } } }, "required": true }, "responses": { "201": { "description": "The process has been successfully initialized in the given dossier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessResponse" }, "examples": { "Example using onfido provider": { "summary": "Onfido response", "description": "Example using onfido provider", "value": { "processId": "d560f9fc-9312-4110-ad88-f3acf392ca9c", "provider": "onfido", "processType": "documentSelfie", "status": "pending", "authorization": "***********", "createdAt": "2024-03-21T11:42:52Z", "updatedAt": "2024-03-21T11:42:52Z" } }, "Example using signicatvideoid provider": { "summary": "SignicatVideoID request", "description": "Example using signicatvideoid provider", "value": { "processId": "ff4de2d7-c436-4f22-a2ee-3887ad4d98ab", "provider": "signicatvideoid", "processType": "substantial", "status": "pending", "authorization": "***********", "providerApiUrl": "https://etrust-sandbox.electronicid.eu/v2", "createdAt": "2024-03-21T14:14:14Z", "updatedAt": "2024-03-21T14:14:14Z" } }, "Example using signicatpaper provider": { "summary": "Signicat Paper response", "description": "Example using signicatpaper provider", "value": { "processId": "95d9f637-c03d-4385-b2f9-5f4d173225fd", "provider": "signicatpaper", "status": "pending", "createdAt": "2024-03-21T10:54:20Z", "updatedAt": "2024-03-21T10:54:20Z" } }, "Example using readid provider": { "summary": "ReadID response", "description": "Example using readid provider", "value": { "processId": "81c334ce-70ab-4136-8b8f-63764ff0dbaf", "provider": "readid", "processType": "sdk", "status": "pending", "authorization": "***********", "providerApiUrl": "https://saas-preprod.readid.com/odata/v1/ODataServlet", "createdAt": "2024-03-21T14:13:34Z", "updatedAt": "2024-03-21T14:13:34Z" } }, "Example using facetec provider": { "summary": "Facetec response", "description": "Example using facetec provider", "value": "{\n \"processId\": \"0d5458a6-02c1-4340-9a93-6b3526297f07\",\n \"provider\": \"facetec\",\n \"status\": \"pending\",\n \"authorization\": \"***********\"\n \"facetecDeviceKeyIdentifier\": \"***********\",\n \"facetecEncryptionPublicKey\": \"\"***********\"\",\n \"facetecMobileSdkProductionKey\": \"\"***********\"\",\n \"createdAt\": \"2024-03-21T15:15:18Z\",\n \"updatedAt\": \"2024-03-21T15:15:18Z\"\n}\n" }, "Example using webid provider": { "summary": "WebID response", "description": "Example using webid provider", "value": { "processId": "3e73ecd4-7fdb-4a55-bd6c-f50dd429e9f9", "provider": "webid", "processType": "videoid", "status": "pending", "createdAt": "2024-03-21T14:06:26Z", "updatedAt": "2024-03-21T14:06:26Z", "redirectUrl": "https://test.webid-solutions.de/service/index/cn/000603/aid/233090202" } } } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "The Bearer token provided in the Authorization header was not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardExceptionUnauthorized" } } } } }, "x-code-samples": [ { "lang": "curl", "source": "curl -X POST https://api.signicat.com/assure/dossiers//processes -H 'Accept: application/json' -H 'Authorization: Bearer ' -H 'Content-Type: application/json' -d '';" } ] } }, "/dossiers/{dossierId}/processes/{processId}": { "get": { "tags": [ "Processes" ], "summary": "Get process", "description": "Use this service to get all the information about a process (e.g. provider, processType, updatedAt, status) and the verification result (e.g. finalResult).
The data in the response may vary depending on the provider used to perform the verification.
See also the Get process section in the integration documentation.", "operationId": "getProcess", "parameters": [ { "name": "dossierId", "in": "path", "description": "This ID is obtained from the \"Create dossier\" response body.", "required": true, "schema": { "type": "string" }, "example": "37191afe-25b3-4c30-b42a-b0ab64aa1d64" }, { "name": "processId", "in": "path", "description": "processId is obtained from the \"Create process\" response body.", "required": true, "schema": { "type": "string" }, "example": "8afb3ac6-6780-42e4-bbc2-3713e2f6d97c" } ], "responses": { "200": { "description": "The process information was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Process" }, "examples": { "The status is accepted when all underlying verifications have passed": { "summary": "Onfido accepted response with extra driving license information.", "description": "The status is accepted when all underlying verifications have passed", "value": { "processId": "b481a2e7-ba64-4889-bede-236a0a4a05d0", "provider": "onfido", "processType": "document", "notificationUrl": "http://httpstat.us/200", "status": "accepted", "finalResult": { "firstName": "JOHN PHILIP", "lastName": "SMITH", "dateOfBirth": "1986-07-24", "documentType": "driversLicense", "documentNumber": "C1234567", "issuingCountry": "PRT", "personalIdentificationNumber": "111111111", "placeOfBirth": "LISBON", "dateOfIssue": "2018-07-14" }, "providerSpecific": { "documentVerification": { "firstName": "JOHN PHILIP", "lastName": "SMITH", "dateOfBirth": "1986-07-24", "documentType": "driversLicense", "documentNumber": "C1234567", "issuingCountry": "PRT", "dateOfIssue": "2018-07-14", "placeOfBirth": "LISBON", "personalIdentificationNumber": "111111111", "subResult": "clear", "ageValidation": "clear", "dataValidation": "clear", "imageIntegrity": "clear", "compromisedDocument": "clear", "result": "clear", "driversLicense": true, "restrictedLicence": false, "rawVehicleClasses": "A1,A2,A,B1,B", "vehicleClassDetails": [ { "category": "A1", "obtainmentDate": "2002-10-14", "expiryDate": "2036-07-23" }, { "category": "A2", "obtainmentDate": "2018-07-11", "expiryDate": "2033-07-14" }, { "category": "A", "obtainmentDate": "2018-07-11", "expiryDate": "2033-07-14" }, { "category": "B1", "obtainmentDate": "2004-10-07", "expiryDate": "2036-07-23" }, { "category": "B", "obtainmentDate": "2004-10-07", "expiryDate": "2036-07-23" } ], "manualTransmissionRestriction": false, "passengerVehicle": { "obtainmentDate": "2004-10-07", "expiryDate": "2036-07-23" }, "breakdowns": { "issuingAuthority": { "breakdown": { "nfcActiveAuthentication": { "properties": {} }, "nfcPassiveAuthentication": { "properties": {} } } }, "imageIntegrity": { "result": "clear", "breakdown": { "supportedDocument": { "result": "clear", "properties": { "onfidoSupportedDocument": "clear", "customSupportedDocument": "clear", "issuingCountrySubjectToSanctions": "clear" } }, "colourPicture": { "result": "clear", "properties": {} }, "imageQuality": { "result": "clear", "properties": {} }, "conclusiveDocumentQuality": { "result": "clear", "properties": { "cornerRemoved": "clear", "abnormalDocumentFeatures": "clear", "obscuredSecurityFeatures": "clear", "watermarksDigitalTextOverlay": "clear", "puncturedDocument": "clear", "obscuredDataPoints": "clear", "missingBack": "clear", "digitalDocument": "clear" } } } }, "dataConsistency": { "breakdown": { "dateOfExpiry": { "properties": {} }, "lastName": { "properties": {} }, "firstName": { "properties": {} }, "nationality": { "properties": {} }, "gender": { "properties": {} }, "multipleDataSourcesPresent": { "properties": {} }, "documentType": { "properties": {} }, "issuingCountry": { "properties": {} }, "dateOfBirth": { "properties": {} }, "documentNumbers": { "properties": {} } } }, "dataComparison": { "breakdown": { "dateOfExpiry": { "properties": {} }, "lastName": { "properties": {} }, "firstName": { "properties": {} }, "gender": { "properties": {} }, "documentType": { "properties": {} }, "issuingCountry": { "properties": {} }, "dateOfBirth": { "properties": {} }, "documentNumbers": { "properties": {} } } }, "ageValidation": { "result": "clear", "breakdown": { "minimumAcceptedAge": { "result": "clear", "properties": {} } } }, "policeRecord": {}, "dataValidation": { "result": "clear", "breakdown": { "expiryDate": { "properties": {} }, "mrz": { "properties": {} }, "gender": { "properties": {} }, "dateOfBirth": { "result": "clear", "properties": {} }, "documentExpiration": { "properties": {} }, "barcode": { "properties": {} }, "documentNumbers": { "result": "clear", "properties": { "documentNumber": "clear" } } } }, "visualAuthenticity": { "result": "clear", "breakdown": { "faceDetection": { "result": "clear", "properties": {} }, "template": { "result": "clear", "properties": {} }, "pictureFaceIntegrity": { "result": "clear", "properties": {} }, "other": { "result": "clear", "properties": {} }, "securityFeatures": { "result": "clear", "properties": {} }, "fonts": { "result": "clear", "properties": {} }, "originalDocumentPresent": { "result": "clear", "properties": { "scan": "clear", "screenshot": "clear", "photoOfScreen": "clear", "documentOnPrintedPaper": "clear" } }, "digitalTampering": { "result": "clear", "properties": {} } } }, "compromisedDocument": { "result": "clear", "breakdown": { "documentDatabase": { "result": "clear", "properties": {} }, "repeatAttempts": { "properties": {} } } } }, "visualAuthenticity": "clear" } }, "createdAt": "2024-12-26T15:40:55Z", "updatedAt": "2024-12-26T15:42:10Z" } }, "Some of the underlying verifications have passed the values consider and suspected.": { "summary": "Onfido inconclusive response", "description": "Some of the underlying verifications have passed the values consider and suspected.", "value": { "provider": "onfido", "status": "inconclusive", "processId": "85210241-4e70-4451-8ea3-7cd3c4d8843a", "createdAt": "2019-09-23T10:05:53Z", "updatedAt": "2019-09-23T10:09:49Z", "providerSpecific": { "facialSimilarity": { "result": "consider", "similarityScore": "high" }, "documentVerification": { "lastName": "SPECIMEN", "dateOfExpiry": "2024-11-01", "subResult": "suspected", "gender": "F", "documentType": "passport", "documentNumber": "00000000", "dateOfBirth": "2002-04-29", "result": "consider", "firstName": "LAERKE OEYVOR AASE", "nationality": "NOR", "issuingCountry": "NOR", "mrzLine1": "I/processes/ -H 'Accept: application/json' -H 'Authorization: Bearer ';" } ] }, "post": { "tags": [ "Processes" ], "summary": "Start verification", "description": "This service requests the provider to perform a verification of the identity document that was uploaded. This service must always run after the ID images are uploaded to the provider (Set images to the process). After calling this service, the information in the process can no longer be changed. This means that if you need to change something in the process (e.g. upload new images), you must create a new process and start over again.", "operationId": "startVerification", "parameters": [ { "name": "dossierId", "in": "path", "description": "This ID is obtained from the \"Create dossier\" response body.", "required": true, "schema": { "type": "string" }, "example": "37191afe-25b3-4c30-b42a-b0ab64aa1d64" }, { "name": "processId", "in": "path", "description": "processId is obtained from the \"Create process\" response body.", "required": true, "schema": { "type": "string" }, "example": "8afb3ac6-6780-42e4-bbc2-3713e2f6d97c" } ], "requestBody": { "description": "Start verification payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerifyRequest" } } } }, "responses": { "200": { "description": "The request was successfully sent.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerifyResponse" } } } }, "204": { "description": "The request was successfully sent (only applies to the 'readid' and 'webid' providers)" }, "400": { "description": "The request cannot be fulfilled due to bad syntax", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardExceptionBadRequest" } } } }, "401": { "description": "The Bearer token provided in the Authorization header was not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardExceptionUnauthorized" } } } }, "404": { "description": "The resource requested cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardExceptionNotFound" } } } } }, "x-code-samples": [ { "lang": "curl", "source": "curl -X POST https://api.signicat.com/assure/dossiers//processes/ -H 'Accept: application/json' -H 'Authorization: Bearer ' -H 'Content-Type: application/json';" } ] }, "delete": { "tags": [ "Processes" ], "summary": "Delete process", "description": "This service deletes all information about a process.

Warning: This is a destructive operation since you cannot do a rollback afterwards.

Note: For Onfido, you are not allowed to delete a process if it is still in the `processing` state (for more details about process statuses, see the Get process page in the integration documentation).

These are the steps for deleting a process:
  • Before you delete, you should wait until the verification is finished, and then save all the information by using the Get process and Download full result services.
  • After saving, use this 'Delete process' service (and later also Delete dossier if you are finished with that end-user’s identity verification).
  • Once the delete operation has finished, the provider of the process will receive a request to delete the information on their side. The information will either be immediately deleted or soft-deleted, i.e., it will be marked for deletion and hard-deleted after X days (decided by each provider).
", "operationId": "deleteProcess", "parameters": [ { "name": "dossierId", "in": "path", "description": "This ID is obtained from the \"Create dossier\" response body.", "required": true, "schema": { "type": "string" }, "example": "37191afe-25b3-4c30-b42a-b0ab64aa1d64" }, { "name": "processId", "in": "path", "description": "processId is obtained from the \"Create process\" response body.", "required": true, "schema": { "type": "string" }, "example": "8afb3ac6-6780-42e4-bbc2-3713e2f6d97c" } ], "responses": { "204": { "description": "The process was successfully deleted." }, "400": { "description": "The request cannot be fulfilled due to bad syntax", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "The Bearer token provided in the Authorization header was not valid" }, "404": { "description": "The resource requested cannot be found" } }, "x-code-samples": [ { "lang": "curl", "source": "curl -X DELETE https://api.signicat.com/assure/dossiers//processes/ -H 'Accept:application/json' -H 'Authorization: Bearer ';" } ] } }, "/dossiers/{dossierId}/processes/{processId}/images": { "get": { "tags": [ "Processes" ], "summary": "Get image", "description": "Use this service to return images from the process.

Note: The images were either uploaded to the process directly through the Set images endpoint or by using the provider’s SDK to capture and upload them.

Supported depiction types are `front` and `back` images of the ID document, `selfie` images of the end-user, and `portrait`images extracted from the ID document (portrait is available only for some providers).

Supported file formats are jpg/png.

For more information, see the Images section in the integration documentation.", "operationId": "getImages", "parameters": [ { "name": "dossierId", "in": "path", "description": "This ID is obtained from the \"Create dossier\" response body.", "required": true, "schema": { "type": "string" }, "example": "37191afe-25b3-4c30-b42a-b0ab64aa1d64" }, { "name": "processId", "in": "path", "description": "processId is obtained from the \"Create process\" response body.", "required": true, "schema": { "type": "string" }, "example": "8afb3ac6-6780-42e4-bbc2-3713e2f6d97c" }, { "name": "depiction", "in": "query", "description": "The type of image to be retrieved from the process.
The portrait value is only available for the 'signicatvideoid' and 'readid' providers.", "required": true, "schema": { "type": "string", "enum": [ "front", "back", "selfie", "portrait" ] }, "example": "front" } ], "responses": { "200": { "description": "The image was successfully retrieved.", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "This provider and process type does not provide the requested image type.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardExceptionBadRequest" } } } }, "401": { "description": "The Bearer token provided in the Authorization header was not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardExceptionUnauthorized" } } } }, "404": { "description": "The dossier was not found. | The image was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardExceptionNotFound" } } } }, "409": { "description": "Conflict found while processing the request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardExceptionConflict" } } } } }, "x-code-samples": [ { "lang": "curl", "source": "curl -X GET 'https://api.signicat.com/assure/dossiers//processes//images?depiction=' -H 'Authorization: Bearer ';" } ] }, "post": { "tags": [ "Processes" ], "summary": "Set images to the process", "description": "Use this service to add images to the process, which in turn will upload images directly to a provider (i.e. not using their SDK to capture and upload the images).

Note: Direct upload using Assure is only available for Onfido, Signicat Paper and FaceTec.

Supported depiction types are `front` and `back` images of the ID document, `selfie` images of the end-user, and `portrait` images extracted from the ID document (portrait is available only for some providers).

Supported file formats are jpg/png. The file must be sent using the dataURL scheme.

You can send one or more images at the same time. If the same depiction type (e.g. selfie) is sent more than once, only the last one is kept.

You are not allowed to upload images after the verification has started.

For more information, see the Images section in the integration documentation.", "operationId": "setImages", "parameters": [ { "name": "dossierId", "in": "path", "description": "This ID is obtained from the \"Create dossier\" response body.", "required": true, "schema": { "type": "string" }, "example": "37191afe-25b3-4c30-b42a-b0ab64aa1d64" }, { "name": "processId", "in": "path", "description": "processId is obtained from the \"Create process\" response body.", "required": true, "schema": { "type": "string" }, "example": "8afb3ac6-6780-42e4-bbc2-3713e2f6d97c" } ], "requestBody": { "description": "Set images payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadImageRequest" } } }, "required": true }, "responses": { "201": { "description": "The files were successfully uploaded." }, "400": { "description": "The request cannot be fulfilled due to bad syntax", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardExceptionBadRequest" } } } }, "401": { "description": "The Bearer token provided in the Authorization header was not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardExceptionUnauthorized" } } } } }, "x-code-samples": [ { "lang": "curl", "source": "curl -X POST https://api.signicat.com/assure/dossiers//processes//images -H 'Authorization: Bearer ' -H 'Content-Type:application/json' -d '';" } ] } }, "/dossiers/{dossierId}/processes/{processId}/fail": { "post": { "tags": [ "Processes" ], "summary": "Fail process", "description": "This endpoint allows you to change a process status from `pending` to `failed`. This is useful if lots of processes get stuck in pending status due to some problems or user errors (e.g. unstable wifi connection, missing access to the web camera, etc.). Changing those statuses to failed, would declutter the dossier. You cannot set other statuses than `pending` to `failed`. If you try to do that, you will receive an HTML 409 error message.", "operationId": "setFailedProcess", "parameters": [ { "name": "dossierId", "in": "path", "description": "This ID is obtained from the \"Create dossier\" response body.", "required": true, "schema": { "type": "string" }, "example": "37191afe-25b3-4c30-b42a-b0ab64aa1d64" }, { "name": "processId", "in": "path", "description": "processId is obtained from the \"Create process\" response body.", "required": true, "schema": { "type": "string" }, "example": "8afb3ac6-6780-42e4-bbc2-3713e2f6d97c" } ], "responses": { "200": { "description": "The process status will be set to `failed`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessStatusResponse", "example": { "processId": "9424224c-b7d9-49f6-83e7-2c1003431bdb", "status": "failed", "reason": { "category": "User.Request", "reason": "Process.Failed", "message": "Failed by request." } } } } } }, "400": { "description": "The request cannot be fulfilled due to bad syntax", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardExceptionBadRequest" } } } }, "401": { "description": "The Bearer token provided in the Authorization header was not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardExceptionUnauthorized" } } } }, "404": { "description": "The resource requested cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardExceptionNotFound" } } } }, "409": { "description": "The process status is not `pending`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardExceptionConflict" } } } } }, "x-code-samples": [ { "lang": "curl", "source": "curl -X POST https://preprod.signicat.com/assure/dossiers//processes//fail -H 'Accept: application/json' -H 'Authorization: Bearer ';" } ] } }, "/dossiers/{dossierId}/match": { "post": { "tags": [ "Matching" ], "summary": "Perform matching", "description": "You can use this service to corroborate the end-user’s identity. This service matches different sources of information about the end-user.", "operationId": "match", "parameters": [ { "name": "dossierId", "in": "path", "description": "This ID is obtained from the \"Create dossier\" response body.", "required": true, "schema": { "type": "string" }, "example": "37191afe-25b3-4c30-b42a-b0ab64aa1d64" } ], "requestBody": { "description": "Matching payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MatchRequest" } } }, "required": true }, "responses": { "200": { "description": "Matching was successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MatchResponse" } } } }, "401": { "description": "The Bearer token provided in the Authorization header was not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MatchResponse" } } } }, "404": { "description": "The resource requested cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardExceptionNotFound" } } } } }, "x-code-samples": [ { "lang": "curl", "source": "curl -X POST https://api.signicat.com/assure/dossiers//match -H 'Authorization: Bearer ' -d '';" } ] } }, "/dossiers/{dossierId}/files": { "get": { "tags": [ "Dossiers" ], "summary": "Get file from dossier", "description": "Use this service to retrieve files in the dossier.

Supported depiction types are `front` and `back` images of the ID document and `selfie` images of the end-user.

Supported file formats are jpg/png.

For more information, see the Files in dossier in the integration documentation.", "operationId": "getFile", "parameters": [ { "name": "dossierId", "in": "path", "description": "This ID is obtained from the \"Create dossier\" response body.", "required": true, "schema": { "type": "string" }, "example": "37191afe-25b3-4c30-b42a-b0ab64aa1d64" }, { "name": "depiction", "in": "query", "description": "The type of image to be retrieved from the dossier.", "required": true, "schema": { "type": "string", "enum": [ "front", "back", "selfie" ] }, "example": "front" } ], "responses": { "200": { "description": "The image was successfully retrieved.", "content": { "application/octet-stream": {} } }, "400": { "description": "This dossier does not provide the requested image type.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardExceptionBadRequest" } } } }, "401": { "description": "The Bearer token provided in the Authorization header was not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardExceptionUnauthorized" } } } }, "404": { "description": "The dossier was not found. | The image was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardExceptionNotFound" } } } } }, "x-code-samples": [ { "lang": "curl", "source": "curl -X GET 'https://api.signicat.com/assure/dossiers//files?depiction=' -H 'Authorization: Bearer ';" } ] }, "post": { "tags": [ "Dossiers" ], "summary": "Set files to the dossier", "description": "Use this service to upload files to the dossier.

Supported depiction types are `front` and `back` images of the ID document and `selfie` images of the end-user.

Supported file formats are jpg/png. The file must be sent using the dataURL scheme.

You can send one or more files at the same time. If the same depiction type (e.g. selfie) is sent more than once, only the last one is kept.

If you want to copy an image from the process into the dossier, you must define the processId parameter in the body. Then the file will be uploaded from the process.

For more information, see the Files in dossier section in the integration documentation.", "operationId": "setFiles", "parameters": [ { "name": "dossierId", "in": "path", "description": "This ID is obtained from the \"Create dossier\" response body.", "required": true, "schema": { "type": "string" }, "example": "37191afe-25b3-4c30-b42a-b0ab64aa1d64" } ], "requestBody": { "description": "Upload image payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileRequest" } } }, "required": true }, "responses": { "201": { "description": "The files were successfully uploaded." }, "400": { "description": "Image encoded is in the wrong format. It must be follow thedataURL format.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardExceptionBadRequest" } } } }, "401": { "description": "The Bearer token provided in the Authorization header was not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardExceptionUnauthorized" } } } }, "404": { "description": "Dossier not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardExceptionNotFound" } } } } }, "x-code-samples": [ { "lang": "curl", "source": "curl -X POST https://api.signicat.com/assure/dossiers//files/ -H 'Authorization: Bearer ' -H 'Content-Type: application/json' -d '';" } ] }, "delete": { "tags": [ "Dossiers" ], "summary": "Delete files from dossier", "description": "All files uploaded to the dossier will be deleted.", "operationId": "deleteFiles", "parameters": [ { "name": "dossierId", "in": "path", "description": "This ID is obtained from the \"Create dossier\" response body.", "required": true, "schema": { "type": "string" }, "example": "37191afe-25b3-4c30-b42a-b0ab64aa1d64" } ], "responses": { "204": { "description": "The files were successfully deleted." }, "401": { "description": "The Bearer token provided in the Authorization header was not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardExceptionUnauthorized" } } } }, "404": { "description": "The dossier was not found. | The image was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardExceptionNotFound" } } } } }, "x-code-samples": [ { "lang": "curl", "source": "curl -X DELETE https://api.signicat.com/assure/dossiers//files -H 'Accept: application/json' -H 'Authorization: Bearer ' -H 'Content-Type:application/json';" } ] } }, "/dossiers/{dossierId}/capture": { "post": { "tags": [ "Capture" ], "summary": "Start capture flow", "description": "This service initiates a flow for performing an identity document verification in a web context. Since this service encapsulates all providers’ Web SDKs, you do not have to integrate with the provider’s SDK yourself. When you call this service, it will:
  • Create a new service on your behalf.
  • Integrate directly with the provider's JS SDK and use it to display a web view to the end-user where they can capture and upload the ID images.
  • Request to start the verification.
When you call this service, you must provide similar request parameters as in the Create process service. For more details, see the parameter descriptions below.

This service also provides other useful features. For example, you can configure the user interface during the web flow. For more usage details about this, see the general documentation in the Start Capture flow section.
", "operationId": "createArtifact", "parameters": [ { "name": "dossierId", "in": "path", "description": "This ID is obtained from the \"Create dossier\" response body.", "required": true, "schema": { "type": "string" }, "example": "37191afe-25b3-4c30-b42a-b0ab64aa1d64" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaptureRequest" }, "examples": { "Example using onfido provider": { "summary": "Onfido example", "description": "Example using onfido provider", "value": { "providers": [ { "provider": "onfido", "processType": "documentSelfie" } ], "sdk": "native", "redirectUrl": "https://customer.site.com" } }, "Example using onfido provider with extra dl information": { "summary": "Onfido request with extra information from driving license", "description": "Example using onfido provider with extra dl information", "value": { "providers": [ { "provider": "onfido", "processType": "documentSelfie", "requestExtraDataFromDrivingLicense": true } ], "sdk": "native", "redirectUrl": "https://customer.site.com" } }, "Example using signicatvideoid provider": { "summary": "Signicat VideoID example", "description": "Example using signicatvideoid provider", "value": { "providers": [ { "provider": "eid", "processType": "substantial" } ], "sdk": "native", "redirectUrl": "https://customer.site.com" } }, "Example using signicatpaper provider": { "summary": "Signicat Paper example", "description": "Example using signicatpaper provider", "value": { "providers": [ { "provider": "paper" } ], "sdk": "capture", "redirectUrl": "https://customer.redirect.site.com" } }, "Example using readid provider": { "summary": "ReadID example", "description": "Example using readid provider", "value": { "providers": [ { "provider": "readid", "processType": "ready" } ], "sdk": "native", "redirectUrl": "https://customer.redirect.site.com" } }, "Example using signicatpictureid provider": { "summary": "Signicat PictureID documentSelfie example", "description": "Example using signicatpictureid provider", "value": "{\n \"providers\": [\n {\n \"provider\": \"signicatpictureid,\n \"processType\": \"documentSelfie\",\n \"documentId\":137\n }\n ],\n \"sdk\": \"capture\",\n \"redirectUrl\": \"https://customer.redirect.site.com\"\n}\n" } } } }, "required": true }, "responses": { "201": { "description": "The URL artifact was successfully created.

You send the end-user to this URL. This is where the JS SDK of the provider is loaded so that the end-user can capture and upload the ID images. For more information about available SDKs, see Using the SDKs available in the Capture service.

", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebURL" } } } }, "400": { "description": "The request cannot be fulfilled due to bad syntax", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardExceptionUnauthorized" } } } }, "401": { "description": "The Bearer token provided in the Authorization header was not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardExceptionUnauthorized" } } } } }, "x-code-samples": [ { "lang": "curl", "source": "curl -X POST https://api.signicat.com/assure/dossiers//capture -H 'Accept: application/json' -H 'Authorization: Bearer ' -H 'Content-Type: application/json' -d '';" } ] } }, "/{providerName}/document-types": { "get": { "tags": [ "Assure" ], "summary": "Get document types", "description": "This service returns a list with document types supported by each provider, e.g. passport, driving licence etc.

Note: There might be limitations for specific services. For example, retrieving Onfido's extra driving licence information is only supported for specific documents. For a list of supported DL documents, see Use Onfido to extract extra driving licence information in the integration guide.", "operationId": "getDocumentTypes", "parameters": [ { "name": "providerName", "in": "path", "description": "The ID of one of the supported providers.
", "required": true, "schema": { "type": "string", "enum": [ "onfido", "signicatpaper", "signicatpictureid", "signicatvideoid" ] }, "example": "signicatvideoid" } ], "responses": { "200": { "description": "The list of document types was successfully retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EidCountryAndDocumentType" } } } } }, "204": { "description": "No document types were found for the requested provider." } }, "x-code-samples": [ { "lang": "curl", "source": "curl -X GET https://api.signicat.com/assure/onfido/document-types -H 'Accept: application/json' -H 'Authorization: Bearer ';" } ] } }, "/processes": { "get": { "tags": [ "Processes" ], "summary": "Get list of processes", "description": "You can use this service to retrieve information about all the processes you have created the last 30 days (as long as they are not deleted). This can be useful, for example, to investigate how many processes have failed and why, to see how many processes are accepted/rejected etc.The result is presented as a list. You can filter the process list on creation date, status, offset and limit (see 'query parameters' below).", "operationId": "getAllProcess", "parameters": [ { "name": "startCreationDate", "in": "query", "description": "The start date and time (ISO-8601 with UTC: YYYY-MM-DDThh:mm:ssZ) for the first process in the process list. This date filter is relative to the date the process was created (the `createdAt` field of the process). ", "required": true, "schema": { "type": "string" }, "example": "2021-10-04T09:35:19Z" }, { "name": "endCreationDate", "in": "query", "description": "The end date and time (ISO-8601 with UTC: YYYY-MM-DDThh:mm:ssZ) for the last process in the process list ", "required": false, "schema": { "type": "string" }, "example": "2021-10-04T09:35:19Z" }, { "name": "status", "in": "query", "description": "This field allows you to filter the process list on one or more statuses. The default value is an empty string, which means it returns all processes with all statuses.", "required": false, "schema": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "example": "accepted" }, { "name": "provider", "in": "query", "description": "This field allows you to filter the process list on one or more providers.", "required": false, "schema": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "example": "signicatvideoid" }, { "name": "offset", "in": "query", "description": "You can enter an offset value to specify which process should be retrieved first. The default offset value is 0 (first position in the database) and maximum is 200000. This maximum number is set to avoid performance issues. If you want to display more processes than defined in 'limit', you can create several requests with a different offset:
1. Create a request for the most recent items: GET /processes?limit=20&offset=0
2. On scroll/next page, create a second request: GET /processes?limit=20&offset=20
3. On scroll/next page, create a third request: GET /processes?limit=20&offset=40
", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0, "maximum": 200000, "minimum": 0 }, "example": 0 }, { "name": "limit", "in": "query", "description": "This is the maximum number of processes allowed in the response. The default value is 100 and maximum allowed is 2000. If you want to look at more processes than the defined limit, you must make more requests using the 'offset' parameter (see the example above).", "required": false, "schema": { "type": "integer", "format": "int32", "default": 100, "maximum": 2000, "minimum": 1 }, "example": 100 }, { "name": "order", "in": "query", "description": "Allows to choose the order on which the processes will be returned - by descending or ascending createdAt date.
Default is descending.", "required": false, "schema": { "type": "string" }, "example": "createdAtDescending" } ], "responses": { "200": { "description": "The list of processes was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListAllProcesses" } } } }, "400": { "description": "Please check the filter values:
  • startCreationDate should be <e endCreationDate
  • status must be valid.
  • offset or limit maximum value was overpassed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-code-samples": [ { "lang": "curl", "source": "curl -X GET https://api.signicat.com/assure/processes?startCreationDate=2022-08-05T08:00:00Z -H 'Authorization: Bearer ' " } ] } }, "/matching/configurations": { "get": { "tags": [ "Matching" ], "summary": "Get all available matching configuration IDs", "description": "Gets all existing matching configuration IDs.", "operationId": "getAllConfigurations", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MatchingConfigurationResponse" } } } } } }, "x-code-samples": [ { "lang": "curl", "source": "curl -X GET https://api.signicat.com/assure/matching/configurations -H 'Authorization: Bearer ';" } ] } }, "/dossiers/{dossierId}": { "get": { "tags": [ "Dossiers" ], "summary": "Get dossier", "description": "Use this service to get all the information about a dossier, including a summarized view of all the processes in it (e.g. Process ID, Status code, Provider...)", "operationId": "getDossier", "parameters": [ { "name": "dossierId", "in": "path", "description": "This ID is obtained from the \"Create dossier\" response body.", "required": true, "schema": { "type": "string" }, "example": "37191afe-25b3-4c30-b42a-b0ab64aa1d64" } ], "responses": { "200": { "description": "The dossier information was successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DossierResponse" } } } }, "401": { "description": "The Bearer token provided in the Authorization header was not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardExceptionUnauthorized" } } } }, "404": { "description": "Dossier not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardExceptionNotFound" } } } } }, "x-code-samples": [ { "lang": "curl", "source": "curl -X GET https://api.signicat.com/assure/dossiers/ -H 'Accept: application/json' -H 'Authorization: Bearer ';" } ] }, "delete": { "tags": [ "Dossiers" ], "summary": "Delete dossier", "description": "This service deletes all userData, files and processes in the given dossier (`dossierId`).

    Warning: This is a destructive operation since you cannot do a rollback afterwards. You should only use this service after you have finished the end-user’s identification.

    Note: For Onfido, you are not allowed to delete a dossier if there are still processes in the `processing` state (for more details about process statuses, see the Get process page in the integration documentation).", "operationId": "deleteDossier", "parameters": [ { "name": "dossierId", "in": "path", "description": "This ID is obtained from the \"Create dossier\" response body.", "required": true, "schema": { "type": "string" }, "example": "37191afe-25b3-4c30-b42a-b0ab64aa1d64" } ], "responses": { "204": { "description": "Dossier deleted successfully." }, "401": { "description": "The Bearer token provided in the Authorization header was not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardExceptionUnauthorized" } } } }, "404": { "description": "Dossier not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardExceptionUnauthorized" } } } } }, "x-code-samples": [ { "lang": "curl", "source": "curl -X DELETE https://api.signicat.com/assure/dossiers/ -H 'Accept: application/json' -H 'Authorization: Bearer ';" } ] } }, "/dossiers/{dossierId}/processes/{processId}/video": { "get": { "tags": [ "Processes" ], "summary": "Get video", "description": "This service gets the video that the end-user recorded while the images were captured and uploaded through their SDK with this option set. The service is available for Signicat VideoID and Onfido.", "operationId": "getVideo", "parameters": [ { "name": "dossierId", "in": "path", "description": "This ID is obtained from the \"Create dossier\" response body.", "required": true, "schema": { "type": "string" }, "example": "37191afe-25b3-4c30-b42a-b0ab64aa1d64" }, { "name": "processId", "in": "path", "description": "processId is obtained from the \"Create process\" response body.", "required": true, "schema": { "type": "string" }, "example": "8afb3ac6-6780-42e4-bbc2-3713e2f6d97c" } ], "responses": { "200": { "description": "The video was successfully retrieved.", "content": { "video/mp4,video/quicktime": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "This provider and process type does not provide a video.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardExceptionBadRequest" } } } }, "401": { "description": "The Bearer token provided in the Authorization header was not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardExceptionUnauthorized" } } } }, "404": { "description": "Video not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardExceptionNotFound" } } } } }, "x-code-samples": [ { "lang": "curl", "source": "curl -X GET https://api.signicat.com/assure/dossiers//processes//video -H 'Accept: application/json' -H 'Authorization: Bearer ';" } ] } }, "/dossiers/{dossierId}/processes/{processId}/raw": { "get": { "tags": [ "Processes" ], "summary": "Get raw result", "description": "Note: This is currently only available for provider readid.

    Use this service to get the raw information about a process as it is retrieved from the provider.

    The data in the response will vary depending on the provider used to perform the verification.

    See also the Get raw result section in the developer documentation.", "operationId": "getRawResult", "parameters": [ { "name": "dossierId", "in": "path", "description": "This ID is obtained from the \"Create dossier\" response body.", "required": true, "schema": { "type": "string" }, "example": "37191afe-25b3-4c30-b42a-b0ab64aa1d64" }, { "name": "processId", "in": "path", "description": "processId is obtained from the \"Create process\" response body.", "required": true, "schema": { "type": "string" }, "example": "8afb3ac6-6780-42e4-bbc2-3713e2f6d97c" } ], "responses": { "200": { "description": "The zip file was successfully created and retrieved.", "content": { "application/json": {} } }, "204": { "description": "No-content if the process is not completed.", "content": { "application/zip": { "schema": { "type": "string" } } } }, "401": { "description": "The Bearer token provided in the Authorization header was not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardExceptionUnauthorized" } } } }, "404": { "description": "The resource requested cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardExceptionNotFound" } } } } }, "x-code-samples": [ { "lang": "curl", "source": "curl -X GET https://api.signicat.com/assure/dossiers//processes//raw -H 'Authorization: Bearer ';" } ] } }, "/dossiers/{dossierId}/processes/{processId}/external-id": { "get": { "tags": [ "Processes" ], "summary": "Get processes' external id", "description": "Use this request to get the process external id. This id is the assure process id in the provider side. It corresponds to different things in each provider: Onfido: applicantId, Signicat VideoID: videoId, ReadID: sessionId (only after the process is finished. Before that it's the same as processId), Signicat Paper: requestId, Facetec: n/a, WebID: actionId, Signicat PictureID: transactionId.", "operationId": "getExternalId", "parameters": [ { "name": "dossierId", "in": "path", "description": "This ID is obtained from the \"Create dossier\" response body.", "required": true, "schema": { "type": "string" }, "example": "37191afe-25b3-4c30-b42a-b0ab64aa1d64" }, { "name": "processId", "in": "path", "description": "processId is obtained from the \"Create process\" response body.", "required": true, "schema": { "type": "string" }, "example": "8afb3ac6-6780-42e4-bbc2-3713e2f6d97c" } ], "responses": { "200": { "description": "Get processes' external id", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalId", "example": { "externalId": "2822984e-fa4d-46a9-b4cd-de47d5050cc0" } } } } }, "400": { "description": "The request cannot be fulfilled due to bad syntax", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "The Bearer token provided in the Authorization header was not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalId" } } } } }, "x-code-samples": [ { "lang": "curl", "source": "curl -X GET https://api.signicat.com/assure/dossiers//processes//external-id -H 'Authorization: Bearer ' " } ] } }, "/dossiers/{dossierId}/processes/{processId}/download": { "get": { "tags": [ "Processes" ], "summary": "Download full result", "description": "This service returns a zip file containing all information (images, videos, json files) about a process after verification is complete (“accepted“, ”rejected“, ”inconclusive“).
    After verification is complete, it is recommended to download all information about the process before you delete the process. <
    See also the Download full result section in the integration documentation.", "operationId": "getZipFile", "parameters": [ { "name": "dossierId", "in": "path", "description": "This ID is obtained from the \"Create dossier\" response body.", "required": true, "schema": { "type": "string" }, "example": "37191afe-25b3-4c30-b42a-b0ab64aa1d64" }, { "name": "processId", "in": "path", "description": "processId is obtained from the \"Create process\" response body.", "required": true, "schema": { "type": "string" }, "example": "8afb3ac6-6780-42e4-bbc2-3713e2f6d97c" }, { "name": "includeTimestamps", "in": "query", "description": "This field only applies to the 'signicatvideoid' provider.
    If true, it includes the timestamps in the zip file and if no timestamps are available the request will fail.", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "The zip file was successfully created and retrieved.", "content": { "application/zip": { "schema": { "type": "string", "format": "binary" } } } }, "204": { "description": "No-content if the process is not completed or the contents of the zip file are not yet available for download.", "content": { "application/zip": { "schema": { "type": "string", "format": "binary" } } } }, "401": { "description": "The Bearer token provided in the Authorization header was not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardExceptionUnauthorized" } } } }, "404": { "description": "The resource requested cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardExceptionNotFound" } } } } }, "x-code-samples": [ { "lang": "curl", "source": "curl -X GET https://api.signicat.com/assure/dossiers//processes//download -H 'Authorization: Bearer ';" } ] } }, "/capture/configurations": { "get": { "tags": [ "Capture" ], "summary": "Get all available capture configuration IDs", "description": "Gets all existing capture configuration IDs.", "operationId": "getAllConfigurations_1", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CaptureConfigurationSlimResponse" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardExceptionNotFound" } } } } }, "x-code-samples": [ { "lang": "curl", "source": "curl -X GET https://api.signicat.com/assure/capture/configurations -H 'Authorization: Bearer ';" } ] } }, "/dossiers/all": { "delete": { "tags": [ "Dossiers" ], "summary": "Delete all dossiers", "description": "Warning: Normally, you should not use this service, since it deletes all dossiers associated with the OIDC client.", "operationId": "deleteAllDossiers", "responses": { "204": { "description": "Dossiers deleted successfully." }, "401": { "description": "The Bearer token provided in the Authorization header was not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardExceptionUnauthorized" } } } }, "404": { "description": "Dossier not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardExceptionUnauthorized" } } } } }, "x-code-samples": [ { "lang": "curl", "source": "curl -X DELETE https://api.signicat.com/assure/dossiers/all -H 'Accept: application/json' -H 'Authorization: Bearer ' -H 'Content-Type:application/json';" } ] } } }, "components": { "schemas": { "NotUnderage": { "description": "Ensures the person in the document is not a minor.", "properties": { "name": { "type": "string", "writeOnly": true }, "passed": { "type": "boolean", "writeOnly": true }, "valid": { "type": "boolean", "description": "Returns information on the multiple security checks that were performed." } } }, "DataIntegrity": { "description": "Ensures the data integrity of the document is intact by checking the MRZ control digits.", "properties": { "name": { "type": "string", "writeOnly": true }, "passed": { "type": "boolean", "writeOnly": true }, "valid": { "type": "boolean", "description": "Returns information on the multiple security checks that were performed." } } }, "NonExpired": { "description": "Ensures the document isn't expired.", "properties": { "name": { "type": "string", "writeOnly": true }, "passed": { "type": "boolean", "writeOnly": true }, "valid": { "type": "boolean", "description": "Returns information on the multiple security checks that were performed." } } }, "Liveness": { "description": "Ensures there is a living person in front of the camera through a facial expression (smile).", "properties": { "name": { "type": "string", "writeOnly": true }, "passed": { "type": "boolean", "writeOnly": true }, "valid": { "type": "boolean", "description": "Returns information on the multiple security checks that were performed." } } }, "NotFaceSpoofing": { "description": "Ensures that the person does not try to show a photo instead of their face.", "properties": { "name": { "type": "string", "writeOnly": true }, "passed": { "type": "boolean", "writeOnly": true }, "valid": { "type": "boolean", "description": "Returns information on the multiple security checks that were performed." } } }, "SidesMatch": { "description": "Ensures that both sides (of the document presented) belong to the same document.", "properties": { "name": { "type": "string", "writeOnly": true }, "passed": { "type": "boolean", "writeOnly": true }, "valid": { "type": "boolean", "description": "Returns information on the multiple security checks that were performed." } } }, "SelfieAndDocumentMatch": { "description": "Ensures the selfie matches the document.", "properties": { "name": { "type": "string", "writeOnly": true }, "passed": { "type": "boolean", "writeOnly": true }, "valid": { "type": "boolean", "description": "Returns information on the multiple security checks that were performed." } } }, "NotBWCopy": { "description": "Ensures the document is not a black and white copy.", "properties": { "name": { "type": "string", "writeOnly": true }, "passed": { "type": "boolean", "writeOnly": true }, "valid": { "type": "boolean", "description": "Returns information on the multiple security checks that were performed." } } }, "UntamperedDocument": { "description": "Ensures the document is not tampered.", "properties": { "name": { "type": "string", "writeOnly": true }, "passed": { "type": "boolean", "writeOnly": true }, "valid": { "type": "boolean", "description": "Returns information on the multiple security checks that were performed." } } }, "untamperedVideo": { "description": "Ensures the video is not tampered.", "properties": { "name": { "type": "string", "writeOnly": true }, "passed": { "type": "boolean", "writeOnly": true }, "valid": { "type": "boolean", "description": "Returns information on the multiple security checks that were performed." } } }, "deviceSecurity": { "description": "Ensures the device is secure.", "properties": { "name": { "type": "string", "writeOnly": true }, "passed": { "type": "boolean", "writeOnly": true }, "valid": { "type": "boolean", "description": "Returns information on the multiple security checks that were performed." } } }, "reflectiveSurface": { "description": "When enabled, it activates the flash to detect the reflectiveness of the document.", "properties": { "name": { "type": "string", "writeOnly": true }, "passed": { "type": "boolean", "writeOnly": true }, "valid": { "type": "boolean", "description": "Returns information on the multiple security checks that were performed." } } }, "documentTilt": { "description": "When enable, it asks the user to tilt the document. ", "properties": { "name": { "type": "string", "writeOnly": true }, "passed": { "type": "boolean", "writeOnly": true }, "valid": { "type": "boolean", "description": "Returns information on the multiple security checks that were performed." } } }, "Process_failReason": { "description": "Warning: This is currently a beta feature that might change in future versions.\n\nThis field is only presented when the process status is `failed`. It contains information about why the process failed. Reasons for failure could be time-out, server errors, expired tokens, validation errors, blocked camera/microphone etc.The reasons vary from provider to provider." }, "ProcessWithDossierNode_failReason": { "description": "Warning: This is currently a beta feature that might change in future versions.\n\nThis field is only presented when the process status is `failed`. It contains information about why the process failed. Reasons for failure could be time-out, server errors, expired tokens, validation errors, blocked camera/microphone etc.The reasons vary from provider to provider." }, "ErrorResponse": { "type": "object", "properties": { "instance": { "type": "string" }, "method": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "type": { "type": "string" }, "title": { "type": "string" }, "detail": { "type": "string" }, "timestamp": { "type": "string" }, "traceId": { "type": "string" } } }, "FieldConfiguration": { "type": "object", "description": "Matching Field Configuration payload", "properties": { "id": { "type": "string", "description": "The field to be compared.", "example": "fieldId1" }, "sourceField": { "type": "string", "description": "Data from source node.", "example": "firstName" }, "targetField": { "type": "string", "description": "Data from target node.", "example": "lastName" }, "normalization": { "$ref": "#/components/schemas/MatchingNormalization", "description": "

    The normalization to be applied to source and target values.

  • 'none': No conversion - case sensitive scenario.
  • 'upper': Converts all characters to upper case - ignores case scenario.
  • 'clean': Converts into latin script - Following ICAO Doc 9303 Part 3 Section 6 recommendation.
  • 'cleanUpper': Apply clean an upper normalization.
  • 'initialsUpper': Converts to the first two initials from multiple words.
  • 'numeric': Converts to the 0-9 characters only.", "example": "upper" }, "algorithm": { "$ref": "#/components/schemas/MatchingAlgorithm", "description": "

    The matching algorithm to be used.

  • 'levenshtein': String compare normalized values
    • Exact match: True if all characters match
    Partial match: True if the similarity ratio is above 90% of characters
  • 'fuzzy': String compare normalized values
    • Exact match: True if all characters match
    Partial match: True if the similarity ratio is above 90% of characters or if one of multiple words are an exact match.    ", "example": "levenshtein" } } }, "MatchingAlgorithm": { "type": "string", "enum": [ "levenshtein", "fuzzy" ] }, "MatchingConfiguration": { "type": "object", "description": "Matching Configuration payload", "properties": { "fields": { "type": "array", "items": { "$ref": "#/components/schemas/FieldConfiguration" } } } }, "MatchingNormalization": { "type": "string", "enum": [ "none", "upper", "clean", "cleanUpper", "initialsUpper", "numeric" ] }, "MatchingConfigurationResponse": { "type": "object", "description": "Matching Configuration Response", "properties": { "configuration": { "$ref": "#/components/schemas/MatchingConfiguration" }, "id": { "type": "string", "description": "The ID of a capture configuration.", "example": "Configuration1", "maxLength": 100 }, "createdAt": { "type": "string", "description": "The date and time the data was created (ISO-8601 with UTC: YYYY-MM-DDThh:mm:ssZ.)", "example": "2021-10-04T09:35:19Z" }, "updatedAt": { "type": "string", "description": "The date and time the data was updated (ISO-8601 with UTC: YYYY-MM-DDThh:mm:ssZ).", "example": "2021-10-04T09:35:19Z" } } }, "StandardExceptionBadRequest": { "type": "object", "description": "Standard Exception Bad Request", "properties": { "instance": { "type": "string", "description": "URI of the endpoint called.", "example": "/assure/dossiers/" }, "method": { "type": "string", "description": "HTTP method associated to the type of request done.", "example": "POST" }, "status": { "type": "integer", "format": "int32", "description": "HTTP status associated with the exception generated.", "example": 400 }, "type": { "type": "string", "description": "Type of the exception generated.", "example": "base:client-problem" }, "title": { "type": "string", "description": "Title of the exception generated.", "example": "Malformed Authorization header." }, "detail": { "type": "string", "description": "Detailed message containing information of the exception generated.", "example": "Please provide a valid Bearer authentication." }, "traceId": { "type": "string", "description": "TraceID for logging purposes.", "example": "034fb8bbc5da31f4dd2cf66e70ef313c" } } }, "StandardExceptionConflict": { "type": "object", "description": "Standard Exception Conflict", "properties": { "instance": { "type": "string", "description": "URI of the endpoint called.", "example": "/assure/dossiers/" }, "method": { "type": "string", "description": "HTTP method associated to the type of request done.", "example": "POST" }, "status": { "type": "integer", "format": "int32", "description": "HTTP status associated with the exception generated.", "example": 409 }, "type": { "type": "string", "description": "Type of the exception generated.", "example": "base:client-problem" }, "title": { "type": "string", "description": "Title of the exception generated.", "example": "Conflict" }, "detail": { "type": "string", "description": "Detailed message containing information of the exception generated.", "example": "Conflict found while processing the request." }, "traceId": { "type": "string", "description": "TraceID for logging purposes.", "example": "034fb8bbc5da31f4dd2cf66e70ef313c" } } }, "Address": { "type": "object", "description": "User data address", "properties": { "formatted": { "type": "string", "description": "Full mailing address, formatted for display or use on a mailing label. This field may contain multiple lines, separated by newlines.", "example": "Street of Best streets nº8, 3810-88 Aveiro PRT" }, "streetAddress": { "type": "string", "description": "Full street address component, which may include building number, street name, Post Office Box, and multi-line extended street address information. This field may contain multiple lines, separated by newlines.", "example": "Street of Best streets nº8" }, "houseNumber": { "type": "string", "description": "House number component.", "example": "8" }, "locality": { "type": "string", "description": "City or locality component.", "example": "Aveiro" }, "region": { "type": "string", "description": "State, province, prefecture, or region component.", "example": "Beira Litoral" }, "postalCode": { "type": "string", "description": "Zip code or postal code component.", "example": "3810-88" }, "country": { "type": "string", "description": "Country name component (ISO-3166 Alpha 3).", "example": "PRT" } } }, "UserData": { "type": "object", "description": "Dossier user data", "properties": { "firstName": { "type": "string", "description": "The end-user's given name(s).", "example": "John", "maxLength": 64, "minLength": 0 }, "lastName": { "type": "string", "description": "The end-user's surname(s).", "example": "Smith", "maxLength": 64, "minLength": 0 }, "gender": { "type": "string", "description": "The end-user's sex.", "enum": [ "M", "F" ], "example": "M", "pattern": "[FM]" }, "nationality": { "type": "string", "description": "The end-user's nationality (country code in ISO 3166 Alpha 3 format).", "example": "PRT" }, "dateOfBirth": { "type": "string", "description": "The end-user's date of birth (YYYY-MM-DD).", "example": "1988-08-18" }, "personalIdentificationNumber": { "type": "string", "description": "The end-user's national identity number.", "example": "12123456" }, "placeOfBirth": { "type": "string", "description": "The end-user's birth place.", "example": "Aveiro" }, "mobile": { "type": "string", "description": "The end-user's mobile phone number.", "example": "+351939393953" }, "email": { "type": "string", "description": "The end-user's email address.", "example": "enduser@email.com" }, "address": { "$ref": "#/components/schemas/Address" } } }, "UserDataRequest": { "type": "object", "description": "Dossier user data payload", "properties": { "userData": { "$ref": "#/components/schemas/UserData" } } }, "StandardExceptionUnauthorized": { "type": "object", "description": "Standard Exception Unauthorized", "properties": { "instance": { "type": "string", "description": "URI of the endpoint called.", "example": "/assure/dossiers/" }, "method": { "type": "string", "description": "HTTP method associated to the type of request done.", "example": "POST" }, "status": { "type": "integer", "format": "int32", "description": "HTTP status associated with the exception generated.", "example": 401 }, "type": { "type": "string", "description": "Type of the exception generated.", "example": "base:client-problem" }, "title": { "type": "string", "description": "Title of the exception generated.", "example": "The signature of the JWT could not be validated because the key was not found." }, "detail": { "type": "string", "description": "Detailed message containing information of the exception generated.", "example": "The given JWT is signed by a key with key ID 'signing-key-aaaaaaaaaaaaaaaaaaaaaaaaaaa', but no such key was found." }, "traceId": { "type": "string", "description": "TraceID for logging purposes.", "example": "034fb8bbc5da31f4dd2cf66e70ef313c" } } }, "StandardExceptionNotFound": { "type": "object", "description": "Standard Exception Not Found", "properties": { "instance": { "type": "string", "description": "URI of the endpoint called.", "example": "/assure/dossiers/" }, "method": { "type": "string", "description": "HTTP method associated to the type of request done.", "example": "POST" }, "status": { "type": "integer", "format": "int32", "description": "HTTP status associated with the exception generated.", "example": 404 }, "type": { "type": "string", "description": "Type of the exception generated.", "example": "base:client-problem" }, "title": { "type": "string", "description": "Title of the exception generated.", "example": "Not Found" }, "detail": { "type": "string", "description": "Detailed message containing information of the exception generated.", "example": "Dossier not found." }, "traceId": { "type": "string", "description": "TraceID for logging purposes.", "example": "034fb8bbc5da31f4dd2cf66e70ef313c" } } }, "CaptureConfiguration": { "type": "object", "description": "Capture Configuration payload", "properties": { "pageTitle": { "type": "string", "default": "Signicat Capture", "description": "The title to be displayed in the browser tab.
    Maximum length: 60 characters.
    In addition to Capture, this field also affects the Onfido and VideoID SDK.", "example": "This is a title" }, "favicon": { "type": "string", "default": "(signicat icon)", "description": " A custom favicon to be displayed in the browser tab. This must be a valid data-uri or link.
    Allowed data formats: [ \"jpeg\", \"png\", \"ico\"]
    In addition to Capture, this field also affects the Onfido and VideoID SDK.", "example": "data:image/x-icon;base64,/9j/4AAQSkZJRg" }, "fontName": { "type": "string", "description": "The name of the font to be used in the Capture SDK user interface.
    In addition to Capture, this field also affects the VideoID SDK.", "example": "Raleway" }, "fontUrl": { "type": "string", "description": "The URL to the CSS file with the font-face.
    In addition to Capture, this field also affects the VideoID SDK.", "example": "https://fonts.googleapis.com/css?family=Raleway:400,500,600,700&display=swap" }, "primaryColor": { "type": "string", "description": "The HEX or RGB code for the primary color.
    In addition to Capture, this field also affects the Onfido and VideoID SDK. ", "example": "#5AAFFF" }, "fontColor": { "type": "string", "default": "black", "description": "The HEX or RGB code for the general font color.
    In addition to Capture, this field also affects the Onfido and VideoID SDK.", "example": "#000000" }, "buttonsColor": { "type": "string", "description": "The HEX or RGB code for the background color of the buttons. If not set, it will default to primaryColor.
    In addition to Capture, this field also affects the Onfido and VideoID SDK.", "example": "#000000" }, "buttonsHoverColor": { "type": "string", "description": "The HEX or RGB code for the background color of the hover buttons. If not set, it will default to primaryColor.
    In addition to Capture, this field also affects the Onfido and VideoID SDK.", "example": "#000000" }, "buttonsTextColor": { "type": "string", "default": "white", "description": "The HEX or RGB code for the text color on the buttons.
    In addition to Capture, this field also affects the Onfido and VideoID SDK.", "example": "#000000" }, "spinnerColor": { "type": "string", "description": "The HEX or RGB code for the color of the loading spinner. If not set, it will default to primaryColor.
    In addition to Capture, this field also affects the Onfido and VideoID SDK.", "example": "#000000" }, "documentTypes": { "type": "array", "description": "Filters the list of document types that the end-user can choose from. If the field is empty or not defined, all the document types supported by the provider will be displayed.
    In addition to Capture, this field also affects the VideoID SDK.
    This setting will not take effect for signicatvideoid processes if eidConfig > idTypes is also sent.", "example": [ "identityCard", "passport", "driversLicense" ], "items": { "type": "string", "enum": [ "driversLicense", "passport", "identityCard", "residencePermit", "workPermit", "voterId", "postalIdCard", "professionalQualificationCard", "professionalPermit", "socialSecurity", "panCard", "passportCard", "stateId", "visa", "asylumRegistrationCard", "nationalHealthInsuranceCard", "aadharCard", "immigrationStatusDocument", "indigenousCard", "municipalityIdentityCard", "privateOperatorsCard", "certificateOfSponsorship", "serviceIdCard", "taxId" ] } }, "documentCountries": { "type": "object", "additionalProperties": {}, "description": "Filters the list of countries that the end-user can choose from. The value will always be an object with the keys corresponding to `documentTypes`. The value of the keys can be:
    • Empty: If the field is empty or not defined, all the countries supported by the provider will be displayed.
    • `univ` (string): The `univ` value (in lower case) is only available for passports. It displays a list of all the countries in the world. Code example: 
      \"documentCountries\": {\n    \"passport\": \"univ\"\n}
    • Array of country codes (ISO 3166 Alpha 3): This displays only the defined countries. Code example: 
      \"documentCountries\": {\n    \"passport\": [ \"PRT\", \"NOR\" ]\n}
      In this case, the end-user will only see the Portuguese and Norwegian document options.
    • `UNIV` in an array with country codes: The `UNIV` value (upper case) is only available for the ‘signicatpaper’ provider with passport as document type. It will display an additional option for \"Other countries\", so the end-user can choose other countries than the ones that are supported in Signicat Paper's template. Code example: 
      \"documentCountries\": {\n    \"passport\": [ \"PRT\", \"NOR\", \"UNIV\" ]\n}
      In this example, the list of passports will show \"Portuguese\", \"Norwegian\" and \"Other countries\" (3 options). You should be aware of the following when using `UNIV`:
      - Only data from the MRZ area is extracted.
      - Redaction will not be performed.
      - It only works for ICAO compliant passports (that comply with the ICAO9303 rule).
    In addition to Capture, this field also affects the VideoID SDK.
    This setting will not take effect for signicatvideoid processes if eidConfig > idTypes is also sent.", "example": { "passport": [ "NLD", "GBR", "PRT" ], "identityCard": [ "NLD" ] } }, "twoSidedPassports": { "description": "List of countries where also the backside of the passport should be captured.The value can be either an array of country codes (ISO 3166 Alpha 3), or a string `all` (to ask for the backside of all passports) or `null` (to not ask for the backside of any passports).", "example": [ "NLD", "PRT" ] }, "languages": { "type": "array", "default": "en", "description": "List of languages the end-user can choose from (ISO 639-1, two-letter codes). In addition to the standard two-letter country codes, we support the following old country codes for backwards compatibility: [ \"cz\", \"gb\", \"gr\", \"uk\" ].
    For supported languages, see the Translations section in the integration documentation.
    In addition to Capture, this field also affects the VideoID SDK.", "example": [ "nl", "pt", "en" ], "items": { "type": "string" }, "uniqueItems": true }, "translations": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "string" } }, "description": "Custom translations for the Capture SDK. For more details about supported languages and how to create your own translations, see the Translations section in the integration documentation.
    In addition to Capture, this field also affects the VideoID SDK.", "example": { "nl": { "chooseCountry": "Selecteer het uitgifteland van het identiteitsbewijs", "verifyingOrientationHint": "Wordt de tekst op beide foto's horizontaalweergegeven zoals in de voorbeelden?" }, "pt": { "chooseCountry": "Selecione a sua nacionalidade", "verifyingOrientationHint": "O seu documento está na mesma orientação que a ilustração em cima?" } } }, "defaultCountry": { "type": "string", "default": "NOR", "description": "Helps the UI decide which country to select by default when multiple options are available. For example: To pre-select the phone country code in the mobile handover screen or to set the default country (ISO 3166 Alpha 3) in the list of countries of the document selection screen.
    In addition to Capture, this field also affects the VideoID SDK.", "example": "NOR" }, "allowFileUpload": { "type": "array", "default": "[mobile, desktop]", "description": "Enables/disables the file upload option for mobile and desktop.", "example": [ "mobile", "desktop" ], "items": { "type": "string" } }, "allowTakePhoto": { "type": "array", "default": "[mobile, desktop]", "description": "Enables/disables the \"take photo\" option for mobile and desktop.", "example": [ "mobile", "desktop" ], "items": { "type": "string" } }, "allowZoomOnPreview": { "type": "array", "description": "Enables/disables the option to zoom the uploaded image when previewing it for both the \"take photo\" and \"upload photo\" flows.", "example": [ "uploadPhoto", "takePhoto" ], "items": { "type": "string" } }, "useSignicatTheming": { "type": "boolean", "default": false, "description": "Enables/disables the use of Signicat Theming.", "example": true }, "enableMobileHandover": { "type": "boolean", "default": true, "description": "Enables/disables the mobile handover feature.
    In addition to Capture, this field also affects the VideoID SDK.", "example": false }, "enableOrientationConfirmation": { "type": "boolean", "default": false, "description": "Enables/disables the orientation confirmation step at the end of the file upload flow.", "example": false }, "autoCapture": { "type": "boolean", "default": false, "description": "Enables/disables the auto-capture feature on the camera flow. Available for passports only.", "example": false }, "detectGlare": { "description": "Enables/disables glare detection for both the \"take photo\" and \"upload photo\" flows.It can be a boolean or array.", "example": [ "uploadPhoto", "takePhoto" ] }, "customRedactionError": { "type": "boolean", "default": false, "description": "If the redaction failed, it enables/disables a specific error page in the mobile flow. If set to true, it will redirect to the red error page. If there was an error but the redaction went well, it will redirect to the yellow error page.", "example": false }, "takeSelfie": { "type": "boolean", "default": false, "description": "Enables/disables the selfie step at the end of the Capture flow (both camera and file upload). This is required if you want to use both the Onfido documentSelfie and the Capture SDK.", "example": false }, "smsDefaultCountry": { "type": "string", "default": "NOR", "description": "Country prefix (ISO 3166 Alpha 3) to be pre-selected on the mobile handover popup screen for phone number input.
    In addition to Capture, this field also affects the VideoID SDK.", "example": "NOR" }, "maxRetries": { "type": "integer", "format": "int32", "default": 0, "description": "The maximum number of retries after the verification fails (e.g. if the document is not valid or possible to read etc.).
    In addition to Capture, this field also affects the VideoID SDK.", "example": 3 }, "showModalBeforeRedirect": { "type": "boolean", "default": true, "description": "If true, the app shows the success/error modal before redirecting to the redirectUrl. If false, it redirects immediately.", "example": true }, "mobileHandoverTimeout": { "type": "integer", "format": "int32", "default": 0, "description": "Number of minutes before the mobile handover loading page times out and cancels the process.
    In addition to Capture, this field also affects the VideoID SDK.", "example": 3 }, "mobileHandoverModes": { "type": "array", "default": "[ sms, qrCode ]", "description": "A list of mobile handover modes the user can choose from. Supported modes are \"sms\" and \"qrCode\". The first in the list is used as default.
    In addition to Capture, this field also affects the VideoID SDK.", "example": [ "sms", "qrCode" ], "items": { "type": "string" } }, "forceMobileHandover": { "type": "boolean", "default": false, "description": "Forces the end-user to take photos with their mobile device.", "example": true }, "useNativeCamera": { "type": "boolean", "default": false, "description": "Forces the end-user to take photos with the native camera app instead of the browser camera on the mobile.", "example": true }, "customCss": { "type": "string", "description": "Optional.
    The custom CSS to be loaded in the app. The string should contain the CSS code.
    In addition to Capture, this field also affects the VideoID SDK.", "example": "html, body {\\n margin: 0;\\n padding: 0;\\n}\\nbody {\\n background-color: #F7F7F7;\\n font-family: 'Roboto Condensed', sans-serif;\\n color: #4F5B63;\\n background-size: cover;\\n background-repeat: no-repeat;\\n min-height:100vh;\\n}\\n.top {\\n width: 512px;\\n margin: 0 auto;\\n}" }, "onfidoConfig": { "$ref": "#/components/schemas/JsonNode", "description": "Custom configurations for the native Onfido Web SDK. This configuration applies when provider is set to onfido and sdk is set to native in Start capture flow. This object is in JSON format. Accepted elements are the ones listed below plus any field included in the Onfido initialisation object: Onfido Web SDK Reference
    • customHtml Optional.
      Custom HTML code (in the form of a string) to replace the HTML of the app. This should always include an element with the ID \"onfido-mount\" where the Onfido SDK will be mounted.
    • customHeaderLogo Optional.
      An image, provided in a Data URI or link format, indicating the logo image that will be displayed in the top left corner of the page.
    • customBackgroundImage Optional.
      An image provided in a Data URI or link format, indicating the image to be displayed as background under the Onfido SDK.
    • language Optional.
      You can customise the SDK language by passing a string. Available languages are: [en, nb, sv, nl]
    • translations Optional.
      An object where the keys are the language code and have the phrases and mobilePhrases Onfido translations. Refer to the Onfido documentation for instructions on how to find the right keys.
      Code example: 
      \"en\": {\n    \"phrases\": { 'capture.driving_licence.instructions': 'This custom string will appear by default' }\n    \"mobilePhrases\": { 'capture.driving_licence.instructions': 'This custom string will only appear on mobile' }\n}
    • useOnfidoTranslations Optional.
      This field only applies to the Onfido provider when `sdk` is set to `native`. It enables Capture to use Onfido's own translations instead of Signicat's translations. For information about the languages Onfido supports, see Supported Languages.
    ", "example": { "customHtml": "", "customHeaderLogo": "data:image/png;base64,/9j/4AAQSkZJRg", "customBackgroundImage": "data:image/png;base64,/9j/4AAQSkZJRg", "containerId": "onfido-mount", "language": "en", "smsNumberCountryCode": "NL", "steps": [ { "type": "document", "options": { "useLiveDocumentCapture": false, "documentTypes": { "passport": true, "driving_licence": false, "national_identity_card": false } } }, { "type": "face", "options": { "requestedVariant": "${processType}" } }, { "type": "complete", "options": {} } ], "translations": { "locale": "en_US", "phrases": { "welcome": { "title": "", "description_p_1": "", "description_p_2": "", "next_button": "" } } } } }, "signicatvideoidConfig": { "$ref": "#/components/schemas/SignicatVideoIdConfig" }, "signicatpictureidConfig": { "$ref": "#/components/schemas/SignicatPictureIdConfig" }, "showConsentPage": { "type": "boolean", "description": "If true, the app shows the consent page before starting the flow" }, "showAccessibilityLink": { "type": "boolean", "description": "If true, the app shows the accessibility statement link at the bottom of the screen." }, "showDocumentInstructionsScreen": { "type": "boolean", "description": "Enables/disables a screen between the document country picker screen and the take photo or upload photo screen. This screen shows the end-user instructions on how to take or upload a valid photo of an identity document." }, "documentInstructionsScreenItems": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentInstructionScreenItem" } }, "showPrerequisitesScreen": { "type": "boolean", "description": "If enabled, this is the first screen the end-user sees when the capture UI is loaded. It presents tips about what they should have ready before they continue the identification. You can see an example of how this screen looks like in the integration documentation under Translations > Prerequisites screen." }, "prerequisitesScreenItems": { "type": "array", "items": { "$ref": "#/components/schemas/PrerequisiteScreenItem" } }, "showCountryBeforeDocumentType": { "type": "boolean", "description": "If true, the app will show the document country picker before the document type picker." } } }, "DocumentInstructionScreenItem": { "type": "object", "description": "Allows customisation of the instruction elements (images, icons, titles, and descriptions) on the document instructions screen.", "properties": { "image": { "type": "string", "description": "Hyperlink of the image that you want to present in the instruction guide.", "example": "https://www.example.com/image.jpg" }, "icon": { "type": "string", "description": "Instruction icon. Available options can be found in the following link: https://fonts.google.com/icons", "example": "check_circle" }, "title": { "type": "string", "description": "Instruction title.", "example": "Ready" }, "description": { "type": "string", "description": "Instruction description.", "example": "The photo is good!" } } }, "JsonNode": {}, "PrerequisiteScreenItem": { "type": "object", "description": "Allows you to override the default prerequisites items (“Identity document”, “Lightning”, “Internet“, “Camera and microphone“) with your own items. Do not set this field if you want to use the default ones. You can see how the default items look like in the integration documentation under Translations > Prerequisites screen.", "properties": { "icon": { "type": "string", "description": "Instruction icon. Available options can be found in the following link: https://fonts.google.com/icons", "example": "light" }, "title": { "type": "string", "description": "Instruction title.", "example": "lightning" }, "description": { "type": "string", "description": "Instruction description.", "example": "A well lit place!" } } }, "SignicatPictureIdConfig": { "type": "object", "description": "Custom configurations for the Signicat PictureID processes. This configuration applies when provider is set to signicatpictureid in Start capture flow.This object is in JSON format", "example": { "allowedIdTypes": [ 222, 136, 137, 271 ], "allowFileUpload": [ "desktop" ], "allowTakePhoto": [ "mobile", "desktop" ], "defaultCountry": "NLD", "translations": { "en": { "start_title": "NEW TRANSLATION" } } }, "properties": { "defaultCountry": { "type": "string", "default": "null", "description": "Country to be pre-selected on the country selection list. String in ISO 3166 Alpha 3 format (ex: “GBR”, “PRT”)", "example": "GBR" }, "allowFileUpload": { "type": "array", "default": [], "description": "Allows to upload the image of the ID document from the desktop and/or mobile.", "example": [ "mobile", "desktop" ], "items": { "type": "string" } }, "allowTakePhoto": { "type": "array", "default": [ "mobile", "desktop" ], "description": "Allows to capture the image of the ID document from the desktop and/or mobile, using the device camera.", "example": [ "mobile", "desktop" ], "items": { "type": "string" } }, "translations": { "$ref": "#/components/schemas/SignicatPictureIdTranslations", "description": "Allows to override the UI strings with new values." }, "allowedIdTypes": { "type": "array", "default": [], "description": "Allow to filter the list of documents displayed on the document picker list", "example": [ 61, 62, 188 ], "items": { "type": "integer", "format": "int32" } } } }, "SignicatPictureIdTranslations": { "type": "object", "description": "Translations strings, where the key is the language code (e.g., 'en', 'es') and the value is a map of translation keys to strings.", "properties": { "translations": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "SignicatVideoIdConfig": { "type": "object", "description": "Custom configurations for the native Signicat VideoID Web SDK. This configuration applies when provider is set to signicatvideoid and sdk is set to native in Start capture flow. This object is in JSON format", "properties": { "checkRequirements": { "type": "boolean", "description": "Default value is false. Enable this setting to run a network connectivity check before the VideoID starts. This will allow to confirm if the current network speed is high enough to allow for video streaming and will only allow the end-user to continue if minimum requirements are met. Note that other checks, such as browser, camera and microphone, are always done and are not controlled by this setting. Also note that checking the network requirements will take some seconds (depending on the network).", "example": false }, "useModal": { "type": "boolean", "description": "Default value is false. Launches the Signicat VideoID SDK inside a modal / popup instead of full-screen.", "example": false }, "minRequirementsMandatory": { "type": "boolean", "description": "If enabled, the end-user will only be allowed to continue with the VideoID if the minimum requirements are met (camera, microphone, OS, browser and also network if checkRequirements is enabled)", "example": true }, "allowedIdTypes": { "type": "array", "description": "This setting only affects signicatvideoid processes.It will overrule any values that are sent in documentTypes or documentCountries in this configurations.", "example": [ 61, 62, 188 ], "items": { "type": "integer", "format": "int32" } }, "sdkLoadTimeout": { "type": "integer", "format": "int32", "description": "Number of seconds to wait for the VideoID SDK to load. After this time, the process status will be set to `failed`. This is a UX measure to avoid end-users getting stuck waiting (and the process stuck at `pending`) if there are problems with VideoID services.", "example": 8 } } }, "CaptureConfigurationResponse": { "type": "object", "description": "Capture Configuration Response", "properties": { "pageTitle": { "type": "string", "default": "Signicat Capture", "description": "The title to be displayed in the browser tab.
    Maximum length: 60 characters.
    In addition to Capture, this field also affects the Onfido and VideoID SDK.", "example": "This is a title" }, "favicon": { "type": "string", "default": "(signicat icon)", "description": " A custom favicon to be displayed in the browser tab. This must be a valid data-uri or link.
    Allowed data formats: [ \"jpeg\", \"png\", \"ico\"]
    In addition to Capture, this field also affects the Onfido and VideoID SDK.", "example": "data:image/x-icon;base64,/9j/4AAQSkZJRg" }, "fontName": { "type": "string", "description": "The name of the font to be used in the Capture SDK user interface.
    In addition to Capture, this field also affects the VideoID SDK.", "example": "Raleway" }, "fontUrl": { "type": "string", "description": "The URL to the CSS file with the font-face.
    In addition to Capture, this field also affects the VideoID SDK.", "example": "https://fonts.googleapis.com/css?family=Raleway:400,500,600,700&display=swap" }, "primaryColor": { "type": "string", "description": "The HEX or RGB code for the primary color.
    In addition to Capture, this field also affects the Onfido and VideoID SDK. ", "example": "#5AAFFF" }, "fontColor": { "type": "string", "default": "black", "description": "The HEX or RGB code for the general font color.
    In addition to Capture, this field also affects the Onfido and VideoID SDK.", "example": "#000000" }, "buttonsColor": { "type": "string", "description": "The HEX or RGB code for the background color of the buttons. If not set, it will default to primaryColor.
    In addition to Capture, this field also affects the Onfido and VideoID SDK.", "example": "#000000" }, "buttonsHoverColor": { "type": "string", "description": "The HEX or RGB code for the background color of the hover buttons. If not set, it will default to primaryColor.
    In addition to Capture, this field also affects the Onfido and VideoID SDK.", "example": "#000000" }, "buttonsTextColor": { "type": "string", "default": "white", "description": "The HEX or RGB code for the text color on the buttons.
    In addition to Capture, this field also affects the Onfido and VideoID SDK.", "example": "#000000" }, "spinnerColor": { "type": "string", "description": "The HEX or RGB code for the color of the loading spinner. If not set, it will default to primaryColor.
    In addition to Capture, this field also affects the Onfido and VideoID SDK.", "example": "#000000" }, "documentTypes": { "type": "array", "description": "Filters the list of document types that the end-user can choose from. If the field is empty or not defined, all the document types supported by the provider will be displayed.
    In addition to Capture, this field also affects the VideoID SDK.
    This setting will not take effect for signicatvideoid processes if eidConfig > idTypes is also sent.", "example": [ "identityCard", "passport", "driversLicense" ], "items": { "type": "string", "enum": [ "driversLicense", "passport", "identityCard", "residencePermit", "workPermit", "voterId", "postalIdCard", "professionalQualificationCard", "professionalPermit", "socialSecurity", "panCard", "passportCard", "stateId", "visa", "asylumRegistrationCard", "nationalHealthInsuranceCard", "aadharCard", "immigrationStatusDocument", "indigenousCard", "municipalityIdentityCard", "privateOperatorsCard", "certificateOfSponsorship", "serviceIdCard", "taxId" ] } }, "documentCountries": { "type": "object", "additionalProperties": {}, "description": "Filters the list of countries that the end-user can choose from. The value will always be an object with the keys corresponding to `documentTypes`. The value of the keys can be:
    • Empty: If the field is empty or not defined, all the countries supported by the provider will be displayed.
    • `univ` (string): The `univ` value (in lower case) is only available for passports. It displays a list of all the countries in the world. Code example: 
      \"documentCountries\": {\n    \"passport\": \"univ\"\n}
    • Array of country codes (ISO 3166 Alpha 3): This displays only the defined countries. Code example: 
      \"documentCountries\": {\n    \"passport\": [ \"PRT\", \"NOR\" ]\n}
      In this case, the end-user will only see the Portuguese and Norwegian document options.
    • `UNIV` in an array with country codes: The `UNIV` value (upper case) is only available for the ‘signicatpaper’ provider with passport as document type. It will display an additional option for \"Other countries\", so the end-user can choose other countries than the ones that are supported in Signicat Paper's template. Code example: 
      \"documentCountries\": {\n    \"passport\": [ \"PRT\", \"NOR\", \"UNIV\" ]\n}
      In this example, the list of passports will show \"Portuguese\", \"Norwegian\" and \"Other countries\" (3 options). You should be aware of the following when using `UNIV`:
      - Only data from the MRZ area is extracted.
      - Redaction will not be performed.
      - It only works for ICAO compliant passports (that comply with the ICAO9303 rule).
    In addition to Capture, this field also affects the VideoID SDK.
    This setting will not take effect for signicatvideoid processes if eidConfig > idTypes is also sent.", "example": { "passport": [ "NLD", "GBR", "PRT" ], "identityCard": [ "NLD" ] } }, "twoSidedPassports": { "description": "List of countries where also the backside of the passport should be captured.The value can be either an array of country codes (ISO 3166 Alpha 3), or a string `all` (to ask for the backside of all passports) or `null` (to not ask for the backside of any passports).", "example": [ "NLD", "PRT" ] }, "languages": { "type": "array", "default": "en", "description": "List of languages the end-user can choose from (ISO 639-1, two-letter codes). In addition to the standard two-letter country codes, we support the following old country codes for backwards compatibility: [ \"cz\", \"gb\", \"gr\", \"uk\" ].
    For supported languages, see the Translations section in the integration documentation.
    In addition to Capture, this field also affects the VideoID SDK.", "example": [ "nl", "pt", "en" ], "items": { "type": "string" }, "uniqueItems": true }, "translations": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "string" } }, "description": "Custom translations for the Capture SDK. For more details about supported languages and how to create your own translations, see the Translations section in the integration documentation.
    In addition to Capture, this field also affects the VideoID SDK.", "example": { "nl": { "chooseCountry": "Selecteer het uitgifteland van het identiteitsbewijs", "verifyingOrientationHint": "Wordt de tekst op beide foto's horizontaalweergegeven zoals in de voorbeelden?" }, "pt": { "chooseCountry": "Selecione a sua nacionalidade", "verifyingOrientationHint": "O seu documento está na mesma orientação que a ilustração em cima?" } } }, "defaultCountry": { "type": "string", "default": "NOR", "description": "Helps the UI decide which country to select by default when multiple options are available. For example: To pre-select the phone country code in the mobile handover screen or to set the default country (ISO 3166 Alpha 3) in the list of countries of the document selection screen.
    In addition to Capture, this field also affects the VideoID SDK.", "example": "NOR" }, "allowFileUpload": { "type": "array", "default": "[mobile, desktop]", "description": "Enables/disables the file upload option for mobile and desktop.", "example": [ "mobile", "desktop" ], "items": { "type": "string" } }, "allowTakePhoto": { "type": "array", "default": "[mobile, desktop]", "description": "Enables/disables the \"take photo\" option for mobile and desktop.", "example": [ "mobile", "desktop" ], "items": { "type": "string" } }, "allowZoomOnPreview": { "type": "array", "description": "Enables/disables the option to zoom the uploaded image when previewing it for both the \"take photo\" and \"upload photo\" flows.", "example": [ "uploadPhoto", "takePhoto" ], "items": { "type": "string" } }, "useSignicatTheming": { "type": "boolean", "default": false, "description": "Enables/disables the use of Signicat Theming.", "example": true }, "enableMobileHandover": { "type": "boolean", "default": true, "description": "Enables/disables the mobile handover feature.
    In addition to Capture, this field also affects the VideoID SDK.", "example": false }, "enableOrientationConfirmation": { "type": "boolean", "default": false, "description": "Enables/disables the orientation confirmation step at the end of the file upload flow.", "example": false }, "autoCapture": { "type": "boolean", "default": false, "description": "Enables/disables the auto-capture feature on the camera flow. Available for passports only.", "example": false }, "detectGlare": { "description": "Enables/disables glare detection for both the \"take photo\" and \"upload photo\" flows.It can be a boolean or array.", "example": [ "uploadPhoto", "takePhoto" ] }, "customRedactionError": { "type": "boolean", "default": false, "description": "If the redaction failed, it enables/disables a specific error page in the mobile flow. If set to true, it will redirect to the red error page. If there was an error but the redaction went well, it will redirect to the yellow error page.", "example": false }, "takeSelfie": { "type": "boolean", "default": false, "description": "Enables/disables the selfie step at the end of the Capture flow (both camera and file upload). This is required if you want to use both the Onfido documentSelfie and the Capture SDK.", "example": false }, "smsDefaultCountry": { "type": "string", "default": "NOR", "description": "Country prefix (ISO 3166 Alpha 3) to be pre-selected on the mobile handover popup screen for phone number input.
    In addition to Capture, this field also affects the VideoID SDK.", "example": "NOR" }, "maxRetries": { "type": "integer", "format": "int32", "default": 0, "description": "The maximum number of retries after the verification fails (e.g. if the document is not valid or possible to read etc.).
    In addition to Capture, this field also affects the VideoID SDK.", "example": 3 }, "showModalBeforeRedirect": { "type": "boolean", "default": true, "description": "If true, the app shows the success/error modal before redirecting to the redirectUrl. If false, it redirects immediately.", "example": true }, "mobileHandoverTimeout": { "type": "integer", "format": "int32", "default": 0, "description": "Number of minutes before the mobile handover loading page times out and cancels the process.
    In addition to Capture, this field also affects the VideoID SDK.", "example": 3 }, "mobileHandoverModes": { "type": "array", "default": "[ sms, qrCode ]", "description": "A list of mobile handover modes the user can choose from. Supported modes are \"sms\" and \"qrCode\". The first in the list is used as default.
    In addition to Capture, this field also affects the VideoID SDK.", "example": [ "sms", "qrCode" ], "items": { "type": "string" } }, "forceMobileHandover": { "type": "boolean", "default": false, "description": "Forces the end-user to take photos with their mobile device.", "example": true }, "useNativeCamera": { "type": "boolean", "default": false, "description": "Forces the end-user to take photos with the native camera app instead of the browser camera on the mobile.", "example": true }, "customCss": { "type": "string", "description": "Optional.
    The custom CSS to be loaded in the app. The string should contain the CSS code.
    In addition to Capture, this field also affects the VideoID SDK.", "example": "html, body {\\n margin: 0;\\n padding: 0;\\n}\\nbody {\\n background-color: #F7F7F7;\\n font-family: 'Roboto Condensed', sans-serif;\\n color: #4F5B63;\\n background-size: cover;\\n background-repeat: no-repeat;\\n min-height:100vh;\\n}\\n.top {\\n width: 512px;\\n margin: 0 auto;\\n}" }, "onfidoConfig": { "$ref": "#/components/schemas/JsonNode", "description": "Custom configurations for the native Onfido Web SDK. This configuration applies when provider is set to onfido and sdk is set to native in Start capture flow. This object is in JSON format. Accepted elements are the ones listed below plus any field included in the Onfido initialisation object: Onfido Web SDK Reference
    • customHtml Optional.
      Custom HTML code (in the form of a string) to replace the HTML of the app. This should always include an element with the ID \"onfido-mount\" where the Onfido SDK will be mounted.
    • customHeaderLogo Optional.
      An image, provided in a Data URI or link format, indicating the logo image that will be displayed in the top left corner of the page.
    • customBackgroundImage Optional.
      An image provided in a Data URI or link format, indicating the image to be displayed as background under the Onfido SDK.
    • language Optional.
      You can customise the SDK language by passing a string. Available languages are: [en, nb, sv, nl]
    • translations Optional.
      An object where the keys are the language code and have the phrases and mobilePhrases Onfido translations. Refer to the Onfido documentation for instructions on how to find the right keys.
      Code example: 
      \"en\": {\n    \"phrases\": { 'capture.driving_licence.instructions': 'This custom string will appear by default' }\n    \"mobilePhrases\": { 'capture.driving_licence.instructions': 'This custom string will only appear on mobile' }\n}
    • useOnfidoTranslations Optional.
      This field only applies to the Onfido provider when `sdk` is set to `native`. It enables Capture to use Onfido's own translations instead of Signicat's translations. For information about the languages Onfido supports, see Supported Languages.
    ", "example": { "customHtml": "", "customHeaderLogo": "data:image/png;base64,/9j/4AAQSkZJRg", "customBackgroundImage": "data:image/png;base64,/9j/4AAQSkZJRg", "containerId": "onfido-mount", "language": "en", "smsNumberCountryCode": "NL", "steps": [ { "type": "document", "options": { "useLiveDocumentCapture": false, "documentTypes": { "passport": true, "driving_licence": false, "national_identity_card": false } } }, { "type": "face", "options": { "requestedVariant": "${processType}" } }, { "type": "complete", "options": {} } ], "translations": { "locale": "en_US", "phrases": { "welcome": { "title": "", "description_p_1": "", "description_p_2": "", "next_button": "" } } } } }, "signicatvideoidConfig": { "$ref": "#/components/schemas/SignicatVideoIdConfig" }, "signicatpictureidConfig": { "$ref": "#/components/schemas/SignicatPictureIdConfig" }, "showConsentPage": { "type": "boolean", "description": "If true, the app shows the consent page before starting the flow" }, "showAccessibilityLink": { "type": "boolean", "description": "If true, the app shows the accessibility statement link at the bottom of the screen." }, "showDocumentInstructionsScreen": { "type": "boolean", "description": "Enables/disables a screen between the document country picker screen and the take photo or upload photo screen. This screen shows the end-user instructions on how to take or upload a valid photo of an identity document." }, "documentInstructionsScreenItems": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentInstructionScreenItem" } }, "showPrerequisitesScreen": { "type": "boolean", "description": "If enabled, this is the first screen the end-user sees when the capture UI is loaded. It presents tips about what they should have ready before they continue the identification. You can see an example of how this screen looks like in the integration documentation under Translations > Prerequisites screen." }, "prerequisitesScreenItems": { "type": "array", "items": { "$ref": "#/components/schemas/PrerequisiteScreenItem" } }, "showCountryBeforeDocumentType": { "type": "boolean", "description": "If true, the app will show the document country picker before the document type picker." }, "id": { "type": "string", "description": "The ID of a capture configuration.", "example": "Configuration1", "maxLength": 100 }, "createdAt": { "type": "string", "description": "The date and time the data was created (ISO-8601 with UTC: YYYY-MM-DDThh:mm:ssZ.)", "example": "2022-01-01T09:00:00Z" }, "updatedAt": { "type": "string", "description": "The date and time the data was updated (ISO-8601 with UTC: YYYY-MM-DDThh:mm:ssZ).", "example": "2022-01-01T10:30:00Z" } } }, "Watermark": { "type": "object", "properties": { "title": { "type": "string", "description": "Who asked for the image.", "example": "MyCompany" }, "description": { "type": "string", "description": "Why the image was requested.", "example": "Loan" }, "date": { "type": "string", "description": "Date of request (YYYY-MM-DD). ", "example": "2024-01-10" } }, "required": [ "date", "description", "title" ] }, "WatermarkAssureRequest": { "type": "object", "description": "Watermark Assure Request", "properties": { "image": { "type": "string", "description": "Image to be watermarked.
    Must be in dataURL format (Example: `data:image/png;base64,iVBORw....`)
    The following formats are supported: png, jpg
    Minimum image size allowed is 250x120 pixels.
    Maximum size allowed is:
    • 4MB
    • 5000px
    Note: Recommended maximum size is 1080px.", "example": "data:image/png;base64,iVBORw..." }, "dossierId": { "type": "string", "description": "Apply a watermark on the image from this dossier.", "example": "37191afe-25b3-4c30-b42a-b0ab64aa1d64" }, "processId": { "type": "string", "description": "Apply a watermark on the image from this process.", "example": "8afb3ac6-6780-42e4-bbc2-3713e2f6d97c" }, "imageDepiction": { "type": "string", "description": "The type of image to be retrieved from the process.
    The portrait value is only available for the 'signicatvideoid' and 'readid' providers.", "enum": [ "selfie", "front" ], "example": "selfie" }, "watermark": { "$ref": "#/components/schemas/Watermark", "description": "Watermark object to be applied to the image." } }, "required": [ "watermark" ] }, "RedactionAssureRequest": { "type": "object", "description": "Redaction Assure Request", "properties": { "front": { "type": "string", "description": "Front image to be redacted.
    Must be in dataURL format (Example: `data:image/png;base64,iVBORw....`)", "example": "data:image/png;base64,iVBORw..." }, "back": { "type": "string", "description": "Back image to be redacted.
    Must be in dataURL format (Example: `data:image/png;base64,iVBORw....`)", "example": "data:image/png;base64,iVBORw..." }, "dossierId": { "type": "string", "description": "Redact the image from this dossier", "example": "37191afe-25b3-4c30-b42a-b0ab64aa1d64" }, "processId": { "type": "string", "description": "Redact the image from this process", "example": "8afb3ac6-6780-42e4-bbc2-3713e2f6d97c" }, "documentType": { "type": "string", "description": "Type of the document to be redacted.", "enum": [ "passport", "identityCard", "driversLicense", "residencePermit" ] }, "documentCountry": { "type": "string", "description": "Country of the document to be redacted (ISO 3166 Alpha 3).", "enum": [ "NLD" ] }, "fieldsToRedact": { "type": "array", "description": "It indicates which field(s) should be redacted from the ID images.", "enum": [ "personalIdentificationNumber", "photo" ], "example": [ "personalIdentificationNumber", "photo" ], "items": { "type": "string" } }, "redactionLevel": { "type": "string", "description": "This is the size of the bounding box for the redaction functionality. 'standard' (smallest) is default.", "enum": [ "standard", "medium", "high", "veryHigh" ] } }, "required": [ "documentCountry", "documentType", "fieldsToRedact" ] }, "RedactionResponse": { "type": "object", "properties": { "success": { "type": "boolean", "description": "'true' if redaction was successful, 'false' otherwise.", "example": true }, "redactedFrontImage": { "type": "string", "description": "Redacted front image in dataURL format", "example": "data:image/png;base64,iVBORw...." }, "redactedBackImage": { "type": "string", "description": "Redacted back image in dataURL format", "example": "data:image/png;base64,iVBORw...." }, "detail": { "type": "string", "description": "Detail on the outcome of the redaction process", "example": "Please check the image has enough quality and that the document provided is from the list of supported documents." } } }, "DossierRequest": { "type": "object", "description": "Create dossier payload", "properties": { "externalReference": { "type": "string", "description": "Customer specific reference to be associated with an ID of a dossier.", "example": "someReferenceExample" } } }, "Dossier": { "type": "object", "description": "Dossiers are objects that contain end-user identity data, e.g. name, date of birth, ID document, etc. They also contain any processes that are created to verify that end-user’s identity.", "properties": { "dossierId": { "type": "string", "description": "This ID is obtained from the \"Create dossier\" response body.", "example": "710a4326-ef7f-4bed-85c4-aa523f742742" }, "externalReference": { "type": "string", "description": "Customer specific reference to be associated with an ID of a dossier.", "example": "someReferenceExample" }, "createdAt": { "type": "string", "description": "The date and time the dossier was created (ISO-8601 with UTC: YYYY-MM-DDThh:mm:ssZ).", "example": "2022-01-01T09:00:00Z" }, "updatedAt": { "type": "string", "description": "The date and time the dossier was updated (ISO-8601 with UTC: YYYY-MM-DDThh:mm:ssZ).", "example": "2022-01-01T10:30:00Z" } } }, "Consents": { "type": "object", "properties": { "privacy": { "type": "boolean", "description": "This field is used only if `processType` is `documentSelfie` or `documentVideo` and is only required if the end-user is located in the USA or unknown location.

    Indicates if the end-user has read and agreed to Onfido’s Privacy Notices and Consent. If the end-user does not agree, Start Verification will fail.", "example": true } } }, "Location": { "type": "object", "properties": { "ipAddress": { "type": "string", "description": "The end-user’s IP address.", "example": "185.91.65.70" }, "countryOfResidence": { "type": "string", "description": "The country where the end-user lives (in ISO 3166 Alpha 3 format. ex: “USA”, “NOR”, “GBR”).\nIf this field is not provided, it will be inferred from the IP address, which may result in an incorrect value.", "example": "USA" } } }, "ProcessParameters": { "type": "object", "description": "Provider specific process parameters", "properties": { "referrer": { "type": "string", "description": "This field is required for 'onfido' processes where the images are uploaded via JS (Web) SDK.
    This is the URL of the web page where the Web SDK will be used.", "example": "https://*.client-server.com/*" }, "mobileAppId": { "type": "string", "description": "This field is required for 'onfido' processes where the images are uploaded via iOS/Android (mobile) SDK.
    This is a unique ID of the mobile app that will integrate with the provider's iOS/Android SDK. This is either a bundle ID for iOS or application ID for Android. ", "example": "com.example.mymobileapp" }, "location": { "$ref": "#/components/schemas/Location", "description": "This field is required for `onfido` processes where the images are uploaded via the Set Images endpoint.

    The end-user’s location." }, "consents": { "$ref": "#/components/schemas/Consents", "description": "This field is used only for `onfido` processes where the images will be uploaded using the Set Images endpoint." }, "requestExtraDataFromDrivingLicense": { "type": "boolean", "default": false, "description": "(Warning: This is a Beta feature. Please contact your account manager for details.) This field is available only for \"onfido\" processes and for specific Driving License documents. If enabled, the process result will contain more information extracted from the Driving License (ex: license category and vehicle classes). ", "example": false }, "webid": { "$ref": "#/components/schemas/WebIDParameters", "description": "This object only applies to the 'webid' provider and is required.
    The information in this field must be provided at the creation of the process. It will be compared with the user information gathered during the process." } } }, "ProcessRequest": { "type": "object", "description": "Create process payload", "properties": { "provider": { "type": "string", "description": "The provider that performs the identity document verification. This field is always required for all the providers (see `Enum` above).

    For more information about supported eIDV methods from Signicat, see the overview of eIDVs in the general documentation. ", "enum": [ "onfido", "readid", "signicatpaper", "facetec", "webid", "signicatpictureid", "signicatvideoid", "connect:idmethod" ], "example": "signicatvideoid" }, "processType": { "type": "string", "description": "This field only applies to the 'signicatvideoid', 'onfido' or 'readid' provider.

    The available values are:
    • For 'signicatvideoid':
      • `high` (default): A human agent will review the process. This is done asynchronously.
      • `substantial`: Process verification is done automatically, meaning no human agent is involved.
      • `substantialFullyAuto`: Similar to `substantial` but without any `inconclusive` status. It will automatically reach an `accepted` or `rejected` status. For more information about what each status means, see the Get process page in the integration guide.
    • For 'onfido'
      • `document`: The verification is only done on the provided identity document.
      • `documentSelfie` (default): The verification is done on the identity document and the photo of the end-user. The photo allows assessing whether the holder of the identity document is the same person as the one in the ID document (facial similarity). The photo must be taken at the time of the request.
      • `documentVideo`: The verification is done on the identity document and also a video-call while the end-user does some requested actions (e.g. “Look over your left shoulder”). The video allows assessing whether the holder of the identity document is the same person as the one on the video-call(facial similarity). It also detects liveness information.
    • For 'readid'
      • `sdk` (default)
      • `ready`
    • For 'webid'
      • `videoid`: The end-user is identified by a support agent in a live video call.
      • `accountid`: The end-user identifies themselves by capturing their ID and selfie.
    • For 'signicatpictureid'
      • `document`: The verification is only done on the provided identity document.
      • `documentSelfie` (default): The verification is done on the identity document and the photo of the end-user. The photo allows assessing whether the holder of the identity document is the same person as the one in the ID document (facial similarity). The photo must be taken at the time of the request.
    ", "enum": [ "substantial", "substantialFullyAuto", "high", "document", "documentSelfie", "documentVideo", "sdk", "ready", "accountid", "videoid" ] }, "documentType": { "type": "string", "description": "This field only applies to the 'onfido' or 'signicatpaper' provider.
    It is required when images are uploaded via the Assure API (not via the SDK).
    This field defines the document type used in the verification.
    To check the available values, use the \"Get Document Types\" service.", "enum": [ "driversLicense", "passport", "identityCard", "residencePermit", "workPermit", "voterId", "postalIdCard", "professionalQualificationCard", "professionalPermit", "socialSecurity", "panCard", "passportCard", "stateId", "visa", "asylumRegistrationCard", "nationalHealthInsuranceCard", "aadharCard", "immigrationStatusDocument", "indigenousCard", "municipalityIdentityCard", "privateOperatorsCard", "certificateOfSponsorship", "serviceIdCard", "taxId" ] }, "processParameters": { "$ref": "#/components/schemas/ProcessParameters" }, "documentCountry": { "type": "string", "description": "This field only applies to the 'signicatpaper' provider and is then a required field.
    It represents the country of the document that will be used in the verification (ISO 3166-1 Alpha 2), e.g. `NL`.

    For passports only, it is also possible to use the `UNIV` value. This allows any ICAO compliant passport to be used in the verification. However, in this case, Signicat Paper will only extract information from the MRZ area. This is useful, for example, if you want information from a passport that is not supported by Signicat Paper and you only need information that is in the MRZ area. For a full list of documents supported by Signicat, see the Get document types endpoint.
    Note: If you use the `UNIV` value, redaction will not be performed.", "example": "PRT" }, "redact": { "type": "array", "description": "This field can only be used when the provider is 'signicatpaper')
    It indicates which field(s) should be redacted from the ID images.
    This will affect the 'front' and 'back' images you are able to get from the process If you request redaction, you will only be able to get those images if they were successfully redacted (i.e., if 'isFullRedaction':'true' in the Get Process response).", "enum": [ "firstName", "lastName", "fullName", "gender", "address", "personalIdentificationNumber", "documentNumber", "date", "dateOfBirth", "dateOfIssue", "dateOfExpiry", "photo", "signature", "accessNumber", "drivingPermits", "issuingAuthority", "mrz", "barcode" ], "items": { "type": "string" } }, "redactionLevel": { "type": "string", "description": "This field can only be used when the provider is 'signicatpaper'.
    This is the size of the bounding box for the redaction functionality. 'standard' (smallest) is default.", "enum": [ "standard", "medium", "high", "veryHigh" ] }, "eventTags": { "type": "array", "description": "List of tags to be used on events API", "example": [ "customerId" ], "items": { "type": "string" } }, "documentId": { "type": "integer", "format": "int32", "description": "Required for provider 'signicatpictureid'. Unique id for the document that will be used to identify the end-user. Get the full list of possible id document from Get Document Types.", "example": 58 } }, "required": [ "provider" ] }, "WebIDAddress": { "type": "object", "properties": { "street": { "type": "string", "description": "Available only if addressLine1 and addressLine2 are empty." }, "streetNumber": { "type": "string", "description": "Available only if addressLine1 and addressLine2 are empty." }, "addressLine1": { "type": "string", "description": "For example, street number and street, or post box or rural route. Available only if street and streetNumber are empty." }, "addressLine2": { "type": "string", "description": "Available only if street and streetNumber are empty." }, "region": { "type": "string", "description": "For example, state, district, province or any local region." }, "zip": { "type": "string", "description": "Zip code." }, "city": { "type": "string", "description": "City." }, "country": { "type": "string", "description": "Country name component (ISO-3166 Alpha 3)." } } }, "WebIDContact": { "type": "object", "description": "WebID contact", "properties": { "email": { "type": "string", "description": "The end-user's email address." }, "cell": { "type": "string", "writeOnly": true }, "mobile": { "type": "string", "description": "The end-user's mobile phone number. Required for `accountid` processes only (not `videoid`)." }, "phone": { "type": "string", "description": "The end-user's home phone number" } }, "required": [ "email" ] }, "WebIDFile": { "type": "object", "properties": { "fileName": { "type": "string", "description": "File name with extension. Extension must be \"pdf\". Slashes ('/') are not allowed in this field." }, "fileContent": { "type": "string", "description": "File content as base64 string." } } }, "WebIDIdDocument": { "type": "object", "description": "Data about the physical ID document. Required for `accountid` processes only (not `videoid`).", "properties": { "authority": { "type": "string", "description": "Name of the authority that issued the ID document. Might be empty." }, "dateOfExpiry": { "type": "string", "description": "ID document's expiry date (YYYY-MM-DD)." }, "dateOfIssue": { "type": "string", "description": "Date when the ID document was issued. No time zone. Might be empty." }, "documentType": { "type": "string", "description": "Type (or name) of the ID document, for example, passport. Only specified values are supported. Other values will be ignored." }, "idNumber": { "type": "string", "description": "The end-user's national identity number." }, "mrz": { "type": "string", "description": "Value of the \"Machine Readable Zone\" in the ID document. Cannot include line breaks or special characters for multi-line variants. Might be empty." }, "nameAtBirth": { "type": "string", "description": "Maiden name as specified in the ID document." }, "nationality": { "type": "string", "description": "The end-user's nationality (country code in ISO 3166 Alpha 3 format). Required for `accountid` processes only (not `videoid`)." }, "placeOfBirth": { "type": "string", "description": "The end-user's birth place." } }, "required": [ "nationality" ] }, "WebIDParameters": { "type": "object", "properties": { "preferredLanguage": { "type": "string", "description": "Your preferred language as a two-letter ISO-3166-1 Alpha-2 code (optional). If specified, this will be used for web pages, emails, etc. directed to the user. Supported language codes are en, de, fr, it. Other values will be mapped to one of these.", "example": "en" }, "user": { "$ref": "#/components/schemas/WebIDUser", "description": "Data about the end-user. Usually, entered by the end-user into your system." }, "idDocument": { "$ref": "#/components/schemas/WebIDIdDocument" }, "userActionParameters": { "$ref": "#/components/schemas/WebIDUserActionParameters", "writeOnly": true }, "hasProvidedConsent": { "type": "boolean", "description": "If the user has already accepted the terms and conditions. Default is 'false'." }, "file": { "$ref": "#/components/schemas/WebIDFile", "description": "PDF file which must correspond to the PDF/A standard (PDF/A 1.3b recommended). Documents on QES processes are intended to be digitally signed by a user throughout the process." } }, "required": [ "idDocument", "user", "userActionParameters" ] }, "WebIDUser": { "type": "object", "properties": { "title": { "type": "string", "description": "Academic title of the user. Will be synchronised with the corresponding field in the ID document." }, "gender": { "type": "string", "description": "The end user's gender.", "enum": [ "M", "F" ], "example": "M", "pattern": "[FM]" }, "firstName": { "type": "string", "description": "The end-user's given name(s).", "example": "John" }, "lastName": { "type": "string", "description": "The end-user's surname(s).", "example": "Smith" }, "dateOfBirth": { "type": "string", "description": "The end-user's date of birth (YYYY-MM-DD).", "example": "2000-12-29" }, "address": { "$ref": "#/components/schemas/WebIDAddress", "description": "Residence or postal address, according to the ID document. Either street or addressLine1 is required. Street and streetNumber may be used to infer the required part of the address. For international addresses, addressLine1 and addressLine2 may be used to infer the required part of the address." }, "contact": { "$ref": "#/components/schemas/WebIDContact" } }, "required": [ "contact", "dateOfBirth", "firstName", "lastName" ] }, "WebIDUserActionParameters": { "type": "object", "description": "Parameters the WebID service needs for the end-user flow.", "properties": { "redirectUrl": { "type": "string", "description": "URL to redirect the user after a successful identification (or signature) (only in web browsers). " }, "redirectDeclineUrl": { "type": "string", "description": "URL to redirect the user after an unsuccessful identification (only in web browsers). " }, "redirectMismatchUrl": { "type": "string", "description": "URL to redirect the user after a successful identification, even if the user data has changed during the identification (only in web browsers). " }, "redirectSkipQesUrl": { "type": "string", "description": "URL to redirect the user when they click the Cancel button on the contract signing page." }, "redirectCancelUrl": { "type": "string", "description": "URL to redirect the user when they manually cancel the identification process." }, "redirectTime": { "type": "integer", "format": "int32", "description": "(When testing in sandbox, this needs to be > 0 https://developer.signicat.com/docs/id-document-and-biometric-verification/provider-specific-integrations/webid/#test-webid) Time in seconds to delay redirect to one of the redirect URLs. If this is 0, users will be redirected directly to those URLs. Otherwise, a success page will be shown after successful identification and redirect occurs after the specified delay. " }, "clientName": { "type": "string", "description": "Name of client or brand customer if the user-action is attributed to a sub-customer. May be shown to a support agent." }, "productType": { "type": "string", "description": "The product type shown to the support agent to help detect fraud. The value should only be one single product type or category, and it should be either in German or English. Examples: \"Account Opening\", \"Loan Application\", \"Credit Card\", \"Financing\", \"SIM Card Activation\", \"Age Verification\", \"Contract\"." } }, "required": [ "clientName", "productType", "redirectCancelUrl", "redirectDeclineUrl", "redirectMismatchUrl", "redirectUrl" ] }, "ProcessResponse": { "type": "object", "description": "Process response", "properties": { "processId": { "type": "string", "description": "processId is obtained from the \"Create process\" response body.", "example": "8afb3ac6-6780-42e4-bbc2-3713e2f6d97c" }, "provider": { "type": "string", "description": "The ID of one of the supported providers.
    ", "example": "signicatvideoid" }, "processType": { "type": "string", "description": "The process type created from the provider.", "example": "document" }, "status": { "type": "string", "description": "The current status of the the identity document verification process. For more information about what each status means, see the Get process page in the integration documentation.", "enum": [ "pending", "processing", "accepted", "rejected", "canceled", "failed", "inconclusive" ], "example": "pending" }, "authorization": { "type": "string", "description": "The authorization token that is necessary for uploading images using the provider's SDK. This is not necessary if the images are uploaded directly through the API, using the Set Images service.", "example": "eyJhbGciOiJJ9.eyJwYXlsb2FYVjRGVhZU252alVsekNHaUMzR9.uW-2dEu_rYUyhF_E" }, "providerApiUrl": { "type": "string", "description": "This field only applies to the 'signicatvideoid' or 'readid' provider.

    For signicatvideoid:
    This is the URL for Signicat Video ID's API. Use this URL to load Signicat Video ID's SDK in your native/web apps.
    In native apps, just use this URL directly to load the iOS/Android SDK.
    In web apps you must load the JS SDK by adding the following to the URL:
    • For default \"processType\":\"high\", for \"processType\":\"substantial\" and for \"processType\":\"substantialFullyAuto\", you must append \"/js/videoid.js\". Example: \"https://etrust-sandbox.electronicid.eu/v2/js/videoid.js\"
    For 'readid':
    This is the URL for ReadID's API. Use this URL in the SDK configuration." }, "base64QRCode": { "type": "string", "description": "This field only applies to the 'readid' provider with `processType` set to `ready`.This QR code is presented to the end-user (instead of `universalLink`) when they are on desktop. Scanning this QR code, redirects the end-user to the ReadID Ready app." }, "universalLink": { "type": "string", "description": "This field only applies to the 'readid' provider with `processType` set to `ready`. This link is presented to the end-user (instead of `base64QRCode`) when they are using a mobile device. You must append a callback query parameter to the universal link, like in this example: `universallink&callback=//redirectuserhere.com`Selecting this link, redirects the end-user to the ReadID Ready app. After the ReadID Ready identification process is completed, the end-user is redirected to the link provided as the callback parameter." }, "facetecDeviceKeyIdentifier": { "type": "string", "description": "This field only applies to the 'facetec' provider.
    This is the token that the SDKs (Android, iOS, javascript) need to authenticate with the FaceTec server.", "example": "eyJwYXlsb2FYVjRGVhZU252alVsekNHaUMzR9" }, "facetecEncryptionPublicKey": { "type": "string", "description": "This field only applies to the 'facetec' provider.
    This is the public Key of the FaceTec server that the SDKs (Android, iOS, javascript) need." }, "facetecMobileSdkProductionKey": { "type": "string", "description": "This field only applies to the 'facetec' provider.
    Textual key that the apps need to be able to start in production mode." }, "createdAt": { "type": "string", "description": "The date and time the process was created (ISO-8601 with UTC: YYYY-MM-DDThh:mm:ssZ).", "example": "2022-01-01T09:00:00Z" }, "updatedAt": { "type": "string", "description": "The date and time the process was updated (ISO-8601 with UTC: YYYY-MM-DDThh:mm:ssZ).", "example": "2022-01-01T10:30:00Z" }, "documentPages": { "type": "integer", "format": "int32", "description": "This field only applies to the 'signicatpictureid' provider.
    This returns an integer between 1 or 2. It's intended to know if you need to upload only a front document image or a frontand a back document image, depending on the documentId submitted." } } }, "FacetecEnrollmentRequest": { "type": "object", "properties": { "faceScan": { "type": "string", "description": "FaceTec's FaceScan (350KB) contains encrypted 3D data from over 100 video frames captured during a 2-second long selfie video.", "example": "BAGZzkV3wyl4CP/CYnAiaq1VfwbcAMM02pohZ8a5Mm5v3" }, "auditTrailImage": { "type": "string", "description": "A picture for the end-user to audit.", "example": "/9j/4AAQSkZJRgABAQAAAQABAAD" }, "lowQualityAuditTrailImage": { "type": "string", "description": "A low-quality picture for the end-user to audit.", "example": "/9j/4AAQSkZJRgABAQAAAQABAAD" }, "userAgent": { "type": "string", "description": "User agent (mobile/desktop browser) identification to be used in the calls to the FaceTec API.", "example": "facetec|sdk|android|com.signicat.assure|dvFMSBMcyjjUB7dvR0lFWsOHoNiBsLDh|C71F69E46DF67349|SM-G970F|9.4.1|pt_PT|pt|621c18e4-5462-43a0-ac2b-346ac68a9270" } } }, "VerifyRequest": { "type": "object", "description": "Process verification request", "properties": { "facetecEnrollment": { "$ref": "#/components/schemas/FacetecEnrollmentRequest", "description": "This field only applies to the 'facetec' provider and is required.
    This object contains necessary information to validate the liveness of a person. The FaceTec SDK provides the returned values of these liveness checks. The values are matched against `imageDepiction`." }, "imageDepiction": { "type": "string", "description": "This field only applies to the 'facetec' provider and is required. It defines the image depiction in the process that is used to compare against the images captured in `facetecEnrollment` (see 'Set Images to the process' to see which depictions are valid for 'facetec' processes).", "enum": [ "selfie", "front" ], "example": "selfie" }, "rauthorityId": { "type": "string" }, "rAuthorityId": { "type": "string", "description": "Id of the registration authority where the VideoID will be sent to be verified by an agent. Not required. If not set, it will use the default value set in your Signicat Account (contact support@signicat.com to change that value).", "example": "11a56f16-6f19-4282-8f2d-3749b86471d5" } } }, "VerifyResponse": { "type": "object", "description": "Process verification response", "properties": { "processId": { "type": "string", "description": "The unique identifier of a process.", "example": "8afb3ac6-6780-42e4-bbc2-3713e2f6d97c" }, "status": { "type": "string", "description": "The current status of the the identity document verification process. For more information about what each status means, see the Get process page in the integration documentation.", "enum": [ "pending", "processing", "accepted", "rejected", "canceled", "failed", "inconclusive" ], "example": "processing" } } }, "UploadImageRequest": { "type": "object", "description": "Process set image request", "properties": { "front": { "type": "string", "description": "Image of the front of the identity document.
    Must be in dataURL format (Example: `data:image/png;base64,iVBORw....`)", "example": "data:image/png;base64,iVBORw..." }, "back": { "type": "string", "description": "Image of the back of the identity document.
    Must be in dataURL format (Example: `data:image/png;base64,iVBORw....`)", "example": "data:image/png;base64,iVBORw..." }, "selfie": { "type": "string", "description": "Selfie image of the end-user.
    Must be in dataURL format (Example: `data:image/png;base64,iVBORw....`)", "example": "data:image/png;base64,iVBORw..." } } }, "ProcessStatusResponse": { "type": "object", "description": "Process status response", "properties": { "processId": { "type": "string", "description": "processId is obtained from the \"Create process\" response body.", "example": "8afb3ac6-6780-42e4-bbc2-3713e2f6d97c" }, "status": { "type": "string", "description": "The current status of the the identity document verification process. For more information about what each status means, see the Get process page in the integration documentation.", "enum": [ "pending", "processing", "accepted", "rejected", "canceled", "failed", "inconclusive" ], "example": "processing" }, "reason": { "$ref": "#/components/schemas/Process_failReason", "example": { "category": "User.Request", "reason": "Process.Failed", "message": "Failed by request." } } } }, "MatchRequest": { "type": "object", "description": "Matching request", "example": { "source": { "dataNode": "userData" }, "target": { "processId": "0338a9c5-e135-4c51-9557-dd8ac6ba9e5c", "dataNode": "finalResult" } }, "properties": { "source": { "$ref": "#/components/schemas/MatchRequestComponent" }, "target": { "$ref": "#/components/schemas/MatchRequestComponent" }, "configurationId": { "type": "string", "description": "Optional field to specify a custom matching configuration." } }, "required": [ "source", "target" ] }, "MatchRequestComponent": { "type": "object", "description": "Matching result by component", "properties": { "processId": { "type": "string", "description": "Use only if dataNode is not `userData`.
    The ID of the process that contains the data used for matching.", "example": "a7f11597-19db-4ef0-84d5-268150f5c760" }, "dataNode": { "type": "string", "description": "Identifies the data node to be used as source/target data for the matching. This data node can be:
    • `userData` in the dossier: In this case you can simply omit `processId` in this request.
    • A data node from a process: It can be `finalResult`' for `onfido` processes. In this case you must also send `processId` in this request. The possible data nodes that can be used from each process depend on the provider of that process.
    For more details on how to perform matching, see the integration documentation.", "enum": [ "userData", "finalResult", "userInfo", "ocr" ], "example": "finalResult" } }, "required": [ "dataNode" ] }, "FieldMatchResult": { "type": "object", "description": "Matching result by field", "properties": { "sourceValue": { "type": "string", "description": "Data from source node.", "example": "John" }, "targetValue": { "type": "string", "description": "Data from target node.", "example": "JOHN" }, "sourceNormalized": { "type": "string", "description": "Value string after the normalization is applied.", "example": "JOHN" }, "targetNormalized": { "type": "string", "description": "Value string after the normalization is applied.", "example": "JOHN" }, "editDistance": { "type": "integer", "format": "int32", "description": "Levenshtein distance between normalized values of source and target. Will be greater than 0 only if exactMatch = false.", "example": 0 }, "error": { "type": "string", "description": "(Exists only if an error occurred while performing match) Indicates why this field wasn't matched.", "example": "Field not present in source/target." }, "algorithm": { "type": "string", "description": "The matching algorithm configured.", "enum": [ "levenshtein", "fuzzy" ], "example": "levenshtein" }, "normalization": { "type": "string", "description": "The matching normalization configured.", "enum": [ "none", "upper", "clean", "cleanUpper", "initialsUpper", "numeric" ], "example": "upper" }, "exactMatch": { "type": "boolean", "description": "True if values of source and data fully match, false otherwise. For more details on how to perform matching, see the integration documentation.", "example": true }, "partialMatch": { "type": "boolean", "description": "True if values of source and data match partially, false otherwise. For more details on how to perform matching, see the integration documentation.", "example": true } } }, "MatchComponent": { "type": "object", "description": "Matching result by component", "properties": { "processId": { "type": "string", "description": "Use only if dataNode is not `userData`.
    The ID of the process that contains the data used for matching.", "example": "a7f11597-19db-4ef0-84d5-268150f5c760" }, "dataNode": { "type": "string", "description": "Identifies the data node to be used as source/target data for the matching. This data node can be:
    • `userData` in the dossier: In this case you can simply omit `processId` in this request.
    • A data node from a process: It can be `finalResult`' for `onfido` processes. In this case you must also send `processId` in this request. The possible data nodes that can be used from each process depend on the provider of that process.
    For more details on how to perform matching, see the integration documentation.", "enum": [ "userData", "finalResult", "userInfo" ], "example": "finalResult" }, "updatedAt": { "type": "string", "description": "The date/time (ISO-8601 with UTC: YYYY-MM-DDThh:mm:ssZ) the match was executed. This field is returned only in the response.", "example": "2019-03-04T15:58:17Z" } }, "required": [ "dataNode" ] }, "MatchResponse": { "type": "object", "description": "Matching response", "example": { "dossierId": "37191afe-25b3-4c30-b42a-b0ab64aa1d64", "createdAt": "2021-03-22T15:21:05.294087Z", "source": { "dataNode": "userData", "updatedAt": "2021-03-22T15:21:02Z" }, "target": { "processId": "0338a9c5-e135-4c51-9557-dd8ac6ba9e5c", "dataNode": "finalResult", "updatedAt": "2021-03-22T15:11:57Z" }, "matchResult": { "firstName": { "sourceValue": "John", "targetValue": "John Michael", "sourceNormalized": "JOHN", "targetNormalized": "JOHN MICHAEL", "exactMatch": false, "partialMatch": true, "editDistance": 8 }, "lastName": { "sourceValue": "McClane", "targetValue": "McClane", "sourceNormalized": "MCCLANE", "targetNormalized": "MCCLANE", "exactMatch": true, "partialMatch": true, "editDistance": 0 }, "gender": { "sourceValue": "M", "targetValue": "M", "sourceNormalized": "M", "targetNormalized": "M", "exactMatch": true, "partialMatch": true, "editDistance": 0 }, "dateOfBirth": { "sourceValue": "1988-08-18", "targetValue": "1983-04-25", "sourceNormalized": "19880818", "targetNormalized": "19830425", "exactMatch": false, "partialMatch": false, "editDistance": 4 } } }, "properties": { "dossierId": { "type": "string", "description": "Identifies the dossier ID where the matching was performed." }, "createdAt": { "type": "string", "description": "The date and time when the matching was performed." }, "source": { "$ref": "#/components/schemas/MatchComponent", "description": "Data from source node." }, "target": { "$ref": "#/components/schemas/MatchComponent", "description": "Data from target node." }, "matchResult": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/FieldMatchResult" }, "description": "Lists the fields that were matched between the source and target (ex: \"firstName\", \"lastName\", \"dateOfBirth)\"." } } }, "FileRequest": { "type": "object", "description": "Dossier image request", "properties": { "front": { "type": "string", "description": "Image of the front of the identity document.
    Must be in dataURL format (Example: `data:image/png;base64,iVBORw....`)", "example": "data:image/png;base64,iVBORw..." }, "back": { "type": "string", "description": "Image of the back of the identity document.
    Must be in dataURL format (Example: `data:image/png;base64,iVBORw....`)", "example": "data:image/png;base64,iVBORw..." }, "selfie": { "type": "string", "description": "Selfie image of the end-user.
    Must be in dataURL format (Example: `data:image/png;base64,iVBORw....`)", "example": "data:image/png;base64,iVBORw..." }, "processId": { "type": "string", "description": "processId is obtained from the \"Create process\" response body.", "example": "8afb3ac6-6780-42e4-bbc2-3713e2f6d97c" } } }, "CaptureProcessParameters": { "type": "object", "description": "Provider specific process parameters", "properties": { "uiProfile": { "type": "string", "description": "This is the graphical profile used when loading the SDK. This graphical profile impacts the frontend layout (e.g. font, colour) and the end-user workflow (e.g. available documents, auto capture, glare detection). For more details about the uiProfile and configurations, please see the general documentation Capture configurations (uiProfile). If a uiProfile is not set, a default value will be used.

    To create a uiProfile configuration use the Create capture configuration endpoint.

    To get all available configurations use the Get all configurations endpoint.", "example": "darkmode" }, "uiProfileJSON": { "$ref": "#/components/schemas/JsonNode", "description": "This is JSON format of the graphical profile used when loading the SDK. Attention this will override configuration properties defined in the uiProfile.For more details about the uiProfile and configurations, please see the general documentation Capture configurations (uiProfile).", "example": { "pageTitle": "This is a json profile" } }, "uiLanguage": { "type": "string", "description": "Sets the initial language for the user interface. Default value is 'en' (English). For details about possible values, see the Translations section in the integration documentation.", "example": "en" }, "smsSender": { "type": "string", "description": "Name of the sender that will appear in the text message if the end-user chooses to capture the images with their mobile phone (mobile handover). This field must either be numeric and consist of up to 15 digits ([0-9]), or be alphanumeric and consist of 1 to 11 characters in the range [A-Za-z0-9]. Default value is 'Signicat'.", "example": "Signicat" }, "smsMessage": { "type": "string", "description": "The text that will appear in the text message. This message is prepended to the URL where the end-user must click to continue the verification process on their mobile phone, if they decided to do a mobile handover (see 'smsSender'). This message must follow the regex expression: `^[A-Za-z0-9-.:s]{1,200}$`Thus, it cannot exceed 200 characters. Default value is 'To continue, please click here:'", "example": "To continue please click here:" }, "defaultCountry": { "type": "string", "description": "The default country (ISO 3166 Alpha 3) to be used during the flow. This country is selected when there is a list of countries. Setting `defaultCountry` here in the request will override whatever defaultCountry is set in the capture configuration. ", "example": "NOR" } } }, "CaptureProcessRequest": { "type": "object", "properties": { "provider": { "type": "string", "description": "The provider that performs the identity document verification. This field is always required for all the providers (see `Enum` above).", "enum": [ "onfido", "signicatpaper", "readid", "signicatpictureid", "signicatvideoid", "webid" ], "example": "onfido" }, "processType": { "type": "string", "description": "This field only applies to the 'signicatvideoid', 'onfido' or 'readid' provider. It is optional for 'signicatvideoid' and 'onfido' and required for 'readid'.

    The available values are:
    • For 'signicatvideoid':
      • `high` (default): A human agent will review the process. This is done asynchronously.
      • `substantial`: Process verification is done automatically, meaning no human agent is involved.
      • `substantialFullyAuto`: Similar to `substantial` but without any `inconclusive` status. It will automatically reach an `accepted` or `rejected` status. For more information about what each status means, see the Get process page in the integration guide.
    • For 'onfido'
      • `document`: The verification is only done on the provided identity document.
      • `documentSelfie` (default): The verification is done on the identity document and the photo of the end-user. The photo allows assessing whether the holder of the identity document is the same person as the one in the ID document (facial similarity). The photo must be taken at the time of the request.
      • `documentVideo`: The verification is done on the identity document and also a video-call while the end-user does some requested actions (e.g. “Look over your left shoulder”). The video allows assessing whether the holder of the identity document is the same person as the one on the video-call(facial similarity). It also detects liveness information.
    • For 'readid'
      • `ready` (required)
    • For 'webid'
      • `accountid`
      • `videoid`
    ", "enum": [ "substantial", "substantialFullyAuto", "high", "document", "documentSelfie", "documentVideo", "ready" ], "example": "documentSelfie" }, "redact": { "type": "array", "description": "This field can only be used when the provider is 'signicatpaper')
    It indicates which field(s) should be redacted from the ID images.
    This will affect the 'front' and 'back' images you are able to get from the process If you request redaction, you will only be able to get those images if they were successfully redacted (i.e., if 'isFullRedaction':'true' in the Get Process response).", "enum": [ "firstName", "lastName", "fullName", "gender", "address", "personalIdentificationNumber", "documentNumber", "date", "dateOfBirth", "dateOfIssue", "dateOfExpiry", "photo", "signature", "accessNumber", "drivingPermits", "issuingAuthority", "mrz", "barcode" ], "items": { "type": "string" } }, "requestExtraDataFromDrivingLicense": { "type": "boolean", "default": false, "description": "(Warning: This is a Beta feature. Please contact your account manager for details.) This field is available only for \"onfido\" processes and for specific Driving License documents. If enabled, the process result will contain more information extracted from the Driving License (ex: license category and vehicle classes). ", "example": false }, "webid": { "$ref": "#/components/schemas/WebIDParameters", "description": "This object only applies to the 'webid' provider and is required.
    The information in this field must be provided at the creation of the process. It will be compared with the user information gathered during the process." } }, "required": [ "provider" ] }, "CaptureRequest": { "type": "object", "description": "Capture request", "properties": { "providers": { "type": "array", "description": "This is a list (array) of providers that perform the verification. Please, use only one provider per request.", "items": { "$ref": "#/components/schemas/CaptureProcessRequest" } }, "sdk": { "type": "string", "description": "Identifies which SDK will be used to capture and upload the images. The available values are:
    • `native`: Uses the provider's native SDK. This is default when the provider is `eid`, `readid`or `onfido`.
    • `capture`: Uses Signicat's SDK. This is default when the provider is `signicatpaper`.
    See also the general documentation, Using the SDKs available in the Capture service.", "enum": [ "native", "capture" ], "example": "native" }, "redirectUrl": { "type": "string", "description": "Contains the URL where the end-user will be redirected to when the image upload is finished (either successfully, failed or canceled).", "example": "https://some-redirect-url.com" }, "requestDomain": { "type": "string", "description": "This specifies the domain you want to use for this specific artifact. The domain will be visible in the end-user's browser. This domain needs to be correctly configured on your account!", "example": "myapp.app.signicat.com" }, "captureParameters": { "$ref": "#/components/schemas/CaptureProcessParameters" }, "eventTags": { "type": "array", "description": "List of tags to be used on events API", "example": [ "customerId" ], "items": { "type": "string" } } }, "required": [ "providers", "redirectUrl", "sdk" ] }, "WebURL": { "type": "object", "description": "Artifact Web URL", "properties": { "url": { "type": "string", "example": "https://api.signicat.com/assure/capture/#/artifact=2qxoa5ybea75iy122vkltm4xou0o0uvpkyh69kex1iac0dyvpb" } } }, "EidCountryAndDocumentType": { "type": "object", "description": "Process country and document type", "properties": { "country": { "type": "string", "description": "Three letter country code (ISO 3166 Alpha 3) representing the country of the document.", "example": "DEU" }, "countryName": { "type": "string", "description": "Name of the type of the document.", "example": "Germany" }, "type": { "type": "string", "description": "The type of document.", "enum": [ "driversLicense", "passport", "identityCard", "residencePermit", "workPermit", "voterId", "postalIdCard", "professionalQualificationCard", "socialSecurity", "panCard", "passportCard", "stateId", "visa", "asylumRegistrationCard", "nationalHealthInsuranceCard", "aadharCard" ], "example": "identityCard" }, "id": { "type": "integer", "format": "int32", "description": "This field only applies to the 'signicatvideoid' provider. The unique ID of the document.", "example": 191 }, "name": { "type": "string", "description": "Name of the type of the document.", "example": "Germany" }, "subType": { "type": "string", "description": "The subtype of document.", "example": "Passport" }, "icao": { "type": "string", "description": "The icao of document.", "example": "TD3" } } }, "ProcessWithDossierNode": { "type": "object", "description": "Dossiers are objects that contain end-user identity data, e.g. name, date of birth, ID document, etc. They also contain any processes that are created to verify that end-user’s identity.", "properties": { "processId": { "type": "string", "description": "processId is obtained from the \"Create process\" response body.", "example": "8afb3ac6-6780-42e4-bbc2-3713e2f6d97c" }, "dossier": { "$ref": "#/components/schemas/Dossier" }, "provider": { "type": "string", "description": "The ID of one of the supported providers.
    ", "example": "signicatvideoid" }, "status": { "type": "string", "description": "The current status of the the identity document verification process. For more information about what each status means, see the Get process page in the integration documentation.", "enum": [ "pending", "processing", "accepted", "rejected", "canceled", "failed", "inconclusive" ], "example": "processing" }, "processType": { "type": "string", "description": "The process type created from the provider.", "example": "document" }, "createdAt": { "type": "string", "description": "The date and time the process was created (ISO-8601 with UTC: YYYY-MM-DDThh:mm:ssZ).", "example": "2022-01-01T09:00:00Z" }, "updatedAt": { "type": "string", "description": "The date and time the process was updated (ISO-8601 with UTC: YYYY-MM-DDThh:mm:ssZ).", "example": "2022-01-01T10:30:00Z" }, "externalId": { "type": "string", "description": "Use this request to get the process external id. This id is the assure process id in the provider side. It corresponds to different things in each provider: Onfido: applicantId, Signicat VideoID: videoId, ReadID: sessionId (only after the process is finished. Before that it's the same as processId), Signicat Paper: requestId, Facetec: n/a, WebID: actionId, Signicat PictureID: transactionId.", "example": "ExternalId" }, "failReason": { "$ref": "#/components/schemas/ProcessWithDossierNode_failReason" } } }, "FiltersRequestParams": { "type": "object", "description": "Process filters request parameters", "properties": { "startCreationDate": { "type": "string", "description": "The start date and time (ISO-8601 with UTC: YYYY-MM-DDThh:mm:ssZ) for the first process in the process list. This date filter is relative to the date the process was created (the `createdAt` field of the process). ", "example": "2022-01-01T09:00:00Z" }, "endCreationDate": { "type": "string", "description": "The end date and time (ISO-8601 with UTC: YYYY-MM-DDThh:mm:ssZ) for the last process in the process list ", "example": "2022-01-01T09:00:00Z" }, "statusList": { "type": "array", "description": "This field allows you to filter the process list on one or more statuses. The default value is an empty string, which means it returns all processes with all statuses.", "example": "accepted", "items": { "type": "string" }, "uniqueItems": true }, "providersList": { "type": "array", "description": "This field allows you to filter the process list on one or more providers.", "example": "signicatvideoid", "items": { "type": "string" }, "uniqueItems": true }, "offset": { "type": "integer", "format": "int32", "description": "You can enter an offset value to specify which process should be retrieved first. The default offset value is 0 (first position in the database) and maximum is 200000. This maximum number is set to avoid performance issues. If you want to display more processes than defined in 'limit', you can create several requests with a different offset:
    1. Create a request for the most recent items: GET /processes?limit=20&offset=0
    2. On scroll/next page, create a second request: GET /processes?limit=20&offset=20
    3. On scroll/next page, create a third request: GET /processes?limit=20&offset=40
    ", "example": 0 }, "limit": { "type": "integer", "format": "int32", "description": "This is the maximum number of processes allowed in the response. The default value is 100 and maximum allowed is 2000. If you want to look at more processes than the defined limit, you must make more requests using the 'offset' parameter (see the example above).", "example": 100 }, "order": { "type": "string", "description": "Allows to choose the order on which the processes will be returned - by descending or ascending createdAt date.
    Default is descending.", "example": "createdAtDescending" } } }, "ListAllProcesses": { "type": "object", "description": "List of all Processes", "properties": { "processes": { "type": "array", "items": { "$ref": "#/components/schemas/ProcessWithDossierNode" } }, "filters": { "$ref": "#/components/schemas/FiltersRequestParams" }, "totalResults": { "type": "integer", "format": "int32", "description": "Total of processes that result from the 'startCreationDate', 'endCreationDate' and 'status' combination.", "example": 548 } } }, "DossierResponse": { "type": "object", "description": "Dossiers are objects that contain end-user identity data, e.g. name, date of birth, ID document, etc. They also contain any processes that are created to verify that end-user’s identity.", "properties": { "dossierId": { "type": "string", "description": "This ID is obtained from the \"Create dossier\" response body.", "example": "710a4326-ef7f-4bed-85c4-aa523f742742" }, "externalReference": { "type": "string", "description": "Customer specific reference to be associated with an ID of a dossier.", "example": "someReferenceExample" }, "createdAt": { "type": "string", "description": "The date and time the dossier was created (ISO-8601 with UTC: YYYY-MM-DDThh:mm:ssZ).", "example": "2022-01-01T09:00:00Z" }, "updatedAt": { "type": "string", "description": "The date and time the dossier was updated (ISO-8601 with UTC: YYYY-MM-DDThh:mm:ssZ).", "example": "2022-01-01T10:30:00Z" }, "processes": { "type": "array", "description": "List of processes associated with the dossier", "items": { "$ref": "#/components/schemas/SlimProcess" } } } }, "SlimProcess": { "type": "object", "properties": { "processId": { "type": "string", "description": "processId is obtained from the \"Create process\" response body.", "example": "8afb3ac6-6780-42e4-bbc2-3713e2f6d97c" }, "provider": { "type": "string", "description": "The ID of one of the supported providers.
    ", "example": "signicatvideoid" }, "processType": { "type": "string", "description": "The process type created from the provider.", "example": "document" }, "status": { "type": "string", "description": "This field allows you to filter the process list on one or more statuses. The default value is an empty string, which means it returns all processes with all statuses.", "example": "pending" }, "createdAt": { "type": "string", "description": "The date and time the process was created (ISO-8601 with UTC: YYYY-MM-DDThh:mm:ssZ).", "example": "2022-01-01T09:00:00Z" }, "updatedAt": { "type": "string", "description": "The date and time the process was updated (ISO-8601 with UTC: YYYY-MM-DDThh:mm:ssZ).", "example": "2022-01-01T10:30:00Z" } } }, "UserDataResponse": { "type": "object", "description": "Dossier user data response", "properties": { "dossierId": { "type": "string", "description": "This ID is obtained from the \"Create dossier\" response body.", "example": "8afb3ac6-6780-42e4-bbc2-3713e2f6d97c" }, "userData": { "$ref": "#/components/schemas/UserData" }, "createdAt": { "type": "string", "description": "The date and time the data was created (ISO-8601 with UTC: YYYY-MM-DDThh:mm:ssZ.)", "example": "2021-10-04T09:35:19Z" }, "updatedAt": { "type": "string", "description": "The date and time the data was updated (ISO-8601 with UTC: YYYY-MM-DDThh:mm:ssZ).", "example": "2021-10-04T09:35:19Z" } } }, "BBox": { "type": "object", "properties": { "x": { "type": "integer", "format": "int32", "description": "Coordinate from the 'x' axis where the bounding box starts.", "example": 517 }, "y": { "type": "integer", "format": "int32", "description": "Coordinate from the 'y' axis where the bounding box starts.", "example": 21 }, "width": { "type": "integer", "format": "int32", "description": "Width of the bounding box.", "example": 97 }, "height": { "type": "integer", "format": "int32", "description": "Height of the bounding box.", "example": 17 } } }, "DocumentVerification": { "type": "object", "properties": { "firstName": { "type": "string", "description": "Provides the first name in the ID document, including any initials and middle names.", "example": "John" }, "lastName": { "type": "string", "description": "The last name(s).", "example": "Reynolds" }, "gender": { "type": "string", "description": "The person's gender.", "example": "F" }, "nationality": { "type": "string", "description": "End-user’s nationality (country code in ISO 3166 Alpha 3 format).", "example": "PRT" }, "dateOfBirth": { "type": "string", "description": "End-user’s date of birth (YYYY-MM-DD).", "example": "1900-01-01" }, "documentType": { "type": "string", "description": "Document type.", "example": "passport" }, "documentNumber": { "type": "string", "description": "Document identification number.", "example": "9999999999" }, "taxNumber": { "type": "string", "description": "Tax number.", "example": "123456789" }, "dateOfExpiry": { "type": "string", "description": "Document expiry date (YYYY-MM-DD).", "example": "1900-01-01" }, "issuingCountry": { "type": "string", "description": "The issuing country (ISO 3166 Alpha 3) of the document. ", "example": "GBR" }, "dateOfIssue": { "type": "string", "description": "The date the document was issued (YYYY-MM-DD).", "example": "2020-03-02" }, "issuingState": { "type": "string", "description": "The issuing state of the document", "example": "WA" }, "issuingAuthority": { "type": "string", "description": "Issuing authority of the document", "example": "GEMEENTE VEENDAM" }, "placeOfBirth": { "type": "string", "description": "The end-user's place of birth.", "example": "Portugal" }, "personalIdentificationNumber": { "type": "string", "description": "The personal ID number in the document.", "example": "1234563" }, "mrzLine1": { "type": "string", "description": "Document’s mrz line 1.", "example": "mrzLine1: I
  • `clear`: All underlying verifications have passed.
  • `rejected`: The report has returned information that stops any further processing (poor quality image or an unsupported document).
  • `suspected`: The analysed document is suspected to be fraudulent.
  • `caution`: The report has returned information that needs to be evaluated.
    • ", "example": "clear" }, "ageValidation": { "type": "string", "description": "Asserts whether the age calculated from the date of birth, is greater than or equal to the minimum acceptable age set at the account level. The standard threshold is 16 years old but you can get Signicat Support to change this for you. Available values are `clear` and `consider`.", "example": "clear" }, "policeRecord": { "type": "string", "description": "Asserts whether the document has been identified as lost, stolen or otherwise compromised. The available values are `clear` and `consider`.", "example": "clear" }, "dataConsistency": { "type": "string", "description": "Asserts whether data represented in multiple places in the document is consistent, for example, between MRZ and OCR extracted text on passports. Validated elements are date of expiry, document type, gender, date of birth, nationality, issuing country, document numbers, first name and last name.The available values are `clear` and `consider`.", "example": "clear" }, "dataValidation": { "type": "string", "description": "Asserts whether algorithmic validated elements are correct. For example, MRZ lines, document expiry date and document numbers. The available values are `clear` and `consider`.", "example": "clear" }, "imageIntegrity": { "type": "string", "description": "Asserts whether the document was of sufficient quality to verify. The available values are `clear` and `consider`.", "example": "clear" }, "dataComparison": { "type": "string", "description": "Asserts whether the elements provided by the end-user match the information in the document, i.e. first name, last name, gender and date of birth. The available values are `clear` and `consider`.", "example": "clear" }, "faceComparison": { "type": "string", "description": "Asserts whether the face in the document matches the face in the selfie/video.
    The available values are `clear` and `consider`.", "example": "clear" }, "compromisedDocument": { "type": "string", "description": "Asserts whether the image of the document is found in Onfido's internal database of compromised documents. The available values are `clear` and `consider`.", "example": "clear" }, "result": { "type": "string", "description": "This field indicates the overall result of a report. The available values are:
    • `clear`: All underlying verifications have passed.
    • `consider`: The report has returned information that needs to be evaluated.
    • `unidentified`: This is returned if the applicant fails an identity check.
    ", "example": "clear" }, "spouseName": { "type": "string", "description": "The spouse name. (will only appear in the response if the field exists and is extracted by the provider)", "example": "MOLENAAR" }, "widowName": { "type": "string", "description": "The widow name. (will only appear in the response if the field exists and is extracted by the provider)", "example": "MOLENAAR" }, "aliasName": { "type": "string", "description": "The alias name. (will only appear in the response if the field exists and is extracted by the provider)", "example": "MOLENAAR" }, "driversLicense": { "type": "boolean", "description": "True when determined to be a non-restricted driving licence (applicant older than 18 years, and no restricted categories detected in the licence title)" }, "restrictedLicence": { "type": "boolean", "description": "True for limited/restricted driving licences, including learner's permits" }, "rawLicenceCategory": { "type": "string", "description": "Underlying, non-normalised, licence category (e.g. \"Junior operators license\")" }, "rawVehicleClasses": { "type": "string", "description": "Comma-separated vehicle classes that the user is qualified for" }, "vehicleClassDetails": { "type": "array", "description": "Detailed classes/categories information", "items": { "$ref": "#/components/schemas/VehicleClass" } }, "manualTransmissionRestriction": { "type": "boolean", "description": "True if the user is not qualified to drive a manual transmission" }, "passengerVehicle": { "$ref": "#/components/schemas/PassengerVehicle", "description": "Normalised data for passenger cars" }, "breakdowns": { "type": "object", "additionalProperties": {}, "description": "Contains detailed information on each verification performed by Onfido over the document. For more info, please refer to https://documentation.onfido.com/guide/document-report/#document-report.", "example": { "imageIntegrity": { "result": "consider", "breakdown": { "supportedDocument": { "result": "unidentified", "properties": {} }, "imageQuality": { "result": "clear", "properties": {} } } } } }, "visualAuthenticity": { "type": "string", "description": "Asserts whether visual (non-textual) elements are correct given the type of document, for example:
    • Is it a photo of a printed photo or of a digital screen (may be configured to map to caution)?
    • Has the document been digitally tampered, e.g. is the name altered?
    • Does the pictures of the person in the ID document show signs of tampering or alteration. In most cases, this will focus on the primary picture. It may also apply to the secondary and tertiary pictures when documents contain them.
    • Are security features expected in the ID document missing or wrong?
    • Does the document match the expected template for the document type and country?
    • Do the fonts in the document match the expected ones.?
    The available values are `clear` and `consider`.", "example": "clear" } } }, "EIDSecurityChecks": { "type": "object", "properties": { "nonExpired": { "$ref": "#/components/schemas/NonExpired" }, "notUnderage": { "$ref": "#/components/schemas/NotUnderage" }, "dataIntegrity": { "$ref": "#/components/schemas/DataIntegrity" }, "liveness": { "$ref": "#/components/schemas/Liveness" }, "sidesMatch": { "$ref": "#/components/schemas/SidesMatch" }, "notBWCopy": { "$ref": "#/components/schemas/NotBWCopy" }, "notFaceSpoofing": { "$ref": "#/components/schemas/NotFaceSpoofing" }, "untamperedDocument": { "$ref": "#/components/schemas/UntamperedDocument" }, "untamperedVideo": { "$ref": "#/components/schemas/untamperedVideo" }, "deviceSecurity": { "$ref": "#/components/schemas/deviceSecurity" }, "reflectiveSurface": { "$ref": "#/components/schemas/reflectiveSurface" }, "documentTilt": { "$ref": "#/components/schemas/documentTilt" } } }, "FaceScanSecurityChecks": { "type": "object", "properties": { "auditTrailVerificationCheckSucceeded": { "type": "boolean", "description": "Checks if the audit trail image comes from the same session as the face scan (true or false).", "example": true }, "replayCheckSucceeded": { "type": "boolean", "description": "Checks that the face scan does not exist in the database.", "example": true }, "faceScanLivenessCheckSucceeded": { "type": "boolean", "description": "Checks if the liveness check succeeded.", "example": true }, "sessionTokenCheckSucceeded": { "type": "boolean", "description": "Checks if the session token is valid, and not expired.", "example": true } } }, "FacetecLivenessResult": { "type": "object", "properties": { "error": { "type": "boolean", "description": "Indicates whether an error occurred during the liveness verification (true) or not (false).", "example": false }, "success": { "type": "boolean", "description": "Indicates whether the liveness verification ended successfully (true) or not (false).", "example": true }, "faceScanSecurityChecks": { "$ref": "#/components/schemas/FaceScanSecurityChecks", "description": "This object presents the results of the different security checks performed during the liveness scan.", "example": { "liveness": { "facescanSecurityChecks": { "auditTrailVerificationCheckSucceeded": true, "replayCheckSucceeded": true, "faceScanLivenessCheckSucceeded": true, "sessionTokenCheckSucceeded": true } } } } } }, "FacetecMatchingAttempt": { "type": "object", "properties": { "matchLevel": { "type": "integer", "format": "int32", "description": "This is the match level between the face in the image and the face in the face map. The available values are (FAR = false acceptance rate):
    • 8 - 1/1,000,000 FAR
    • 7 - 1/500,000 FAR
    • 6 - 1/100,000 FAR
    • 5 - 1/10,000 FAR
    • 4 - 1/1,000 FAR
    • 3 - 1/500 FAR
    • 2 - 1/250 FAR
    • 1 - 1/100 FAR
    • 0 - Non-match
    The possible values depend on the matching algorithm that was used:
    • facePortrait: 0 to 8
    • idPhoto:0 to 7
    • idPhotoLowQuality: 0 to 5
    ", "example": 8 }, "imageProcessing": { "type": "string", "description": "This field describes the quality of the image that was used in the matching.
    The available values are:
    • `faceFound`: The face was found.
    • `invalidImage`: The image was not valid.
    • `faceDetectionIssue`: There was an issue detecting the face in the image.
    • `lowQuality`: The image has insufficient quality.
    ", "enum": [ "faceFound", "invalidImage", "faceDetectionIssue", "lowQuality" ], "example": "faceFound" }, "success": { "type": "boolean", "description": "Indicates whether the matching was successful (true) or not (false).", "example": true }, "error": { "type": "boolean", "description": "Indicates whether an error occurred during the matching verification (true) or not (false).", "example": false } } }, "FacetecMatchingResult": { "type": "object", "properties": { "attempts": { "type": "array", "description": "This is a list of all attempts at matching the face/document image with FaceTec's face map. It will contain minimum 1 attempt and maximum 3. Each attempt uses a different matching algorithm in the following order:
    • The first attempt uses the 'facePortrait' algorithm.
    • The second attempt uses the 'idPhoto' algorithm.
    • The third attempt uses the 'idPhotoLowQuality' algorithm.
    ", "example": { "matching": { "attempts": [ { "algorithm": "facePortrait", "matchLevel": 0, "imageProcessing": "invalidImage", "success": false, "error": false }, { "algorithm": "idPhoto", "matchLevel": 0, "imageProcessing": "lowQuality", "success": false, "error": false }, { "algorithm": "idPhotoLowQuality", "matchLevel": 5, "imageProcessing": "faceFound", "success": true, "error": false } ], "algorithm": "idPhotoLowQuality", "matchLevel": 5, "imageProcessing": "faceFound", "success": true, "error": false } }, "items": { "$ref": "#/components/schemas/FacetecMatchingAttempt" } }, "matchLevel": { "type": "integer", "format": "int32", "description": "This is the match level between the face in the image and the face in the face map. The available values are (FAR = false acceptance rate):
    • 8 - 1/1,000,000 FAR
    • 7 - 1/500,000 FAR
    • 6 - 1/100,000 FAR
    • 5 - 1/10,000 FAR
    • 4 - 1/1,000 FAR
    • 3 - 1/500 FAR
    • 2 - 1/250 FAR
    • 1 - 1/100 FAR
    • 0 - Non-match
    The possible values depend on the matching algorithm that was used:
    • facePortrait: 0 to 8
    • idPhoto:0 to 7
    • idPhotoLowQuality: 0 to 5
    ", "example": 8 }, "imageProcessing": { "type": "string", "description": "This field describes the quality of the image that was used in the matching.
    The available values are:
    • `faceFound`: The face was found.
    • `invalidImage`: The image was not valid.
    • `faceDetectionIssue`: There was an issue detecting the face in the image.
    • `lowQuality`: The image has insufficient quality.
    ", "enum": [ "faceFound", "invalidImage", "faceDetectionIssue", "lowQuality" ], "example": "faceFound" }, "success": { "type": "boolean", "description": "Indicates whether the matching was successful (true) or not (false).", "example": true }, "error": { "type": "boolean", "description": "Indicates whether an error occurred during the matching verification (true) or not (false).", "example": false } } }, "FacialSimilarity": { "type": "object", "properties": { "result": { "type": "string", "description": "This field indicates the overall result of a report. Possible values can be:
    • `clear`: All underlying verifications have passed.
    • `consider`: The report has returned information that needs to be evaluated
    • `unidentified`: This is returned if the applicant fails an identity check.
    ", "enum": [ "clear", "consider", "unidentified" ], "example": "clear" }, "imageIntegrity": { "type": "string", "description": "Asserts whether the quality of the uploaded files and the content within are sufficient to do a face comparison, for example:
    • If the image of the picture is in colour (may be configured to be rejected if not).
    • If a single face of good enough quality is found in both the document image and the selfie/video.
    • If the selfie/video is not trustworthy, i.e. may have been digitally tampered from a fake webcam or from other dubious sources.
    • If the document image has good enough quality to perform a fraud inspection (for example, if parts of the document are not visible).
    Possible values are `clear` and `consider`.", "example": "clear" }, "faceComparison": { "type": "string", "description": "Asserts whether the face in the document matches the face in the selfie/video.
    Possible values are `clear` and `consider`.", "example": "clear" }, "visualAuthenticity": { "type": "string", "description": "Asserts whether the person in the selfie or live video is real (not a spoof) and alive (only done for live videos).
    Possible values are `clear` and `consider`.\" ", "example": "clear" }, "similarityScore": { "type": "string", "description": "This indicates how similar the two faces are. If the face matching algorithm fails to detect a face, the score property will not be present. The score only measures how similar the faces are, and does not assess the nature of the photo or video. If tampering (such as photos of printed photos or photos of digital screens) is detected, the end-user is rejected regardless of the facial similarity score. Possible values are `high`, `medium`, `low` or `veryLow`. Onfido originally returns a floating point number between 0 and 1 that expresses how similar the two faces are, where 1 is a perfect match. Assure normalizes that value into:
    • `high` if the score is > 0.75.
    • `medium` if the score is > 0.5 and <= 0.75.
    • `low` if the score is > 0.25 and <= 0.5.
    • `veryLow` if the score is <= 0.25.
    ", "example": "medium" }, "breakdowns": { "type": "object", "additionalProperties": {}, "description": "Contains detailed information on each verification performed by Onfido regarding the facial similarity. For more info, please refer to https://documentation.onfido.com/guide/facial-similarity-reports/#photo-and-photo-fully-auto.", "example": { "imageIntegrity": { "result": "clear", "breakdown": { "faceDetected": { "result": "clear", "properties": {} }, "sourceIntegrity": { "result": "clear", "properties": {} } } }, "faceComparison": { "result": "consider", "breakdown": { "faceMatch": { "result": "consider", "properties": { "score": 0.2842, "documentId": "47bcce99-5178-4263-bafe-c1d426d64af4" } } } }, "visualAuthenticity": { "result": "clear", "breakdown": { "spoofingDetection": { "result": "clear", "properties": { "score": 0.5686 } } } } } } } }, "Feature": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the visual feature in the document.", "example": "Header 2" }, "found": { "type": "boolean", "description": "Indicates if the feature was found in the document or not.", "example": true }, "bbox": { "$ref": "#/components/schemas/BBox", "description": "Bounding box position where the feature was found. In case the feature is not found, the bounding box will not appear." }, "side": { "type": "string", "description": "Side of the document where the feature is located.", "example": "front" } } }, "FinalResultDetails": { "type": "object", "properties": { "firstName": { "type": "string", "description": "The end-user’s given name.", "example": "MARIA PAULA" }, "lastName": { "type": "string", "description": "The end-user’s surname.", "example": "SMITH REINOLDS" }, "dateOfExpiry": { "type": "string", "description": "The document’s date of expiry (YYYY-MM-DD).", "example": "2024-03-02" }, "dateOfBirth": { "type": "string", "description": "The end-user’s date of birth (YYYY-MM-DD).", "example": "1970-09-19" }, "gender": { "type": "string", "description": "The end-user’s gender.", "enum": [ "M", "F" ], "example": "F" }, "nationality": { "type": "string", "description": "The end-user’s nationality (country code in ISO 3166 Alpha 3 format).", "example": "PRT" }, "documentType": { "type": "string", "description": "The document’s type.", "enum": [ "driversLicense", "passport", "identityCard", "residencePermit", "workPermit", "voterId", "postalIdCard", "professionalQualificationCard", "professionalPermit", "socialSecurity", "panCard", "passportCard", "stateId", "visa", "asylumRegistrationCard", "nationalHealthInsuranceCard", "aadharCard", "immigrationStatusDocument", "indigenousCard", "municipalityIdentityCard", "privateOperatorsCard", "certificateOfSponsorship", "serviceIdCard", "taxId" ], "example": "passport" }, "documentNumber": { "type": "string", "description": "The document’s number.", "example": "CA412356" }, "issuingCountry": { "type": "string", "description": "The document’s issuing country (ISO 3166 Alpha 3).", "example": "GBR" }, "similarityScore": { "type": "string", "description": "The similarity score between the end-user's face and the photo in the ID. The value indicates the probability of the person in the selfie being the same as the person in the document image. Possible values are:
    • `veryLow`: Very unlikely the same person.
    • `low`: Probably not the same person.
    • `medium`: Probably the same person.
    • `high`: Very likely the same person.
    To know more about what this score means for each provider, see the `providerSpecific` fields for each provider", "example": "high" }, "personalIdentificationNumber": { "type": "string", "description": "The personal identification number used by the governments of many countries as a means of tracking their citizens.", "example": "12123456" }, "livenessDetected": { "type": "boolean", "description": "Was liveness detected during the process.", "example": true }, "placeOfBirth": { "type": "string", "description": "The end-user's place of birth.", "example": "Portugal" }, "lastNameSecondLine": { "type": "string", "description": "Displays an additional surname (e.g. spouse name) in the second line.", "example": "e/v Molenaar" }, "dateOfIssue": { "type": "string", "description": "The document’s issuing date (YYYY-MM-DD).", "example": "2021-01-01" } } }, "ManualApproval": { "type": "object", "properties": { "duration": { "type": "string", "description": "How long the manual approval process took (number of seconds).", "example": "24" }, "firstName": { "type": "string", "description": "First name(s).", "example": "MARIA PAULA" }, "alternativeFirstName": { "type": "string", "description": "Alternative first name(s).", "example": "John" }, "lastName": { "type": "string", "description": "Last name(s).", "example": "SMITH REINOLDS" }, "alternativeLastName": { "type": "string", "description": "Alternative last name(s).", "example": "Reynolds" }, "dateOfExpiry": { "type": "string", "description": "Document expiry date (YYYY-MM-DD).", "example": "2024-03-02" }, "gender": { "type": "string", "description": "The end user's gender.", "example": "F" }, "nationality": { "type": "string", "description": "Nationality (country code in ISO 3166 Alpha 3 format).", "example": "PRT" }, "documentNumber": { "type": "string", "description": "Document number.", "example": "CA479556" }, "issuingCountry": { "type": "string", "description": "The country (ISO 3166 Alpha 3) that issued the document.", "example": "PRT" }, "dateOfBirth": { "type": "string", "description": "Date of birth (YYYY-MM-DD).", "example": "1989-09-09" }, "birthPlace": { "type": "string", "description": "Place of birth.", "example": "BREMERHAVEN" }, "issuingAuthority": { "type": "string", "description": "Issuing Authority.", "example": "HANSESTADT HAMBURG BEZIRKSAMT WANDSBEK" }, "address": { "type": "string", "description": "Address.", "example": "22043 HAMBURG, WEG NR.12 8E" }, "personalIdentificationNumber": { "type": "string", "description": "The end-user's national identity number.", "example": "12123456" }, "rejectionReasons": { "type": "array", "description": "This field only appears when the status of the process is 'rejected'. Contains the reasons given by the agent to have rejected the identification.
    The available values are:
    {\n  \"type\" : \"Environment.CaptchaNotRead\",\n  \"message\" : \"It is not evident that the person has read the captcha **captcha** in the video\",\n},\n{\n  \"type\" : \"Environment.NotAppropriate\",\n  \"message\" : \"There is no evidence of a living person, recognizable in a well-lit environment\",\n},\n{\n  \"type\" : \"Document.Aspect\",\n  \"message\" : \"There is no evidence of a legal identity document\",\n},\n{\n  \"type\" : \"Document.NotSecurityElements\",\n  \"message\" : \"Document security features are not identified\",\n},\n{\n  \"type\" : \"Document.NotLegible\",\n  \"message\" : \"Document data is not legible\",\n},\n{\n  \"type\" : \"Document.DoesNotMatchData\",\n  \"message\" : \"The front side of the document does not match with the back side\",\n},\n{\n  \"type\" : \"Photo.Invalid\",\n  \"message\" : \"The characteristics of the photo are not identified with those determined in the protocol\",\n},\n{\n  \"type\" : \"Photo.DoesNotMatchPerson\",\n  \"message\" : \"The person in the video does not match with the photo in the document\",\n},\n{\n  \"type\" : \"Custom.Question\",\n  \"message\" : \"Custom question to be filled out by the agent\",\n},\n{\n  \"type\" : \"Document.Expired\",\n\t\"message\" : \"Expired Document\",\n},\n{\n  \"type\" : \"Person.Underage\",\n  \"message\" : \"The person is a minor\",\n}\n
    ", "items": { "$ref": "#/components/schemas/Reason" } }, "videoId": { "type": "string", "description": "The id of the video that was sent for the agent to verify (same as \"externalId\")" }, "verificationId": { "type": "string", "description": "Unique id of the agent verification." }, "verifierId": { "type": "string", "description": "The id of the agent who did the verification." }, "verificationDate": { "type": "string", "description": "The date/time at which the agent finished the verification.", "example": "2019-09-19T22:10:56Z" }, "rauthorityId": { "type": "string" }, "rAuthorityId": { "type": "string", "description": "The ID of the Registration Authority Application.", "example": "11a56f16-6f19-4282-8f2d-3749b86471d5" } } }, "Ocr": { "type": "object", "properties": { "lastName": { "type": "string", "description": "Last name(s).", "example": "Reynolds" }, "alternativeLastName": { "type": "string", "description": "Alternative last name(s).", "example": "Reynolds" }, "dateOfExpiry": { "type": "string", "description": "Document expiry date (YYYY-MM-DD).", "example": "1900-01-01" }, "healthNumber": { "type": "string", "description": "Health number.", "example": "366355550" }, "gender": { "type": "string", "description": "The end user's gender.", "example": "F" }, "documentType": { "type": "string", "description": "Type of document that was provided (e.g. a passport).", "example": "identityCard" }, "idType": { "type": "string", "description": "ID type", "example": "188" }, "socialSecurityNumber": { "type": "string", "description": "Social security number.", "example": "11876398740" }, "documentNumber": { "type": "string", "description": "Document number.", "example": "122336694ZY4" }, "taxNumber": { "type": "string", "description": "Tax number.", "example": "200693803" }, "personalIdentificationNumber": { "type": "string", "description": "The end-user's national identity number.", "example": "12123456" }, "livenessDetected": { "type": "string", "description": "Ensures there is a living person in front of the camera through a facial expression (smile).", "example": { "valid": true } }, "predictedAge": { "type": "string", "description": "The predicted age", "example": "43.559265" }, "dateOfBirth": { "type": "string", "description": "Date of birth (YYYY-MM-DD).", "example": "1973-02-10" }, "dateOfIssue": { "type": "string", "description": "Date of issue (YYYY-MM-DD).", "example": "2025-02-18" }, "birthPlace": { "type": "string", "description": "Place of birth.", "example": "BREMERHAVEN" }, "similarityScore": { "type": "string", "description": "This is the biometric match level between the face of the person holding the document and the picture on it. Possible values are `high` (very likely the same person), `medium` (probably the same person), `low`(probably not) and `veryLow` (very unlikely). Default settings require `medium` as a minimum similarity level for the person to be able to complete the video identification. Other users will not be able to finish the process. If you want to change the default settings, please contact .", "example": "high" }, "firstName": { "type": "string", "description": "First name(s).", "example": "John" }, "alternativeFirstName": { "type": "string", "description": "Alternative first name(s).", "example": "John" }, "nationality": { "type": "string", "description": "Nationality (country code in ISO 3166 Alpha 3 format).", "example": "PRT" }, "issuingCountry": { "type": "string", "description": "The country (ISO 3166 Alpha 3) that issued the document.", "example": "PRT" }, "issuingAuthority": { "type": "string", "description": "Issuing Authority.", "example": "HANSESTADT HAMBURG BEZIRKSAMT WANDSBEK" }, "address": { "type": "string", "description": "Address.", "example": "22043 HAMBURG, WEG NR.12 8E" }, "securityChecks": { "$ref": "#/components/schemas/EIDSecurityChecks", "description": "Series of checks that are made on certain characteristics of the document to ensure its integrity and legality." }, "features": { "type": "array", "description": "List of visual features extracted from the document.
    Features mean the visual elements used in the ID document, like for example header1, header2, texts, bounding boxes, photo etc.
    The list of features can vary from document to document, meaning that a feature (e.g. 'Header 1') may exist in one document but not in another document. This list will contain each feature's name, an indication on whether the feature was found or not and information about its position in the document.", "items": { "$ref": "#/components/schemas/Feature" } } } }, "PaperFeatures": { "type": "object", "properties": { "firstName": { "type": "string", "description": "The person's first name(s).", "example": "Jose" }, "lastName": { "type": "string", "description": "The person's last name(s).", "example": "Ferreira" }, "dateOfExpiry": { "type": "string", "description": "The date until which the document is valid (YYYY-MM-DD).", "example": "2020-10-15" }, "issuingAuthority": { "type": "string", "description": "The name of the authority that issued the document.", "example": "SEF SERV ESTR E FRONTEIRAS" }, "gender": { "type": "string", "description": "The end user's gender.", "enum": [ "M", "F" ], "example": "F" }, "documentNumber": { "type": "string", "description": "The document's number.", "example": "N123456" }, "dateOfBirth": { "type": "string", "description": "The person's date of birth (YYYY-MM-DD).", "example": "1984-12-08" }, "personalIdentificationNumber": { "type": "string", "description": "The personal ID number in the document.", "example": "1234563" }, "dateOfIssue": { "type": "string", "description": "The date the document was issued (YYYY-MM-DD).", "example": "2015-10-15" }, "placeOfBirth": { "type": "string", "description": "The person's place of birth.", "example": "Portugal" }, "lastNameSecondLine": { "type": "string", "description": "Displays an additional surname (e.g. spouse name) in the second line.", "example": "e/v Molenaar" }, "qrcode.personal_number": { "type": "string", "description": "This is the personal identification number that is present in a QR code in the document. This field is available only for some documents, for example, the Dutch passport from 2021 which has a QR code on the back page." } } }, "PaperFeaturesVerification": { "type": "object", "properties": { "dateOfExpiry": { "type": "string", "description": "Feature verification result for the date of expiry.", "example": "MISSING" }, "lastName": { "type": "string", "description": "Feature verification result for the last name.", "example": "MISSING" }, "issuingAuthority": { "type": "string", "description": "Feature verification result for the issuing authority.", "example": "FOUND" }, "firstName": { "type": "string", "description": "Feature verification result for the first name.", "example": "MISSING" }, "documentNumber": { "type": "string", "description": "Feature verification result for the document number.", "example": "FOUND" }, "drivingPermits": { "type": "string", "description": "Feature verification result for the driving permits.", "example": "MISSING" }, "dateOfBirth": { "type": "string", "description": "Feature verification result for the date of birth.", "example": "FOUND" }, "personalIdentificationNumber": { "type": "string", "description": "Feature verification result for the personal identification number.", "example": "FOUND" }, "dateOfIssue": { "type": "string", "description": "Feature verification result for the date of issue.", "example": "MISSING" } } }, "PaperMRZ": { "type": "object", "properties": { "firstName": { "type": "string", "description": "The person's first name(s).", "example": "Jose" }, "lastName": { "type": "string", "description": "The person's last name(s).", "example": "Ferreira" }, "dateOfExpiry": { "type": "string", "description": "The date until which the document is valid (YYYY-MM-DD).", "example": "2020-10-15" }, "nationality": { "type": "string", "description": "The person's nationality (country code in ISO 3166 Alpha 3 format).", "example": "PRT" }, "gender": { "type": "string", "description": "The end user's gender.", "enum": [ "M", "F" ], "example": "F" }, "documentType": { "type": "string", "description": "The type of document, e.g. passport, identityCard, driversLicence.", "example": "passport" }, "issuingCountry": { "type": "string", "description": "The country (ISO 3166 Alpha 3) that issued the document.", "example": "PRT" }, "documentNumber": { "type": "string", "description": "The document's number.", "example": "N123456" }, "dateOfBirth": { "type": "string", "description": "The person's date of birth (YYYY-MM-DD).", "example": "1984-12-08" }, "personalIdentificationNumber": { "type": "string", "description": "The personal ID number in the document.", "example": "1234563" } } }, "PaperMrzCheckSum": { "type": "object", "properties": { "dateOfExpiry": { "type": "string", "description": "Evaluation performed on date of expiry (YYYY-MM-DD).", "example": "VALID" }, "documentNumber": { "type": "string", "description": "Evaluation performed on document number.", "example": "VALID" }, "dateOfBirth": { "type": "string", "description": "Evaluation performed on date of birth (YYYY-MM-DD).", "example": "VALID" }, "personalIdentificationNumber": { "type": "string", "description": "Evaluation performed on personal number.", "example": "VALID" } } }, "PaperMrzFeatureMatching": { "type": "object", "properties": { "dateOfExpiry": { "type": "string", "description": "Mrz feature matching result for the date of expiry", "example": "FULL_MATCH" }, "lastName": { "type": "string", "description": "Mrz feature matching result for the last name.", "example": "FULL_MATCH" }, "lastNameSecondLine": { "type": "string", "description": "Displays an additional surname (e.g. spouse name) in the second line.", "example": "e/v Molenaar" }, "issuingAuthority": { "type": "string", "description": "Mrz feature matching result for the issuing authority", "example": "FOUND" }, "firstName": { "type": "string", "description": "Mrz feature matching result for the first name.", "example": "FULL_MATCH" }, "documentNumber": { "type": "string", "description": "Mrz feature matching result for the document number.", "example": "FULL_MATCH" }, "dateOfBirth": { "type": "string", "description": "Mrz feature matching result for the date of birth.", "example": "FULL_MATCH" }, "placeOfBirth": { "type": "string", "description": "The person's place of birth.", "example": "Portugal" }, "driving_permits": { "type": "string", "description": "Mrz feature matching result for the driving permits.", "example": "MISSING" }, "personalIdentificationNumber": { "type": "string", "description": "Mrz feature matching result for the personal ID number in the document.", "example": "LEVENSHTEIN1" }, "dateOfIssue": { "type": "string", "description": "Mrz feature matching result for the date of issue.", "example": "VALID" } } }, "PaperMrzVerification": { "type": "object", "properties": { "dateOfExpiry": { "type": "string", "description": "The expiry date of the document (YYYY-MM-DD). `VALID` if the date is in the future, `INVALID` otherwise.", "example": "VALID" }, "documentType": { "type": "string", "description": "The type of document (e.g. passport, identity card, driver's license).`VALID` if the type of document is valid, `INVALID` otherwise.", "example": "VALID" }, "dateOfBirth": { "type": "string", "description": "The person's date of birth (YYYY-MM-DD). `VALID` if the date is in the past, `INVALID` otherwise.", "example": "VALID" }, "issuingCountry": { "type": "string", "description": "The country that issued the document. `VALID` if the value is an ISO 3166-1 alpha-3 country code, `INVALID` otherwise.", "example": "VALID" } } }, "PaperRedactionResult": { "type": "object", "properties": { "isPartialRedaction": { "type": "boolean", "description": "Possible values are `true`or `false`. true: At least one of the fields that were requested to be redacted were found (thus, were redacted). Check the value of `fullRedaction` to see if they all were redacted or not. false: None of the fields requested to be redacted were found (thus no field could be redacted).", "example": true }, "isFullRedaction": { "type": "boolean", "description": "Possible values are `true`or `false`. true: All fields that were requested to be redacted were found (thus, were successfully redacted). false: At least one of the fields that were requested to be redacted was not found (thus could not be redacted).", "example": true } } }, "PaperVerification": { "type": "object", "properties": { "type": { "type": "string", "description": "The type of verification. Possible values are:
    • MRZ_FEATURE_COMPARISON: Retrieved the information from both the `mrz` and the text fields (features) from the document and will analyse and match their values.
    • MRZ_ONLY: Retrieved and analysed only the information from the `mrz` area (used with “passport” documents only).
    • FEATURES_ONLY: Retrieved and analysed only the information from the text fields (used with documents that do not have `mrz` and only have text fields).
    ", "example": "MRZ_FEATURE_COMPARISON" }, "status": { "type": "boolean", "description": "The status of the verification. if \"true\", the verification was successful, if \"false\" at least one error was found.", "example": true } } }, "PassengerVehicle": { "type": "object", "properties": { "permissionToDrive": { "type": "string", "description": "Whether they are qualified for a passenger car, such as a “B” class in the UK" }, "obtainmentDate": { "type": "string", "description": "Date the class qualification was obtained" }, "expiryDate": { "type": "string", "description": "Date the class qualification expires, which may be different to doc expiry" } } }, "Process": { "type": "object", "description": "Assure Process", "properties": { "processId": { "type": "string", "description": "processId is obtained from the \"Create process\" response body.", "example": "8afb3ac6-6780-42e4-bbc2-3713e2f6d97c" }, "provider": { "type": "string", "description": "The ID of one of the supported providers.
    ", "example": "signicatvideoid" }, "processType": { "type": "string", "description": "The process type created from the provider.", "example": "document" }, "status": { "type": "string", "description": "The current status of the the identity document verification process. For more information about what each status means, see the Get process page in the integration documentation.", "enum": [ "pending", "processing", "accepted", "rejected", "canceled", "failed", "inconclusive" ], "example": "pending" }, "failReason": { "$ref": "#/components/schemas/Process_failReason" }, "depictions": { "type": "array", "description": "This field displays a list of available image types (\"back\", \"front\", \"selfie\", \"portrait\") representing the files stored in a process during its creation. This tells you which images you can get from a process. By knowing this you can avoid unnecessary calls to the Get image endpoint, trying to get images that do not exist in the process.\nNotes:\n
    • The field will only exist for processes with a final status.
    • If the process is finished and contains no images, the field will contain an empty array. Ex: \"depictions\": [].
    • All depictions of images that exist in the process will appear in this list, including images that might have been redacted by request (to which you will get an HTTP 403 UNAUTHORIZED if you try to Get Image, as usual)
    ", "enum": [ "front", "back", "selfie", "portrait" ], "example": [ "front", "back", "portrait", "selfie" ], "items": { "type": "string" } }, "finalResult": { "$ref": "#/components/schemas/FinalResultDetails", "description": "The element in this area is only present if the verification was accepted.
    The elements in this node depend on the document/provider/processType that was used in the process creation." }, "providerSpecific": { "$ref": "#/components/schemas/ProviderDetails", "description": "Contains information retrieved by the provider. Inner elements will differ depending on the provider" }, "redactionRequested": { "type": "boolean", "description": "This field only applies to the 'signicatpaper' provider. The flag is set to true if the redaction was requested.", "example": false }, "statusReasons": { "type": "array", "description": "Warning: This is a beta feature.
    This field is only available for signicatpictureid provider.
    It contains a list of reasons of why a process status had an inconclusive or rejected state.", "example": [ { "type": "Document", "category": "SecurityCheckFailed", "subCategory": "NonExpired", "message": "Security check 'nonExpired' failed." } ], "items": { "$ref": "#/components/schemas/StatusReason" } }, "createdAt": { "type": "string", "description": "The date and time the process was created (ISO-8601 with UTC: YYYY-MM-DDThh:mm:ssZ).", "example": "2022-01-01T09:00:00Z" }, "updatedAt": { "type": "string", "description": "The date and time the process was updated (ISO-8601 with UTC: YYYY-MM-DDThh:mm:ssZ).", "example": "2022-01-01T10:30:00Z" } } }, "ProviderDetails": { "type": "object", "properties": { "documentVerification": { "$ref": "#/components/schemas/DocumentVerification", "description": "This field only applies to the 'onfido' provider.
    It contains information from Onfido's document verification." }, "facialSimilarity": { "$ref": "#/components/schemas/FacialSimilarity", "description": "This field only applies to the 'onfido' provider.
    Contains information from Onfido's facial similarity verification." }, "identResponse": { "$ref": "#/components/schemas/WebIDIdentResponse", "description": "WebID user identification response" }, "verification": { "$ref": "#/components/schemas/PaperVerification", "description": "This field only applies to the 'signicatpaper' provider.
    It contains information about the type of verification that was done by Signicat Paper. Either it verified both the `mrz` area and the textual fields of the document or it was able to only check one of those." }, "features": { "$ref": "#/components/schemas/PaperFeatures", "description": "This field only applies to the 'signicatpaper' provider.
    It contains values extracted from the textual fields in the document." }, "mrz": { "$ref": "#/components/schemas/PaperMRZ", "description": "This field only applies to the 'signicatpaper' provider.
    It contains the information that was retrieved from MRZ area in the document." }, "mrzChecksum": { "$ref": "#/components/schemas/PaperMrzCheckSum", "description": "This field only applies to the 'signicatpaper' provider.
    It contains information about checksum evaluations performed over the checkdigits in the `mrz`. Possible values are:
    • VALID: The checksum evaluation is valid;
    • INVALID: The checksum evaluation is not valid.
    " }, "mrzVerification": { "$ref": "#/components/schemas/PaperMrzVerification", "description": "This field only applies to the 'signicatpaper' provider.
    It contains information about the validity of some of the `mrz` fields in the document. Possible values are:
    • VALID: The value is a valid date.
    • PARSED: The value is not a valid date.
    • FOUND: The value was found but it cannot be parsed as a date (meaning it will also not be a valid date).
    • MISSING: The value was not found.
    " }, "mrzFeatureMatching": { "$ref": "#/components/schemas/PaperMrzFeatureMatching", "description": "This field only applies to the 'signicatpaper' provider.
    It provides matching results from comparing the values with the `features` field with the corresponding values in the `mrz` feature fields (for example `lastName`, `firstName`, `dateOfBirth` etc.). Possible values are:
    • FULL_MATCH: Used for both date and text fields. The value in the feature field matches completely the value in `mrz`.
    • LEVENSHTEIN1, LEVENSHTEIN2, LEVENSHTEIN3, LEVENSHTEIN4: Used for both date and text fields. The value in the feature field differs from the value in `mrz` from 1 to 4 characters.
    • VALID: The difference is greater than LEVENSHTEIN4 but the value in the feature field is still a valid date.
    • PARSED: Used for date fields only. The difference is greater than LEVENSHTEIN4 but the value in the field is not a valid date.
    • FOUND: For text fields, the value was found in the field but it differs more than 5 degrees from the value in `mrz`. For date fields, the value was found in the field but it cannot be parsed as a date (meaning it will also not be a valid date).
    • MISSING: The value was not found in any field.
    " }, "featuresVerification": { "$ref": "#/components/schemas/PaperFeaturesVerification", "description": "This field only applies to the 'signicatpaper' provider.
    This is only presented when the document has no MRZ (ex: Danish health card))
    Provides information if the field was found or not in the document. " }, "redactionResult": { "$ref": "#/components/schemas/PaperRedactionResult", "description": "This field only applies to the 'signicatpaper' provider.
    It contains the redaction result when redaction is requested for one or more fields in an identity document. The redaction result will contain \"partial\" and \"full\" boolean values.

    Notes about redaction:
    • This information only exists if `redact` is sent in the request body.
    • The redaction results do not have any impact on the process' final status. The process status indicates the success of the verification and redaction is a parallel feature.
    For more details, see the Redaction section in the integration documentation." }, "errors": { "type": "array", "description": "This field only applies to the 'signicatpaper' provider.
    List of errors found by SignicatPaper during the verification.", "items": { "type": "string" } }, "ocr": { "$ref": "#/components/schemas/Ocr", "description": "This field only applies to the 'eid' provider.
    It contains information obtained from Signicat VideoID's OCR analysis of the document during the video identification." }, "manualApproval": { "$ref": "#/components/schemas/ManualApproval", "description": "This field only applies when the provider is 'signicatvideoid' and `processType` is `high`.
    It contains the data that was extracted by ElectronicID during the video identification and after it was manually reviewed by an agent. The sub-fields are similar to the ones you find in `ocr` but may have been improved." }, "consolidatedIdentityData": { "$ref": "#/components/schemas/ReadIDConsolidatedIdentityData", "description": "This field only applies to the 'readid' provider.
    It contains information from the Read ID consolidated data." }, "documentContent": { "$ref": "#/components/schemas/ReadIDDocumentContent", "description": "This field only applies to the 'readid' provider.
    It contains some more information present in the identity document." }, "iproovSession": { "$ref": "#/components/schemas/ReadIDIproovSession", "description": "This field only applies to the 'readid' provider.
    It contains information from the iProov liveness session." }, "liveness": { "$ref": "#/components/schemas/FacetecLivenessResult", "description": "This field only applies to the 'facetec' provider.
    This object contains information from FaceTec's liveness verification." }, "matching": { "$ref": "#/components/schemas/FacetecMatchingResult", "description": "This field only applies to the 'facetec' provider.
    This object contains information from FaceTec's matching verification." }, "document": { "$ref": "#/components/schemas/SignicatPictureIdDocumentDto", "description": "This field only applies to the 'signicatpictureid' provider.
    It contains information from Signicat Picture ID document verification." }, "selfie": { "$ref": "#/components/schemas/SignicatPictureIdSelfie", "description": "This field only applies to the 'signicatpictureid' provider.
    Contains information from Signicat Picture ID facial similarity verification." } } }, "ReadIDConsolidatedIdentityData": { "type": "object", "properties": { "chipVerification": { "type": "string", "description": "This is the chip verification status. It verifies that the contents in the chip is authentic. Values can be either `SUCCEEDED` or `FAILED`. Assure API uses the value from this field in combination with ChipCloneDetection to map the final status of the process. For more details about the final status mapping, see the ReadID results section in the general documentation. ", "example": "SUCCEEDED" }, "chipCloneDetection": { "type": "string", "description": "This is the chip clone detection status. It verifies if the actual chip is used (and not a clone). Values can be either `SUCCEEDED`, `FAILED` or `NOT_AVAILABLE`. Assure API uses the value from this field in combination with ChipVerification to map the final status of the process. For more details about the final status mapping, see the ReadID results section in the general documentation. ", "example": "FAILED" }, "documentType": { "type": "string", "description": "The document type (e.g. passport, identityCard, driversLicence).", "example": "passport" }, "firstName": { "type": "string", "description": "First name(s).", "example": "TIAGO MIGUEL" }, "lastName": { "type": "string", "description": "Surname(s).", "example": "FERREIRA MENDES" }, "gender": { "type": "string", "description": "The end user's gender.", "enum": [ "M", "F" ], "example": "F" }, "nationality": { "type": "string", "description": "The nationality (country code in ISO 3166 Alpha 3 format).", "example": "PRT" }, "dateOfBirth": { "type": "string", "description": "Date of birth (YYYY-MM-DD).", "example": "1988-05-23" }, "documentNumber": { "type": "string", "description": "The document number.", "example": "CB022930" }, "dateOfExpiry": { "type": "string", "description": "The document expiry date (YYYY-MM-DD).", "example": "2024-08-26" }, "issuingCountry": { "type": "string", "description": "The document issuing country (ISO 3166 Alpha 3).", "example": "PRT" }, "documentCode": { "type": "string", "description": "Document code indicating the document type. ‘P’ for a passport, ‘I’ for an Identity Document, ´D´ for a driver's license.", "example": "P" }, "personalIdentificationNumber": { "type": "string", "description": "The personal ID number in the document.", "example": "1234563" } } }, "ReadIDDocumentContent": { "type": "object", "properties": { "dateOfBirth": { "type": "string", "description": "Date of birth (YYYY-MM-DD).", "example": "1988-05-23" }, "dateOfExpiry": { "type": "string", "description": "The document expiry date (YYYY-MM-DD).", "example": "2024-08-26" }, "dateOfIssue": { "type": "string", "description": "The date the document was issued (YYYY-MM-DD).", "example": "2015-10-15" }, "documentNumber": { "type": "string", "description": "The document number.", "example": "CB022930" }, "issuingAuthority": { "type": "string", "description": "The name of the authority that issued the document.", "example": "SEF SERV ESTR E FRONTEIRAS" }, "issuingCountry": { "type": "string", "description": "The country (ISO 3166 Alpha 3) that issued the document.", "example": "PRT" }, "personalIdentificationNumber": { "type": "string", "description": "The personal ID number in the document.", "example": "1234563" }, "firstName": { "type": "string", "description": "The person's first name(s).", "example": "Jose" }, "lastName": { "type": "string", "description": "The person's last name(s).", "example": "Ferreira" }, "gender": { "type": "string", "description": "The end user's gender.", "enum": [ "M", "F" ], "example": "F" }, "mrzFirstName": { "type": "string", "description": "The person's first name(s), in the MRZ", "example": "Jose" }, "mrzLastName": { "type": "string", "description": "The person's last name(s), in the MRZ.", "example": "Ferreira" }, "nationality": { "type": "string", "description": "The person's nationality (country code in ISO 3166 Alpha 3 format).", "example": "PRT" }, "placeOfBirth": { "type": "string", "description": "The person's place of birth.", "example": "Portugal" }, "profession": { "type": "string", "description": "The person's profession.", "example": "Portugal" }, "telephone": { "type": "string", "description": "The person's telephone number.", "example": "Portugal" }, "title": { "type": "string", "description": "The person's job title.", "example": "Portugal" } } }, "ReadIDIproovSession": { "type": "object", "properties": { "attempts": { "type": "integer", "format": "int32", "description": "The number of times the user tried to run the iProov session.", "example": 1 }, "enrollmentImageSource": { "type": "string", "description": "The source of the image used to perform matching in the iProov session.", "example": "Chip" }, "errorString": { "type": "string", "description": "The error description when the iProov session fails." }, "finished": { "type": "boolean", "description": "Indicates if the iProov session was finished.", "example": true }, "hasError": { "type": "boolean", "description": "Indicates if the iProov session had an error.", "example": false }, "passed": { "type": "boolean", "description": "Indicates if the iProov session was successful.", "example": true }, "enrollmentRiskProfile": { "type": "string", "description": "The risk profile that was returned on the enrollment response." }, "riskProfile": { "type": "string", "description": "The risk profile that was used for the enrollment." }, "iproovAssuranceType": { "type": "string", "writeOnly": true }, "getiProovAssuranceType": { "type": "string", "description": "The assurance type used for this iProov session. Allowed types for the account are established by contract with iProov. Default type, if allowed, is GENUINE_PRESENCE.", "example": "GENUINE_PRESENCE" } } }, "Reason": { "type": "object", "properties": { "type": { "type": "string", "description": "Reject Type.", "enum": [ "Environment.NotAppropriate", "Document.Aspect", "Document.NotSecurityElements", "Photo.Invalid", "Document.NotLegible", "Document.DoesNotMatchData", "Photo.DoesNotMatchPerson", "Custom.Question" ], "example": "Environment.CaptchaNotRead" }, "message": { "type": "string", "description": "Reject Message", "example": "It is not evident that the person has read the captcha captcha in the video" } } }, "SignicatPictureIdDocumentDto": { "type": "object", "properties": { "issuingCountry": { "type": "string", "description": "The issuing country (ISO 3166 Alpha 3) of the document. ", "example": "GBR" }, "issuingPlace": { "type": "string", "description": "Issuing Authority.", "example": "HANSESTADT HAMBURG BEZIRKSAMT WANDSBEK" }, "dateOfIssue": { "type": "string", "description": "The date the document was issued (YYYY-MM-DD).", "example": "2024-10-18" }, "dateOfExpiry": { "type": "string", "description": "Document expiry date (YYYY-MM-DD).", "example": "2030-01-01" }, "nonExpiring": { "type": "boolean", "description": "TODO" }, "documentNumber": { "type": "string", "description": "Document identification number.", "example": "9999999999" }, "subject": { "$ref": "#/components/schemas/SignicatPictureIdSubjectDto", "description": "The end-user's details." }, "securityChecks": { "$ref": "#/components/schemas/SignicatPictureIdSecurityChecks", "description": "Series of checks that are made on certain characteristics of the document to ensure its integrity and legality." } } }, "SignicatPictureIdElement": { "type": "object", "properties": { "x": { "type": "integer", "format": "int32", "description": "TODO" }, "y": { "type": "integer", "format": "int32", "description": "TODO" }, "width": { "type": "integer", "format": "int32", "description": "TODO" }, "height": { "type": "integer", "format": "int32", "description": "TODO" } } }, "SignicatPictureIdSecurityChecks": { "type": "object", "properties": { "notTamperedDocument": { "$ref": "#/components/schemas/UntamperedDocument" }, "nonExpired": { "$ref": "#/components/schemas/NonExpired" }, "notUnderage": { "$ref": "#/components/schemas/NotUnderage" }, "notBlackAndWhite": { "$ref": "#/components/schemas/NotBWCopy" }, "dataIntegrity": { "$ref": "#/components/schemas/DataIntegrity" }, "selfieAndDocumentMatch": { "$ref": "#/components/schemas/SelfieAndDocumentMatch" }, "sidesMatch": { "$ref": "#/components/schemas/SidesMatch" }, "notFaceSpoofing": { "$ref": "#/components/schemas/NotFaceSpoofing" } } }, "SignicatPictureIdSelfie": { "type": "object", "properties": { "status": { "type": "string", "description": "TODO", "enum": [ "UNDEFINED", "SUCCESS", "NO_FACE_DETECTED", "MULTIPLE_FACES_DETECTED" ] }, "x": { "type": "integer", "format": "int32", "description": "TODO" }, "y": { "type": "integer", "format": "int32", "description": "TODO" }, "width": { "type": "integer", "format": "int32", "description": "TODO" }, "height": { "type": "integer", "format": "int32", "description": "TODO" } } }, "SignicatPictureIdSubjectDto": { "type": "object", "properties": { "firstName": { "type": "string", "description": "The end-user's first name(s).", "example": "John" }, "lastName": { "type": "string", "description": "The end-user's last name(s).", "example": "Reynolds" }, "commonName": { "type": "string", "description": "TODO" }, "alternativePrimaryName": { "type": "string", "description": "TODO" }, "alternativeSecondaryName": { "type": "string", "description": "TODO" }, "dateOfBirth": { "type": "string", "description": "End-user’s date of birth (YYYY-MM-DD).", "example": "1900-01-01" }, "placeOfBirth": { "type": "string", "description": "The end-user's place of birth.", "example": "Portugal" }, "address": { "type": "string", "description": "The end-user's address.", "example": "22043 HAMBURG, WEG NR.12 8E" }, "gender": { "type": "string", "description": "The end-user's gender.", "example": "F" }, "nationality": { "type": "string", "description": "Nationality (country code in ISO 3166 Alpha 3 format).", "example": "PRT" }, "personalIdentificationNumber": { "type": "string", "description": "The personal ID number in the document.", "example": "1234563" }, "photo": { "$ref": "#/components/schemas/SignicatPictureIdElement", "description": "TODO" }, "signature": { "$ref": "#/components/schemas/SignicatPictureIdElement", "description": "TODO" } } }, "StatusReason": { "type": "object", "properties": { "type": { "type": "string", "description": "The status reason type.", "example": "Document" }, "category": { "type": "string", "description": "The status reason category.", "example": "SimilarityLevel" }, "subCategory": { "type": "string", "description": "(optional) The status reason sub-category.", "example": "NotUnderage" }, "message": { "type": "string", "description": "A message describing the status reason.", "example": "Security check 'notUnderage' failed." } } }, "VehicleClass": { "type": "object", "properties": { "category": { "type": "string", "description": "Vehicle class/category" }, "codes": { "type": "string", "description": "Special conditions driver must meet" }, "obtainmentDate": { "type": "string", "description": "Category obtainment date" }, "expiryDate": { "type": "string", "description": "Category expiry date" } } }, "WebIDBankAccount": { "type": "object", "properties": { "iban": { "type": "string", "description": "The international bank account number (IBAN) of the bank account that was used." } } }, "WebIDCustomParameters": { "type": "object", "description": "WebID Custom Parameters", "properties": { "signicatEnvironmentPrefix": { "type": "string" }, "signicatEnvironmentSuffix": { "type": "string" } } }, "WebIDIdDocumentResponse": { "type": "object", "description": "Data about the physical ID document. ", "properties": { "authority": { "type": "string", "writeOnly": true }, "dateOfExpiry": { "type": "string", "description": "ID document's expiry date (YYYY-MM-DD)." }, "dateOfIssue": { "type": "string", "description": "Date when the ID document was issued. No time zone. Might be empty." }, "documentType": { "type": "string", "description": "Type (or name) of the ID document, for example, passport. Only specified values are supported. Other values will be ignored." }, "idNumber": { "type": "string", "writeOnly": true }, "mrz": { "type": "string", "description": "Value of the \"Machine Readable Zone\" in the ID document. Cannot include line breaks or special characters for multi-line variants. Might be empty." }, "nameAtBirth": { "type": "string", "description": "Maiden name as specified in the ID document." }, "nationality": { "type": "string", "description": "The end-user's nationality (country code in ISO 3166 Alpha 3 format)." }, "placeOfBirth": { "type": "string", "description": "The end-user's birth place." }, "issuingCountry": { "type": "string", "description": "The country (ISO 3166 Alpha 3) that issued the document.", "example": "PRT" }, "issuingAuthority": { "type": "string", "description": "Name of the authority that issued the ID document. Might be empty." }, "documentNumber": { "type": "string", "description": "Document number." } } }, "WebIDIdentResponse": { "type": "object", "properties": { "actionId": { "type": "string", "description": "A 9-digit unique identifier of a user-action." }, "transactionId": { "type": "string", "description": "Identifier provided by integration partner, e.g. an account number. Included in all further communication." }, "actionType": { "type": "string", "description": "Type of user-action. Workflow and features of user-action depend on this.", "enum": [ "auto_ident", "video_ident", "precheck_video_ident", "customer_ident", "eid_ident", "pay_ident", "auto_ident_avs" ] }, "success": { "type": "boolean", "description": "Flag to determine if the user-action was finished successfully." }, "mismatch": { "type": "boolean", "description": "A flag is set if the user data confirmed by a support agent is different from the data the user initially provided." }, "customParameters": { "$ref": "#/components/schemas/WebIDCustomParameters", "writeOnly": true }, "responseType": { "type": "string", "description": "Type of response." }, "finishedOn": { "type": "string", "description": "When the success / no-success state was reached." }, "identMode": { "type": "string", "description": "Identification mode. Determines how user identification is executed.", "enum": [ "ident", "automated_ident", "qes", "expired", "cert", "pay_money_transfer" ] }, "agentId": { "type": "string", "description": "Callcenter agent identifier." }, "identifiedOn": { "type": "string", "description": "Actual date/time when identification was completed. This may be earlier than finished-on, if this user-action references a former successful user-action (eCheck). May be null, if identification failed." }, "idDocument": { "$ref": "#/components/schemas/WebIDIdDocumentResponse" }, "rejectionReason": { "type": "string", "description": "Optional reason value for unsuccessful identifications." }, "user": { "$ref": "#/components/schemas/WebIDUserResponse", "description": "End-user personal details" }, "productInfos": { "$ref": "#/components/schemas/WebIDProductInfos", "description": "Optional product related information." } } }, "WebIDProductInfos": { "type": "object", "properties": { "bankAccount": { "$ref": "#/components/schemas/WebIDBankAccount", "description": "Additional information about bank account. Only available for bank account related identification." } } }, "WebIDUserResponse": { "type": "object", "properties": { "title": { "type": "string", "description": "Academic title of user. Will be synchronised with the corresponding field in the ID document." }, "sex": { "type": "string", "writeOnly": true }, "firstname": { "type": "string", "writeOnly": true }, "lastname": { "type": "string", "writeOnly": true }, "dateOfBirth": { "type": "string", "description": "The end-user's date of birth (YYYY-MM-DD).", "example": "2000-12-29" }, "address": { "$ref": "#/components/schemas/WebIDAddress", "description": "Residence or postal address, according to the ID document. Either street or addressLine1 is required. Street and streetNumber may be used to infer the required part of the address. For international addresses, addressLine1 and addressLine2 may be used to infer the required part of the address." }, "contact": { "$ref": "#/components/schemas/WebIDContact" }, "gender": { "type": "string", "description": "The end user's gender.", "enum": [ "M", "F" ], "example": "M" }, "firstName": { "type": "string", "description": "The end-user's given name(s).", "example": "John" }, "lastName": { "type": "string", "description": "The end-user's surname(s).", "example": "Smith" } } }, "ExternalId": { "type": "object", "description": "External Id", "properties": { "externalId": { "type": "string", "description": "Provider internal ID to correlate with Assure process ID", "example": "2822984e-fa4d-46a9-b4cd-de47d5050cc0" } } }, "CaptureConfigurationSlimResponse": { "type": "object", "description": "Capture Configuration Slim Response", "properties": { "id": { "type": "string", "description": "The ID of a capture configuration.", "example": "Configuration1", "maxLength": 100 }, "createdAt": { "type": "string", "description": "The date and time the data was created (ISO-8601 with UTC: YYYY-MM-DDThh:mm:ssZ.)", "example": "2022-01-01T09:00:00Z" }, "updatedAt": { "type": "string", "description": "The date and time the data was updated (ISO-8601 with UTC: YYYY-MM-DDThh:mm:ssZ).", "example": "2022-01-01T10:30:00Z" } } } }, "securitySchemes": { "basicAuth": { "type": "http", "description": "JWT Security Scheme", "scheme": "bearer", "bearerFormat": "JWT" } } } }