{ "uuid": "f4a82143-e116-4e35-b94d-cddccd83c270", "lastMigration": 19, "name": "Credas API", "endpointPrefix": "", "latency": 0, "port": 3000, "hostname": "0.0.0.0", "routes": [ { "uuid": "981782fa-931f-48c6-ad80-7423fa78612d", "documentation": "Verifies bank account details.", "method": "post", "endpoint": "api/bank-accounts/verify", "responses": [ { "uuid": "8ec3aa25-b76a-4649-bd8f-72c878837229", "body": "{\n \"accountNumber\": \"\",\n \"accountNumberValidation\": \"{{oneOf (array '0' '1' '2' '3' '4' '5')}}\",\n \"accountNumberValidationText\": \"\",\n \"accountStatus\": \"{{oneOf (array '0' '1' '2' '3')}}\",\n \"accountStatusText\": \"\",\n \"accountValid\": {{faker 'random.boolean'}},\n \"addressValidation\": \"{{oneOf (array '0' '1' '2' '3' '4')}}\",\n \"addressValidationText\": \"\",\n \"checkDate\": \"{{faker 'date.recent' 365}}\",\n \"checkId\": \"{{faker 'random.uuid'}}\",\n \"checkStatus\": \"{{oneOf (array '0' '1' '2' '3')}}\",\n \"error\": {{faker 'random.boolean'}},\n \"hasBeenOverridden\": {{faker 'random.boolean'}},\n \"nameValidation\": \"{{oneOf (array '0' '1' '2')}}\",\n \"nameValidationText\": \"\",\n \"referenceId\": \"\",\n \"sortcode\": \"\",\n \"sortcodeValidation\": \"{{oneOf (array '0' '1' '2' '3' '4')}}\",\n \"sortcodeValidationText\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "d10d74a4-c038-4d11-8e75-b4ce1c5e1d3f", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "If the service was supplied invalid data.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "c0dfccac-6e9f-4f78-b7bb-5ed621c163c8", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "If credentials supplied were invalid.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "7d863299-caec-490f-852c-a0206cd8bfc3", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 402, "label": "Error code meaning that the operation was aborted due to insufficient credits.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "14655a6f-d49a-4086-8ef6-30607b8782e7", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 500, "label": "If an unexpected exception occurred whilst processing the request.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "6218b499-1e82-4abd-b0ba-5ed3e1288360", "documentation": "Searches for a company based on its Company Number and returns its details.", "method": "post", "endpoint": "api/companies", "responses": [ { "uuid": "96e80e08-4cb4-410c-b640-6f15413199c0", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "cc80547c-fe0a-473b-88aa-52f01b656d79", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "If the service was supplied invalid data.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "1c020127-e605-4d16-ab33-535404ae0dd9", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "If credentials supplied were invalid.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "288f78d9-b37c-4734-8967-6352534ab1b3", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 402, "label": "If the consumer doesn't have the required permission to use the endpoint.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "9b5bc11e-867e-42ad-8da6-eae2bc8b464f", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 500, "label": "If an unexpected exception occurred whilst processing the request.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "da69cf58-3a89-42ff-b2ea-65ce847835ef", "documentation": "", "method": "get", "endpoint": "api/companies/:companyId", "responses": [ { "uuid": "18ce48ca-6ece-45c1-8ce5-744849d28f77", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "4d61ca76-24b8-4e01-9ddf-3cb4c36eff4b", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "If the service was supplied invalid data.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "4da1f95f-5a3d-426e-a20f-a10063945249", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "If credentials supplied were invalid.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "fae1b46a-454b-42e7-8e96-11f1488259d5", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 402, "label": "If the consumer doesn't have the required permission to use the endpoint.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "c52cbab2-ee1e-41c8-bf05-94593b345d23", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 500, "label": "If an unexpected exception occurred whilst processing the request.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "bfaed1c0-9055-4282-94dc-104d39d4c6d0", "documentation": "Check includes identifying bankruptcy, insolvency, CCJ's or Company Directorship.", "method": "post", "endpoint": "api/credit-status/perform", "responses": [ { "uuid": "b01f2c95-ee05-409e-ab07-db1ce6f8c8f2", "body": "{\n \"ccj\": [\n {\n \"address1\": \"\",\n \"address2\": \"\",\n \"address3\": \"\",\n \"address4\": \"\",\n \"address5\": \"\",\n \"amount\": \"\",\n \"caseNumber\": \"\",\n \"courtName\": \"\",\n \"dateEnd\": \"{{faker 'date.recent' 365}}\",\n \"dob\": \"{{faker 'date.recent' 365}}\",\n \"judgementDate\": \"{{faker 'date.recent' 365}}\",\n \"judgementType\": \"{{oneOf (array '0' '1' '2' '3' '4' '5')}}\",\n \"judgementTypeText\": \"\",\n \"name\": \"\",\n \"postcode\": \"\"\n }\n ],\n \"checkDate\": \"{{faker 'date.recent' 365}}\",\n \"companyDirector\": [\n {\n \"companyAppointments\": [\n {\n \"address\": \"\",\n \"appointmentDate\": \"{{faker 'date.recent' 365}}\",\n \"appointmentType\": \"\",\n \"dob\": \"{{faker 'date.recent' 365}}\",\n \"name\": \"\",\n \"nationality\": \"\",\n \"occupation\": \"\",\n \"title\": \"\"\n }\n ],\n \"companyName\": \"\",\n \"companyRegNo\": \"\",\n \"dateAppointed\": \"{{faker 'date.recent' 365}}\",\n \"matchType\": \"{{oneOf (array '0' '1' '2' '3')}}\",\n \"matchTypeText\": \"\",\n \"registeredOffice\": \"\"\n }\n ],\n \"hasBeenOverridden\": {{faker 'random.boolean'}},\n \"insolvency\": [\n {\n \"address\": {\n \"address1\": \"\",\n \"address2\": \"\",\n \"address3\": \"\",\n \"address4\": \"\",\n \"address5\": \"\",\n \"dps\": \"\",\n \"isEmpty\": {{faker 'random.boolean'}},\n \"postcode\": \"\"\n },\n \"aliases\": \"\",\n \"assetTotal\": \"\",\n \"caseNo\": \"\",\n \"caseType\": \"\",\n \"court\": \"\",\n \"debtTotal\": \"\",\n \"description\": \"\",\n \"dob\": \"{{faker 'date.recent' 365}}\",\n \"name\": \"\",\n \"occupation\": \"\",\n \"presentationDate\": \"{{faker 'date.recent' 365}}\",\n \"previousAddress\": {\n \"address1\": \"\",\n \"address2\": \"\",\n \"address3\": \"\",\n \"address4\": \"\",\n \"address5\": \"\",\n \"dps\": \"\",\n \"isEmpty\": {{faker 'random.boolean'}},\n \"postcode\": \"\"\n },\n \"serviceOffice\": \"\",\n \"startDate\": \"{{faker 'date.recent' 365}}\",\n \"status\": \"\",\n \"telephoneNumber\": \"\",\n \"tradingNames\": \"\",\n \"type\": \"{{oneOf (array '0' '1' '2' '3' '4' '5')}}\",\n \"typeText\": \"\"\n }\n ],\n \"status\": \"{{oneOf (array '0' '1' '2' '3')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "5856145b-926a-4a0d-9046-3676faa23ef8", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "If the service was supplied invalid data.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "92ef7397-4527-471e-a00c-39b0c232cb92", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "If credentials supplied were invalid.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "143dc48f-9bb7-4f89-bb07-42efc3dfb165", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 402, "label": "Error code meaning that the operation was aborted due to insufficient credits.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "f1f2600a-9ac9-4e1c-aab6-d55541f135c7", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 500, "label": "If an unexpected exception occurred whilst processing the request.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "9bb63658-8921-410b-b54d-c1eea9970121", "documentation": "Creates new data check against a specified registration.", "method": "post", "endpoint": "api/datachecks", "responses": [ { "uuid": "917e37af-54f7-4d90-8994-4c76ffc66c2a", "body": "{\n \"id\": \"{{faker 'random.uuid'}}\",\n \"regCode\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Details of newly added data check.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "de7f9532-a609-492f-8e3f-e6a284bff42d", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "If the service was supplied invalid data.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "0576ba9f-b662-433c-bc7b-70ddb844dbb6", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "If credentials supplied were invalid.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "3821f686-01a7-405f-9763-f7ec9a0a8449", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 402, "label": "Error code meaning that the operation was aborted due to insufficient credits.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "35017962-9166-4374-b233-445c74b2d752", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 500, "label": "If an unexpected exception occurred whilst processing the request.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "2429863e-42db-4b2c-bb4c-00b3b1cfad43", "documentation": "Add an id document image to the specified registration.", "method": "post", "endpoint": "api/images/id-document", "responses": [ { "uuid": "2c2f314b-3361-401c-a02f-1efa3cd36346", "body": "{\n \"documentStatus\": \"{{oneOf (array '1' '2' '3')}}\",\n \"documentType\": \"{{oneOf (array '0' '1' '2' '3' '4' '5' '6' '7' '8' '9' '10' '11' '12' '13' '14' '15' '16' '17' '18' '19' '20' '21' '22' '23' '24' '25' '26' '27' '28' '29' '30' '41' '42' '43' '44' '45' '46' '48' '49' '50' '51' '52' '53' '54' '55' '56' '57' '58' '59' '60' '61' '62' '63' '64' '65' '66' '67' '68' '69' '70' '71' '72' '73' '74' '75' '76' '77')}}\",\n \"facialMatch\": {{faker 'random.boolean'}},\n \"id\": \"{{faker 'random.uuid'}}\",\n \"regCode\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Details of the processed id document.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "625d32e6-0d93-4741-81e7-da754f38a158", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "If the service was supplied invalid data.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "9ee40afc-5537-49ab-9ce4-536984b3b584", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "If credentials supplied were invalid.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "5e237f24-98cd-472c-ac60-8aecd781aeee", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 402, "label": "Error code meaning that the operation was aborted due to insufficient credits.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "5a6b0ede-4bcb-4c8b-9831-ac1bad281d09", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 500, "label": "If an unexpected exception occurred whilst processing the request.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "ac1d9cec-0cb8-4b49-ab00-9aaa9320c15e", "documentation": "Get all id document images associated with a registration.", "method": "get", "endpoint": "api/images/id-document/:registrationId", "responses": [ { "uuid": "f973e284-b1e9-4d15-8f7e-e1978d3f7be8", "body": "{\n \"addressCity\": \"\",\n \"addressFull\": \"\",\n \"addressPostcode\": \"\",\n \"country\": \"\",\n \"countryCode\": \"\",\n \"dateCreated\": \"{{faker 'date.recent' 365}}\",\n \"dateOfBirth\": \"{{faker 'date.recent' 365}}\",\n \"description\": \"\",\n \"documentAnalysisResult\": \"{{oneOf (array '0' '1' '2' '3' '4' '5' '10' '11')}}\",\n \"documentNumber\": \"\",\n \"documentSide\": \"{{oneOf (array '0' '1' '2')}}\",\n \"expiryDate\": \"{{faker 'date.recent' 365}}\",\n \"facialMatch\": {{faker 'random.boolean'}},\n \"forename\": \"\",\n \"fullName\": \"\",\n \"hiResUrl\": \"\",\n \"id\": \"{{faker 'random.uuid'}}\",\n \"isUnderReview\": {{faker 'random.boolean'}},\n \"manuallyVerified\": {{faker 'random.boolean'}},\n \"middleName\": \"\",\n \"mrz1\": \"\",\n \"mrz2\": \"\",\n \"mrz3\": \"\",\n \"nameCheck\": {{faker 'random.boolean'}},\n \"nameCheckMethod\": \"{{oneOf (array '0' '1' '2')}}\",\n \"nfcCheck\": {{faker 'random.boolean'}},\n \"nfcFacialUrl\": \"\",\n \"nfcReadStatus\": \"{{oneOf (array '0' '1' '2' '3' '4' '5' '6' '7' '8' '9')}}\",\n \"primaryScanId\": \"{{faker 'random.uuid'}}\",\n \"status\": \"{{oneOf (array '0' '1' '2' '3')}}\",\n \"surname\": \"\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Details of the id documents associated with the registration.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "5610ac34-9d47-46b9-9e97-58ae08744e35", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "If the service was supplied invalid data.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "311ec72c-5c6b-4eab-982d-324ae29f5757", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "If credentials supplied were invalid.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "bebc17cd-2cab-4077-88d6-68d4da825890", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "If requesting entity have no permission to access the resource.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "dd9e1e33-0f78-4008-8ad8-5ac301737904", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 500, "label": "If an unexpected exception occurred whilst processing the request.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "18a505ed-6050-4938-ace2-7615b69de7db", "documentation": "Add a liveness image (UAP) to the specified registration.", "method": "post", "endpoint": "api/images/liveness", "responses": [ { "uuid": "714d4001-68c7-4dda-a859-a40875df6471", "body": "", "latency": 0, "statusCode": 200, "label": "OK response indicating a successful action.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "3ed27f21-7429-4643-947e-b098e6fa45f4", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "If the service was supplied invalid data.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "c091df1f-bfc5-44e1-9698-c044bd79b923", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "If credentials supplied were invalid.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "2674f82d-b465-4d8d-8e5f-a762ca918d3f", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 500, "label": "If an unexpected exception occurred whilst processing the request.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "f8586ef0-0ec9-4117-b374-85b5302582b7", "documentation": "Retrieve the liveness performed image associated with a registration.", "method": "get", "endpoint": "api/images/liveness-performed/:registrationId", "responses": [ { "uuid": "396a9be9-0984-43ff-b2ca-d0ea9e7e58ec", "body": "{\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Response containing Liveness performed image details.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "1a3416bb-7707-4c3d-a7f1-8c7377fd925a", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "If the service was supplied invalid data.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "8580c69d-a6cb-4bb2-aa28-c90a3e3fc6e5", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "If credentials supplied were invalid.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "fd50d785-fcb1-4d68-974f-ccf596a79cff", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "If requesting entity have no permission to access the resource.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "842cf7d6-0a22-4b5a-aa00-0931fb09ac5c", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the liveness performed image doesn't exist.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "946ee33f-a694-46eb-acc2-448972d9123e", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 500, "label": "If an unexpected exception occurred whilst processing the request.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "d936da06-0d81-4386-9f02-0e89789f1376", "documentation": "Retrieve the liveness action image (UAP) associated with a registration.", "method": "get", "endpoint": "api/images/liveness/:registrationId", "responses": [ { "uuid": "de0bb829-7e2f-488d-a6dd-22ee69f5a410", "body": "{\n \"description\": \"\",\n \"id\": \"{{faker 'random.uuid'}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Response containing Liveness image details.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "0c7be9e4-efb8-4e3c-8b55-c91ded9de5b5", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "If the service was supplied invalid data.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "29611205-333f-48cc-a387-5a6dff4efb7a", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "If credentials supplied were invalid.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "820bd634-04cf-4a29-8a88-fa950d6ef3b4", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "If requesting entity have no permission to access the resource.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "37d4d866-af46-4db5-8330-509d06e40af6", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 500, "label": "If an unexpected exception occurred whilst processing the request.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "13062206-dd26-49d8-8554-8099e79f3ed7", "documentation": "Add a selfie image to the registration.", "method": "post", "endpoint": "api/images/selfie", "responses": [ { "uuid": "870964d9-b540-4470-88af-d52e713e96c0", "body": "{\n \"livenessConfirmed\": {{faker 'random.boolean'}}\n}", "latency": 0, "statusCode": 200, "label": "Result of uploading selfie image; including liveness check indicator.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "65757bef-0d90-4f66-86d4-53ff5707b468", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "If the service was supplied invalid data.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "88d66043-4b2a-4d89-9692-546a1a3f974b", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "If credentials supplied were invalid.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "8aa4fb21-5871-43f0-93f4-589cee078dea", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 500, "label": "If an unexpected exception occurred whilst processing the request.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "b4eab950-0f89-44a8-b198-e5d6b2bff79e", "documentation": "Retrieve the selfie image associated with a registration.", "method": "get", "endpoint": "api/images/selfie/:registrationId", "responses": [ { "uuid": "784f8b41-639f-4a0e-9256-2e55fc5ad949", "body": "{\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Response containing the selfie image details.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "a1d5c51d-3c44-49c0-bcb1-f0cbd5e1a10a", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "If the service was supplied invalid data.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "3f0f5f03-5836-4401-a769-be5a539e63ac", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "If credentials supplied were invalid.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "33e6d348-9b20-4b85-800a-78370a52d8c0", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "If requesting entity have no permission to access the resource.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "d818266b-296c-4e72-845a-b3df3134d3c9", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 500, "label": "If an unexpected exception occurred whilst processing the request.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "358d0f81-eba5-4979-b753-6d6215c68020", "documentation": "Creates new property registry check against the registration.", "method": "post", "endpoint": "api/property-register", "responses": [ { "uuid": "77599b0b-c044-43c5-bf2c-c99dd183bdb3", "body": "{\n \"checkStatus\": \"{{oneOf (array '0' '1' '2' '3')}}\",\n \"hasBeenOverridden\": {{faker 'random.boolean'}},\n \"matchResult\": \"{{oneOf (array '0' '1' '2' '3' '4' '5' '6' '7')}}\",\n \"matchResultText\": \"\",\n \"propertyOwnership\": \"{{oneOf (array '0' '1' '2')}}\",\n \"propertyOwnershipText\": \"\",\n \"titleNumber\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Details of newly added data check.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "f271e75e-4fab-4595-8e91-fb584e9356de", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "If the service was supplied invalid data.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "661d068c-6e64-48fd-935c-4b58cad47fe4", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "If credentials supplied were invalid.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "a04e85c0-b488-49bf-b93a-6a98c0856212", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 402, "label": "Error code meaning that the operation was aborted due to insufficient credits.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "2149a5a4-326d-43a9-9d09-31ed5f4e8939", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 500, "label": "If an unexpected exception occurred whilst processing the request.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "75dc62c2-c946-4a3c-badd-2d7384cbc6dd", "documentation": "Retrieves property registry check associated with the registration.", "method": "get", "endpoint": "api/property-register/:id", "responses": [ { "uuid": "8b386048-192f-4820-a400-8f239301fbe7", "body": "{\n \"checkStatus\": \"{{oneOf (array '0' '1' '2' '3')}}\",\n \"hasBeenOverridden\": {{faker 'random.boolean'}},\n \"matchResult\": \"{{oneOf (array '0' '1' '2' '3' '4' '5' '6' '7')}}\",\n \"matchResultText\": \"\",\n \"propertyOwnership\": \"{{oneOf (array '0' '1' '2')}}\",\n \"propertyOwnershipText\": \"\",\n \"titleNumber\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Details of the property register check.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "f9a189fd-6aa6-4bec-b486-94cfc617ae3d", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "If the service was supplied invalid data.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "35a9558e-7832-4c09-a0a7-979a5b519051", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "If credentials supplied were invalid.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "5f9df101-f68d-4927-ac2f-8d0cc2d26034", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If registration does not have associated property register check.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "e49b4e0e-209f-439e-8543-602d58fbf18d", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 500, "label": "If an unexpected exception occurred whilst processing the request.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "aed6fc0c-3849-4786-a7ea-3956061046b9", "documentation": "Gets all available RegTypes.", "method": "get", "endpoint": "api/reg-types", "responses": [ { "uuid": "44375b14-d36e-4296-bcd4-791e115dcb71", "body": "[\n {\n \"id\": \"{{faker 'random.uuid'}}\",\n \"name\": \"\"\n }\n]", "latency": 0, "statusCode": 200, "label": "A collection of available RegTypes.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "08c2e71b-838e-403a-b363-9bba3cb0d890", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "If credentials supplied were invalid.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "7ec2b7dc-b5e6-40e4-ba46-282f26e05e32", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 500, "label": "If an unexpected exception occurred whilst processing the request.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "7db5b32e-284b-45b6-8cb7-a72d01785e5c", "documentation": "Creates new registration.", "method": "post", "endpoint": "api/registrations", "responses": [ { "uuid": "e71ef420-ccd0-4c33-9094-67515ff7ff77", "body": "{\n \"id\": \"{{faker 'random.uuid'}}\",\n \"regCode\": \"\",\n \"webJourneyUrl\": {\n \"url\": \"\",\n \"validUntil\": \"{{faker 'date.recent' 365}}\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Details of newly added registration.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "79ca4a94-db26-4ab7-9e67-f085b8703e9b", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "If the service was supplied invalid data.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "14e6a0d9-70db-45f6-9649-07fb08f72d63", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "If credentials supplied were invalid.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "b971529d-e9a6-4f19-a9cd-b5fa78eac576", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 402, "label": "Error code meaning that the operation was aborted due to insufficient credits.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "2e461ecb-3737-459b-b37a-eb21a87e7476", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 500, "label": "If an unexpected exception occurred whilst processing the request.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "7ed23694-97d3-490c-8057-9a36a6e17b65", "documentation": "Creates new registration record, adds an ID document and optional selfie image in one go.", "method": "post", "endpoint": "api/registrations/instant", "responses": [ { "uuid": "a559e79e-1ace-4fbc-b0cc-cd605c36136e", "body": "{\n \"documentStatus\": \"{{oneOf (array '1' '2' '3')}}\",\n \"documentType\": \"{{oneOf (array '0' '1' '2' '3' '4' '5' '6' '7' '8' '9' '10' '11' '12' '13' '14' '15' '16' '17' '18' '19' '20' '21' '22' '23' '24' '25' '26' '27' '28' '29' '30' '41' '42' '43' '44' '45' '46' '48' '49' '50' '51' '52' '53' '54' '55' '56' '57' '58' '59' '60' '61' '62' '63' '64' '65' '66' '67' '68' '69' '70' '71' '72' '73' '74' '75' '76' '77')}}\",\n \"facialMatch\": {{faker 'random.boolean'}},\n \"id\": \"{{faker 'random.uuid'}}\",\n \"regCode\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "OK response with object containing the document information.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "2556ded5-0f90-4be2-b76c-7cc75e8d4601", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "If the service was supplied invalid data.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "0820185e-ad65-413a-a545-809c2ff4672a", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "If credentials supplied were invalid.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "899dfc56-1cca-498e-a0fe-20690fc20e15", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 500, "label": "If an unexpected exception occurred whilst processing the request.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "bacd6c10-6e4d-4a67-bfef-fe6e9bc3a259", "documentation": "Finds registrations by the ReferenceId.", "method": "get", "endpoint": "api/registrations/referenceid/:referenceId/summary", "responses": [ { "uuid": "f64dd858-322c-49ef-9275-4076d879cc78", "body": "[\n {\n \"bankAccountChecks\": [\n {\n \"accountNumber\": \"\",\n \"accountNumberValidation\": \"{{oneOf (array '0' '1' '2' '3' '4' '5')}}\",\n \"accountNumberValidationText\": \"\",\n \"accountStatus\": \"{{oneOf (array '0' '1' '2' '3')}}\",\n \"accountStatusText\": \"\",\n \"accountValid\": {{faker 'random.boolean'}},\n \"addressValidation\": \"{{oneOf (array '0' '1' '2' '3' '4')}}\",\n \"addressValidationText\": \"\",\n \"checkDate\": \"{{faker 'date.recent' 365}}\",\n \"checkId\": \"{{faker 'random.uuid'}}\",\n \"checkStatus\": \"{{oneOf (array '0' '1' '2' '3')}}\",\n \"error\": {{faker 'random.boolean'}},\n \"hasBeenOverridden\": {{faker 'random.boolean'}},\n \"nameValidation\": \"{{oneOf (array '0' '1' '2')}}\",\n \"nameValidationText\": \"\",\n \"referenceId\": \"\",\n \"sortcode\": \"\",\n \"sortcodeValidation\": \"{{oneOf (array '0' '1' '2' '3' '4')}}\",\n \"sortcodeValidationText\": \"\"\n }\n ],\n \"creditStatusCheck\": {\n \"ccj\": [\n {\n \"address1\": \"\",\n \"address2\": \"\",\n \"address3\": \"\",\n \"address4\": \"\",\n \"address5\": \"\",\n \"amount\": \"\",\n \"caseNumber\": \"\",\n \"courtName\": \"\",\n \"dateEnd\": \"{{faker 'date.recent' 365}}\",\n \"dob\": \"{{faker 'date.recent' 365}}\",\n \"judgementDate\": \"{{faker 'date.recent' 365}}\",\n \"judgementType\": \"{{oneOf (array '0' '1' '2' '3' '4' '5')}}\",\n \"judgementTypeText\": \"\",\n \"name\": \"\",\n \"postcode\": \"\"\n }\n ],\n \"checkDate\": \"{{faker 'date.recent' 365}}\",\n \"companyDirector\": [\n {\n \"companyAppointments\": [\n {\n \"address\": \"\",\n \"appointmentDate\": \"{{faker 'date.recent' 365}}\",\n \"appointmentType\": \"\",\n \"dob\": \"{{faker 'date.recent' 365}}\",\n \"name\": \"\",\n \"nationality\": \"\",\n \"occupation\": \"\",\n \"title\": \"\"\n }\n ],\n \"companyName\": \"\",\n \"companyRegNo\": \"\",\n \"dateAppointed\": \"{{faker 'date.recent' 365}}\",\n \"matchType\": \"{{oneOf (array '0' '1' '2' '3')}}\",\n \"matchTypeText\": \"\",\n \"registeredOffice\": \"\"\n }\n ],\n \"hasBeenOverridden\": {{faker 'random.boolean'}},\n \"insolvency\": [\n {\n \"address\": {\n \"address1\": \"\",\n \"address2\": \"\",\n \"address3\": \"\",\n \"address4\": \"\",\n \"address5\": \"\",\n \"dps\": \"\",\n \"isEmpty\": {{faker 'random.boolean'}},\n \"postcode\": \"\"\n },\n \"aliases\": \"\",\n \"assetTotal\": \"\",\n \"caseNo\": \"\",\n \"caseType\": \"\",\n \"court\": \"\",\n \"debtTotal\": \"\",\n \"description\": \"\",\n \"dob\": \"{{faker 'date.recent' 365}}\",\n \"name\": \"\",\n \"occupation\": \"\",\n \"presentationDate\": \"{{faker 'date.recent' 365}}\",\n \"previousAddress\": {\n \"address1\": \"\",\n \"address2\": \"\",\n \"address3\": \"\",\n \"address4\": \"\",\n \"address5\": \"\",\n \"dps\": \"\",\n \"isEmpty\": {{faker 'random.boolean'}},\n \"postcode\": \"\"\n },\n \"serviceOffice\": \"\",\n \"startDate\": \"{{faker 'date.recent' 365}}\",\n \"status\": \"\",\n \"telephoneNumber\": \"\",\n \"tradingNames\": \"\",\n \"type\": \"{{oneOf (array '0' '1' '2' '3' '4' '5')}}\",\n \"typeText\": \"\"\n }\n ],\n \"status\": \"{{oneOf (array '0' '1' '2' '3')}}\"\n },\n \"customTermsAccepted\": {{faker 'random.boolean'}},\n \"customTermsAcceptedDateTime\": \"{{faker 'date.recent' 365}}\",\n \"customTermsAcceptedVersion\": {{faker 'random.number'}},\n \"dataCheckResult\": \"{{oneOf (array '0' '1' '2' '3')}}\",\n \"dataCheckSources\": [\n {\n \"dateCreated\": \"{{faker 'date.recent' 365}}\",\n \"hasBeenOverridden\": {{faker 'random.boolean'}},\n \"hasPepSanctionsData\": {{faker 'random.boolean'}},\n \"label\": \"\",\n \"pepSanctionsData\": [\n {\n \"addresses\": [\n {\n \"lines\": [\n \"\"\n ]\n }\n ],\n \"aliases\": [\n \"\"\n ],\n \"fullName\": \"\",\n \"id\": \"\",\n \"positions\": [\n {\n \"country\": \"\",\n \"position\": \"\"\n }\n ],\n \"sanctionBodies\": [\n \"\"\n ],\n \"sanctionDates\": [\n {\n \"date\": \"{{faker 'date.recent' 365}}\",\n \"day\": {{faker 'random.number'}},\n \"month\": {{faker 'random.number'}},\n \"type\": \"{{oneOf (array '0' '1' '2')}}\",\n \"year\": {{faker 'random.number'}}\n }\n ]\n }\n ],\n \"remarks\": [\n {\n \"category\": \"{{oneOf (array '1' '2' '3' '4')}}\",\n \"description\": \"\"\n }\n ],\n \"sourceType\": \"{{oneOf (array '0' '1' '2' '3' '4' '5' '6' '7' '8' '9' '10')}}\",\n \"status\": \"{{oneOf (array '0' '1' '2' '3')}}\"\n }\n ],\n \"dataChecksPerformed\": {{faker 'random.boolean'}},\n \"dateCreated\": \"{{faker 'date.recent' 365}}\",\n \"email\": \"\",\n \"forename\": \"\",\n \"id\": \"{{faker 'random.uuid'}}\",\n \"idDocuments\": [\n {\n \"addressCity\": \"\",\n \"addressFull\": \"\",\n \"addressPostcode\": \"\",\n \"country\": \"\",\n \"countryCode\": \"\",\n \"dateCreated\": \"{{faker 'date.recent' 365}}\",\n \"dateOfBirth\": \"{{faker 'date.recent' 365}}\",\n \"description\": \"\",\n \"documentAnalysisResult\": \"{{oneOf (array '0' '1' '2' '3' '4' '5' '10' '11')}}\",\n \"documentNumber\": \"\",\n \"documentSide\": \"{{oneOf (array '0' '1' '2')}}\",\n \"expiryDate\": \"{{faker 'date.recent' 365}}\",\n \"facialMatch\": {{faker 'random.boolean'}},\n \"forename\": \"\",\n \"fullName\": \"\",\n \"id\": \"{{faker 'random.uuid'}}\",\n \"isUnderReview\": {{faker 'random.boolean'}},\n \"manuallyVerified\": {{faker 'random.boolean'}},\n \"middleName\": \"\",\n \"mrz1\": \"\",\n \"mrz2\": \"\",\n \"mrz3\": \"\",\n \"nameCheck\": {{faker 'random.boolean'}},\n \"nameCheckMethod\": \"{{oneOf (array '0' '1' '2')}}\",\n \"nfcCheck\": {{faker 'random.boolean'}},\n \"nfcReadStatus\": \"{{oneOf (array '0' '1' '2' '3' '4' '5' '6' '7' '8' '9')}}\",\n \"primaryScanId\": \"{{faker 'random.uuid'}}\",\n \"status\": \"{{oneOf (array '0' '1' '2' '3')}}\",\n \"surname\": \"\"\n }\n ],\n \"idVerification\": {\n \"checkStatus\": \"{{oneOf (array '0' '1' '2' '3')}}\",\n \"hasBeenOverridden\": {{faker 'random.boolean'}}\n },\n \"isAgentLed\": {{faker 'random.boolean'}},\n \"livenessMethod\": \"{{oneOf (array '0' '1' '2')}}\",\n \"livenessStatus\": \"{{oneOf (array '0' '1' '2' '3' '4')}}\",\n \"livenessVerified\": {{faker 'random.boolean'}},\n \"personalDetails\": {\n \"address\": {\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"addressLine3\": \"\",\n \"city\": \"\",\n \"country\": \"\",\n \"county\": \"\",\n \"postcode\": \"\"\n },\n \"dateOfBirth\": \"{{faker 'date.recent' 365}}\",\n \"forename\": \"\",\n \"surname\": \"\"\n },\n \"phoneNumber\": \"\",\n \"proofOfOwnershipCheck\": {\n \"checkStatus\": \"{{oneOf (array '0' '1' '2' '3')}}\",\n \"hasBeenOverridden\": {{faker 'random.boolean'}},\n \"matchResult\": \"{{oneOf (array '0' '1' '2' '3' '4' '5' '6' '7')}}\",\n \"matchResultText\": \"\",\n \"propertyOwnership\": \"{{oneOf (array '0' '1' '2')}}\",\n \"propertyOwnershipText\": \"\",\n \"titleNumber\": \"\"\n },\n \"referenceId\": \"\",\n \"regCode\": \"\",\n \"regTypeId\": \"{{faker 'random.uuid'}}\",\n \"rightToWorkDocumentsProvided\": \"{{oneOf (array '0' '1' '2')}}\",\n \"status\": \"{{oneOf (array '0' '1' '2' '3' '4' '6')}}\",\n \"surname\": \"\"\n }\n]", "latency": 0, "statusCode": 200, "label": "Collection of Registration summary objects.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "56d3bfbb-2dd4-4708-aca4-2f9fd8afb986", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "If the service was supplied invalid data.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "091cc9dd-5a45-478d-a337-9c1a1ab2f440", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "If credentials supplied were invalid.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "e02a60e8-b40d-4295-848a-5b0fbc275a33", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "If requesting entity have no permission to access the resource.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "2f9d3641-d45f-4fdc-ad67-13f481f99e6d", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If registration matching the RegCode was not found.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "00fb0d10-6517-4969-98fd-2d2f418b02b3", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 500, "label": "If an unexpected exception occurred whilst processing the request.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "bd30a44d-877e-4fc2-b678-0a957cb1b44e", "documentation": "Finds a registration by the RegCode.", "method": "get", "endpoint": "api/registrations/regcode/:regCode/summary", "responses": [ { "uuid": "ede57a4f-fd14-45fa-b7ca-e5b0119f6c7c", "body": "{\n \"bankAccountChecks\": [\n {\n \"accountNumber\": \"\",\n \"accountNumberValidation\": \"{{oneOf (array '0' '1' '2' '3' '4' '5')}}\",\n \"accountNumberValidationText\": \"\",\n \"accountStatus\": \"{{oneOf (array '0' '1' '2' '3')}}\",\n \"accountStatusText\": \"\",\n \"accountValid\": {{faker 'random.boolean'}},\n \"addressValidation\": \"{{oneOf (array '0' '1' '2' '3' '4')}}\",\n \"addressValidationText\": \"\",\n \"checkDate\": \"{{faker 'date.recent' 365}}\",\n \"checkId\": \"{{faker 'random.uuid'}}\",\n \"checkStatus\": \"{{oneOf (array '0' '1' '2' '3')}}\",\n \"error\": {{faker 'random.boolean'}},\n \"hasBeenOverridden\": {{faker 'random.boolean'}},\n \"nameValidation\": \"{{oneOf (array '0' '1' '2')}}\",\n \"nameValidationText\": \"\",\n \"referenceId\": \"\",\n \"sortcode\": \"\",\n \"sortcodeValidation\": \"{{oneOf (array '0' '1' '2' '3' '4')}}\",\n \"sortcodeValidationText\": \"\"\n }\n ],\n \"creditStatusCheck\": {\n \"ccj\": [\n {\n \"address1\": \"\",\n \"address2\": \"\",\n \"address3\": \"\",\n \"address4\": \"\",\n \"address5\": \"\",\n \"amount\": \"\",\n \"caseNumber\": \"\",\n \"courtName\": \"\",\n \"dateEnd\": \"{{faker 'date.recent' 365}}\",\n \"dob\": \"{{faker 'date.recent' 365}}\",\n \"judgementDate\": \"{{faker 'date.recent' 365}}\",\n \"judgementType\": \"{{oneOf (array '0' '1' '2' '3' '4' '5')}}\",\n \"judgementTypeText\": \"\",\n \"name\": \"\",\n \"postcode\": \"\"\n }\n ],\n \"checkDate\": \"{{faker 'date.recent' 365}}\",\n \"companyDirector\": [\n {\n \"companyAppointments\": [\n {\n \"address\": \"\",\n \"appointmentDate\": \"{{faker 'date.recent' 365}}\",\n \"appointmentType\": \"\",\n \"dob\": \"{{faker 'date.recent' 365}}\",\n \"name\": \"\",\n \"nationality\": \"\",\n \"occupation\": \"\",\n \"title\": \"\"\n }\n ],\n \"companyName\": \"\",\n \"companyRegNo\": \"\",\n \"dateAppointed\": \"{{faker 'date.recent' 365}}\",\n \"matchType\": \"{{oneOf (array '0' '1' '2' '3')}}\",\n \"matchTypeText\": \"\",\n \"registeredOffice\": \"\"\n }\n ],\n \"hasBeenOverridden\": {{faker 'random.boolean'}},\n \"insolvency\": [\n {\n \"address\": {\n \"address1\": \"\",\n \"address2\": \"\",\n \"address3\": \"\",\n \"address4\": \"\",\n \"address5\": \"\",\n \"dps\": \"\",\n \"isEmpty\": {{faker 'random.boolean'}},\n \"postcode\": \"\"\n },\n \"aliases\": \"\",\n \"assetTotal\": \"\",\n \"caseNo\": \"\",\n \"caseType\": \"\",\n \"court\": \"\",\n \"debtTotal\": \"\",\n \"description\": \"\",\n \"dob\": \"{{faker 'date.recent' 365}}\",\n \"name\": \"\",\n \"occupation\": \"\",\n \"presentationDate\": \"{{faker 'date.recent' 365}}\",\n \"previousAddress\": {\n \"address1\": \"\",\n \"address2\": \"\",\n \"address3\": \"\",\n \"address4\": \"\",\n \"address5\": \"\",\n \"dps\": \"\",\n \"isEmpty\": {{faker 'random.boolean'}},\n \"postcode\": \"\"\n },\n \"serviceOffice\": \"\",\n \"startDate\": \"{{faker 'date.recent' 365}}\",\n \"status\": \"\",\n \"telephoneNumber\": \"\",\n \"tradingNames\": \"\",\n \"type\": \"{{oneOf (array '0' '1' '2' '3' '4' '5')}}\",\n \"typeText\": \"\"\n }\n ],\n \"status\": \"{{oneOf (array '0' '1' '2' '3')}}\"\n },\n \"customTermsAccepted\": {{faker 'random.boolean'}},\n \"customTermsAcceptedDateTime\": \"{{faker 'date.recent' 365}}\",\n \"customTermsAcceptedVersion\": {{faker 'random.number'}},\n \"dataCheckResult\": \"{{oneOf (array '0' '1' '2' '3')}}\",\n \"dataCheckSources\": [\n {\n \"dateCreated\": \"{{faker 'date.recent' 365}}\",\n \"hasBeenOverridden\": {{faker 'random.boolean'}},\n \"hasPepSanctionsData\": {{faker 'random.boolean'}},\n \"label\": \"\",\n \"pepSanctionsData\": [\n {\n \"addresses\": [\n {\n \"lines\": [\n \"\"\n ]\n }\n ],\n \"aliases\": [\n \"\"\n ],\n \"fullName\": \"\",\n \"id\": \"\",\n \"positions\": [\n {\n \"country\": \"\",\n \"position\": \"\"\n }\n ],\n \"sanctionBodies\": [\n \"\"\n ],\n \"sanctionDates\": [\n {\n \"date\": \"{{faker 'date.recent' 365}}\",\n \"day\": {{faker 'random.number'}},\n \"month\": {{faker 'random.number'}},\n \"type\": \"{{oneOf (array '0' '1' '2')}}\",\n \"year\": {{faker 'random.number'}}\n }\n ]\n }\n ],\n \"remarks\": [\n {\n \"category\": \"{{oneOf (array '1' '2' '3' '4')}}\",\n \"description\": \"\"\n }\n ],\n \"sourceType\": \"{{oneOf (array '0' '1' '2' '3' '4' '5' '6' '7' '8' '9' '10')}}\",\n \"status\": \"{{oneOf (array '0' '1' '2' '3')}}\"\n }\n ],\n \"dataChecksPerformed\": {{faker 'random.boolean'}},\n \"dateCreated\": \"{{faker 'date.recent' 365}}\",\n \"email\": \"\",\n \"forename\": \"\",\n \"id\": \"{{faker 'random.uuid'}}\",\n \"idDocuments\": [\n {\n \"addressCity\": \"\",\n \"addressFull\": \"\",\n \"addressPostcode\": \"\",\n \"country\": \"\",\n \"countryCode\": \"\",\n \"dateCreated\": \"{{faker 'date.recent' 365}}\",\n \"dateOfBirth\": \"{{faker 'date.recent' 365}}\",\n \"description\": \"\",\n \"documentAnalysisResult\": \"{{oneOf (array '0' '1' '2' '3' '4' '5' '10' '11')}}\",\n \"documentNumber\": \"\",\n \"documentSide\": \"{{oneOf (array '0' '1' '2')}}\",\n \"expiryDate\": \"{{faker 'date.recent' 365}}\",\n \"facialMatch\": {{faker 'random.boolean'}},\n \"forename\": \"\",\n \"fullName\": \"\",\n \"id\": \"{{faker 'random.uuid'}}\",\n \"isUnderReview\": {{faker 'random.boolean'}},\n \"manuallyVerified\": {{faker 'random.boolean'}},\n \"middleName\": \"\",\n \"mrz1\": \"\",\n \"mrz2\": \"\",\n \"mrz3\": \"\",\n \"nameCheck\": {{faker 'random.boolean'}},\n \"nameCheckMethod\": \"{{oneOf (array '0' '1' '2')}}\",\n \"nfcCheck\": {{faker 'random.boolean'}},\n \"nfcReadStatus\": \"{{oneOf (array '0' '1' '2' '3' '4' '5' '6' '7' '8' '9')}}\",\n \"primaryScanId\": \"{{faker 'random.uuid'}}\",\n \"status\": \"{{oneOf (array '0' '1' '2' '3')}}\",\n \"surname\": \"\"\n }\n ],\n \"idVerification\": {\n \"checkStatus\": \"{{oneOf (array '0' '1' '2' '3')}}\",\n \"hasBeenOverridden\": {{faker 'random.boolean'}}\n },\n \"isAgentLed\": {{faker 'random.boolean'}},\n \"livenessMethod\": \"{{oneOf (array '0' '1' '2')}}\",\n \"livenessStatus\": \"{{oneOf (array '0' '1' '2' '3' '4')}}\",\n \"livenessVerified\": {{faker 'random.boolean'}},\n \"personalDetails\": {\n \"address\": {\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"addressLine3\": \"\",\n \"city\": \"\",\n \"country\": \"\",\n \"county\": \"\",\n \"postcode\": \"\"\n },\n \"dateOfBirth\": \"{{faker 'date.recent' 365}}\",\n \"forename\": \"\",\n \"surname\": \"\"\n },\n \"phoneNumber\": \"\",\n \"proofOfOwnershipCheck\": {\n \"checkStatus\": \"{{oneOf (array '0' '1' '2' '3')}}\",\n \"hasBeenOverridden\": {{faker 'random.boolean'}},\n \"matchResult\": \"{{oneOf (array '0' '1' '2' '3' '4' '5' '6' '7')}}\",\n \"matchResultText\": \"\",\n \"propertyOwnership\": \"{{oneOf (array '0' '1' '2')}}\",\n \"propertyOwnershipText\": \"\",\n \"titleNumber\": \"\"\n },\n \"referenceId\": \"\",\n \"regCode\": \"\",\n \"regTypeId\": \"{{faker 'random.uuid'}}\",\n \"rightToWorkDocumentsProvided\": \"{{oneOf (array '0' '1' '2')}}\",\n \"status\": \"{{oneOf (array '0' '1' '2' '3' '4' '6')}}\",\n \"surname\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Registration summary object.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "0b898b59-7ddb-4f8e-ad95-e343a9f33852", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "If the service was supplied invalid data.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "3e5aa41e-afc2-4b05-a7a1-c36976d56ddc", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "If credentials supplied were invalid.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "024f3a7d-d18d-4e05-b552-6bd4847756d9", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "If requesting entity have no permission to access the resource.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "7fd3506f-b94c-42cd-af30-c1418939ce4c", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If registration matching the RegCode was not found.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "456604cb-4439-4a78-ba8d-64835d495d9d", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 500, "label": "If an unexpected exception occurred whilst processing the request.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "ece2d8b5-1f78-4b8c-a285-b8060cfa0417", "documentation": "Gets paged registration list by search criteria or nothing if there are no matching fields.\r\nOptional parameters may be appended to the query string.\r\nMaximum page size is 50.", "method": "get", "endpoint": "api/registrations/search", "responses": [ { "uuid": "b9576a11-3c16-4e4f-ad70-d8413ccc4631", "body": "{\n \"registrationSummaries\": [\n {\n \"bankAccountChecks\": [\n {\n \"accountNumber\": \"\",\n \"accountNumberValidation\": \"{{oneOf (array '0' '1' '2' '3' '4' '5')}}\",\n \"accountNumberValidationText\": \"\",\n \"accountStatus\": \"{{oneOf (array '0' '1' '2' '3')}}\",\n \"accountStatusText\": \"\",\n \"accountValid\": {{faker 'random.boolean'}},\n \"addressValidation\": \"{{oneOf (array '0' '1' '2' '3' '4')}}\",\n \"addressValidationText\": \"\",\n \"checkDate\": \"{{faker 'date.recent' 365}}\",\n \"checkId\": \"{{faker 'random.uuid'}}\",\n \"checkStatus\": \"{{oneOf (array '0' '1' '2' '3')}}\",\n \"error\": {{faker 'random.boolean'}},\n \"hasBeenOverridden\": {{faker 'random.boolean'}},\n \"nameValidation\": \"{{oneOf (array '0' '1' '2')}}\",\n \"nameValidationText\": \"\",\n \"referenceId\": \"\",\n \"sortcode\": \"\",\n \"sortcodeValidation\": \"{{oneOf (array '0' '1' '2' '3' '4')}}\",\n \"sortcodeValidationText\": \"\"\n }\n ],\n \"creditStatusCheck\": {\n \"ccj\": [\n {\n \"address1\": \"\",\n \"address2\": \"\",\n \"address3\": \"\",\n \"address4\": \"\",\n \"address5\": \"\",\n \"amount\": \"\",\n \"caseNumber\": \"\",\n \"courtName\": \"\",\n \"dateEnd\": \"{{faker 'date.recent' 365}}\",\n \"dob\": \"{{faker 'date.recent' 365}}\",\n \"judgementDate\": \"{{faker 'date.recent' 365}}\",\n \"judgementType\": \"{{oneOf (array '0' '1' '2' '3' '4' '5')}}\",\n \"judgementTypeText\": \"\",\n \"name\": \"\",\n \"postcode\": \"\"\n }\n ],\n \"checkDate\": \"{{faker 'date.recent' 365}}\",\n \"companyDirector\": [\n {\n \"companyAppointments\": [\n {\n \"address\": \"\",\n \"appointmentDate\": \"{{faker 'date.recent' 365}}\",\n \"appointmentType\": \"\",\n \"dob\": \"{{faker 'date.recent' 365}}\",\n \"name\": \"\",\n \"nationality\": \"\",\n \"occupation\": \"\",\n \"title\": \"\"\n }\n ],\n \"companyName\": \"\",\n \"companyRegNo\": \"\",\n \"dateAppointed\": \"{{faker 'date.recent' 365}}\",\n \"matchType\": \"{{oneOf (array '0' '1' '2' '3')}}\",\n \"matchTypeText\": \"\",\n \"registeredOffice\": \"\"\n }\n ],\n \"hasBeenOverridden\": {{faker 'random.boolean'}},\n \"insolvency\": [\n {\n \"address\": {\n \"address1\": \"\",\n \"address2\": \"\",\n \"address3\": \"\",\n \"address4\": \"\",\n \"address5\": \"\",\n \"dps\": \"\",\n \"isEmpty\": {{faker 'random.boolean'}},\n \"postcode\": \"\"\n },\n \"aliases\": \"\",\n \"assetTotal\": \"\",\n \"caseNo\": \"\",\n \"caseType\": \"\",\n \"court\": \"\",\n \"debtTotal\": \"\",\n \"description\": \"\",\n \"dob\": \"{{faker 'date.recent' 365}}\",\n \"name\": \"\",\n \"occupation\": \"\",\n \"presentationDate\": \"{{faker 'date.recent' 365}}\",\n \"previousAddress\": {\n \"address1\": \"\",\n \"address2\": \"\",\n \"address3\": \"\",\n \"address4\": \"\",\n \"address5\": \"\",\n \"dps\": \"\",\n \"isEmpty\": {{faker 'random.boolean'}},\n \"postcode\": \"\"\n },\n \"serviceOffice\": \"\",\n \"startDate\": \"{{faker 'date.recent' 365}}\",\n \"status\": \"\",\n \"telephoneNumber\": \"\",\n \"tradingNames\": \"\",\n \"type\": \"{{oneOf (array '0' '1' '2' '3' '4' '5')}}\",\n \"typeText\": \"\"\n }\n ],\n \"status\": \"{{oneOf (array '0' '1' '2' '3')}}\"\n },\n \"customTermsAccepted\": {{faker 'random.boolean'}},\n \"customTermsAcceptedDateTime\": \"{{faker 'date.recent' 365}}\",\n \"customTermsAcceptedVersion\": {{faker 'random.number'}},\n \"dataCheckResult\": \"{{oneOf (array '0' '1' '2' '3')}}\",\n \"dataCheckSources\": [\n {\n \"dateCreated\": \"{{faker 'date.recent' 365}}\",\n \"hasBeenOverridden\": {{faker 'random.boolean'}},\n \"hasPepSanctionsData\": {{faker 'random.boolean'}},\n \"label\": \"\",\n \"pepSanctionsData\": [\n {\n \"addresses\": [\n {\n \"lines\": [\n \"\"\n ]\n }\n ],\n \"aliases\": [\n \"\"\n ],\n \"fullName\": \"\",\n \"id\": \"\",\n \"positions\": [\n {\n \"country\": \"\",\n \"position\": \"\"\n }\n ],\n \"sanctionBodies\": [\n \"\"\n ],\n \"sanctionDates\": [\n {\n \"date\": \"{{faker 'date.recent' 365}}\",\n \"day\": {{faker 'random.number'}},\n \"month\": {{faker 'random.number'}},\n \"type\": \"{{oneOf (array '0' '1' '2')}}\",\n \"year\": {{faker 'random.number'}}\n }\n ]\n }\n ],\n \"remarks\": [\n {\n \"category\": \"{{oneOf (array '1' '2' '3' '4')}}\",\n \"description\": \"\"\n }\n ],\n \"sourceType\": \"{{oneOf (array '0' '1' '2' '3' '4' '5' '6' '7' '8' '9' '10')}}\",\n \"status\": \"{{oneOf (array '0' '1' '2' '3')}}\"\n }\n ],\n \"dataChecksPerformed\": {{faker 'random.boolean'}},\n \"dateCreated\": \"{{faker 'date.recent' 365}}\",\n \"email\": \"\",\n \"forename\": \"\",\n \"id\": \"{{faker 'random.uuid'}}\",\n \"idDocuments\": [\n {\n \"addressCity\": \"\",\n \"addressFull\": \"\",\n \"addressPostcode\": \"\",\n \"country\": \"\",\n \"countryCode\": \"\",\n \"dateCreated\": \"{{faker 'date.recent' 365}}\",\n \"dateOfBirth\": \"{{faker 'date.recent' 365}}\",\n \"description\": \"\",\n \"documentAnalysisResult\": \"{{oneOf (array '0' '1' '2' '3' '4' '5' '10' '11')}}\",\n \"documentNumber\": \"\",\n \"documentSide\": \"{{oneOf (array '0' '1' '2')}}\",\n \"expiryDate\": \"{{faker 'date.recent' 365}}\",\n \"facialMatch\": {{faker 'random.boolean'}},\n \"forename\": \"\",\n \"fullName\": \"\",\n \"id\": \"{{faker 'random.uuid'}}\",\n \"isUnderReview\": {{faker 'random.boolean'}},\n \"manuallyVerified\": {{faker 'random.boolean'}},\n \"middleName\": \"\",\n \"mrz1\": \"\",\n \"mrz2\": \"\",\n \"mrz3\": \"\",\n \"nameCheck\": {{faker 'random.boolean'}},\n \"nameCheckMethod\": \"{{oneOf (array '0' '1' '2')}}\",\n \"nfcCheck\": {{faker 'random.boolean'}},\n \"nfcReadStatus\": \"{{oneOf (array '0' '1' '2' '3' '4' '5' '6' '7' '8' '9')}}\",\n \"primaryScanId\": \"{{faker 'random.uuid'}}\",\n \"status\": \"{{oneOf (array '0' '1' '2' '3')}}\",\n \"surname\": \"\"\n }\n ],\n \"idVerification\": {\n \"checkStatus\": \"{{oneOf (array '0' '1' '2' '3')}}\",\n \"hasBeenOverridden\": {{faker 'random.boolean'}}\n },\n \"isAgentLed\": {{faker 'random.boolean'}},\n \"livenessMethod\": \"{{oneOf (array '0' '1' '2')}}\",\n \"livenessStatus\": \"{{oneOf (array '0' '1' '2' '3' '4')}}\",\n \"livenessVerified\": {{faker 'random.boolean'}},\n \"personalDetails\": {\n \"address\": {\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"addressLine3\": \"\",\n \"city\": \"\",\n \"country\": \"\",\n \"county\": \"\",\n \"postcode\": \"\"\n },\n \"dateOfBirth\": \"{{faker 'date.recent' 365}}\",\n \"forename\": \"\",\n \"surname\": \"\"\n },\n \"phoneNumber\": \"\",\n \"proofOfOwnershipCheck\": {\n \"checkStatus\": \"{{oneOf (array '0' '1' '2' '3')}}\",\n \"hasBeenOverridden\": {{faker 'random.boolean'}},\n \"matchResult\": \"{{oneOf (array '0' '1' '2' '3' '4' '5' '6' '7')}}\",\n \"matchResultText\": \"\",\n \"propertyOwnership\": \"{{oneOf (array '0' '1' '2')}}\",\n \"propertyOwnershipText\": \"\",\n \"titleNumber\": \"\"\n },\n \"referenceId\": \"\",\n \"regCode\": \"\",\n \"regTypeId\": \"{{faker 'random.uuid'}}\",\n \"rightToWorkDocumentsProvided\": \"{{oneOf (array '0' '1' '2')}}\",\n \"status\": \"{{oneOf (array '0' '1' '2' '3' '4' '6')}}\",\n \"surname\": \"\"\n }\n ],\n \"totalCount\": {{faker 'random.number'}}\n}", "latency": 0, "statusCode": 200, "label": "Registration summary object list.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "2c8d5586-f5e5-4bb1-9c07-5cbe7cb149d6", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "If the service was supplied invalid data.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "b2056cfe-c8e4-4540-a92c-e07b259b078d", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "If credentials supplied were invalid.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "6080b797-b704-4182-a9ea-ecc4a39da6c4", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "If requesting entity have no permission to access the resource.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "b5ab063b-d68c-45eb-a866-aae076fded70", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If registration matching the Id was not found.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "f1ce1f6c-331d-4c78-8491-6a3fc3ccc17a", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 500, "label": "If an unexpected exception occurred whilst processing the request.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "1d763f9f-2134-4dec-8217-ab53e0cdcb23", "documentation": "Checks if submitted documents are sufficient to complete registration.", "method": "get", "endpoint": "api/registrations/:id/check-submitted-id-documents", "responses": [ { "uuid": "7143fe00-9447-47fa-8830-352fafb3c9fe", "body": "{\n \"checkCode\": \"{{oneOf (array '1' '2' '3')}}\",\n \"message\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "OK response with object containing the result of the document check.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "92d772c7-aaa2-4fa4-b27b-a083d1c100de", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "If the service was supplied invalid data.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "3ad5d9d9-c963-4b19-9e0a-52b0fa4141fc", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "If credentials supplied were invalid.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "bfae849d-a63c-44b7-a0f3-805515468939", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 500, "label": "If an unexpected exception occurred whilst processing the request.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "a0785a4c-e2a4-4f9e-b307-2c604bf3268c", "documentation": "Updates a registration's contact details.", "method": "put", "endpoint": "api/registrations/:id/contact-details", "responses": [ { "uuid": "5b448d3d-beda-4c10-a044-faafb77219db", "body": "", "latency": 0, "statusCode": 200, "label": "Registration contact details updated.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "2aa950ac-440b-41f8-88d2-390389dae311", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "If the service was supplied invalid data.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "2742bfcd-c4cf-4940-8205-bcd8ef2e8fe2", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "If credentials supplied were invalid.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "3e2c7e18-2eec-4a7d-a889-70056b3db997", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "If requesting entity have no permission to access the resource.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "ca1d69d1-11f7-4bed-80bb-15c9d9a10e5a", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If registration matching the Id was not found.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "f907129a-2c54-4e2b-bb52-8d1cc12b572a", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 500, "label": "If an unexpected exception occurred whilst processing the request.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "4cfcef69-7aee-4eb5-92b7-05528253fb69", "documentation": "Sets an override for a specific check on the registration.", "method": "put", "endpoint": "api/registrations/:id/override-check-status", "responses": [ { "uuid": "7d7c493b-e767-4eaa-996a-226b063b48e3", "body": "", "latency": 0, "statusCode": 200, "label": "Status of the operation.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "97b2e6d2-6436-4db3-adcf-86ef1a9b762e", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "If the service was supplied invalid data.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "8c509c4d-49c5-424d-ab8c-0f59b51823ad", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "If credentials supplied were invalid.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "e1a4d797-0c94-4599-9154-d60d45263131", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "If requesting entity have no permission to access the resource.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "c389f16b-422d-4111-b479-8fda93eeee2e", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If registration matching the Id was not found.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "e6f589c6-ac1c-4e06-bda5-3f0a18c3dbef", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 500, "label": "If an unexpected exception occurred whilst processing the request.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "48c3863a-2c0e-4af5-91fa-e39af5f4ac10", "documentation": "Returns PDF export for a given registration.", "method": "get", "endpoint": "api/registrations/:id/pdf-export", "responses": [ { "uuid": "a1a4c0a3-5765-497f-819f-ac2f40eb3225", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "PDF document containing registration extract as byte stream.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "db5de5e6-7bbc-4b86-95d8-757bbfba4664", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "If the service was supplied invalid data.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "8bb69564-8371-463e-bfe9-53f9f834d6bc", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "If credentials supplied were invalid.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "7ee83157-3603-43ca-b77c-a7bca5c0b21d", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "If requesting entity have no permission to access the resource.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "885c5bc6-f1d7-4d4a-846d-410a2111cbbf", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If registration matching the Id was not found.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "cceda789-8579-4a5b-9d21-b83930857a0a", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 500, "label": "If an unexpected exception occurred whilst processing the request.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "e0c414a1-8150-4aeb-a016-0532072ec375", "documentation": "Resends any invitation for the specified registration.", "method": "post", "endpoint": "api/registrations/:id/resend-invitation", "responses": [ { "uuid": "95b3176c-4037-4a53-b289-83b94bae8f12", "body": "", "latency": 0, "statusCode": 200, "label": "Invitation sent.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "76f02701-6f0d-4285-9e1b-0145604c2ac7", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "If the service was supplied invalid data.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "27fe91ef-b8e0-4c61-bd6e-30f40ff7c232", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "If credentials supplied were invalid.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "6f97081e-5087-4dea-92e4-8a8ff1c69f3e", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "If requesting entity have no permission to access the resource.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "15f5a2e8-107b-498f-ab8f-f3847084b307", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If registration matching the Id was not found.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "a35a7ff7-161f-48b8-9d9c-8379e6541965", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 500, "label": "If an unexpected exception occurred whilst processing the request.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "e6b64f61-1673-4968-9190-314f734cf4e6", "documentation": "Gets registration settings or nothing if there are no settings associated with the registration.", "method": "get", "endpoint": "api/registrations/:id/settings", "responses": [ { "uuid": "7ba2f10a-8ae5-4b19-bece-cea8e73d3538", "body": "", "latency": 0, "statusCode": 200, "label": "Registration settings updated.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "ed7d87f8-d9da-44cb-85f6-c81daf214221", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "If the service was supplied invalid data.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "48d41235-d39f-45b2-9275-15b35d34c745", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "If credentials supplied were invalid.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "c5298a09-1080-472b-95f0-52c1a6155173", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "If requesting entity have no permission to access the resource.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "2af0b179-905c-4cdf-85bd-407ff79baa18", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If registration matching the Id was not found.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "8fdd23de-5cbc-4d87-ba78-72f2881f9f7c", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 500, "label": "If an unexpected exception occurred whilst processing the request.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "93145937-fbca-4dd1-be02-0b60ed4b5d3a", "documentation": "Updates registration settings.", "method": "put", "endpoint": "api/registrations/:id/settings", "responses": [ { "uuid": "f3f460ae-ac65-47b5-8c7e-3fd38e5b5e32", "body": "", "latency": 0, "statusCode": 200, "label": "Registration settings updated.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "0553d8aa-d4e8-489d-9a45-6108cfbf8962", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "If the service was supplied invalid data.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "e9a2326c-a5b3-4f01-9df5-c3e2a3c86629", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "If credentials supplied were invalid.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "7df02fe6-9929-4302-95c0-eb745a31c405", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "If requesting entity have no permission to access the resource.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "3c75993c-48e8-4238-8fd8-5e1ef2ddf6c6", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If registration matching the Id was not found.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "13d55568-a6c6-4004-b80a-48572c84ae07", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 500, "label": "If an unexpected exception occurred whilst processing the request.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "074c43a5-fd74-4f6a-8acc-acb2eed8994b", "documentation": "Updates the status of the registration to one specified in the request.", "method": "put", "endpoint": "api/registrations/:id/status", "responses": [ { "uuid": "d7182028-8f02-4103-86f0-0f794802fa9d", "body": "", "latency": 0, "statusCode": 200, "label": "Update was successful.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "f987d490-9616-45ed-8292-f8cac4235b91", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "If the service was supplied invalid data.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "97fdf412-cdb5-4dfd-b02d-c295d0f2a077", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "If credentials supplied were invalid.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "904aa3d3-476a-490c-b212-70579a0cb98d", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If the registration was not found.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "146f171a-2f6b-497c-a3e6-5ec916b61387", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 500, "label": "If an unexpected exception occurred whilst processing the request.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "35883371-4fad-4679-bdff-86cfaf92237d", "documentation": "Finds a registration by the Id.", "method": "get", "endpoint": "api/registrations/:id/summary", "responses": [ { "uuid": "2529ed28-d016-4d85-9ab2-634133a849c7", "body": "{\n \"bankAccountChecks\": [\n {\n \"accountNumber\": \"\",\n \"accountNumberValidation\": \"{{oneOf (array '0' '1' '2' '3' '4' '5')}}\",\n \"accountNumberValidationText\": \"\",\n \"accountStatus\": \"{{oneOf (array '0' '1' '2' '3')}}\",\n \"accountStatusText\": \"\",\n \"accountValid\": {{faker 'random.boolean'}},\n \"addressValidation\": \"{{oneOf (array '0' '1' '2' '3' '4')}}\",\n \"addressValidationText\": \"\",\n \"checkDate\": \"{{faker 'date.recent' 365}}\",\n \"checkId\": \"{{faker 'random.uuid'}}\",\n \"checkStatus\": \"{{oneOf (array '0' '1' '2' '3')}}\",\n \"error\": {{faker 'random.boolean'}},\n \"hasBeenOverridden\": {{faker 'random.boolean'}},\n \"nameValidation\": \"{{oneOf (array '0' '1' '2')}}\",\n \"nameValidationText\": \"\",\n \"referenceId\": \"\",\n \"sortcode\": \"\",\n \"sortcodeValidation\": \"{{oneOf (array '0' '1' '2' '3' '4')}}\",\n \"sortcodeValidationText\": \"\"\n }\n ],\n \"creditStatusCheck\": {\n \"ccj\": [\n {\n \"address1\": \"\",\n \"address2\": \"\",\n \"address3\": \"\",\n \"address4\": \"\",\n \"address5\": \"\",\n \"amount\": \"\",\n \"caseNumber\": \"\",\n \"courtName\": \"\",\n \"dateEnd\": \"{{faker 'date.recent' 365}}\",\n \"dob\": \"{{faker 'date.recent' 365}}\",\n \"judgementDate\": \"{{faker 'date.recent' 365}}\",\n \"judgementType\": \"{{oneOf (array '0' '1' '2' '3' '4' '5')}}\",\n \"judgementTypeText\": \"\",\n \"name\": \"\",\n \"postcode\": \"\"\n }\n ],\n \"checkDate\": \"{{faker 'date.recent' 365}}\",\n \"companyDirector\": [\n {\n \"companyAppointments\": [\n {\n \"address\": \"\",\n \"appointmentDate\": \"{{faker 'date.recent' 365}}\",\n \"appointmentType\": \"\",\n \"dob\": \"{{faker 'date.recent' 365}}\",\n \"name\": \"\",\n \"nationality\": \"\",\n \"occupation\": \"\",\n \"title\": \"\"\n }\n ],\n \"companyName\": \"\",\n \"companyRegNo\": \"\",\n \"dateAppointed\": \"{{faker 'date.recent' 365}}\",\n \"matchType\": \"{{oneOf (array '0' '1' '2' '3')}}\",\n \"matchTypeText\": \"\",\n \"registeredOffice\": \"\"\n }\n ],\n \"hasBeenOverridden\": {{faker 'random.boolean'}},\n \"insolvency\": [\n {\n \"address\": {\n \"address1\": \"\",\n \"address2\": \"\",\n \"address3\": \"\",\n \"address4\": \"\",\n \"address5\": \"\",\n \"dps\": \"\",\n \"isEmpty\": {{faker 'random.boolean'}},\n \"postcode\": \"\"\n },\n \"aliases\": \"\",\n \"assetTotal\": \"\",\n \"caseNo\": \"\",\n \"caseType\": \"\",\n \"court\": \"\",\n \"debtTotal\": \"\",\n \"description\": \"\",\n \"dob\": \"{{faker 'date.recent' 365}}\",\n \"name\": \"\",\n \"occupation\": \"\",\n \"presentationDate\": \"{{faker 'date.recent' 365}}\",\n \"previousAddress\": {\n \"address1\": \"\",\n \"address2\": \"\",\n \"address3\": \"\",\n \"address4\": \"\",\n \"address5\": \"\",\n \"dps\": \"\",\n \"isEmpty\": {{faker 'random.boolean'}},\n \"postcode\": \"\"\n },\n \"serviceOffice\": \"\",\n \"startDate\": \"{{faker 'date.recent' 365}}\",\n \"status\": \"\",\n \"telephoneNumber\": \"\",\n \"tradingNames\": \"\",\n \"type\": \"{{oneOf (array '0' '1' '2' '3' '4' '5')}}\",\n \"typeText\": \"\"\n }\n ],\n \"status\": \"{{oneOf (array '0' '1' '2' '3')}}\"\n },\n \"customTermsAccepted\": {{faker 'random.boolean'}},\n \"customTermsAcceptedDateTime\": \"{{faker 'date.recent' 365}}\",\n \"customTermsAcceptedVersion\": {{faker 'random.number'}},\n \"dataCheckResult\": \"{{oneOf (array '0' '1' '2' '3')}}\",\n \"dataCheckSources\": [\n {\n \"dateCreated\": \"{{faker 'date.recent' 365}}\",\n \"hasBeenOverridden\": {{faker 'random.boolean'}},\n \"hasPepSanctionsData\": {{faker 'random.boolean'}},\n \"label\": \"\",\n \"pepSanctionsData\": [\n {\n \"addresses\": [\n {\n \"lines\": [\n \"\"\n ]\n }\n ],\n \"aliases\": [\n \"\"\n ],\n \"fullName\": \"\",\n \"id\": \"\",\n \"positions\": [\n {\n \"country\": \"\",\n \"position\": \"\"\n }\n ],\n \"sanctionBodies\": [\n \"\"\n ],\n \"sanctionDates\": [\n {\n \"date\": \"{{faker 'date.recent' 365}}\",\n \"day\": {{faker 'random.number'}},\n \"month\": {{faker 'random.number'}},\n \"type\": \"{{oneOf (array '0' '1' '2')}}\",\n \"year\": {{faker 'random.number'}}\n }\n ]\n }\n ],\n \"remarks\": [\n {\n \"category\": \"{{oneOf (array '1' '2' '3' '4')}}\",\n \"description\": \"\"\n }\n ],\n \"sourceType\": \"{{oneOf (array '0' '1' '2' '3' '4' '5' '6' '7' '8' '9' '10')}}\",\n \"status\": \"{{oneOf (array '0' '1' '2' '3')}}\"\n }\n ],\n \"dataChecksPerformed\": {{faker 'random.boolean'}},\n \"dateCreated\": \"{{faker 'date.recent' 365}}\",\n \"email\": \"\",\n \"forename\": \"\",\n \"id\": \"{{faker 'random.uuid'}}\",\n \"idDocuments\": [\n {\n \"addressCity\": \"\",\n \"addressFull\": \"\",\n \"addressPostcode\": \"\",\n \"country\": \"\",\n \"countryCode\": \"\",\n \"dateCreated\": \"{{faker 'date.recent' 365}}\",\n \"dateOfBirth\": \"{{faker 'date.recent' 365}}\",\n \"description\": \"\",\n \"documentAnalysisResult\": \"{{oneOf (array '0' '1' '2' '3' '4' '5' '10' '11')}}\",\n \"documentNumber\": \"\",\n \"documentSide\": \"{{oneOf (array '0' '1' '2')}}\",\n \"expiryDate\": \"{{faker 'date.recent' 365}}\",\n \"facialMatch\": {{faker 'random.boolean'}},\n \"forename\": \"\",\n \"fullName\": \"\",\n \"id\": \"{{faker 'random.uuid'}}\",\n \"isUnderReview\": {{faker 'random.boolean'}},\n \"manuallyVerified\": {{faker 'random.boolean'}},\n \"middleName\": \"\",\n \"mrz1\": \"\",\n \"mrz2\": \"\",\n \"mrz3\": \"\",\n \"nameCheck\": {{faker 'random.boolean'}},\n \"nameCheckMethod\": \"{{oneOf (array '0' '1' '2')}}\",\n \"nfcCheck\": {{faker 'random.boolean'}},\n \"nfcReadStatus\": \"{{oneOf (array '0' '1' '2' '3' '4' '5' '6' '7' '8' '9')}}\",\n \"primaryScanId\": \"{{faker 'random.uuid'}}\",\n \"status\": \"{{oneOf (array '0' '1' '2' '3')}}\",\n \"surname\": \"\"\n }\n ],\n \"idVerification\": {\n \"checkStatus\": \"{{oneOf (array '0' '1' '2' '3')}}\",\n \"hasBeenOverridden\": {{faker 'random.boolean'}}\n },\n \"isAgentLed\": {{faker 'random.boolean'}},\n \"livenessMethod\": \"{{oneOf (array '0' '1' '2')}}\",\n \"livenessStatus\": \"{{oneOf (array '0' '1' '2' '3' '4')}}\",\n \"livenessVerified\": {{faker 'random.boolean'}},\n \"personalDetails\": {\n \"address\": {\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"addressLine3\": \"\",\n \"city\": \"\",\n \"country\": \"\",\n \"county\": \"\",\n \"postcode\": \"\"\n },\n \"dateOfBirth\": \"{{faker 'date.recent' 365}}\",\n \"forename\": \"\",\n \"surname\": \"\"\n },\n \"phoneNumber\": \"\",\n \"proofOfOwnershipCheck\": {\n \"checkStatus\": \"{{oneOf (array '0' '1' '2' '3')}}\",\n \"hasBeenOverridden\": {{faker 'random.boolean'}},\n \"matchResult\": \"{{oneOf (array '0' '1' '2' '3' '4' '5' '6' '7')}}\",\n \"matchResultText\": \"\",\n \"propertyOwnership\": \"{{oneOf (array '0' '1' '2')}}\",\n \"propertyOwnershipText\": \"\",\n \"titleNumber\": \"\"\n },\n \"referenceId\": \"\",\n \"regCode\": \"\",\n \"regTypeId\": \"{{faker 'random.uuid'}}\",\n \"rightToWorkDocumentsProvided\": \"{{oneOf (array '0' '1' '2')}}\",\n \"status\": \"{{oneOf (array '0' '1' '2' '3' '4' '6')}}\",\n \"surname\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Registration summary object.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "1a5e5769-69ae-44ec-acc5-91ec71e87fd6", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "If the service was supplied invalid data.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "81fe97bd-8392-4148-bb36-eb785255a9c5", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "If credentials supplied were invalid.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "5a9ce45b-e394-4166-ae3e-3093f7303a82", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "If requesting entity have no permission to access the resource.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "ab753d6c-90b6-4256-bc0c-b69bd02e501a", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If registration matching the Id was not found.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "3bbee5c0-9521-4460-9531-6e1a452075ad", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 500, "label": "If an unexpected exception occurred whilst processing the request.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "5f0f55ef-0d7f-44fc-a2d1-fb9613c43ff0", "documentation": "Get a list of supported id document for the specified registration id.", "method": "get", "endpoint": "api/registrations/:id/supported-id-documents", "responses": [ { "uuid": "2e49dca6-63f2-44cb-a5ff-a7a81d95ff33", "body": "{\n \"name\": \"\",\n \"type\": \"{{oneOf (array '0' '1' '2' '3' '4' '5' '6' '7' '8' '9')}}\"\n}", "latency": 0, "statusCode": 200, "label": "List of supported id document objects.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "3f47d189-973c-457f-a9b1-794c2d46fa3b", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "If the service was supplied invalid data.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "8ba2d258-676d-4071-8826-957f71433bfd", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "If credentials supplied were invalid.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "86361d83-e5ca-492e-9578-add86a79256f", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "If requesting entity have no permission to access the resource.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "0ea1c9f3-5b1a-4cd8-8cc9-db0c87e44a48", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "If registration matching the Id was not found.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "a1a55222-6f65-49bc-bff0-b1bed9fa513a", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 500, "label": "If an unexpected exception occurred whilst processing the request.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "8d9e13a6-5f6f-4cee-8017-e3911c58d191", "documentation": "Retrieves secure links to registration details pages searching by the Reference Id.", "method": "post", "endpoint": "api/report-view/by-referenceid", "responses": [ { "uuid": "81e2ee9d-856b-4883-b354-ecdd1518d899", "body": "{\n \"results\": [\n {\n \"forename\": \"\",\n \"surname\": \"\",\n \"url\": \"\",\n \"validUntil\": \"{{faker 'date.recent' 365}}\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Results of the query", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "6742bff1-6111-4e2f-ac37-9c9b21eb1ee0", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "If the service was supplied invalid data.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "0b181597-98bf-4502-a41b-a71aea8e4216", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "If credentials supplied were invalid.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "f2ea5ad6-800f-4cee-aaeb-e4ce7e8e1a34", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 500, "label": "If an unexpected exception occurred whilst processing the request.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "c4399f31-5d18-4bf9-8edd-13a8a90be545", "documentation": "Retrieves secure link to registration details page searching by the Registration Id.", "method": "post", "endpoint": "api/report-view/by-registrationid", "responses": [ { "uuid": "376dbfec-51ed-4572-83dd-fb9c4529907b", "body": "{\n \"results\": [\n {\n \"forename\": \"\",\n \"surname\": \"\",\n \"url\": \"\",\n \"validUntil\": \"{{faker 'date.recent' 365}}\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Results of the query", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "b621498a-3799-4da6-8a62-6b1f53771d8a", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "If the service was supplied invalid data.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "d611a185-0eea-4d59-b07a-a4c104f0f30a", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "If credentials supplied were invalid.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "af7da962-8051-4ad2-930e-6cd3e5c934ea", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 500, "label": "If an unexpected exception occurred whilst processing the request.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "f5f9ad25-240c-4373-b267-c1414eed306a", "documentation": "Retrieves secure links to web verification pages searching by the Reference Id.", "method": "post", "endpoint": "api/web-verifications/by-referenceid", "responses": [ { "uuid": "b0d4f591-1a37-4ef4-9247-4f79432414a0", "body": "{\n \"results\": [\n {\n \"journeyUrl\": {\n \"url\": \"\",\n \"validUntil\": \"{{faker 'date.recent' 365}}\"\n }\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Results of the query", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "a5b3db64-ab82-43b6-8982-8f734daf8b0c", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "If the service was supplied invalid data.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "13fac593-bdc6-4746-a0d2-1336309830ea", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "If credentials supplied were invalid.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "a50f0159-6594-4b94-98ed-8cc259f49cca", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 500, "label": "If an unexpected exception occurred whilst processing the request.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "1c0cf222-8ccf-45dd-a4a5-7f003b271ff2", "documentation": "Retrieves secure link to web verification page searching by the Registration Id.", "method": "post", "endpoint": "api/web-verifications/by-registrationid", "responses": [ { "uuid": "0d1bc04a-f7a0-44e8-a997-e1d0d3dd58d6", "body": "{\n \"results\": [\n {\n \"journeyUrl\": {\n \"url\": \"\",\n \"validUntil\": \"{{faker 'date.recent' 365}}\"\n }\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Results of the query", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "63e2d382-593d-4819-8411-eb5b79a2091f", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "If the service was supplied invalid data.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "0cb341bf-bccd-4797-850b-ca039784f1f3", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "If credentials supplied were invalid.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "bec749da-ddba-405a-a34c-a9d4e74f786a", "body": "{\n \"details\": {},\n \"message\": \"\"\n}", "latency": 0, "statusCode": 500, "label": "If an unexpected exception occurred whilst processing the request.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false } ], "proxyMode": false, "proxyHost": "", "proxyRemovePrefix": false, "tlsOptions": { "enabled": false, "type": "CERT", "pfxPath": "", "certPath": "", "keyPath": "", "caPath": "", "passphrase": "" }, "cors": true, "headers": [], "proxyReqHeaders": [ { "key": "", "value": "" } ], "proxyResHeaders": [ { "key": "", "value": "" } ] }