openapi-directory
Version:
Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS
1 lines • 198 kB
JSON
{"openapi":"3.0.0","info":{"title":"Credas API","version":"v1","x-apisguru-categories":["security"],"x-logo":{"url":"https://www.credas.co.uk/wp-content/uploads/2018/02/favicon.png"},"x-origin":[{"format":"openapi","url":"https://pi-api.credas.co.uk/swagger/v1/swagger.json","version":"3.0"}],"x-providerName":"credas.co.uk","x-serviceName":"pi"},"paths":{"/api/bank-accounts/verify":{"post":{"operationId":"Verify","parameters":[{"description":"ApiKey supplied.","in":"header","name":"apikey","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/*+json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.BankAccounts.AccountVerificationRequest"}},"application/*+xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.BankAccounts.AccountVerificationRequest"}},"application/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.BankAccounts.AccountVerificationRequest"}},"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.BankAccounts.AccountVerificationRequest"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.BankAccounts.AccountVerificationRequest"}},"text/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.BankAccounts.AccountVerificationRequest"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.BankAccounts.AccountVerificationRequest"}}},"description":"Object containing data required to perform bank account verification."},"responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"Address1":null,"City":null,"Forename":null,"MiddleName":null,"PostCode":null,"Surname":null,"accountNumber":"12345678","accountNumberValidation":2,"accountNumberValidationText":"Valid","accountStatus":2,"accountStatusText":"Live","accountValid":true,"addressValidation":2,"addressValidationText":"Current address","checkDate":"2025-06-15T13:48:28.847Z","checkId":"12345678-1234-5678-abcd-1234567890ab","checkStatus":1,"error":false,"hasBeenOverridden":false,"nameValidation":2,"nameValidationText":"Valid","referenceId":"RF1234","sortcode":"123456","sortcodeValidation":2,"sortcodeValidationText":"Valid"}}},"schema":{"$ref":"#/components/schemas/Credas.Api.Models.BankAccounts.AccountVerificationResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.BankAccounts.AccountVerificationResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.BankAccounts.AccountVerificationResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.BankAccounts.AccountVerificationResponse"}}},"description":"Success"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}}},"description":"If the service was supplied invalid data."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}}},"description":"If credentials supplied were invalid."},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}}},"description":"Error code meaning that the operation was aborted due to insufficient credits."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}}},"description":"If an unexpected exception occurred whilst processing the request."}},"summary":"Verifies bank account details.","tags":["BankAccounts"]}},"/api/companies":{"post":{"description":"If a company appears multiple times within the structure, it will only be detailed in full (i.e. with significant ownership details) in its first instance. Subsequent instances will be \r\n marked as duplicates.\r\n Whilst duplicate instances of companies can and will be identified, it is not possible to categorically identify duplicated people.","operationId":"SearchCompany","parameters":[{"description":"The company registration number of the company that should be searched.","in":"query","name":"companyNumber","required":false,"schema":{"type":"string"}},{"description":"ApiKey supplied.","in":"header","name":"apikey","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"addressLine1":"25 Westgate Street","companyName":"Widget Production Limited","companyNumber":"12345678","dateOfRegistration":"2025-06-15T13:48:28.847Z","duplicate":false,"id":"38eba446-0ff9-4602-9694-ee7f786ef9b1","locality":"","postCode":"CF101NS","region":"Cardiff","significantParentCompanies":[{"addressLine1":null,"companyName":"Widgets International Limited","companyNumber":"54345678","dateOfRegistration":"2025-06-15T13:48:28.847Z","duplicate":false,"id":"ebbc9433-40a6-4197-902d-d4ff2efdbaa5","locality":null,"postCode":null,"region":null,"significantParentCompanies":null,"significantPeople":[{"forename":"John","id":"b58ec846-1da1-4ac2-be27-b1dcbff8c8dd","regEntryId":null,"surname":"Smith"}]},{"addressLine1":null,"companyName":"Widget Services Limited","companyNumber":"23232321","dateOfRegistration":"2025-06-15T13:48:28.847Z","duplicate":false,"id":"48641603-7593-46a9-b993-8ead4daca09e","locality":null,"postCode":null,"region":null,"significantParentCompanies":[{"addressLine1":"25 Westgate Street","companyName":"Widgets International Limited","companyNumber":"54345678","dateOfRegistration":"2025-06-15T13:48:28.847Z","duplicate":true,"id":"ebbc9433-40a6-4197-902d-d4ff2efdbaa5","locality":"","postCode":"CF101NS","region":"Cardiff","significantParentCompanies":null,"significantPeople":null}],"significantPeople":null}],"significantPeople":[{"forename":"John","id":"108db0e1-fe11-44be-ad8f-405ed57d3fbc","regEntryId":"a5d3b128-f65d-4e6d-a9e2-ac8f2763ec7a","surname":"Smith"},{"forename":"Jane","id":"965f3298-da35-4906-8d9e-d346008289dc","regEntryId":null,"surname":"Smith"}]}}},"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Companies.CompanyDetail"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Companies.CompanyDetail"}},"text/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Companies.CompanyDetail"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Companies.CompanyDetail"}}},"description":"Success"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}}},"description":"If the service was supplied invalid data."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}}},"description":"If credentials supplied were invalid."},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}}},"description":"If the consumer doesn't have the required permission to use the endpoint."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}}},"description":"If an unexpected exception occurred whilst processing the request."}},"summary":"Searches for a company based on its Company Number and returns its details.","tags":["Companies"]}},"/api/companies/{companyId}":{"get":{"operationId":"GetCompany","parameters":[{"in":"path","name":"companyId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"ApiKey supplied.","in":"header","name":"apikey","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"addressLine1":"25 Westgate Street","companyName":"Widget Production Limited","companyNumber":"12345678","dateOfRegistration":"2025-06-15T13:48:28.848Z","duplicate":false,"id":"38eba446-0ff9-4602-9694-ee7f786ef9b1","locality":"","postCode":"CF101NS","region":"Cardiff","significantParentCompanies":[{"addressLine1":null,"companyName":"Widgets International Limited","companyNumber":"54345678","dateOfRegistration":"2025-06-15T13:48:28.848Z","duplicate":false,"id":"ebbc9433-40a6-4197-902d-d4ff2efdbaa5","locality":null,"postCode":null,"region":null,"significantParentCompanies":null,"significantPeople":[{"forename":"John","id":"b58ec846-1da1-4ac2-be27-b1dcbff8c8dd","regEntryId":null,"surname":"Smith"}]},{"addressLine1":null,"companyName":"Widget Services Limited","companyNumber":"23232321","dateOfRegistration":"2025-06-15T13:48:28.848Z","duplicate":false,"id":"48641603-7593-46a9-b993-8ead4daca09e","locality":null,"postCode":null,"region":null,"significantParentCompanies":[{"addressLine1":"25 Westgate Street","companyName":"Widgets International Limited","companyNumber":"54345678","dateOfRegistration":"2025-06-15T13:48:28.848Z","duplicate":true,"id":"ebbc9433-40a6-4197-902d-d4ff2efdbaa5","locality":"","postCode":"CF101NS","region":"Cardiff","significantParentCompanies":null,"significantPeople":null}],"significantPeople":null}],"significantPeople":[{"forename":"John","id":"108db0e1-fe11-44be-ad8f-405ed57d3fbc","regEntryId":"a5d3b128-f65d-4e6d-a9e2-ac8f2763ec7a","surname":"Smith"},{"forename":"Jane","id":"965f3298-da35-4906-8d9e-d346008289dc","regEntryId":null,"surname":"Smith"}]}}},"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Companies.CompanyDetail"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Companies.CompanyDetail"}},"text/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Companies.CompanyDetail"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Companies.CompanyDetail"}}},"description":"Success"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}}},"description":"If the service was supplied invalid data."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}}},"description":"If credentials supplied were invalid."},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}}},"description":"If the consumer doesn't have the required permission to use the endpoint."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}}},"description":"If an unexpected exception occurred whilst processing the request."}},"tags":["Companies"]}},"/api/credit-status/perform":{"post":{"operationId":"CheckCreditStatus","parameters":[{"description":"ApiKey supplied.","in":"header","name":"apikey","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/*+json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.StatusChecks.StatusCheckRequest"}},"application/*+xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.StatusChecks.StatusCheckRequest"}},"application/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.StatusChecks.StatusCheckRequest"}},"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.StatusChecks.StatusCheckRequest"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.StatusChecks.StatusCheckRequest"}},"text/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.StatusChecks.StatusCheckRequest"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.StatusChecks.StatusCheckRequest"}}},"description":"Object containing data required to perform the check."},"responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"address":null,"ccj":[{"address1":"Flat 30","address2":"Richmond Court, St. Peters Street","address3":null,"address4":null,"address5":null,"amount":"£5000.00","caseNumber":"CS1113-56-33","courtName":"CARMARTHEN COUNTY COURT","dateEnd":"2025-06-15T13:48:28.848Z","dob":"2025-06-15T13:48:28.848Z","judgementDate":"2025-06-15T13:48:28.848Z","judgementType":2,"judgementTypeText":"Satisfaction","name":"ANGELA ZOE SPECIMEN","postcode":"CF24 3AZ"}],"checkDate":"2025-06-15T13:48:28.848Z","companyDirector":[{"companyAppointments":[{"address":"FLAT 30, RICHMOND COURT, ST. PETERS STREET, CARDIFF, CF24 3AZ","appointmentDate":"2025-06-15T13:48:28.848Z","appointmentType":"Current Director","dob":"2025-06-15T13:48:28.848Z","name":"Angela Zoe Specimen","nationality":"British","occupation":"Field Agent","title":"Ms"}],"companyName":"ANGELS LIMITED","companyRegNo":"00123456","dateAppointed":"2025-06-15T13:48:28.848Z","matchType":3,"matchTypeText":"Name, Address and Date of Birth","registeredOffice":"FLAT 3, RICHMOND COURT, ST. PETERS STREET, CARDIFF, CF24 3AZ"}],"hasBeenOverridden":false,"insolvency":[{"address":{"address1":"Flat 30","address2":"Richmond Court","address3":"St Peters Street","address4":null,"address5":null,"dps":"DPS1","isEmpty":false,"postcode":"CF24 3AZ"},"aliases":"ANGEL UK","assetTotal":"£2000.00","caseNo":"IC123456789-22232","caseType":"Standard","court":"CARMARTHEN COUNTY COURT","debtTotal":"£20000.00","description":"ANGELA ZOE SPECIMEN TRADING AS ANGELS LIMITED","dob":"2025-06-15T13:48:28.848Z","name":"ANGELA SPECIMEN","occupation":"Field Agent","presentationDate":"2025-06-15T13:48:28.848Z","previousAddress":null,"serviceOffice":"MR JON WILLIAM JONES","startDate":"2025-06-15T13:48:28.848Z","status":"CURRENT","telephoneNumber":"02920113244","tradingNames":"ANGELS LTD","type":4,"typeText":"England and Wales DRO"}],"person":null,"status":3}}},"schema":{"$ref":"#/components/schemas/Credas.Api.Models.StatusChecks.StatusCheck"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.StatusChecks.StatusCheck"}},"text/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.StatusChecks.StatusCheck"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.StatusChecks.StatusCheck"}}},"description":"Success"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}}},"description":"If the service was supplied invalid data."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}}},"description":"If credentials supplied were invalid."},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}}},"description":"Error code meaning that the operation was aborted due to insufficient credits."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}}},"description":"If an unexpected exception occurred whilst processing the request."}},"summary":"Check includes identifying bankruptcy, insolvency, CCJ's or Company Directorship.","tags":["CreditStatus"]}},"/api/datachecks":{"post":{"operationId":"AddDataCheck","parameters":[{"description":"ApiKey supplied.","in":"header","name":"apikey","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/*+json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.DataCheck.AddDataCheckRequest"}},"application/*+xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.DataCheck.AddDataCheckRequest"}},"application/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.DataCheck.AddDataCheckRequest"}},"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.DataCheck.AddDataCheckRequest"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.DataCheck.AddDataCheckRequest"}},"text/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.DataCheck.AddDataCheckRequest"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.DataCheck.AddDataCheckRequest"}}},"description":"Object containing data check details."},"responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"id":"abcdef12-abcd-abcd-beef-ab123cd12345","regCode":"QX92TAG7"}}},"schema":{"$ref":"#/components/schemas/Credas.Api.Models.DataCheck.AddDataCheckResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.DataCheck.AddDataCheckResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.DataCheck.AddDataCheckResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.DataCheck.AddDataCheckResponse"}}},"description":"Details of newly added data check."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}}},"description":"If the service was supplied invalid data."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}}},"description":"If credentials supplied were invalid."},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}}},"description":"Error code meaning that the operation was aborted due to insufficient credits."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}}},"description":"If an unexpected exception occurred whilst processing the request."}},"summary":"Creates new data check against a specified registration.","tags":["DataChecks"]}},"/api/images/id-document":{"post":{"operationId":"AddIdDocumentImage","parameters":[{"description":"ApiKey supplied.","in":"header","name":"apikey","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/*+json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Images.AddIdDocumentImageRequest"}},"application/*+xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Images.AddIdDocumentImageRequest"}},"application/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Images.AddIdDocumentImageRequest"}},"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Images.AddIdDocumentImageRequest"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Images.AddIdDocumentImageRequest"}},"text/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Images.AddIdDocumentImageRequest"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Images.AddIdDocumentImageRequest"}}},"description":"Object containing the id document image and registration id."},"responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"documentStatus":1,"documentType":1,"facialMatch":true,"id":"a9c10b16-130b-4051-9d60-c0c6ee9dca76","regCode":"57RV4345"}}},"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Images.AddIdDocumentImageResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Images.AddIdDocumentImageResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Images.AddIdDocumentImageResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Images.AddIdDocumentImageResponse"}}},"description":"Details of the processed id document."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}}},"description":"If the service was supplied invalid data."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}}},"description":"If credentials supplied were invalid."},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}}},"description":"Error code meaning that the operation was aborted due to insufficient credits."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}}},"description":"If an unexpected exception occurred whilst processing the request."}},"summary":"Add an id document image to the specified registration.","tags":["Images"]}},"/api/images/id-document/{registrationId}":{"get":{"operationId":"GetIdDocumentImages","parameters":[{"description":"The id of the registration.","in":"path","name":"registrationId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"ApiKey supplied.","in":"header","name":"apikey","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":[{"addressCity":null,"addressFull":null,"addressPostcode":null,"country":"United Kingdom","countryCode":"GBR","dateCreated":"2025-06-15T13:48:28.848Z","dateOfBirth":"2025-06-15T13:48:28.848Z","description":"Passport","documentAnalysisResult":1,"documentNumber":"123456789","documentSide":1,"expiryDate":"2025-06-15T13:48:28.848Z","facialMatch":true,"forename":"Alan","fullName":"Alan Harper","hiResUrl":"https://","id":"fedcba89-dead-1278-bead-8901234abcde","isUnderReview":false,"manuallyVerified":false,"middleName":"William","mrz1":"P<GBRHARPER<<ALAN<WILLIAM<<<<<<<<<<<<<<<<<<<","mrz2":"1234567897GBR6811233M2504214<<<<<<<<<<<<<<06","mrz3":null,"nameCheck":true,"nameCheckMethod":0,"nfcCheck":true,"nfcFacialUrl":"https://","nfcReadStatus":0,"primaryScanId":null,"status":1,"surname":"Harper","url":"https://"},{"addressCity":"London","addressFull":"10 Downing St, Westminster, London, SW1A2AA","addressPostcode":"SW1A2AA","country":"United Kingdom","countryCode":"GBR","dateCreated":"2025-06-15T13:48:28.848Z","dateOfBirth":"2025-06-15T13:48:28.848Z","description":"Driving Licence","documentAnalysisResult":2,"documentNumber":"HARPER765453P99RT","documentSide":1,"expiryDate":"2025-06-15T13:48:28.848Z","facialMatch":false,"forename":"Alan","fullName":"Alan William Harper","hiResUrl":"https://","id":"fedcba89-dead-1278-bead-8901234abcde","isUnderReview":false,"manuallyVerified":true,"middleName":"William","mrz1":null,"mrz2":null,"mrz3":null,"nameCheck":true,"nameCheckMethod":0,"nfcCheck":false,"nfcFacialUrl":null,"nfcReadStatus":0,"primaryScanId":null,"status":2,"surname":"Harper","url":"https://"},{"addressCity":null,"addressFull":null,"addressPostcode":null,"country":"United Kingdom","countryCode":"GBR","dateCreated":"2025-06-15T13:48:28.848Z","dateOfBirth":"2025-06-15T13:48:28.848Z","description":"Driving Licence","documentAnalysisResult":2,"documentNumber":"HARPER765453P99RT","documentSide":2,"expiryDate":"2025-06-15T13:48:28.848Z","facialMatch":false,"forename":"Alan","fullName":"Alan William Harper","hiResUrl":"https://","id":"fedcba89-dead-1278-bead-8901234abcff","isUnderReview":false,"manuallyVerified":false,"middleName":"William","mrz1":null,"mrz2":null,"mrz3":null,"nameCheck":false,"nameCheckMethod":0,"nfcCheck":false,"nfcFacialUrl":null,"nfcReadStatus":8,"primaryScanId":"fedcba89-dead-1278-bead-8901234abcde","status":2,"surname":"Harper","url":"https://"}]}},"schema":{"items":{"$ref":"#/components/schemas/Credas.Api.Models.Images.GetIdDocumentImageResponse"},"type":"array","uniqueItems":false}},"application/xml":{"schema":{"items":{"$ref":"#/components/schemas/Credas.Api.Models.Images.GetIdDocumentImageResponse"},"type":"array","uniqueItems":false}},"text/json":{"schema":{"items":{"$ref":"#/components/schemas/Credas.Api.Models.Images.GetIdDocumentImageResponse"},"type":"array","uniqueItems":false}},"text/xml":{"schema":{"items":{"$ref":"#/components/schemas/Credas.Api.Models.Images.GetIdDocumentImageResponse"},"type":"array","uniqueItems":false}}},"description":"Details of the id documents associated with the registration."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}}},"description":"If the service was supplied invalid data."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}}},"description":"If credentials supplied were invalid."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}}},"description":"If requesting entity have no permission to access the resource."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}}},"description":"If an unexpected exception occurred whilst processing the request."}},"summary":"Get all id document images associated with a registration.","tags":["Images"]}},"/api/images/liveness":{"post":{"operationId":"AddLivenessImage","parameters":[{"description":"ApiKey supplied.","in":"header","name":"apikey","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/*+json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Images.AddLivenessImageRequest"}},"application/*+xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Images.AddLivenessImageRequest"}},"application/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Images.AddLivenessImageRequest"}},"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Images.AddLivenessImageRequest"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Images.AddLivenessImageRequest"}},"text/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Images.AddLivenessImageRequest"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Images.AddLivenessImageRequest"}}},"description":"Object containing the liveness image and registration id."},"responses":{"200":{"description":"OK response indicating a successful action."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}}},"description":"If the service was supplied invalid data."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}}},"description":"If credentials supplied were invalid."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}}},"description":"If an unexpected exception occurred whilst processing the request."}},"summary":"Add a liveness image (UAP) to the specified registration.","tags":["Images"]}},"/api/images/liveness-performed/{registrationId}":{"get":{"operationId":"GetLivenessPerformedImage","parameters":[{"description":"The id of the registration.","in":"path","name":"registrationId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"ApiKey supplied.","in":"header","name":"apikey","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"base64Data":null,"url":"https://url.to/a/liveness-performed/image.jpg"}}},"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Images.GetLivenessPerformedImageResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Images.GetLivenessPerformedImageResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Images.GetLivenessPerformedImageResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Images.GetLivenessPerformedImageResponse"}}},"description":"Response containing Liveness performed image details."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}}},"description":"If the service was supplied invalid data."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}}},"description":"If credentials supplied were invalid."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}}},"description":"If requesting entity have no permission to access the resource."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}}},"description":"If the liveness performed image doesn't exist."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}}},"description":"If an unexpected exception occurred whilst processing the request."}},"summary":"Retrieve the liveness performed image associated with a registration.","tags":["Images"]}},"/api/images/liveness/{registrationId}":{"get":{"operationId":"GetLivenessImage","parameters":[{"description":"The id of the registration.","in":"path","name":"registrationId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"ApiKey supplied.","in":"header","name":"apikey","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"description":"Touch your LEFT cheek with your LEFT hand","id":"afbaa1d2-d81a-415d-bc51-092651c84bbb","url":"https://example.com/image.jpg"}}},"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Images.GetLivenessImageResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Images.GetLivenessImageResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Images.GetLivenessImageResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Images.GetLivenessImageResponse"}}},"description":"Response containing Liveness image details."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}}},"description":"If the service was supplied invalid data."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}}},"description":"If credentials supplied were invalid."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}}},"description":"If requesting entity have no permission to access the resource."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}}},"description":"If an unexpected exception occurred whilst processing the request."}},"summary":"Retrieve the liveness action image (UAP) associated with a registration.","tags":["Images"]}},"/api/images/scan-report-pdf/{scanId}":{"get":{"operationId":"GetScanReportPdf","parameters":[{"description":"Id of the individual scanned document","in":"path","name":"scanId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"ApiKey supplied.","in":"header","name":"apikey","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":"ZGVmZ2hp"}},"schema":{"format":"byte","type":"string"}},"application/xml":{"schema":{"format":"byte","type":"string"}},"text/json":{"schema":{"format":"byte","type":"string"}},"text/xml":{"schema":{"format":"byte","type":"string"}}},"description":"PDF document containing detail analysis of scanned documents as a byte stream."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}}},"description":"If the service was supplied invalid data."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}}},"description":"If credentials supplied were invalid."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}}},"description":"If requesting entity have no permission to access the resource."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}}},"description":"If scan matching the scanId was not found."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}}},"description":"If an unexpected exception occurred whilst processing the request."}},"summary":"Returns a detailed report on the analysis that has taken place of a scanned document","tags":["Images"]}},"/api/images/selfie":{"post":{"operationId":"AddSelfieImage","parameters":[{"description":"ApiKey supplied.","in":"header","name":"apikey","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/*+json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Images.AddSelfieImageRequest"}},"application/*+xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Images.AddSelfieImageRequest"}},"application/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Images.AddSelfieImageRequest"}},"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Images.AddSelfieImageRequest"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Images.AddSelfieImageRequest"}},"text/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Images.AddSelfieImageRequest"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Images.AddSelfieImageRequest"}}},"description":"Object containing the selfie image and registration id."},"responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"livenessConfirmed":true}}},"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Images.AddSelfieImageResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Images.AddSelfieImageResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Images.AddSelfieImageResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Images.AddSelfieImageResponse"}}},"description":"Result of uploading selfie image; including liveness check indicator."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}}},"description":"If the service was supplied invalid data."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}}},"description":"If credentials supplied were invalid."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}}},"description":"If an unexpected exception occurred whilst processing the request."}},"summary":"Add a selfie image to the registration.","tags":["Images"]}},"/api/images/selfie/{registrationId}":{"get":{"operationId":"GetSelfieImage","parameters":[{"description":"The id of the registration.","in":"path","name":"registrationId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"ApiKey supplied.","in":"header","name":"apikey","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"base64Data":null,"url":"https://url.to/a/selfie/image.jpg"}}},"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Images.GetSelfieImageResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Images.GetSelfieImageResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Images.GetSelfieImageResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Images.GetSelfieImageResponse"}}},"description":"Response containing the selfie image details."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}}},"description":"If the service was supplied invalid data."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}}},"description":"If credentials supplied were invalid."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Credas.Api.Models.Errors.ErrorResponse"}},"text/json":{"sc