getid-api-v1.json

{
    "openapi": "3.0.0",
    "info": {
        "title": "GetID API",
        "version": "1.5",
        "x-logo": {
            "url": "./logo.svg",
            "altText": "GetID"
        },
        "description": "# Overview\n\nThe GetID API allows you to send applications for verification and receive the results.\nVerification results for applications created using our SDKs can also be obtained through the API.\n\nA verification consists of one or more \"checks\".\nDifferent checks require different sets of an applicant's data.\n\n# Request, response format\n\nYou should use a `Content-Type: application/json` header with all requests.\nResponses return JSON with a consistent structure.\n\n# Authentication\n\nThe GetID API uses token-based authentication. \nAPI tokens must be included in the header of all requests made to the API.\n\n<SecurityDefinitions />\n"
    },
    "tags": [
        {
            "name": "Application",
            "x-displayName": "Applications",
            "description": "\"Application\" is the basic concept used in this API.\nIt is a set of data that have to be verified, is being verified or has already been verified.\n\nIt may contain text data of the applicant's profile, image(s) of his/her identity document, selfie of the applicant, as well as additional files.\nAlso, if the application was created using our SDK, it may contain artefacts confirm that the applicant passes the liveness check.\n"
        },
        {
            "name": "Translation",
            "x-displayName": "Translations",
            "description": "GetID SDK gets the user's preferred locale or uses the locale passed to its initializer as the default one.\nThen the SDK loads translations for the selected locale from the server.\nIt works automatically and doesn't require any additional configuration.\n\nBut one can change some translations if needed.\nIn order to do that, one have to upload a \"translation dictionary\" for one or several locales.\nIf the \"translation dictionary\" name is passed to the SDK initializer, the translations from this dictionary will be used.\nTranslations for keys that the dictionary does not contain will be taken from the default GetID dictionary.\n\nThe actual list of supported locales can be obtained using `GET /sdk/v2/locales` method.\nAnd the actual list of translation keys can be obtained using `GET /sdk/v2/translations` method.\n"
        },
        {
            "name": "Token",
            "x-displayName": "Tokens",
            "description": "One can create a token to avoid using the API key in requests.\nThe API key have full access to all methods and data.\nSo using tokens with limited access is preferable for security reasons.\n"
        },
        {
            "name": "One-time link",
            "x-displayName": "One-time links"
        },
        {
            "name": "ApplicationToVerify",
            "x-displayName": "Application to verify",
            "description": "<SchemaDefinition schemaRef=\"#/components/schemas/ApplicationToVerifyContainer\" />\n"
        },
        {
            "name": "VerificationResult",
            "x-displayName": "Verification result",
            "description": "<SchemaDefinition schemaRef=\"#/components/schemas/VerificationResult\" />\n"
        }
    ],
    "x-tagGroups": [
        {
            "name": "Endpoints",
            "tags": [
                "Application",
                "Token"
            ]
        },
        {
            "name": "Models",
            "tags": [
                "ApplicationToVerify",
                "VerificationResult"
            ]
        },
        {
            "name": "SDK-related endpoints",
            "tags": [
                "Translation",
                "One-time link"
            ]
        }
    ],
    "paths": {
        "/api/v1/application": {
            "post": {
                "summary": "Create an application",
                "security": [
                    {
                        "APIKeyAuth": []
                    },
                    {
                        "APITokenAuth": []
                    }
                ],
                "description": "Submits an application for verification.\n",
                "requestBody": {
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/ApplicationToVerifyContainer"
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "OK.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "allOf": [
                                        {
                                            "type": "object",
                                            "properties": {
                                                "id": {
                                                    "$ref": "#/components/schemas/ApplicationID"
                                                }
                                            },
                                            "required": [
                                                "id"
                                            ]
                                        },
                                        {
                                            "$ref": "#/components/schemas/ResponseCode200"
                                        }
                                    ]
                                }
                            }
                        }
                    },
                    "400": {
                        "description": "Bad request.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "allOf": [
                                        {
                                            "type": "object",
                                            "properties": {
                                                "errors": {
                                                    "type": "array",
                                                    "items": {
                                                        "$ref": "#/components/schemas/ApplicationValidationError"
                                                    }
                                                }
                                            }
                                        },
                                        {
                                            "$ref": "#/components/schemas/ResponseCode400"
                                        }
                                    ]
                                }
                            }
                        }
                    },
                    "401": {
                        "$ref": "#/components/responses/Unauthorized"
                    }
                },
                "callbacks": {
                    "onOrderedCallback": {
                        "The URL can be set in the Webhooks section of the Administrative Portal": {
                            "post": {
                                "parameters": [
                                    {
                                        "in": "header",
                                        "name": "Cache-Control",
                                        "description": "Is used to specify instructions for caching mechanisms.",
                                        "schema": {
                                            "type": "string",
                                            "example": "no-cache"
                                        }
                                    },
                                    {
                                        "in": "header",
                                        "name": "Accept",
                                        "schema": {
                                            "type": "string",
                                            "example": "application/json"
                                        }
                                    },
                                    {
                                        "in": "header",
                                        "name": "Content-Type",
                                        "schema": {
                                            "type": "string",
                                            "example": "application/json"
                                        }
                                    },
                                    {
                                        "in": "header",
                                        "name": "X-Signature",
                                        "description": "The request body concatenated with the `X-Timestamp` header, signed by the private key.\nThis signature can be used to validate that the sender is GetID.\nSee more details in the Webhooks section of the Administrative Portal.\n",
                                        "schema": {
                                            "type": "string"
                                        }
                                    },
                                    {
                                        "in": "header",
                                        "name": "X-Timestamp",
                                        "description": "The time of signing.",
                                        "schema": {
                                            "$ref": "#/components/schemas/Timestamp"
                                        }
                                    }
                                ],
                                "requestBody": {
                                    "content": {
                                        "application/json": {
                                            "schema": {
                                                "$ref": "#/components/schemas/VerificationResult"
                                            }
                                        }
                                    }
                                },
                                "responses": {
                                    "200": {
                                        "description": "OK."
                                    }
                                }
                            }
                        }
                    }
                },
                "tags": [
                    "Application"
                ]
            }
        },
        "/api/v1/application/{id}": {
            "get": {
                "summary": "Inspect an application",
                "security": [
                    {
                        "APIKeyAuth": []
                    },
                    {
                        "APITokenAuth": []
                    }
                ],
                "description": "Retrieves a previously submitted application by providing its ID.\n",
                "parameters": [
                    {
                        "in": "path",
                        "name": "id",
                        "required": true,
                        "schema": {
                            "oneOf": [
                                {
                                    "$ref": "#/components/schemas/ApplicationID"
                                },
                                {
                                    "$ref": "#/components/schemas/SubmittedExternalID"
                                }
                            ]
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "allOf": [
                                        {
                                            "$ref": "#/components/schemas/VerificationResult"
                                        },
                                        {
                                            "$ref": "#/components/schemas/ResponseCode200"
                                        }
                                    ]
                                }
                            }
                        }
                    },
                    "401": {
                        "$ref": "#/components/responses/Unauthorized"
                    },
                    "404": {
                        "$ref": "#/components/responses/NotFound"
                    }
                },
                "tags": [
                    "Application"
                ]
            },
            "delete": {
                "summary": "Delete an application",
                "security": [
                    {
                        "APIKeyAuth": []
                    },
                    {
                        "APITokenAuth": []
                    }
                ],
                "description": "Deletes a previously submitted application by providing its ID.\n",
                "parameters": [
                    {
                        "in": "path",
                        "name": "id",
                        "required": true,
                        "schema": {
                            "$ref": "#/components/schemas/ApplicationID"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "$ref": "#/components/responses/OK"
                    },
                    "401": {
                        "$ref": "#/components/responses/Unauthorized"
                    },
                    "404": {
                        "$ref": "#/components/responses/NotFound"
                    }
                },
                "tags": [
                    "Application"
                ]
            }
        },
        "/api/v1/application/{id}/set-comment": {
            "post": {
                "summary": "Set a comment to an application",
                "security": [
                    {
                        "APIKeyAuth": []
                    },
                    {
                        "APITokenAuth": []
                    }
                ],
                "description": "Sets a comment to a previously submitted application.\n",
                "parameters": [
                    {
                        "in": "path",
                        "name": "id",
                        "required": true,
                        "schema": {
                            "$ref": "#/components/schemas/ApplicationID"
                        }
                    }
                ],
                "requestBody": {
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/CommentToSet"
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "$ref": "#/components/responses/OK"
                    },
                    "401": {
                        "$ref": "#/components/responses/Unauthorized"
                    },
                    "404": {
                        "$ref": "#/components/responses/NotFound"
                    }
                },
                "tags": [
                    "Application"
                ]
            }
        },
        "/api/v1/application/{id}/set-status": {
            "post": {
                "summary": "Set the status of an application",
                "security": [
                    {
                        "APIKeyAuth": []
                    },
                    {
                        "APITokenAuth": []
                    }
                ],
                "description": "Sets the status of a previously submitted application.\n",
                "parameters": [
                    {
                        "in": "path",
                        "name": "id",
                        "required": true,
                        "schema": {
                            "$ref": "#/components/schemas/ApplicationID"
                        }
                    }
                ],
                "requestBody": {
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/StatusToSet"
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "$ref": "#/components/responses/OK"
                    },
                    "401": {
                        "$ref": "#/components/responses/Unauthorized"
                    },
                    "404": {
                        "$ref": "#/components/responses/NotFound"
                    }
                },
                "tags": [
                    "Application"
                ]
            }
        },
        "/api/v1/pdf/{id}": {
            "get": {
                "summary": "Get an application in PDF format",
                "security": [
                    {
                        "APIKeyAuth": []
                    },
                    {
                        "APITokenAuth": []
                    }
                ],
                "description": "Retrieves a previously submitted application in PDF format.\n",
                "parameters": [
                    {
                        "in": "path",
                        "name": "id",
                        "required": true,
                        "schema": {
                            "$ref": "#/components/schemas/ApplicationID"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK.",
                        "content": {
                            "application/pdf": {
                                "schema": {
                                    "type": "string",
                                    "format": "binary"
                                }
                            }
                        }
                    },
                    "401": {
                        "$ref": "#/components/responses/Unauthorized"
                    },
                    "404": {
                        "$ref": "#/components/responses/NotFound"
                    }
                },
                "tags": [
                    "Application"
                ]
            }
        },
        "/api/v1/applications-list": {
            "get": {
                "summary": "List applications",
                "security": [
                    {
                        "APIKeyAuth": []
                    },
                    {
                        "APITokenAuth": []
                    }
                ],
                "description": "Lists the submitted applications.\n",
                "parameters": [
                    {
                        "$ref": "#/components/parameters/startDate"
                    },
                    {
                        "$ref": "#/components/parameters/endDate"
                    },
                    {
                        "$ref": "#/components/parameters/statusFilter"
                    },
                    {
                        "$ref": "#/components/parameters/countryFilter"
                    },
                    {
                        "$ref": "#/components/parameters/docTypeFilter"
                    },
                    {
                        "$ref": "#/components/parameters/platformFilter"
                    },
                    {
                        "$ref": "#/components/parameters/authorFilter"
                    },
                    {
                        "$ref": "#/components/parameters/flowFilter"
                    },
                    {
                        "$ref": "#/components/parameters/pageLimit"
                    },
                    {
                        "$ref": "#/components/parameters/offset"
                    },
                    {
                        "$ref": "#/components/parameters/idsOnly"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "allOf": [
                                        {
                                            "$ref": "#/components/schemas/ApplicationListResponse"
                                        },
                                        {
                                            "$ref": "#/components/schemas/ResponseCode200"
                                        }
                                    ]
                                }
                            }
                        }
                    },
                    "401": {
                        "$ref": "#/components/responses/Unauthorized"
                    }
                },
                "tags": [
                    "Application"
                ]
            }
        },
        "/api/v1/tokenized-url": {
            "post": {
                "summary": "Create a one-time verification link",
                "security": [
                    {
                        "APIKeyAuth": []
                    },
                    {
                        "APITokenAuth": []
                    }
                ],
                "description": "Creates a one-time verification link.\n\nAn end user, by following the created link, will be able to submit an application for verification using our SDK.\n",
                "parameters": [
                    {
                        "in": "query",
                        "name": "name",
                        "description": "The name of the verification flow. \nYou can create, view, edit and delete verification flows in the Administrative Portal.\n",
                        "schema": {
                            "type": "string",
                            "example": "getid-doc-selfie-liveness"
                        },
                        "required": true
                    },
                    {
                        "in": "query",
                        "name": "externalId",
                        "schema": {
                            "$ref": "#/components/schemas/ExternalID"
                        }
                    }
                ],
                "requestBody": {
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/SDKConfiguration"
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "OK.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "properties": {
                                        "url": {
                                            "type": "string",
                                            "description": "The verification link."
                                        }
                                    },
                                    "required": [
                                        "url"
                                    ]
                                }
                            }
                        }
                    },
                    "401": {
                        "$ref": "#/components/responses/Unauthorized"
                    }
                },
                "tags": [
                    "One-time link"
                ]
            }
        },
        "/api/v1/translations": {
            "post": {
                "summary": "Create a translation dictionary",
                "security": [
                    {
                        "APIKeyAuth": []
                    }
                ],
                "description": "Creates a translation dictionary.\n",
                "requestBody": {
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/TranslationDictionariesToCreate"
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "$ref": "#/components/responses/OK"
                    },
                    "400": {
                        "$ref": "#/components/responses/BadRequest"
                    },
                    "401": {
                        "$ref": "#/components/responses/Unauthorized"
                    }
                },
                "tags": [
                    "Translation"
                ]
            },
            "get": {
                "summary": "List translation dictionaries",
                "security": [
                    {
                        "APIKeyAuth": []
                    }
                ],
                "description": "Returns all translation dictionaries.\n",
                "responses": {
                    "200": {
                        "description": "OK.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "allOf": [
                                        {
                                            "$ref": "#/components/schemas/TranslationDictionaryListResponse"
                                        },
                                        {
                                            "$ref": "#/components/schemas/ResponseCode200"
                                        }
                                    ]
                                }
                            }
                        }
                    },
                    "401": {
                        "$ref": "#/components/responses/Unauthorized"
                    }
                },
                "tags": [
                    "Translation"
                ]
            }
        },
        "/api/v1/translations/{dictionary}/{locale}": {
            "delete": {
                "summary": "Delete a translation dictionary",
                "security": [
                    {
                        "APIKeyAuth": []
                    }
                ],
                "description": "Deletes a translation dictionary.\n",
                "parameters": [
                    {
                        "in": "path",
                        "name": "dictionary",
                        "required": true,
                        "schema": {
                            "$ref": "#/components/schemas/TranslationDictionaryName"
                        }
                    },
                    {
                        "in": "path",
                        "name": "locale",
                        "required": true,
                        "schema": {
                            "$ref": "#/components/schemas/LocaleIdentifier"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "$ref": "#/components/responses/OK"
                    },
                    "401": {
                        "$ref": "#/components/responses/Unauthorized"
                    },
                    "404": {
                        "$ref": "#/components/responses/NotFound"
                    }
                },
                "tags": [
                    "Translation"
                ]
            }
        },
        "/api/v1/token": {
            "post": {
                "summary": "Create a token",
                "security": [
                    {
                        "APIKeyAuth": []
                    }
                ],
                "description": "Creates a token.\n",
                "requestBody": {
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/APITokenToCreate"
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "$ref": "#/components/responses/OK"
                    },
                    "401": {
                        "$ref": "#/components/responses/Unauthorized"
                    }
                },
                "tags": [
                    "Token"
                ]
            }
        },
        "/api/v1/token/{token}": {
            "delete": {
                "summary": "Delete a token",
                "security": [
                    {
                        "APIKeyAuth": []
                    }
                ],
                "description": "Deletes a token.\n",
                "parameters": [
                    {
                        "in": "path",
                        "name": "token",
                        "description": "The token to be deleted.",
                        "required": true,
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "$ref": "#/components/responses/OK"
                    },
                    "401": {
                        "$ref": "#/components/responses/Unauthorized"
                    },
                    "404": {
                        "$ref": "#/components/responses/NotFound"
                    }
                },
                "tags": [
                    "Token"
                ]
            }
        }
    },
    "components": {
        "securitySchemes": {
            "APIKeyAuth": {
                "type": "apiKey",
                "in": "header",
                "name": "X-API-Key",
                "description": "Your API key can be used as a token. \nThe API key can be found in the Settings section of the Administrative Portal.\n\nThe API key provides access to all submitted applications, so keep it in safety. Never use the API key in the frontend side of your system.\n"
            },
            "APITokenAuth": {
                "type": "apiKey",
                "in": "header",
                "name": "X-API-Key",
                "description": "Tokens created using the `POST api/v1/token` method give access only to applications created using the very same token.\n\nSuch tokens can be deleted using `DELETE api/v1/token/{token}` method, for example, if a token has been compromised or when staff members with access to a token leave your organisation.\n\nNote: tokens with `root` access level provide access to all submitted applications.\n"
            }
        },
        "parameters": {
            "startDate": {
                "name": "startDate",
                "description": "The start of the period for which applications are to be queried, in milliseconds.",
                "in": "query",
                "schema": {
                    "type": "integer",
                    "format": "int64"
                },
                "example": 1636927200000
            },
            "endDate": {
                "name": "endDate",
                "description": "The end of the period for which applications are to be queried, in milliseconds.",
                "in": "query",
                "schema": {
                    "type": "integer",
                    "format": "int64"
                },
                "example": 1637704740000
            },
            "statusFilter": {
                "name": "statusFilter",
                "in": "query",
                "schema": {
                    "type": "array",
                    "description": "The filter by statuses applications are in.",
                    "items": {
                        "type": "string",
                        "enum": [
                            "declined",
                            "approved",
                            "needs-review",
                            "error",
                            "pending"
                        ]
                    },
                    "example": [
                        "needs-review",
                        "declined"
                    ]
                }
            },
            "countryFilter": {
                "name": "countryFilter",
                "in": "query",
                "schema": {
                    "type": "array",
                    "description": "The filter by issuing countries of documents used for verification.",
                    "items": {
                        "type": "string"
                    },
                    "example": [
                        "EST",
                        "FIN"
                    ]
                }
            },
            "docTypeFilter": {
                "name": "docTypeFilter",
                "in": "query",
                "schema": {
                    "type": "array",
                    "description": "The filter by types of documents used for verification.",
                    "items": {
                        "$ref": "#/components/schemas/DocumentType"
                    },
                    "example": [
                        "passport",
                        "id-card"
                    ]
                }
            },
            "platformFilter": {
                "name": "platformFilter",
                "in": "query",
                "schema": {
                    "type": "array",
                    "description": "The filter by platforms from which applications were submitted.",
                    "items": {
                        "$ref": "#/components/schemas/Platform"
                    },
                    "example": [
                        "ios",
                        "API",
                        "internal"
                    ]
                }
            },
            "authorFilter": {
                "name": "authorFilter",
                "in": "query",
                "schema": {
                    "type": "array",
                    "description": "The filter by Administrative Portal users who created applications. \"No Author\" value can be used to retrieve applications without an author.",
                    "items": {
                        "type": "string"
                    },
                    "example": [
                        "user@company.com",
                        "No+Author"
                    ]
                }
            },
            "flowFilter": {
                "name": "flowFilter",
                "in": "query",
                "schema": {
                    "type": "array",
                    "description": "The filter by verification flows that were used to submit applications.",
                    "items": {
                        "type": "string"
                    },
                    "example": [
                        "getid-doc-selfie",
                        "getid-doc-selfie-liveness"
                    ]
                }
            },
            "pageLimit": {
                "name": "pageLimit",
                "in": "query",
                "schema": {
                    "type": "integer",
                    "description": "The limit of the number of applications in the response.",
                    "example": 10,
                    "default": 10
                }
            },
            "offset": {
                "name": "offset",
                "in": "query",
                "schema": {
                    "type": "integer",
                    "description": "The offset from the first application in the list.",
                    "example": 50,
                    "default": 0
                }
            },
            "idsOnly": {
                "name": "idsOnly",
                "in": "query",
                "schema": {
                    "type": "boolean",
                    "description": "Indicates whether full verification results or only application IDs are queried.",
                    "example": true,
                    "default": false
                }
            }
        },
        "responses": {
            "OK": {
                "description": "OK.",
                "content": {
                    "application/json": {
                        "schema": {
                            "$ref": "#/components/schemas/ResponseCode200"
                        }
                    }
                }
            },
            "BadRequest": {
                "description": "Bad request.",
                "content": {
                    "application/json": {
                        "schema": {
                            "allOf": [
                                {
                                    "type": "object",
                                    "properties": {
                                        "errorMessage": {
                                            "type": "string"
                                        }
                                    }
                                },
                                {
                                    "$ref": "#/components/schemas/ResponseCode400"
                                }
                            ]
                        }
                    }
                }
            },
            "Unauthorized": {
                "description": "Unauthorized access, invalid or missing authorization header.",
                "content": {
                    "application/json": {
                        "schema": {
                            "type": "object",
                            "properties": {
                                "responseCode": {
                                    "type": "integer",
                                    "enum": [
                                        401
                                    ]
                                },
                                "errorMessage": {
                                    "type": "string",
                                    "example": "Wrong API key"
                                }
                            },
                            "required": [
                                "responseCode"
                            ]
                        }
                    }
                }
            },
            "NotFound": {
                "description": "Resource not found.",
                "content": {
                    "application/json": {
                        "schema": {
                            "type": "object",
                            "properties": {
                                "responseCode": {
                                    "type": "integer",
                                    "enum": [
                                        404
                                    ]
                                }
                            },
                            "required": [
                                "responseCode"
                            ]
                        }
                    }
                }
            }
        },
        "schemas": {
            "ApplicationToVerifyContainer": {
                "type": "object",
                "description": "The data that GetID accepts as input to perform the verification.\n",
                "properties": {
                    "metadata": {
                        "$ref": "#/components/schemas/ApplicationToVerifyMetadata"
                    },
                    "application": {
                        "$ref": "#/components/schemas/ApplicationToVerify"
                    },
                    "verificationTypes": {
                        "$ref": "#/components/schemas/VerificationTypesToPerform"
                    }
                },
                "required": [
                    "application"
                ],
                "additionalProperties": false
            },
            "ApplicationToVerifyMetadata": {
                "type": "object",
                "description": "Meta information about the application.",
                "properties": {
                    "externalId": {
                        "$ref": "#/components/schemas/ExternalID"
                    },
                    "labels": {
                        "$ref": "#/components/schemas/MetadataLabels"
                    }
                }
            },
            "ExternalID": {
                "type": "string",
                "description": "A unique identifier.\nYou can use it to link an application with a user in your system.\n",
                "maxLength": 256,
                "example": "dse31-sla05-wte93"
            },
            "MetadataLabels": {
                "type": "object",
                "description": "A set of arbitrary key-value pairs. The maximum amount of keys is 30.",
                "maxProperties": 30,
                "additionalProperties": {
                    "type": "string"
                }
            },
            "ApplicationToVerify": {
                "type": "object",
                "description": "The data to verify.",
                "properties": {
                    "fields": {
                        "allOf": [
                            {
                                "description": "The profile data of the applicant.\n\nIt must be provided and must contain \"First name\", \"Last name\" and \"Date of birth\" fields to perform a `watchlists` check.\n"
                            },
                            {
                                "$ref": "#/components/schemas/ProfileDataFields"
                            }
                        ]
                    },
                    "documents": {
                        "type": "array",
                        "description": "The applicant's ID document.\n\nIt must be provided to perform `data-extraction` and `face-matching` checks.\n",
                        "items": {
                            "$ref": "#/components/schemas/DocumentToVerify"
                        },
                        "minItems": 0,
                        "maxItems": 1
                    },
                    "selfie": {
                        "description": "The applicant's selfie.\n\nIt must be provided to perform a `face-matching` check.\n",
                        "properties": {
                            "files": {
                                "type": "array",
                                "items": {
                                    "$ref": "#/components/schemas/MediaFile"
                                },
                                "minItems": 0,
                                "maxItems": 1
                            }
                        },
                        "required": [
                            "files"
                        ],
                        "additionalProperties": false
                    }
                },
                "additionalProperties": false
            },
            "ProfileDataFields": {
                "type": "array",
                "description": "The profile data of the applicant.\n",
                "items": {
                    "$ref": "#/components/schemas/ProfileDataField"
                },
                "example": [
                    {
                        "category": "First name",
                        "content": "John",
                        "contentType": "string"
                    },
                    {
                        "category": "Last name",
                        "content": "Doe",
                        "contentType": "string"
                    },
                    {
                        "category": "Date of birth",
                        "content": "1985-11-25",
                        "contentType": "date"
                    },
                    {
                        "category": "Gender",
                        "content": "male",
                        "contentType": "sex"
                    }
                ]
            },
            "ProfileDataField": {
                "type": "object",
                "properties": {
                    "category": {
                        "$ref": "#/components/schemas/FieldCategory"
                    },
                    "content": {
                        "type": "string",
                        "description": "The value of the field.\n\nThe format of the value depends on its `category`.\n\nDates must be in YYYY-MM-DD format.\nThe \"Gender\" field can take only two values: `male`, `female`.\nCountry fields must be in ISO 3166-1 [alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3#Officially_assigned_code_elements) format.\nOther fields are plain strings.\n",
                        "example": "John"
                    },
                    "contentType": {
                        "$ref": "#/components/schemas/ContentType"
                    }
                },
                "required": [
                    "category",
                    "content"
                ],
                "additionalProperties": false
            },
            "FieldCategory": {
                "type": "string",
                "description": "The name of the field.\n\nThe naming convention for field names is \"the first word is capitalised, others are lowercased\".\n",
                "example": "First name"
            },
            "DocumentToVerify": {
                "type": "object",
                "properties": {
                    "issuingCountry": {
                        "$ref": "#/components/schemas/IssuingCountryCode"
                    },
                    "documentType": {
                        "$ref": "#/components/schemas/DocumentType"
                    },
                    "files": {
                        "description": "A photo of the main page of the document or two photos of both sides of a double-sided document.\n",
                        "type": "array",
                        "items": {
                            "$ref": "#/components/schemas/DocumentPageMediaFile"
                        },
                        "minItems": 1,
                        "maxItems": 2
                    }
                },
                "required": [
                    "files"
                ],
                "additionalProperties": false
            },
            "IssuingCountryCode": {
                "type": "string",
                "description": "The code of the issuing country of the document. Format: ISO 3166-1 [alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3#Officially_assigned_code_elements))\n",
                "pattern": "^[A-Z]{3}$",
                "example": "JPN"
            },
            "DocumentType": {
                "type": "string",
                "description": "The type of the document.",
                "enum": [
                    "passport",
                    "id-card",
                    "driving-licence",
                    "residence-permit",
                    "voter-card",
                    "tax-card",
                    "address-card",
                    "domestic-passport",
                    "unknown"
                ],
                "example": "id-card"
            },
            "DocumentPageKind": {
                "type": "string",
                "description": "A page of the document.\n* `front` is the front side of a two-sided document or the only provided page of a document\n* `back` is the back side of a two-sided document\n* `single-page` is the main page of a document that has only one page required for verification (e.g. most countries' passports)\n",
                "enum": [
                    "front",
                    "back",
                    "single-page"
                ],
                "example": "front"
            },
            "DocumentPageMediaFile": {
                "type": "object",
                "allOf": [
                    {
                        "type": "object",
                        "properties": {
                            "kind": {
                                "$ref": "#/components/schemas/DocumentPageKind"
                            }
                        },
                        "required": [
                            "kind"
                        ]
                    },
                    {
                        "$ref": "#/components/schemas/MediaFile"
                    }
                ],
                "additionalProperties": false
            },
            "MediaFile": {
                "type": "object",
                "properties": {
                    "uri": {
                        "description": "An image encoded to a base64 string.\n\nBoth JPEG and PNG images are acceptable.\nImages in PDF format are acceptable too.\n",
                        "type": "string",
                        "example": "data:image/png;base64,aGVsbG8="
                    }
                },
                "required": [
                    "uri"
                ],
                "additionalProperties": false
            },
            "DataExtraction": {
                "type": "string",
                "description": "The data extraction from the provided document.\n",
                "enum": [
                    "data-extraction"
                ]
            },
            "FaceMatching": {
                "type": "string",
                "description": "The biometric comparison of the person in the selfie and the person in the ID document photo.\n",
                "enum": [
                    "face-matching"
                ]
            },
            "Watchlists": {
                "type": "string",
                "description": "A detailed report of any records relevant to the applicant's profile data (First name, Last name, Date of birth) found during global AML watchlists' screening.\n",
                "enum": [
                    "watchlists"
                ]
            },
            "Liveness": {
                "type": "string",
                "description": "Identity check in live mode.\nThis check can be performed only if the GetID SDK was used for submitting the application.\n",
                "enum": [
                    "liveness"
                ]
            },
            "VerificationTypeToPerform": {
                "oneOf": [
                    {
                        "$ref": "#/components/schemas/DataExtraction"
                    },
                    {
                        "$ref": "#/components/schemas/FaceMatching"
                    },
                    {
                        "$ref": "#/components/schemas/Watchlists"
                    }
                ]
            },
            "VerificationTypesToPerform": {
                "type": "array",
                "description": "The list of checks requested.\nIf no list is set, then all types of checks that have been paid for will be performed.\n",
                "items": {
                    "$ref": "#/components/schemas/VerificationTypeToPerform"
                },
                "example": [
                    "data-extraction",
                    "face-matching",
                    "watchlists"
                ]
            },
            "ApplicationListResponse": {
                "allOf": [
                    {
                        "type": "object",
                        "properties": {
                            "applicationsListTotalItems": {
                                "type": "integer",
                                "description": "The total number of applications submitted.",
                                "example": 5
                            }
                        },
                        "required": [
                            "applicationsListTotalItems"
                        ],
                        "additionalProperties": false
                    },
                    {
                        "oneOf": [
                            {
                                "$ref": "#/components/schemas/ApplicationList"
                            },
                            {
                                "$ref": "#/components/schemas/ApplicationListIDs"
                            }
                        ]
                    }
                ]
            },
            "ApplicationList": {
                "type": "object",
                "properties": {
                    "applicationsList": {
                        "type": "array",
                        "description": "The list of submitted applications.\nThis field is omitted if the request contains `idsOnly=true`.\n",
                        "items": {
                            "$ref": "#/components/schemas/VerificationResult"
                        }
                    }
                },
                "required": [
                    "applicationsList"
                ],
                "additionalProperties": false
            },
            "ApplicationListIDs": {
                "type": "object",
                "properties": {
                    "applicationsListIds": {
                        "type": "array",
                        "description": "The list of submitted applications' IDs.\nThis field exists if the request contains `idsOnly=true`.\n",
                        "items": {
                            "$ref": "#/components/schemas/ApplicationID"
                        }
                    }
                },
                "required": [
                    "applicationsListIds"
                ],
                "additionalProperties": false
            },
            "ApplicationID": {
                "type": "string",
                "description": "The ID of the application.",
                "example": "5e62110968e3fb4d655756d1"
            },
            "VerificationResult": {
                "type": "object",
                "description": "The data that GetID provides as output for each application submitted.\n",
                "properties": {
                    "id": {
                        "$ref": "#/components/schemas/ApplicationID"
                    },
                    "metadata": {
                        "$ref": "#/components/schemas/Metadata"
                    },
                    "application": {
                        "$ref": "#/components/schemas/Application"
                    },
                    "verificationTypes": {
                        "$ref": "#/components/schemas/VerificationTypes"
                    },
                    "processingState": {
                        "$ref": "#/components/schemas/ApplicationProcessingState"
                    },
                    "overallResult": {
                        "$ref": "#/components/schemas/OverallResult"
                    },
                    "servicesResults": {
                        "$ref": "#/components/schemas/ServiceResults"
                    },
                    "comment": {
                        "$ref": "#/components/schemas/Comment"
                    },
                    "logs": {
                        "$ref": "#/components/schemas/Logs"
                    }
                },
                "required": [
                    "id",
                    "metadata",
                    "application",
                    "processingState"
                ]
            },
            "Metadata": {
                "type": "object",
                "description": "Meta information about the application.\nContains information passed with the application when submitting it using this API, or information added to the application by our SDK.\nAlso contains information added on our backend after receiving the application.\n",
                "properties": {
                    "externalId": {
                        "$ref": "#/components/schemas/SubmittedExternalID"
                    },
                    "labels": {
                        "allOf": [
                            {
                                "description": "The set of arbitrary key-value pairs passed as `labels` when submitting the application."
                            },
                            {
                                "$ref": "#/components/schemas/MetadataLabels"
                            }
                        ]
                    },
                    "platform": {
                        "$ref": "#/components/schemas/Platform"
                    },
                    "sdkVersion": {
                        "type": "string",
                        "description": "The version of the SDK that was used for submitting the application.",
                        "example": "6.8.2"
                    },
                    "createdAt": {
                        "allOf": [
                            {
                                "description": "The time when the application was created."
                            },
                            {
                                "$ref": "#/components/schemas/Timestamp"
                            }
                        ]
                    },
                    "ipAddress": {
                        "type": "string",
                        "description": "The IP address of the end-user that submitted the application using our SDK.",
                        "example": "74.50.8.152"
                    },
                    "country": {
                        "type": "string",
                        "description": "The country from which the user submitted the application. Determined by the IP address.",
                        "example": "EST"
                    },
                    "city": {
                        "type": "string",
                        "description": "The city from which the user submitted the application. Determined by the IP address.",
                        "example": "Tallinn"
                    },
                    "userAgent": {
                        "type": "string",
                        "description": "The user agent of the end-user that submitted the application using our SDK.",
                        "example": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/81.0.4044.122 Safari/537.36"
                    },
                    "author": {
                        "type": "string",
                        "description": "The username or email of the Administrative Portal's user that submitted the application using an \"internal flow\"."
                    },
                    "createdBy": {
                        "type": "string",
                        "description": "The SDK that was used to submit the application.\n\nThis field is primarily needed to separate `web-mobile` and `web-desktop`, because all applications submitted using our Web SDK belongs to the `web` platform.\n",
                        "enum": [
                            "web-desktop",
                            "web-mobile",
                            "android",
                            "ios"
                        ],
                        "example": "web-mobile"
                    },
                    "locale": {
                        "type": "string",
                        "description": "The locale of the end-user that submitted the application using our SDK.\n\nNote: different platforms use different separators and some locales contain more than two components.\nFor example, `en_GB` or `zh-Hans-CN` are also valid values.\n",
                        "example": "en-GB"
                    },
                    "flowName": {
                        "type": "string",
                        "description": "The name of the verification flow, if our SDK was used.\nOr the name of an \"internal flow\".\n",
                        "example": "getid-doc-selfie-liveness"
                    }
                }
            },
            "SubmittedExternalID": {
                "allOf": [
                    {
                        "description": "The value passed as `externalId` when submitting the application."
                    },
                    {
                        "$ref": "#/components/schemas/ExternalID"
                    }
                ]
            },
            "Platform": {
                "type": "string",
                "description": "The platform from which the application was submitted, if our SDK was used: `ios`, `android` or `web`.\nOr, if the application was submitted using the `POST api/v1/application` method, then the value is `API`.\nAlso, the value can be `internal` if the application was submitted using an \"internal flow\" in Administrative Portal.\n",
                "enum": [
                    "android",
                    "ios",
                    "web",
                    "API",
                    "internal"
                ],
                "example": "web"
            },
            "Timestamp": {
                "type": "string",
                "format": "date-time",
                "example": "2020-03-17T20:28:37.061Z"
            },
            "Application": {
                "type": "object",
                "description": "The data that have been provided for verification.\n",
                "properties": {
                    "fields": {
                        "$ref": "#/components/schemas/ProfileDataFields"
                    },
                    "documents": {
                        "type": "array",
                        "description": "The ID document provided by the applicant.",
                        "items": {
                            "$ref": "#/components/schemas/ResultDocument"
                        },
                        "minItems": 0,
                        "maxItems": 1
                    },
                    "selfie": {
                        "type": "object",
                        "description": "Temporary links to media files with the applicant's face.",
                        "properties": {
                            "files": {
                                "type": "array",
                                "items": {
                                    "$ref": "#/components/schemas/ResultFacesMedia"
                                },
                                "minItems": 0,
                                "maxItems": 3
                            }
                        },
                        "required": [
                            "files"
                        ],
                        "additionalProperties": false
                    }
                },
                "additionalProperties": false
            },
            "ResultDocument": {
                "type": "object",
                "properties": {
                    "issuingCountry": {
                        "$ref": "#/components/schemas/IssuingCountryCode"
                    },
                    "documentType": {
                        "$ref": "#/components/schemas/DocumentType"
                    },
                    "files": {
                        "description": "Temporary links to the photos of the ID document.",
                        "type": "array",
                        "items": {
                            "$ref": "#/components/schemas/ResultDocumentMedia"
                        },
                        "minItems": 1,
                        "maxItems": 2
                    }
                },
                "required": [
                    "files"
                ],
                "additionalProperties": false
            },
            "ResultMedia": {
                "type": "object",
                "properties": {
                    "id": {
                        "$ref": "#/components/schemas/MediaFileID"
                    },
                    "uri": {
                        "$ref": "#/components/schemas/MediaURI"
                    },
                    "mediaType": {
                        "type": "string",
                        "example": "image/jpeg"
                    }
                },
                "required": [
                    "id",
                    "uri"
                ],
                "additionalProperties": false
            },
            "MediaFileID": {
                "type": "string",
                "description": "The ID of the file.",
                "example": "416bc61f2b001c8871ab8e73"
            },
            "MediaURI": {
                "type": "string",
                "description": "A temporary link to the media file.",
                "format": "uri",
                "example": "https://some.site/image.jpeg?t=123"
            },
            "ResultDocumentMedia": {
                "allOf": [
                    {
                        "$ref": "#/components/schemas/ResultMedia"
                    },
                    {
                        "type": "object",
                        "properties": {
                            "kind": {
                                "$ref": "#/components/schemas/DocumentPageKind"
                            }
                        },
                        "required": [
                            "kind"
                        ],
                        "additionalProperties": false
                    }
                ]
            },
            "ResultFacesMedia": {
                "allOf": [
                    {
                        "$ref": "#/components/schemas/ResultMedia"
                    },
                    {
                        "type": "object",
                        "properties": {
                            "kind": {
                                "$ref": "#/components/schemas/FaceKind"
                            }
                        },
                        "required": [
                            "kind"
                        ],
                        "additionalProperties": false
                    }
                ]
            },
            "FaceKind": {
                "type": "string",
                "description": "The type of a media file with the applicant's face.\n* `selfie` is an image with a selfie of the applicant\n* `liveness-video` is a video recorded during the applicant's liveness check\n* `liveness-full-face` is an image taken during the liveness check\n",
                "enum": [
                    "selfie",
                    "liveness-video",
                    "liveness-full-face"
                ],
                "example": "selfie"
            },
            "VerificationTypes": {
                "type": "array",
                "description": "The list of checks performed.",
                "items": {
                    "oneOf": [
                        {
                            "$ref": "#/components/schemas/DataExtraction"
                        },
                        {
                            "$ref": "#/components/schemas/FaceMatching"
                        },
                        {
                            "$ref": "#/components/schemas/Watchlists"
                        },
                        {
                            "$ref": "#/components/schemas/Liveness"
                        }
                    ]
                },
                "example": [
                    "data-extraction",
                    "face-matching",
                    "liveness"
                ]
            },
            "ApplicationProcessingState": {
                "allOf": [
                    {
                        "description": "Indicates whether the verification of this application has been completed.\n\n* `processing` - the application is being processed\n* `done` - the verification has been completed\n"
                    },
                    {
                        "$ref": "#/components/schemas/ProcessingState"
                    }
                ]
            },
            "ServiceProcessingState": {
                "allOf": [
                    {
                        "description": "Indicates whether the check has been completed.\n\n* `processing` - the service is still performing the check\n* `done` - the check has been completed\n"
                    },
                    {
                        "$ref": "#/components/schemas/ProcessingState"
                    }
                ]
            },
            "ProcessingState": {
                "type": "string",
                "enum": [
                    "processing",
                    "done"
                ],
                "example": "done"
            },
            "OverallResult": {
                "type": "object",
                "description": "The summary of the result of the verification.\n",
                "properties": {
                    "status": {
                        "$ref": "#/components/schemas/ApplicationVerificationStatus"
                    },
                    "comments": {
                        "type": "array",
                        "description": "The list of checks performed and their brief results.",
                        "items": {
                            "$ref": "#/components/schemas/ServiceComment"
                        }
                    },
                    "concerns": {
                        "type": "array",
                        "description": "The list of all the issues found during all the checks.",
                        "items": {
                            "$ref": "#/components/schemas/ServiceConcern"
                        }
                    },
                    "validationDate": {
                        "allOf": [
                            {
                                "description": "The date and time of completion of the validation.\n"
                            },
                            {
                                "$ref": "#/components/schemas/Timestamp"
                            }
                        ]
                    }
                },
                "required": [
                    "status",
                    "comments",
                    "validationDate"
                ],
                "additionalProperties": false
            },
            "ServiceComment": {
                "type": "object",
                "properties": {
                    "service": {
                        "$ref": "#/components/schemas/Service"
                    },
                    "status": {
                        "allOf": [
                            {
                                "$ref": "#/components/schemas/ServiceVerificationStatus"
                            },
                            {
                                "example": "approved"
                            }
                        ]
                    },
                    "comment": {
                        "description": "A brief comment on the result of the check.",
                        "type": "string",
                        "example": "No issues found."
                    }
                },
                "required": [
                    "service",
                    "status"
                ]
            },
            "ServiceConcern": {
                "type": "object",
                "properties": {
                    "service": {
                        "$ref": "#/components/schemas/Service"
                    },
                    "status": {
                        "allOf": [
                            {
                                "description": "The level of severity of the issue according to the current settings of the verification rules.\n"
                            },
                            {
                                "$ref": "#/components/schemas/ServiceConcernStatus"
                            },
                            {
                                "example": "declined"
                            }
                        ]
                    },
                    "message": {
                        "description": "A brief description of the issue.",
                        "type": "string",
                        "example": "The photo is not a selfie."
                    }
                },
                "required": [
                    "service",
                    "status"
                ]
            },
            "Service": {
                "type": "string",
                "description": "The name of the service performed the check.",
                "enum": [
                    "doc-check",
                    "profile-check",
                    "face-matching",
                    "liveness",
                    "watchlists"
                ],
                "example": "face-matching"
            },
            "ApplicationVerificationStatus": {
                "allOf": [
                    {
                        "description": "The worst result of all the checks performed.\n\nA \"check\" in this context means checking a particular aspect of the application submitted.\nAll checks and their results can be found in `servicesResults` property of the verification result.\n\nThe worst result means the closest to the end of the following list: `approved`, `needs-review`, `declined`, `error`.\n\nThe result of most checks depends not only on the provided data, but also on the \"verification rules\" settings in the Administrative Portal.\n"
                    },
                    {
                        "$ref": "#/components/schemas/VerificationStatus"
                    }
                ]
            },
            "ServiceVerificationStatus": {
                "allOf": [
                    {
                        "description": "The result of the check.\n"
                    },
                    {
                        "$ref": "#/components/schemas/VerificationStatus"
                    }
                ]
            },
            "ServiceConcernStatus": {
                "oneOf": [
                    {
                        "$ref": "#/components/schemas/NeedsReview"
                    },
                    {
                        "$ref": "#/components/schemas/Declined"
                    }
                ]
            },
            "VerificationStatus": {
                "oneOf": [
                    {
                        "$ref": "#/components/schemas/Approved"
                    },
                    {
                        "$ref": "#/components/schemas/NeedsReview"
                    },
                    {
                        "$ref": "#/components/schemas/Declined"
                    },
                    {
                        "$ref": "#/components/schemas/Error"
                    }
                ]
            },
            "CheckStatus": {
                "allOf": [
                    {
                        "description": "The result of the check.\n"
                    },
                    {
                        "$ref": "#/components/schemas/VerificationStatus"
                    }
                ]
            },
            "BreakdownStatus": {
                "oneOf": [
                    {
                        "$ref": "#/components/schemas/Approved"
                    },
                    {
                        "$ref": "#/components/schemas/NeedsReview"
                    },
                    {
                        "$ref": "#/components/schemas/Declined"
                    },
                    {
                        "$ref": "#/components/schemas/Disabled"
                    }
                ]
            },
            "Approved": {
                "type": "string",
                "description": "No problems are found.\n",
                "enum": [
                    "approved"
                ]
            },
            "NeedsReview": {
                "type": "string",
                "description": "A problem detected which is not considered critical under the current settings of the verification rules.\n",
                "enum": [
                    "needs-review"
                ]
            },
            "Declined": {
                "type": "string",
                "description": "A problem detected which is considered critical under the current settings of the verification rules.\n",
                "enum": [
                    "declined"
                ]
            },
            "Error": {
                "type": "string",
                "description": "An error occurred, for example due to invalid input data.\n",
                "enum": [
                    "error"
                ]
            },
            "Disabled": {
                "type": "string",
                "description": "The check is disabled.\n",
                "enum": [
                    "disabled"
                ]
            },
            "ServiceResults": {
                "type": "object",
                "description": "The list of checks performed and their full results.",
                "properties": {
                    "docCheck": {
                        "$ref": "#/components/schemas/DocCheckServiceResult"
                    },
                    "profileCheck": {
                        "$ref": "#/components/schemas/ProfileCheckServiceResult"
                    },
                    "faceMatching": {
                        "$ref": "#/components/schemas/FaceMatchingServiceResult"
                    },
                    "livenessCheck": {
                        "$ref": "#/components/schemas/LivenessCheckServiceResult"
                    },
                    "watchlists": {
                        "$ref": "#/components/schemas/WatchlistsServiceResult"
                    }
                },
                "additionalProperties": false
            },
            "DocCheckServiceResult": {
                "type": "object",
                "description": "The result of the complex check of the provided ID document.\n",
                "properties": {
                    "verifier": {
                        "allOf": [
                            {
                                "$ref": "#/components/schemas/ServiceResultVerifier"
                            },
                            {
                                "example": "Doc-checker"
                            }
                        ]
                    },
                    "comment": {
                        "allOf": [
                            {
                                "$ref": "#/components/schemas/ServiceResultComment"
                            },
                            {
                                "example": "No issues found."
                            }
                        ]
                    },
                    "processingState": {
                        "$ref": "#/components/schemas/ServiceProcessingState"
                    },
                    "status": {
                        "$ref": "#/components/schemas/ServiceVerificationStatus"
                    },
                    "extracted": {
                        "$ref": "#/components/schemas/ExtractedData"
                    },
                    "documentDataChecking": {
                        "$ref": "#/components/schemas/DocumentDataChecking"
                    },
                    "documentPhotoQuality": {
                        "$ref": "#/components/schemas/DocumentPhotoQualityResult"
                    },
                    "originalDocumentPresence": {
                        "$ref": "#/components/schemas/OriginalDocumentPresenceResult"
                    },
                    "documentQuality": {
                        "$ref": "#/components/schemas/DocumentQualityResult"
                    },
                    "fraudAssessment": {
                        "$ref": "#/components/schemas/FraudAssessmentResult"
                    },
                    "dataExtractionConsistency": {
                        "$ref": "#/components/schemas/DataExtractionConsistencyResult"
                    }
                },
                "required": [
                    "processingState"
                ]
            },
            "ExtractedData": {
                "type": "object",
                "description": "The data extracted from the ID document.\n",
                "properties": {
                    "ocr": {
                        "type": "array",
                        "description": "The data extracted from the \"visual\" part of the ID document.",
                        "items": {
                            "$ref": "#/components/schemas/ExtractedDataField"
                        }
                    },
                    "mrz": {
                        "type": "array",
                        "description": "The data extracted from the Machine Readable Zone of the ID document.",
                        "items": {
                            "allOf": [
                                {
                                    "$ref": "#/components/schemas/ExtractedDataField"
                                },
                                {
                                    "type": "object",
                                    "properties": {
                                        "valid": {
                                            "type": "boolean",
                                            "example": true
                                        }
                                    }
                                }
                            ]
                        }
                    },
                    "images": {
                        "type": "array",
                        "description": "Images of different parts of the ID document.",
                        "items": {
                            "properties": {
                                "kind": {
                                    "type": "string",
                                    "example": "portrait"
                                },
                                "uri": {
                                    "$ref": "#/components/schemas/MediaURI"
                                },
                                "mediaType": {
                                    "type": "string",
                                    "example": "image/jpeg"
                                }
                            },
                            "additionalProperties": false,
                            "required": [
                                "kind",
                                "uri"
                            ]
                        }
                    }
                }
            },
            "ExtractedDataField": {
                "type": "object",
                "properties": {
                    "category": {
                        "$ref": "#/components/schemas/FieldCategory"
                    },
                    "content": {
                        "$ref": "#/components/schemas/ExtractedDataContent"
                    },
                    "contentType": {
                        "$ref": "#/components/schemas/ContentType"
                    }
                },
                "required": [
                    "category",
                    "content"
                ]
            },
            "ExtractedDataContent": {
                "type": "string",
                "description": "The value of the field.\n\nThe format of the value depends on its `category`.\n\nDates are in YYYY-MM-DD format.\nThe \"Gender\" field can take only two values: `male`, `female`.\nCountry fields are in ISO 3166-1 [alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3#Officially_assigned_code_elements) format.\nOther fields are plain strings.\n",
                "example": "John"
            },
            "DocumentDataChecking": {
                "type": "array",
                "description": "The result of comparison of values extracted from \"visual\" and MRZ parts of the ID document.\n",
                "items": {
                    "$ref": "#/components/schemas/DocumentDataCheckingItem"
                }
            },
            "DocumentDataCheckingItem": {
                "type": "object",
                "properties": {
                    "category": {
                        "$ref": "#/components/schemas/FieldCategory"
                    },
                    "mrz": {
                        "type": "string",
                        "description": "The value extracted from the Machine Readable Zone of the ID document.",
                        "example": "John"
                    },
                    "ocr": {
                        "type": "string",
                        "description": "The value extracted from the \"visual\" part of the ID document.",
                        "example": "John"
                    },
                    "equal": {
                        "type": "boolean",
                        "nullable": true,
                        "description": "Indicates whether the `mrz` and the `ocr` values are equal.\n\nNote: `null` means that no comparison has been performed.\n",
                        "example": true
                    },
                    "valid": {
                        "type": "boolean",
                        "description": "The result of the field value validation.",
                        "example": true
                    },
                    "status": {
                        "$ref": "#/components/schemas/CheckStatus"
                    },
                    "message": {
                        "type": "string",
                        "example": "Value is ok"
                    },
                    "conflicts": {
                        "description": "The list of conflicts found.",
                        "type": "array",
                        "items": {
                            "type": "string"
                        }
                    }
                },
                "required": [
                    "category",
                    "equal"
                ],
                "additionalProperties": false
            },
            "DocumentPhotoQualityResult": {
                "type": "object",
                "description": "The results of all the considerations related to the quality of the provided photo of the ID document.\n",
                "properties": {
                    "group": {
                        "type": "string",
                        "enum": [
                            "documentPhotoQuality"
                        ]
                    },
                    "description": {
                        "type": "string",
                        "example": "Document photo quality"
                    },
                    "considers": {
                        "type": "array",
                        "description": "The list of the considerations and their results.",
                        "items": {
                            "allOf": [
                                {
                                    "type": "object",
                                    "properties": {
                                        "name": {
                                            "$ref": "#/components/schemas/DocumentPhotoQualityConsiderationName"
                                        }
                                    },
                                    "additionalProperties": false
                                },
                                {
                                    "$ref": "#/components/schemas/Consideration"
                                }
                            ]
                        }
                    }
                },
                "required": [
                    "group",
                    "considers"
                ],
                "additionalProperties": false
            },
            "DocumentPhotoQualityConsiderationName": {
                "type": "string",
                "enum": [
                    "noDocumentInImage",
                    "supportedDocument",
                    "darkPhoto",
                    "glareOnPhoto",
                    "blurredPhoto",
                    "colourPicture",
                    "otherPhotoIssue"
                ],
                "example": "noDocumentInImage"
            },
            "OriginalDocumentPresenceResult": {
                "type": "object",
                "description": "The results of all the considerations related to the presence of the original ID document in the provided photo.\n",
                "properties": {
                    "group": {
                        "type": "string",
                        "enum": [
                            "originalDocumentPresence"
                        ]
                    },
                    "description": {
                        "type": "string",
                        "example": "Original document presence"
                    },
                    "considers": {
                        "type": "array",
                        "description": "The list of the considerations and their results.",
                        "items": {
                            "allOf": [
                                {
                                    "type": "object",
                                    "properties": {
                                        "name": {
                                            "$ref": "#/components/schemas/OriginalDocumentPresenceConsiderationName"
                                        }
                                    },
                                    "additionalProperties": false
                                },
                                {
                                    "$ref": "#/components/schemas/Consideration"
                                }
                            ]
                        }
                    }
                },
                "required": [
                    "group",
                    "considers"
                ],
                "additionalProperties": false
            },
            "OriginalDocumentPresenceConsiderationName": {
                "type": "string",
                "enum": [
                    "photoOfScreen",
                    "screenshot",
                    "documentOnPrintedPaper",
                    "scan"
                ],
                "example": "photoOfScreen"
            },
            "DocumentQualityResult": {
                "type": "object",
                "description": "The results of all the considerations related to the quality and the integrity of the provided ID document.\n",
                "properties": {
                    "group": {
                        "type": "string",
                        "enum": [
                            "documentQuality"
                        ]
                    },
                    "description": {
                        "type": "string",
                        "example": "Document quality"
                    },
                    "considers": {
                        "type": "array",
                        "description": "The list of the considerations and their results.",
                        "items": {
                            "allOf": [
                                {
                                    "type": "object",
                                    "properties": {
                                        "name": {
                                            "$ref": "#/components/schemas/DocumentQualityConsiderationName"
                                        }
                                    },
                                    "additionalProperties": false
                                },
                                {
                                    "$ref": "#/components/schemas/Consideration"
                                }
                            ]
                        }
                    }
                },
                "required": [
                    "group",
                    "considers"
                ],
                "additionalProperties": false
            },
            "DocumentQualityConsiderationName": {
                "type": "string",
                "enum": [
                    "twoDocumentsUploaded",
                    "incorrectSide",
                    "missingBack",
                    "cutOffDocument",
                    "coveredphoto",
                    "cornerRemoved",
                    "puncturedDocument",
                    "damagedDocument",
                    "obscuredDataPoints",
                    "obscuredSecurityFeatures",
                    "abnormalDocumentFeatures",
                    "watermarksDigitalTextOverlay",
                    "digitalDocument"
                ],
                "example": "cornerRemoved"
            },
            "FraudAssessmentResult": {
                "type": "object",
                "description": "The results of all the considerations related to the visual authenticity of the ID document.\n",
                "properties": {
                    "group": {
                        "type": "string",
                        "enum": [
                            "fraudAssessment"
                        ]
                    },
                    "description": {
                        "type": "string",
                        "example": "Fraud assessment"
                    },
                    "considers": {
                        "type": "array",
                        "description": "The list of the considerations and their results.",
                        "items": {
                            "allOf": [
                                {
                                    "type": "object",
                                    "properties": {
                                        "name": {
                                            "$ref": "#/components/schemas/FraudAssessmentConsiderationName"
                                        }
                                    },
                                    "additionalProperties": false
                                },
                                {
                                    "$ref": "#/components/schemas/Consideration"
                                }
                            ]
                        }
                    }
                },
                "required": [
                    "group",
                    "considers"
                ],
                "additionalProperties": false
            },
            "FraudAssessmentConsiderationName": {
                "type": "string",
                "enum": [
                    "template",
                    "faceDetection",
                    "pictureFaceIntegrity",
                    "digitalTampering",
                    "fonts",
                    "securityFeatures"
                ],
                "example": "digitalTampering"
            },
            "DataExtractionConsistencyResult": {
                "type": "object",
                "description": "The results of all the considerations related to the consistency and validity of the data extracted from the ID document.\n",
                "properties": {
                    "group": {
                        "type": "string",
                        "enum": [
                            "dataExtractionConsistency"
                        ]
                    },
                    "description": {
                        "type": "string",
                        "example": "Consistency and validity of extracted data"
                    },
                    "considers": {
                        "type": "array",
                        "description": "The list of the considerations and their results.",
                        "items": {
                            "allOf": [
                                {
                                    "type": "object",
                                    "properties": {
                                        "name": {
                                            "$ref": "#/components/schemas/DataExtractionConsistencyConsiderationName"
                                        }
                                    },
                                    "additionalProperties": false
                                },
                                {
                                    "$ref": "#/components/schemas/Consideration"
                                }
                            ]
                        }
                    }
                },
                "required": [
                    "group",
                    "considers"
                ],
                "additionalProperties": false
            },
            "DataExtractionConsistencyConsiderationName": {
                "type": "string",
                "enum": [
                    "ageVerification",
                    "First name",
                    "Last name",
                    "Date of birth",
                    "Date of expiry",
                    "Document number",
                    "Personal number",
                    "MRZ full"
                ],
                "example": "First name"
            },
            "ProfileCheckServiceResult": {
                "type": "object",
                "description": "The result of the comparison of the applicant's profile data that was provided using this API or collected using our SDK with the data extracted from the ID document.\n",
                "properties": {
                    "verifier": {
                        "allOf": [
                            {
                                "$ref": "#/components/schemas/ServiceResultVerifier"
                            },
                            {
                                "example": "Profile-checker"
                            }
                        ]
                    },
                    "comment": {
                        "allOf": [
                            {
                                "$ref": "#/components/schemas/ServiceResultComment"
                            },
                            {
                                "example": "No issues found."
                            }
                        ]
                    },
                    "processingState": {
                        "$ref": "#/components/schemas/ServiceProcessingState"
                    },
                    "status": {
                        "$ref": "#/components/schemas/ServiceVerificationStatus"
                    },
                    "formCompare": {
                        "$ref": "#/components/schemas/FormCompareResult"
                    },
                    "matchLocation": {
                        "$ref": "#/components/schemas/MatchLocationResult"
                    },
                    "fieldChecking": {
                        "$ref": "#/components/schemas/FieldChecking"
                    }
                }
            },
            "FormCompareResult": {
                "type": "object",
                "description": "The result of comparison of the applicant's profile data and the data extracted from the document.\n",
                "properties": {
                    "group": {
                        "type": "string",
                        "enum": [
                            "formCompare"
                        ]
                    },
                    "description": {
                        "type": "string",
                        "example": "Comparison of the applicant's profile data with the data extracted from the document"
                    },
                    "considers": {
                        "type": "array",
                        "description": "The list of the considerations and their results.",
                        "items": {
                            "allOf": [
                                {
                                    "type": "object",
                                    "properties": {
                                        "name": {
                                            "$ref": "#/components/schemas/FormCompareConsiderationName"
                                        }
                                    },
                                    "additionalProperties": false
                                },
                                {
                                    "$ref": "#/components/schemas/Consideration"
                                }
                            ]
                        }
                    }
                },
                "required": [
                    "group",
                    "considers"
                ],
                "additionalProperties": false
            },
            "FormCompareConsiderationName": {
                "type": "string",
                "enum": [
                    "First name",
                    "Last name",
                    "Date of birth",
                    "Issue country",
                    "Document type",
                    "Date of issue",
                    "Date of expiry",
                    "Nationality",
                    "Nationality code",
                    "Gender",
                    "Document number",
                    "Personal number",
                    "Place of birth",
                    "Place of issue"
                ],
                "example": "First name"
            },
            "MatchLocationResult": {
                "type": "object",
                "description": "The result of comparison of the applicant's current location with the profile data.\n\nThis check can only be performed using the GetID SDK.\n",
                "properties": {
                    "group": {
                        "type": "string",
                        "enum": [
                            "matchLocation"
                        ]
                    },
                    "description": {
                        "type": "string",
                        "example": "Comparison of the applicant's location with the profile data"
                    },
                    "considers": {
                        "type": "array",
                        "description": "The list of the considerations and their results.",
                        "items": {
                            "allOf": [
                                {
                                    "type": "object",
                                    "properties": {
                                        "name": {
                                            "$ref": "#/components/schemas/MatchLocationConsiderationName"
                                        }
                                    },
                                    "additionalProperties": false
                                },
                                {
                                    "$ref": "#/components/schemas/Consideration"
                                }
                            ]
                        }
                    }
                },
                "required": [
                    "group",
                    "considers"
                ],
                "additionalProperties": false
            },
            "MatchLocationConsiderationName": {
                "type": "string",
                "enum": [
                    "Country of residence",
                    "City of residence"
                ],
                "example": "Country of residence"
            },
            "FieldChecking": {
                "type": "array",
                "description": "The result of comparing the profile data and the data extracted from the ID document.",
                "items": {
                    "$ref": "#/components/schemas/FieldCheckingItem"
                }
            },
            "FieldCheckingItem": {
                "type": "object",
                "properties": {
                    "category": {
                        "$ref": "#/components/schemas/FieldCategory"
                    },
                    "field": {
                        "type": "string",
                        "description": "The value provided as profile data.",
                        "example": "John"
                    },
                    "extracted": {
                        "type": "string",
                        "description": "The value extracted from the ID document.",
                        "example": "John"
                    },
                    "equal": {
                        "type": "boolean",
                        "description": "Indicates whether the `field` and the `extracted` values are equal.",
                        "example": true
                    },
                    "status": {
                        "$ref": "#/components/schemas/CheckStatus"
                    }
                },
                "required": [
                    "category",
                    "field",
                    "extracted",
                    "equal",
                    "status"
                ],
                "additionalProperties": false
            },
            "FaceMatchingServiceResult": {
                "type": "object",
                "description": "The result of the biometric comparison of the person who takes a selfie and/or passes the liveness check and the person in the ID document photo.\n",
                "properties": {
                    "verifier": {
                        "allOf": [
                            {
                                "$ref": "#/components/schemas/ServiceResultVerifier"
                            },
                            {
                                "example": "Face-checker"
                            }
                        ]
                    },
                    "comment": {
                        "allOf": [
                            {
                                "$ref": "#/components/schemas/ServiceResultComment"
                            },
                            {
                                "example": "No issues found."
                            }
                        ]
                    },
                    "processingState": {
                        "$ref": "#/components/schemas/ServiceProcessingState"
                    },
                    "status": {
                        "$ref": "#/components/schemas/ServiceVerificationStatus"
                    },
                    "results": {
                        "$ref": "#/components/schemas/FaceMatchingResult"
                    },
                    "settings": {
                        "type": "object",
                        "description": "The settings that determine the result of the check.\nIf both thresholds are equal, the `status` can only be `declined` or `approved`.\n",
                        "properties": {
                            "declineThreshold": {
                                "description": "The threshold between `declined` and `needs-review` statuses.",
                                "type": "number",
                                "example": 0.4
                            },
                            "needsReviewThreshold": {
                                "description": "The threshold between `needs-review` and `approved` statuses.",
                                "type": "number",
                                "example": 0.6
                            }
                        }
                    }
                },
                "required": [
                    "processingState"
                ],
                "additionalProperties": false
            },
            "FaceMatchingResult": {
                "type": "array",
                "description": "The result of the biometric comparison of the faces in the images provided.",
                "minItems": 1,
                "maxItems": 1,
                "items": {
                    "properties": {
                        "files": {
                            "description": "The list of IDs of files participated in the comparison.",
                            "type": "array",
                            "minItems": 2,
                            "maxItems": 3,
                            "uniqueItems": true,
                            "items": {
                                "type": "string"
                            },
                            "example": [
                                "face-abc1",
                                "document-photo-qwe7"
                            ]
                        },
                        "selfieQuality": {
                            "$ref": "#/components/schemas/SelfieQualityResult"
                        },
                        "score": {
                            "description": "A number indicating the level of similarity of faces.",
                            "type": "number",
                            "example": 0.3
                        }
                    },
                    "required": [
                        "score",
                        "files"
                    ],
                    "additionalProperties": false
                }
            },
            "SelfieQualityResult": {
                "type": "object",
                "description": "The results of all the considerations related to the provided selfie and/or the image captured during the liveness check.\n",
                "properties": {
                    "group": {
                        "type": "string",
                        "enum": [
                            "selfieQuality"
                        ]
                    },
                    "description": {
                        "type": "string"
                    },
                    "considers": {
                        "type": "array",
                        "description": "The list of the considerations and their results.",
                        "items": {
                            "allOf": [
                                {
                                    "type": "object",
                                    "properties": {
                                        "name": {
                                            "$ref": "#/components/schemas/SelfieQualityConsiderationName"
                                        }
                                    },
                                    "additionalProperties": false
                                },
                                {
                                    "$ref": "#/components/schemas/Consideration"
                                }
                            ]
                        }
                    }
                },
                "required": [
                    "group",
                    "considers"
                ],
                "additionalProperties": false
            },
            "SelfieQualityConsiderationName": {
                "type": "string",
                "enum": [
                    "multipleFacesFound",
                    "photoNotProvided",
                    "matchLiveness",
                    "isSelfie"
                ],
                "example": "multipleFacesFound"
            },
            "LivenessCheckServiceResult": {
                "type": "object",
                "description": "The result of the liveness check.\n\nThis check can only be performed using the GetID SDK.\nIt's not possible to perform this check submitting the application using the API.\n",
                "properties": {
                    "verifier": {
                        "allOf": [
                            {
                                "$ref": "#/components/schemas/ServiceResultVerifier"
                            },
                            {
                                "example": "Liveness service"
                            }
                        ]
                    },
                    "comment": {
                        "allOf": [
                            {
                                "$ref": "#/components/schemas/ServiceResultComment"
                            },
                            {
                                "example": "Liveness check passed."
                            }
                        ]
                    },
                    "processingState": {
                        "$ref": "#/components/schemas/ServiceProcessingState"
                    },
                    "status": {
                        "$ref": "#/components/schemas/ServiceVerificationStatus"
                    },
                    "livenessCheck": {
                        "$ref": "#/components/schemas/LivenessCheckResult"
                    }
                },
                "required": [
                    "processingState",
                    "status"
                ],
                "additionalProperties": false
            },
            "LivenessCheckResult": {
                "type": "object",
                "description": "The results of all the considerations related to the liveness check.\n",
                "properties": {
                    "group": {
                        "type": "string",
                        "enum": [
                            "livenessCheck"
                        ]
                    },
                    "description": {
                        "type": "string",
                        "example": "Identity check in live mode"
                    },
                    "considers": {
                        "type": "array",
                        "description": "The list of the considerations and their results.",
                        "items": {
                            "allOf": [
                                {
                                    "type": "object",
                                    "properties": {
                                        "name": {
                                            "$ref": "#/components/schemas/LivenessConsiderationName"
                                        }
                                    },
                                    "additionalProperties": false
                                },
                                {
                                    "$ref": "#/components/schemas/Consideration"
                                }
                            ]
                        }
                    }
                },
                "required": [
                    "group",
                    "considers"
                ],
                "additionalProperties": false
            },
            "Consideration": {
                "type": "object",
                "properties": {
                    "type": {
                        "allOf": [
                            {
                                "description": "The result of the \"consideration\"."
                            },
                            {
                                "$ref": "#/components/schemas/ConsiderationResult"
                            }
                        ]
                    },
                    "status": {
                        "allOf": [
                            {
                                "description": "The result of the check.\n\nDepends on the result of the \"consideration\" and the current settings of the verification rules.\n\nIf the result of the \"consideration\" is `clear` then the `stutus` is `approved`. Otherwise, the `status` is `needs-review`, `declined` or `disabled`.\n"
                            },
                            {
                                "$ref": "#/components/schemas/BreakdownStatus"
                            }
                        ]
                    },
                    "description": {
                        "type": "string",
                        "description": "A description of the check."
                    }
                },
                "required": [
                    "type",
                    "status"
                ],
                "additionalProperties": false
            },
            "LivenessConsiderationName": {
                "type": "string",
                "enum": [
                    "livenessCheckPassed",
                    "livenessServiceSignatureMatch"
                ],
                "example": "livenessCheckPassed"
            },
            "ServiceResultVerifier": {
                "type": "string",
                "description": "The name of the service performed the check."
            },
            "ServiceResultComment": {
                "type": "string",
                "description": "A brief description of the result of the check."
            },
            "ConsiderationResult": {
                "oneOf": [
                    {
                        "$ref": "#/components/schemas/Clear"
                    },
                    {
                        "$ref": "#/components/schemas/Consider"
                    }
                ]
            },
            "Clear": {
                "type": "string",
                "description": "No problems are found.",
                "enum": [
                    "clear"
                ]
            },
            "Consider": {
                "type": "string",
                "description": "A problem detected.",
                "enum": [
                    "consider"
                ]
            },
            "WatchlistsServiceResult": {
                "type": "object",
                "description": "A detailed report of any records relevant to the applicant's profile data (First name, Last name, Date of birth) found during global AML watchlists' screening.\n",
                "properties": {
                    "verifier": {
                        "allOf": [
                            {
                                "$ref": "#/components/schemas/ServiceResultVerifier"
                            },
                            {
                                "example": "Watchlists-checker"
                            }
                        ]
                    },
                    "comment": {
                        "allOf": [
                            {
                                "$ref": "#/components/schemas/ServiceResultComment"
                            },
                            {
                                "example": "No issues found."
                            }
                        ]
                    },
                    "processingState": {
                        "$ref": "#/components/schemas/ServiceProcessingState"
                    },
                    "status": {
                        "$ref": "#/components/schemas/ServiceVerificationStatus"
                    },
                    "sentFields": {
                        "type": "array",
                        "items": {
                            "type": "string"
                        },
                        "description": "A list of the profile data fields that have been used to search for records in the watchlists.",
                        "example": [
                            "First name",
                            "Last name",
                            "Date of birth"
                        ]
                    },
                    "summary": {
                        "$ref": "#/components/schemas/WatchlistsSummary"
                    },
                    "records": {
                        "type": "array",
                        "description": "Records from AML watchlists can have any structure.",
                        "items": {
                            "$ref": "#/components/schemas/WatchlistsRecord"
                        }
                    }
                },
                "required": [
                    "processingState"
                ],
                "additionalProperties": false
            },
            "WatchlistsSummary": {
                "type": "object",
                "description": "The results of all the considerations related to the global AML watchlists' screening.\n",
                "properties": {
                    "group": {
                        "type": "string",
                        "enum": [
                            "watchlists"
                        ]
                    },
                    "description": {
                        "type": "string"
                    },
                    "considers": {
                        "type": "array",
                        "description": "The list of the considerations and their results.",
                        "items": {
                            "allOf": [
                                {
                                    "type": "object",
                                    "properties": {
                                        "name": {
                                            "$ref": "#/components/schemas/WatchlistsConsideration"
                                        }
                                    },
                                    "additionalProperties": false
                                },
                                {
                                    "$ref": "#/components/schemas/Consideration"
                                }
                            ]
                        }
                    }
                },
                "required": [
                    "group",
                    "considers"
                ],
                "additionalProperties": false
            },
            "WatchlistsConsideration": {
                "type": "string",
                "enum": [
                    "peps",
                    "sanctions",
                    "aMedia",
                    "other"
                ],
                "example": "peps"
            },
            "WatchlistsRecord": {
                "type": "object"
            },
            "ContentType": {
                "type": "string",
                "description": "A type of a profile data field content. Deprecated.",
                "enum": [
                    "string",
                    "number",
                    "sex",
                    "date",
                    "country",
                    "boolean"
                ]
            },
            "Comment": {
                "type": "object",
                "description": "A user's comment.",
                "properties": {
                    "text": {
                        "$ref": "#/components/schemas/CommentText"
                    },
                    "author": {
                        "type": "string",
                        "description": "The login of the comment's author.",
                        "example": "admin"
                    },
                    "createdAt": {
                        "type": "string",
                        "description": "The date and time of the comment's creation.",
                        "format": "date-time",
                        "example": "2020-03-17T20:28:37.061Z"
                    }
                }
            },
            "CommentText": {
                "type": "string",
                "description": "The text of the comment.",
                "example": "Everything's OK"
            },
            "Logs": {
                "type": "array",
                "description": "A list of events occurred with the application.\n",
                "items": {
                    "type": "object",
                    "properties": {
                        "action": {
                            "type": "string",
                            "description": "The type of the event.",
                            "enum": [
                                "application_created",
                                "application_processed",
                                "verifications_completed",
                                "application_viewed",
                                "application_removed",
                                "application_deletion_scheduled",
                                "application_deletion_canceled",
                                "comment_changed",
                                "problem_reported",
                                "pdf_downloaded",
                                "status_changed"
                            ],
                            "example": "application_created"
                        },
                        "user": {
                            "type": "string",
                            "description": "The login of the user initiated the event.\nOr, if there is no such person, but event was triggered by the GetID system itself then the value is \"System\".\n",
                            "example": "System"
                        },
                        "comment": {
                            "type": "string",
                            "description": "A brief description of the event.",
                            "example": "The application has been created."
                        },
                        "time": {
                            "allOf": [
                                {
                                    "description": "The time when the event occured."
                                },
                                {
                                    "$ref": "#/components/schemas/Timestamp"
                                }
                            ]
                        }
                    },
                    "required": [
                        "action",
                        "user",
                        "time"
                    ],
                    "additionalProperties": false
                }
            },
            "ApplicationValidationError": {
                "type": "object",
                "properties": {
                    "keyword": {
                        "type": "string",
                        "description": "Describes the type of validation that wasn't passed. Examples: required, type, format, pattern.\n",
                        "example": "pattern"
                    },
                    "dataPath": {
                        "type": "string",
                        "description": "The path to the invalid data.",
                        "example": ".application.documents[0].issuingCountry"
                    },
                    "schemaPath": {
                        "type": "string",
                        "description": "The reference to the schema.",
                        "example": "#/components/schemas/ApplicationToVerify/properties/documents/items/properties/issuingCountry/pattern"
                    },
                    "params": {
                        "type": "object",
                        "example": {
                            "pattern": "^[A-Z]{3}$"
                        }
                    },
                    "message": {
                        "type": "string",
                        "description": "A human-readable description of the error.",
                        "example": "It should match the pattern \"^[A-Z]{3}$\"."
                    }
                },
                "additionalProperties": false
            },
            "CommentToSet": {
                "type": "object",
                "properties": {
                    "text": {
                        "$ref": "#/components/schemas/CommentText"
                    }
                },
                "required": [
                    "text"
                ]
            },
            "StatusToSet": {
                "type": "object",
                "properties": {
                    "status": {
                        "type": "string",
                        "description": "The new status of the application.",
                        "enum": [
                            "approved",
                            "needs-review",
                            "declined"
                        ]
                    }
                },
                "required": [
                    "status"
                ]
            },
            "SDKConfiguration": {
                "type": "object",
                "properties": {
                    "locale": {
                        "allOf": [
                            {
                                "description": "A locale identifier. The SDK uses the specified locale as the default one.\n\nThe actual list of supported locales can be obtained using `GET /sdk/v2/locales` method.\n"
                            },
                            {
                                "$ref": "#/components/schemas/LocaleIdentifier"
                            }
                        ]
                    },
                    "profile": {
                        "type": "object",
                        "description": "The profile data of the applicant.\n\nThe keys are the names of the profile data fields.\nYou can pass the data you know about the user.\nIt can be fields we check like `First name`, `Last name` or `Date of birth`, and just an arbitrary information.\n\nThe format of the value depends on the type of the field.\nFor more information on the profile data fields, see the description of the application to verify.\n",
                        "example": {
                            "First name": "John",
                            "Last name": "Doe",
                            "Date of birth": "1985-11-22"
                        }
                    },
                    "redirects": {
                        "type": "object",
                        "description": "URLs to redirect the user after completing the verification flow.",
                        "properties": {
                            "onComplete": {
                                "type": "string",
                                "description": "A URL to redirect to if the user has successfully passed the verification flow.",
                                "example": "https://google.com"
                            },
                            "onFail": {
                                "type": "string",
                                "description": "A URL to redirect to if the user has not passed the verification flow.",
                                "example": "https://google.com"
                            }
                        }
                    },
                    "ttl": {
                        "type": "integer",
                        "format": "int32",
                        "description": "Time to live of the link, in minutes.",
                        "example": 600
                    },
                    "metadata": {
                        "type": "object",
                        "description": "Meta information about the application.",
                        "properties": {
                            "labels": {
                                "$ref": "#/components/schemas/MetadataLabels"
                            }
                        }
                    }
                }
            },
            "LocaleIdentifier": {
                "type": "string",
                "example": "pt_BR"
            },
            "TranslationDictionariesToCreate": {
                "type": "object",
                "properties": {
                    "dictionaries": {
                        "type": "array",
                        "items": {
                            "$ref": "#/components/schemas/TranslationDictionary"
                        }
                    }
                },
                "required": [
                    "dictionaries"
                ],
                "additionalProperties": false
            },
            "TranslationDictionary": {
                "type": "object",
                "properties": {
                    "dictionary": {
                        "$ref": "#/components/schemas/TranslationDictionaryName"
                    },
                    "locale": {
                        "allOf": [
                            {
                                "description": "A locale identifier."
                            },
                            {
                                "$ref": "#/components/schemas/LocaleIdentifier"
                            }
                        ]
                    },
                    "items": {
                        "type": "object",
                        "description": "A set of key-value pairs.",
                        "additionalProperties": {
                            "type": "string"
                        },
                        "example": {
                            "global_shared_next": "Go next"
                        }
                    }
                },
                "required": [
                    "dictionary",
                    "locale",
                    "items"
                ]
            },
            "TranslationDictionaryName": {
                "type": "string",
                "description": "The name of a translations dictionary.",
                "example": "my-translations"
            },
            "TranslationDictionaryListResponse": {
                "type": "object",
                "properties": {
                    "dictionaries": {
                        "type": "array",
                        "items": {
                            "$ref": "#/components/schemas/TranslationDictionary"
                        }
                    }
                },
                "required": [
                    "dictionaries"
                ],
                "additionalProperties": false
            },
            "APITokenToCreate": {
                "type": "object",
                "properties": {
                    "ttl": {
                        "type": "integer",
                        "description": "Time to live for the API token in seconds. The default value is 86400 (24 hours).",
                        "example": 86400
                    },
                    "accessLevel": {
                        "enum": [
                            "root"
                        ],
                        "type": "string",
                        "description": "A token created with `root` access level can be used to retrieve any submitted application."
                    }
                },
                "additionalProperties": false
            },
            "ResponseCode200": {
                "type": "object",
                "properties": {
                    "responseCode": {
                        "type": "integer",
                        "enum": [
                            200
                        ]
                    }
                },
                "required": [
                    "responseCode"
                ]
            },
            "ResponseCode400": {
                "type": "object",
                "properties": {
                    "responseCode": {
                        "type": "integer",
                        "enum": [
                            400
                        ]
                    }
                },
                "required": [
                    "responseCode"
                ]
            }
        }
    }
}