From 851174a47ea85f692e9b0a257a48d658eb91ac1a Mon Sep 17 00:00:00 2001 From: Bruno Hanus <79256579+Bruniiik@users.noreply.github.com> Date: Fri, 30 Aug 2024 20:19:47 +0200 Subject: [PATCH] Release swagger documentation and postman collection for version 1.42.0 --- api/swagger.json | 1098 ++++++++++++++++++++++++++-------------------- 1 file changed, 630 insertions(+), 468 deletions(-) diff --git a/api/swagger.json b/api/swagger.json index 39a28f7..7b95cf6 100644 --- a/api/swagger.json +++ b/api/swagger.json @@ -2,7 +2,7 @@ "openapi": "3.0.1", "info": { "title": "Digital Identity Service API", - "version": "1.41.0" + "version": "1.42.0" }, "servers": [ { @@ -112,8 +112,8 @@ } } }, - "400": { - "description": "Bad request\n\nPossible error codes:\n - INVALID_ID\n - INVALID_REQUEST_BODY\n - INVALID_IMAGE", + "409": { + "description": "Conflict\n\nPossible error codes:\n - CONFLICT", "content": { "application/json": { "schema": { @@ -122,8 +122,8 @@ } } }, - "409": { - "description": "Conflict\n\nPossible error codes:\n - CONFLICT", + "500": { + "description": "Internal Server Error\n\nPossible error codes:\n - UNEXPECTED_ERROR", "content": { "application/json": { "schema": { @@ -132,8 +132,8 @@ } } }, - "500": { - "description": "Internal Server Error\n\nPossible error codes:\n - UNEXPECTED_ERROR", + "400": { + "description": "Bad request\n\nPossible error codes:\n - INVALID_ID\n - INVALID_REQUEST_BODY\n - INVALID_IMAGE", "content": { "application/json": { "schema": { @@ -166,12 +166,6 @@ } ], "responses": { - "403": { - "description": "Forbidden" - }, - "401": { - "description": "Unauthorized" - }, "400": { "description": "Bad request\n\nPossible error codes:\n - INVALID_ID", "content": { @@ -192,6 +186,12 @@ } } }, + "403": { + "description": "Forbidden" + }, + "401": { + "description": "Unauthorized" + }, "204": { "description": "No Content" } @@ -231,8 +231,8 @@ } } }, - "404": { - "description": "Not found\n\nPossible error codes:\n - NOT_FOUND", + "400": { + "description": "Bad request\n\nPossible error codes:\n - INVALID_ID", "content": { "application/json": { "schema": { @@ -241,14 +241,8 @@ } } }, - "403": { - "description": "Forbidden" - }, - "401": { - "description": "Unauthorized" - }, - "400": { - "description": "Bad request\n\nPossible error codes:\n - INVALID_ID", + "404": { + "description": "Not found\n\nPossible error codes:\n - NOT_FOUND", "content": { "application/json": { "schema": { @@ -276,6 +270,12 @@ } } } + }, + "403": { + "description": "Forbidden" + }, + "401": { + "description": "Unauthorized" } }, "security": [ @@ -301,12 +301,6 @@ } ], "responses": { - "403": { - "description": "Forbidden" - }, - "401": { - "description": "Unauthorized" - }, "400": { "description": "Bad request\n\nPossible error codes:\n - INVALID_ID", "content": { @@ -327,6 +321,12 @@ } } }, + "403": { + "description": "Forbidden" + }, + "401": { + "description": "Unauthorized" + }, "204": { "description": "No Content" } @@ -376,16 +376,6 @@ } } }, - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LivenessChallengeResponse" - } - } - } - }, "404": { "description": "Not found\n\nPossible error codes:\n - NOT_FOUND", "content": { @@ -396,12 +386,6 @@ } } }, - "403": { - "description": "Forbidden" - }, - "401": { - "description": "Unauthorized" - }, "409": { "description": "Conflict\n\nPossible error codes:\n - CONFLICT", "content": { @@ -421,6 +405,22 @@ } } } + }, + "403": { + "description": "Forbidden" + }, + "401": { + "description": "Unauthorized" + }, + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LivenessChallengeResponse" + } + } + } } }, "security": [ @@ -468,32 +468,26 @@ } } }, - "404": { - "description": "Not found\n\nPossible error codes:\n - NOT_FOUND", + "200": { + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/CreateDocumentResponse" } } } }, - "200": { - "description": "OK", + "404": { + "description": "Not found\n\nPossible error codes:\n - NOT_FOUND", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CreateDocumentResponse" + "$ref": "#/components/schemas/ErrorResponse" } } } }, - "403": { - "description": "Forbidden" - }, - "401": { - "description": "Unauthorized" - }, "409": { "description": "Conflict\n\nPossible error codes:\n - CONFLICT", "content": { @@ -513,6 +507,12 @@ } } } + }, + "403": { + "description": "Forbidden" + }, + "401": { + "description": "Unauthorized" } }, "security": [ @@ -538,12 +538,6 @@ } ], "responses": { - "403": { - "description": "Forbidden" - }, - "401": { - "description": "Unauthorized" - }, "400": { "description": "Bad request\n\nPossible error codes:\n - INVALID_ID", "content": { @@ -564,6 +558,12 @@ } } }, + "403": { + "description": "Forbidden" + }, + "401": { + "description": "Unauthorized" + }, "204": { "description": "No Content" } @@ -615,16 +615,6 @@ "401": { "description": "Unauthorized" }, - "404": { - "description": "Not found\n\nPossible error codes:\n - NOT_FOUND", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, "200": { "description": "OK", "content": { @@ -635,8 +625,8 @@ } } }, - "400": { - "description": "Bad request\n\nPossible error codes:\n - INVALID_ID\n - INVALID_REQUEST_BODY\n - INVALID_IMAGE", + "404": { + "description": "Not found\n\nPossible error codes:\n - NOT_FOUND", "content": { "application/json": { "schema": { @@ -664,6 +654,16 @@ } } } + }, + "400": { + "description": "Bad request\n\nPossible error codes:\n - INVALID_ID\n - INVALID_REQUEST_BODY\n - INVALID_IMAGE", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } } }, "security": [ @@ -691,16 +691,22 @@ "required": true }, "responses": { - "200": { - "description": "OK", + "500": { + "description": "Internal Server Error\n\nPossible error codes:\n - UNEXPECTED_ERROR", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CreateSessionResponse" + "$ref": "#/components/schemas/ErrorResponse" } } } }, + "403": { + "description": "Forbidden" + }, + "401": { + "description": "Unauthorized" + }, "400": { "description": "Bad request\n\nPossible error codes:\n - INVALID_REQUEST_BODY", "content": { @@ -711,18 +717,12 @@ } } }, - "403": { - "description": "Forbidden" - }, - "401": { - "description": "Unauthorized" - }, - "500": { - "description": "Internal Server Error\n\nPossible error codes:\n - UNEXPECTED_ERROR", + "200": { + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/CreateSessionResponse" } } } @@ -752,12 +752,6 @@ } ], "responses": { - "403": { - "description": "Forbidden" - }, - "401": { - "description": "Unauthorized" - }, "500": { "description": "Internal Server Error\n\nPossible error codes:\n - UNEXPECTED_ERROR", "content": { @@ -768,6 +762,12 @@ } } }, + "403": { + "description": "Forbidden" + }, + "401": { + "description": "Unauthorized" + }, "204": { "description": "No Content" } @@ -829,22 +829,22 @@ } } }, - "200": { - "description": "OK", + "500": { + "description": "Internal Server Error\n\nPossible error codes:\n - UNEXPECTED_ERROR", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CreateFaceResponse" + "$ref": "#/components/schemas/ErrorResponse" } } } }, - "500": { - "description": "Internal Server Error\n\nPossible error codes:\n - UNEXPECTED_ERROR", + "200": { + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/CreateFaceResponse" } } } @@ -895,12 +895,6 @@ } } }, - "403": { - "description": "Forbidden" - }, - "401": { - "description": "Unauthorized" - }, "400": { "description": "Bad request\n\nPossible error codes:\n - INVALID_REQUEST_BODY\n - INVALID_IMAGE\n - UNSUPPORTED_VERSION_TEMPLATE\n - CORRUPTED_TEMPLATE\n - INCOMPATIBLE_TEMPLATE", "content": { @@ -930,6 +924,12 @@ } } } + }, + "403": { + "description": "Forbidden" + }, + "401": { + "description": "Unauthorized" } }, "security": [ @@ -957,12 +957,6 @@ } } }, - "403": { - "description": "Forbidden" - }, - "401": { - "description": "Unauthorized" - }, "500": { "description": "Internal Server Error\n\nPossible error codes:\n - UNEXPECTED_ERROR", "content": { @@ -972,6 +966,12 @@ } } } + }, + "403": { + "description": "Forbidden" + }, + "401": { + "description": "Unauthorized" } }, "security": [ @@ -999,8 +999,8 @@ } ], "responses": { - "404": { - "description": "Not found\n\nPossible error codes:\n - NOT_FOUND", + "400": { + "description": "Bad request\n\nPossible error codes:\n - INVALID_ID", "content": { "application/json": { "schema": { @@ -1009,14 +1009,8 @@ } } }, - "403": { - "description": "Forbidden" - }, - "401": { - "description": "Unauthorized" - }, - "400": { - "description": "Bad request\n\nPossible error codes:\n - INVALID_ID", + "404": { + "description": "Not found\n\nPossible error codes:\n - NOT_FOUND", "content": { "application/json": { "schema": { @@ -1044,6 +1038,12 @@ } } } + }, + "403": { + "description": "Forbidden" + }, + "401": { + "description": "Unauthorized" } }, "security": [ @@ -1089,12 +1089,6 @@ } } }, - "403": { - "description": "Forbidden" - }, - "401": { - "description": "Unauthorized" - }, "400": { "description": "Bad request\n\nPossible error codes:\n - INVALID_ID", "content": { @@ -1114,6 +1108,12 @@ } } } + }, + "403": { + "description": "Forbidden" + }, + "401": { + "description": "Unauthorized" } }, "security": [ @@ -1139,12 +1139,6 @@ } ], "responses": { - "403": { - "description": "Forbidden" - }, - "401": { - "description": "Unauthorized" - }, "400": { "description": "Bad request\n\nPossible error codes:\n - INVALID_ID", "content": { @@ -1165,6 +1159,12 @@ } } }, + "403": { + "description": "Forbidden" + }, + "401": { + "description": "Unauthorized" + }, "204": { "description": "No Content" } @@ -1176,13 +1176,13 @@ ] } }, - "/api/v1/customers/{id}/liveness/selfies": { + "/api/v1/customers/{id}/store": { "post": { "tags": [ - "Customer onboarding" + "Trust Platform" ], - "summary": "Provide customer\u0027s liveness selfie", - "operationId": "createLivenessSelfie", + "summary": "Store customer in the Trust Platform", + "operationId": "storeInTrustPlatform", "parameters": [ { "name": "id", @@ -1197,13 +1197,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CreateCustomerLivenessSelfieRequest" + "$ref": "#/components/schemas/CustomerStoreRequest" } } }, "required": true }, "responses": { + "400": { + "description": "Bad request\n\nPossible error codes:\n - INVALID_ID\n - INVALID_REQUEST_BODY", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, "404": { "description": "Not found\n\nPossible error codes:\n - NOT_FOUND", "content": { @@ -1214,12 +1224,22 @@ } } }, - "200": { - "description": "OK", + "409": { + "description": "Conflict\n\nPossible error codes:\n - CONFLICT", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CreateCustomerLivenessSelfieResponse" + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal Server Error\n\nPossible error codes:\n - UNEXPECTED_ERROR", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" } } } @@ -1230,8 +1250,47 @@ "401": { "description": "Unauthorized" }, - "400": { - "description": "Bad request\n\nPossible error codes:\n - INVALID_ID\n - INVALID_REQUEST_BODY\n - INVALID_IMAGE", + "204": { + "description": "No Content" + } + }, + "security": [ + { + "api": [] + } + ] + } + }, + "/api/v1/customers/{id}/liveness/selfies": { + "post": { + "tags": [ + "Customer onboarding" + ], + "summary": "Provide customer\u0027s liveness selfie", + "operationId": "createLivenessSelfie", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateCustomerLivenessSelfieRequest" + } + } + }, + "required": true + }, + "responses": { + "404": { + "description": "Not found\n\nPossible error codes:\n - NOT_FOUND", "content": { "application/json": { "schema": { @@ -1259,6 +1318,32 @@ } } } + }, + "400": { + "description": "Bad request\n\nPossible error codes:\n - INVALID_ID\n - INVALID_REQUEST_BODY\n - INVALID_IMAGE", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden" + }, + "401": { + "description": "Unauthorized" + }, + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateCustomerLivenessSelfieResponse" + } + } + } } }, "security": [ @@ -1307,24 +1392,18 @@ } } }, - "403": { - "description": "Forbidden" - }, - "401": { - "description": "Unauthorized" - }, - "200": { - "description": "OK", + "409": { + "description": "Conflict\n\nPossible error codes:\n - CONFLICT", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CreateCustomerLivenessRecordResponse" + "$ref": "#/components/schemas/ErrorResponse" } } } }, - "400": { - "description": "Bad request\n\nPossible error codes:\n - INVALID_ID\n - INVALID_REQUEST_BODY\n - INVALID_IMAGE", + "500": { + "description": "Internal Server Error\n\nPossible error codes:\n - UNEXPECTED_ERROR", "content": { "application/json": { "schema": { @@ -1333,8 +1412,8 @@ } } }, - "409": { - "description": "Conflict\n\nPossible error codes:\n - CONFLICT", + "400": { + "description": "Bad request\n\nPossible error codes:\n - INVALID_ID\n - INVALID_REQUEST_BODY\n - INVALID_IMAGE", "content": { "application/json": { "schema": { @@ -1343,12 +1422,18 @@ } } }, - "500": { - "description": "Internal Server Error\n\nPossible error codes:\n - UNEXPECTED_ERROR", + "403": { + "description": "Forbidden" + }, + "401": { + "description": "Unauthorized" + }, + "200": { + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/CreateCustomerLivenessRecordResponse" } } } @@ -1409,24 +1494,18 @@ } } }, - "200": { - "description": "OK", + "409": { + "description": "Conflict\n\nPossible error codes:\n - CONFLICT", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EvaluateCustomerLivenessResponse" + "$ref": "#/components/schemas/ErrorResponse" } } } }, - "403": { - "description": "Forbidden" - }, - "401": { - "description": "Unauthorized" - }, - "409": { - "description": "Conflict\n\nPossible error codes:\n - CONFLICT", + "500": { + "description": "Internal Server Error\n\nPossible error codes:\n - UNEXPECTED_ERROR", "content": { "application/json": { "schema": { @@ -1435,12 +1514,18 @@ } } }, - "500": { - "description": "Internal Server Error\n\nPossible error codes:\n - UNEXPECTED_ERROR", + "403": { + "description": "Forbidden" + }, + "401": { + "description": "Unauthorized" + }, + "200": { + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/EvaluateCustomerLivenessResponse" } } } @@ -1471,34 +1556,28 @@ } ], "responses": { - "404": { - "description": "Not found\n\nPossible error codes:\n - NOT_FOUND", + "200": { + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/CustomerInspectResponse" } } } }, - "200": { - "description": "OK", + "400": { + "description": "Bad request\n\nPossible error codes:\n - INVALID_ID", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CustomerInspectResponse" + "$ref": "#/components/schemas/ErrorResponse" } } } }, - "403": { - "description": "Forbidden" - }, - "401": { - "description": "Unauthorized" - }, - "400": { - "description": "Bad request\n\nPossible error codes:\n - INVALID_ID", + "404": { + "description": "Not found\n\nPossible error codes:\n - NOT_FOUND", "content": { "application/json": { "schema": { @@ -1526,6 +1605,12 @@ } } } + }, + "403": { + "description": "Forbidden" + }, + "401": { + "description": "Unauthorized" } }, "security": [ @@ -1553,8 +1638,8 @@ } ], "responses": { - "404": { - "description": "Not found\n\nPossible error codes:\n - NOT_FOUND", + "400": { + "description": "Bad request\n\nPossible error codes:\n - INVALID_ID", "content": { "application/json": { "schema": { @@ -1563,24 +1648,18 @@ } } }, - "200": { - "description": "OK", + "404": { + "description": "Not found\n\nPossible error codes:\n - NOT_FOUND", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CustomerInspectDiscloseResponse" + "$ref": "#/components/schemas/ErrorResponse" } } } }, - "403": { - "description": "Forbidden" - }, - "401": { - "description": "Unauthorized" - }, - "400": { - "description": "Bad request\n\nPossible error codes:\n - INVALID_ID", + "409": { + "description": "Conflict\n\nPossible error codes:\n - CONFLICT", "content": { "application/json": { "schema": { @@ -1589,8 +1668,8 @@ } } }, - "409": { - "description": "Conflict\n\nPossible error codes:\n - CONFLICT", + "500": { + "description": "Internal Server Error\n\nPossible error codes:\n - UNEXPECTED_ERROR", "content": { "application/json": { "schema": { @@ -1599,12 +1678,18 @@ } } }, - "500": { - "description": "Internal Server Error\n\nPossible error codes:\n - UNEXPECTED_ERROR", + "403": { + "description": "Forbidden" + }, + "401": { + "description": "Unauthorized" + }, + "200": { + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/CustomerInspectDiscloseResponse" } } } @@ -1635,8 +1720,8 @@ } ], "responses": { - "404": { - "description": "Not found\n\nPossible error codes:\n - NOT_FOUND", + "400": { + "description": "Bad request\n\nPossible error codes:\n - INVALID_ID", "content": { "application/json": { "schema": { @@ -1645,24 +1730,18 @@ } } }, - "403": { - "description": "Forbidden" - }, - "200": { - "description": "OK", + "404": { + "description": "Not found\n\nPossible error codes:\n - NOT_FOUND", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DocumentInspectResponse" + "$ref": "#/components/schemas/ErrorResponse" } } } }, - "401": { - "description": "Unauthorized" - }, - "400": { - "description": "Bad request\n\nPossible error codes:\n - INVALID_ID", + "409": { + "description": "Conflict\n\nPossible error codes:\n - CONFLICT", "content": { "application/json": { "schema": { @@ -1671,8 +1750,8 @@ } } }, - "409": { - "description": "Conflict\n\nPossible error codes:\n - CONFLICT", + "500": { + "description": "Internal Server Error\n\nPossible error codes:\n - UNEXPECTED_ERROR", "content": { "application/json": { "schema": { @@ -1681,15 +1760,21 @@ } } }, - "500": { - "description": "Internal Server Error\n\nPossible error codes:\n - UNEXPECTED_ERROR", + "200": { + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/DocumentInspectResponse" } } } + }, + "403": { + "description": "Forbidden" + }, + "401": { + "description": "Unauthorized" } }, "security": [ @@ -1717,6 +1802,26 @@ } ], "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DocumentInspectDiscloseResponse" + } + } + } + }, + "400": { + "description": "Bad request\n\nPossible error codes:\n - INVALID_ID", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, "404": { "description": "Not found\n\nPossible error codes:\n - NOT_FOUND", "content": { @@ -1727,12 +1832,48 @@ } } }, + "409": { + "description": "Conflict\n\nPossible error codes:\n - CONFLICT", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Internal Server Error\n\nPossible error codes:\n - UNEXPECTED_ERROR", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, "403": { "description": "Forbidden" }, "401": { "description": "Unauthorized" - }, + } + }, + "security": [ + { + "api": [] + } + ] + } + }, + "/api/v1/trust-evaluation/trust-factor-definitions": { + "get": { + "tags": [ + "Trust Evaluator" + ], + "summary": "Get a list of available Trust Factor definitions", + "operationId": "getTrustFactorDefinitions", + "responses": { "400": { "description": "Bad request\n\nPossible error codes:\n - INVALID_ID", "content": { @@ -1743,8 +1884,8 @@ } } }, - "409": { - "description": "Conflict\n\nPossible error codes:\n - CONFLICT", + "404": { + "description": "Not found\n\nPossible error codes:\n - NOT_FOUND", "content": { "application/json": { "schema": { @@ -1753,16 +1894,6 @@ } } }, - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DocumentInspectDiscloseResponse" - } - } - } - }, "500": { "description": "Internal Server Error\n\nPossible error codes:\n - UNEXPECTED_ERROR", "content": { @@ -1772,6 +1903,12 @@ } } } + }, + "403": { + "description": "Forbidden" + }, + "401": { + "description": "Unauthorized" } }, "security": [ @@ -1789,28 +1926,28 @@ "summary": "Get metadata", "operationId": "metadata", "responses": { - "403": { - "description": "Forbidden" - }, - "200": { - "description": "OK", + "500": { + "description": "Internal Server Error\n\nPossible error codes:\n - UNEXPECTED_ERROR", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DocumentMetadataResponse" + "$ref": "#/components/schemas/ErrorResponse" } } } }, + "403": { + "description": "Forbidden" + }, "401": { "description": "Unauthorized" }, - "500": { - "description": "Internal Server Error\n\nPossible error codes:\n - UNEXPECTED_ERROR", + "200": { + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/DocumentMetadataResponse" } } } @@ -1841,34 +1978,28 @@ } ], "responses": { - "404": { - "description": "Not found\n\nPossible error codes:\n - NOT_FOUND", + "200": { + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/FaceQualityResponse" } } } }, - "200": { - "description": "OK", + "400": { + "description": "Bad request\n\nPossible error codes:\n - INVALID_ID", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/FaceQualityResponse" + "$ref": "#/components/schemas/ErrorResponse" } } } }, - "403": { - "description": "Forbidden" - }, - "401": { - "description": "Unauthorized" - }, - "400": { - "description": "Bad request\n\nPossible error codes:\n - INVALID_ID", + "404": { + "description": "Not found\n\nPossible error codes:\n - NOT_FOUND", "content": { "application/json": { "schema": { @@ -1886,6 +2017,12 @@ } } } + }, + "403": { + "description": "Forbidden" + }, + "401": { + "description": "Unauthorized" } }, "security": [ @@ -1913,8 +2050,8 @@ } ], "responses": { - "404": { - "description": "Not found\n\nPossible error codes:\n - NOT_FOUND", + "400": { + "description": "Bad request\n\nPossible error codes:\n - INVALID_ID", "content": { "application/json": { "schema": { @@ -1923,24 +2060,18 @@ } } }, - "200": { - "description": "OK", + "404": { + "description": "Not found\n\nPossible error codes:\n - NOT_FOUND", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GlassesResponse" + "$ref": "#/components/schemas/ErrorResponse" } } } }, - "403": { - "description": "Forbidden" - }, - "401": { - "description": "Unauthorized" - }, - "400": { - "description": "Bad request\n\nPossible error codes:\n - INVALID_ID", + "500": { + "description": "Internal Server Error\n\nPossible error codes:\n - UNEXPECTED_ERROR", "content": { "application/json": { "schema": { @@ -1949,15 +2080,21 @@ } } }, - "500": { - "description": "Internal Server Error\n\nPossible error codes:\n - UNEXPECTED_ERROR", + "200": { + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/GlassesResponse" } } } + }, + "403": { + "description": "Forbidden" + }, + "401": { + "description": "Unauthorized" } }, "security": [ @@ -1985,34 +2122,28 @@ } ], "responses": { - "404": { - "description": "Not found\n\nPossible error codes:\n - NOT_FOUND", + "200": { + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/FaceTemplateResponse" } } } }, - "403": { - "description": "Forbidden" - }, - "200": { - "description": "OK", + "400": { + "description": "Bad request\n\nPossible error codes:\n - INVALID_ID", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/FaceTemplateResponse" + "$ref": "#/components/schemas/ErrorResponse" } } } }, - "401": { - "description": "Unauthorized" - }, - "400": { - "description": "Bad request\n\nPossible error codes:\n - INVALID_ID", + "404": { + "description": "Not found\n\nPossible error codes:\n - NOT_FOUND", "content": { "application/json": { "schema": { @@ -2030,6 +2161,12 @@ } } } + }, + "403": { + "description": "Forbidden" + }, + "401": { + "description": "Unauthorized" } }, "security": [ @@ -2057,12 +2194,12 @@ } ], "responses": { - "200": { - "description": "OK", + "400": { + "description": "Bad request\n\nPossible error codes:\n - INVALID_ID", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/FaceMaskResponse" + "$ref": "#/components/schemas/ErrorResponse" } } } @@ -2077,14 +2214,8 @@ } } }, - "403": { - "description": "Forbidden" - }, - "401": { - "description": "Unauthorized" - }, - "400": { - "description": "Bad request\n\nPossible error codes:\n - INVALID_ID", + "500": { + "description": "Internal Server Error\n\nPossible error codes:\n - UNEXPECTED_ERROR", "content": { "application/json": { "schema": { @@ -2093,12 +2224,18 @@ } } }, - "500": { - "description": "Internal Server Error\n\nPossible error codes:\n - UNEXPECTED_ERROR", + "403": { + "description": "Forbidden" + }, + "401": { + "description": "Unauthorized" + }, + "200": { + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/FaceMaskResponse" } } } @@ -2157,14 +2294,8 @@ } } }, - "403": { - "description": "Forbidden" - }, - "401": { - "description": "Unauthorized" - }, - "500": { - "description": "Internal Server Error\n\nPossible error codes:\n - UNEXPECTED_ERROR", + "400": { + "description": "Bad request\n\nPossible error codes:\n - INVALID_ID\n - INVALID_REQUEST_PARAMETER", "content": { "application/json": { "schema": { @@ -2173,25 +2304,31 @@ } } }, - "200": { - "description": "OK", + "500": { + "description": "Internal Server Error\n\nPossible error codes:\n - UNEXPECTED_ERROR", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ImageCrop" + "$ref": "#/components/schemas/ErrorResponse" } } } }, - "400": { - "description": "Bad request\n\nPossible error codes:\n - INVALID_ID\n - INVALID_REQUEST_PARAMETER", + "200": { + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/ImageCrop" } } } + }, + "403": { + "description": "Forbidden" + }, + "401": { + "description": "Unauthorized" } }, "security": [ @@ -2247,14 +2384,8 @@ } } }, - "403": { - "description": "Forbidden" - }, - "401": { - "description": "Unauthorized" - }, - "500": { - "description": "Internal Server Error\n\nPossible error codes:\n - UNEXPECTED_ERROR", + "400": { + "description": "Bad request\n\nPossible error codes:\n - INVALID_ID\n - INVALID_REQUEST_PARAMETER", "content": { "application/json": { "schema": { @@ -2263,25 +2394,31 @@ } } }, - "200": { - "description": "OK", + "500": { + "description": "Internal Server Error\n\nPossible error codes:\n - UNEXPECTED_ERROR", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ImageCrop" + "$ref": "#/components/schemas/ErrorResponse" } } } }, - "400": { - "description": "Bad request\n\nPossible error codes:\n - INVALID_ID\n - INVALID_REQUEST_PARAMETER", + "200": { + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/ImageCrop" } } } + }, + "403": { + "description": "Forbidden" + }, + "401": { + "description": "Unauthorized" } }, "security": [ @@ -2309,12 +2446,12 @@ } ], "responses": { - "200": { - "description": "OK", + "400": { + "description": "Bad request\n\nPossible error codes:\n - INVALID_ID", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CropCoordinatesResponse" + "$ref": "#/components/schemas/ErrorResponse" } } } @@ -2329,14 +2466,8 @@ } } }, - "403": { - "description": "Forbidden" - }, - "401": { - "description": "Unauthorized" - }, - "400": { - "description": "Bad request\n\nPossible error codes:\n - INVALID_ID", + "500": { + "description": "Internal Server Error\n\nPossible error codes:\n - UNEXPECTED_ERROR", "content": { "application/json": { "schema": { @@ -2345,15 +2476,21 @@ } } }, - "500": { - "description": "Internal Server Error\n\nPossible error codes:\n - UNEXPECTED_ERROR", + "200": { + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/CropCoordinatesResponse" } } } + }, + "403": { + "description": "Forbidden" + }, + "401": { + "description": "Unauthorized" } }, "security": [ @@ -2381,8 +2518,8 @@ } ], "responses": { - "404": { - "description": "Not found\n\nPossible error codes:\n - NOT_FOUND", + "400": { + "description": "Bad request\n\nPossible error codes:\n - INVALID_ID", "content": { "application/json": { "schema": { @@ -2391,24 +2528,18 @@ } } }, - "403": { - "description": "Forbidden" - }, - "401": { - "description": "Unauthorized" - }, - "200": { - "description": "OK", + "404": { + "description": "Not found\n\nPossible error codes:\n - NOT_FOUND", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/FaceAspectsResponse" + "$ref": "#/components/schemas/ErrorResponse" } } } }, - "400": { - "description": "Bad request\n\nPossible error codes:\n - INVALID_ID", + "500": { + "description": "Internal Server Error\n\nPossible error codes:\n - UNEXPECTED_ERROR", "content": { "application/json": { "schema": { @@ -2417,15 +2548,21 @@ } } }, - "500": { - "description": "Internal Server Error\n\nPossible error codes:\n - UNEXPECTED_ERROR", + "200": { + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/FaceAspectsResponse" } } } + }, + "403": { + "description": "Forbidden" + }, + "401": { + "description": "Unauthorized" } }, "security": [ @@ -2489,14 +2626,8 @@ } } }, - "403": { - "description": "Forbidden" - }, - "401": { - "description": "Unauthorized" - }, - "500": { - "description": "Internal Server Error\n\nPossible error codes:\n - UNEXPECTED_ERROR", + "400": { + "description": "Bad request\n\nPossible error codes:\n - INVALID_ID\n - INVALID_REQUEST_PARAMETER", "content": { "application/json": { "schema": { @@ -2505,25 +2636,31 @@ } } }, - "200": { - "description": "OK", + "500": { + "description": "Internal Server Error\n\nPossible error codes:\n - UNEXPECTED_ERROR", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ImageCrop" + "$ref": "#/components/schemas/ErrorResponse" } } } }, - "400": { - "description": "Bad request\n\nPossible error codes:\n - INVALID_ID\n - INVALID_REQUEST_PARAMETER", + "200": { + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/ImageCrop" } } } + }, + "403": { + "description": "Forbidden" + }, + "401": { + "description": "Unauthorized" } }, "security": [ @@ -2579,14 +2716,8 @@ } } }, - "403": { - "description": "Forbidden" - }, - "401": { - "description": "Unauthorized" - }, - "500": { - "description": "Internal Server Error\n\nPossible error codes:\n - UNEXPECTED_ERROR", + "400": { + "description": "Bad request\n\nPossible error codes:\n - INVALID_ID\n - INVALID_REQUEST_PARAMETER", "content": { "application/json": { "schema": { @@ -2595,25 +2726,31 @@ } } }, - "200": { - "description": "OK", + "500": { + "description": "Internal Server Error\n\nPossible error codes:\n - UNEXPECTED_ERROR", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ImageCrop" + "$ref": "#/components/schemas/ErrorResponse" } } } }, - "400": { - "description": "Bad request\n\nPossible error codes:\n - INVALID_ID\n - INVALID_REQUEST_PARAMETER", + "200": { + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/ImageCrop" } } } + }, + "403": { + "description": "Forbidden" + }, + "401": { + "description": "Unauthorized" } }, "security": [ @@ -2669,14 +2806,8 @@ } } }, - "403": { - "description": "Forbidden" - }, - "401": { - "description": "Unauthorized" - }, - "500": { - "description": "Internal Server Error\n\nPossible error codes:\n - UNEXPECTED_ERROR", + "400": { + "description": "Bad request\n\nPossible error codes:\n - INVALID_ID\n - INVALID_REQUEST_PARAMETER", "content": { "application/json": { "schema": { @@ -2685,25 +2816,31 @@ } } }, - "200": { - "description": "OK", + "500": { + "description": "Internal Server Error\n\nPossible error codes:\n - UNEXPECTED_ERROR", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ImageCrop" + "$ref": "#/components/schemas/ErrorResponse" } } } }, - "400": { - "description": "Bad request\n\nPossible error codes:\n - INVALID_ID\n - INVALID_REQUEST_PARAMETER", + "200": { + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/ImageCrop" } } } + }, + "403": { + "description": "Forbidden" + }, + "401": { + "description": "Unauthorized" } }, "security": [ @@ -2767,14 +2904,8 @@ } } }, - "403": { - "description": "Forbidden" - }, - "401": { - "description": "Unauthorized" - }, - "500": { - "description": "Internal Server Error\n\nPossible error codes:\n - UNEXPECTED_ERROR", + "400": { + "description": "Bad request\n\nPossible error codes:\n - INVALID_ID\n - INVALID_REQUEST_PARAMETER", "content": { "application/json": { "schema": { @@ -2783,25 +2914,31 @@ } } }, - "200": { - "description": "OK", + "500": { + "description": "Internal Server Error\n\nPossible error codes:\n - UNEXPECTED_ERROR", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ImageCrop" + "$ref": "#/components/schemas/ErrorResponse" } } } }, - "400": { - "description": "Bad request\n\nPossible error codes:\n - INVALID_ID\n - INVALID_REQUEST_PARAMETER", + "200": { + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/ImageCrop" } } } + }, + "403": { + "description": "Forbidden" + }, + "401": { + "description": "Unauthorized" } }, "security": [ @@ -2837,8 +2974,8 @@ } ], "responses": { - "404": { - "description": "Not found\n\nPossible error codes:\n - NOT_FOUND", + "400": { + "description": "Bad request\n\nPossible error codes:\n - INVALID_ID", "content": { "application/json": { "schema": { @@ -2847,24 +2984,18 @@ } } }, - "403": { - "description": "Forbidden" - }, - "200": { - "description": "OK", + "404": { + "description": "Not found\n\nPossible error codes:\n - NOT_FOUND", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DocumentPageQuality" + "$ref": "#/components/schemas/ErrorResponse" } } } }, - "401": { - "description": "Unauthorized" - }, - "400": { - "description": "Bad request\n\nPossible error codes:\n - INVALID_ID", + "500": { + "description": "Internal Server Error\n\nPossible error codes:\n - UNEXPECTED_ERROR", "content": { "application/json": { "schema": { @@ -2873,12 +3004,18 @@ } } }, - "500": { - "description": "Internal Server Error\n\nPossible error codes:\n - UNEXPECTED_ERROR", + "403": { + "description": "Forbidden" + }, + "401": { + "description": "Unauthorized" + }, + "200": { + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/DocumentPageQuality" } } } @@ -2937,14 +3074,8 @@ } } }, - "403": { - "description": "Forbidden" - }, - "401": { - "description": "Unauthorized" - }, - "500": { - "description": "Internal Server Error\n\nPossible error codes:\n - UNEXPECTED_ERROR", + "400": { + "description": "Bad request\n\nPossible error codes:\n - INVALID_ID\n - INVALID_REQUEST_PARAMETER", "content": { "application/json": { "schema": { @@ -2953,25 +3084,31 @@ } } }, - "200": { - "description": "OK", + "500": { + "description": "Internal Server Error\n\nPossible error codes:\n - UNEXPECTED_ERROR", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ImageCrop" + "$ref": "#/components/schemas/ErrorResponse" } } } }, - "400": { - "description": "Bad request\n\nPossible error codes:\n - INVALID_ID\n - INVALID_REQUEST_PARAMETER", + "200": { + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/ImageCrop" } } } + }, + "403": { + "description": "Forbidden" + }, + "401": { + "description": "Unauthorized" } }, "security": [ @@ -3027,14 +3164,8 @@ } } }, - "403": { - "description": "Forbidden" - }, - "401": { - "description": "Unauthorized" - }, - "500": { - "description": "Internal Server Error\n\nPossible error codes:\n - UNEXPECTED_ERROR", + "400": { + "description": "Bad request\n\nPossible error codes:\n - INVALID_ID\n - INVALID_REQUEST_PARAMETER", "content": { "application/json": { "schema": { @@ -3043,25 +3174,31 @@ } } }, - "200": { - "description": "OK", + "500": { + "description": "Internal Server Error\n\nPossible error codes:\n - UNEXPECTED_ERROR", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ImageCrop" + "$ref": "#/components/schemas/ErrorResponse" } } } }, - "400": { - "description": "Bad request\n\nPossible error codes:\n - INVALID_ID\n - INVALID_REQUEST_PARAMETER", + "200": { + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse" + "$ref": "#/components/schemas/ImageCrop" } } } + }, + "403": { + "description": "Forbidden" + }, + "401": { + "description": "Unauthorized" } }, "security": [ @@ -3089,12 +3226,6 @@ } ], "responses": { - "403": { - "description": "Forbidden" - }, - "401": { - "description": "Unauthorized" - }, "400": { "description": "Bad request\n\nPossible error codes:\n - INVALID_ID", "content": { @@ -3115,6 +3246,12 @@ } } }, + "403": { + "description": "Forbidden" + }, + "401": { + "description": "Unauthorized" + }, "204": { "description": "No Content" } @@ -4009,6 +4146,31 @@ }, "readOnly": true }, + "CustomerStoreRequest": { + "required": [ + "onboardingStatus" + ], + "type": "object", + "properties": { + "externalId": { + "pattern": "^[a-zA-Z\\d._-]{1,64}$", + "type": "string", + "description": "External identifier of the customer (for pairing between Trust Platform and external database), limited to alphanumeric, \u0027.\u0027, \u0027-\u0027 and \u0027_\u0027 characters and maximum length of 64. If not supplied, the UUID of the customer present in the request URL is used instead.", + "writeOnly": true, + "example": "55bd71d3-12cc-4c15-accd-b6dc8702bf3b" + }, + "onboardingStatus": { + "type": "string", + "description": "Onboarding status of the customer to be stored in the Trust Platform. Use the FINISHED status only if you have collected all required data of the customer.", + "writeOnly": true, + "example": "IN_PROGRESS", + "enum": [ + "IN_PROGRESS", + "FINISHED" + ] + } + } + }, "CreateCustomerLivenessSelfieRequest": { "required": [ "assertion" @@ -5861,4 +6023,4 @@ } } } -} \ No newline at end of file +}