{"note":"OpenAPI conversion -- returning structured metadata","name":"credas-co-uk-pi","description":"Credas API","version":"v1","base_url":"","endpoints":37,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api Credas API\n@version v1\n@auth ApiKey apikey in header\n@common_fields {apikey: any # ApiKey supplied.}\n@endpoints 37\n@hint download_for_search\n@toc api(37)\n\n@endpoint POST /api/bank-accounts/verify\n@desc Verifies bank account details.\n@optional {request: map # Object containing data required to perform bank account verification.}\n@returns(200) Success\n@errors {400: If the service was supplied invalid data., 401: If credentials supplied were invalid., 402: Error code meaning that the operation was aborted due to insufficient credits., 500: If an unexpected exception occurred whilst processing the request.}\n\n@endpoint POST /api/companies\n@desc Searches for a company based on its Company Number and returns its details.\n@optional {companyNumber: any # The company registration number of the company that should be searched.}\n@returns(200) Success\n@errors {400: If the service was supplied invalid data., 401: If credentials supplied were invalid., 402: If the consumer doesn't have the required permission to use the endpoint., 500: If an unexpected exception occurred whilst processing the request.}\n\n@endpoint GET /api/companies/{companyId}\n@required {companyId: any}\n@returns(200) Success\n@errors {400: If the service was supplied invalid data., 401: If credentials supplied were invalid., 402: If the consumer doesn't have the required permission to use the endpoint., 500: If an unexpected exception occurred whilst processing the request.}\n\n@endpoint POST /api/credit-status/perform\n@desc Check includes identifying bankruptcy, insolvency, CCJ's or Company Directorship.\n@optional {request: map # Object containing data required to perform the check.}\n@returns(200) Success\n@errors {400: If the service was supplied invalid data., 401: If credentials supplied were invalid., 402: Error code meaning that the operation was aborted due to insufficient credits., 500: If an unexpected exception occurred whilst processing the request.}\n\n@endpoint POST /api/datachecks\n@desc Creates new data check against a specified registration.\n@optional {dataCheck: map # Object containing data check details.}\n@returns(200) Details of newly added data check.\n@errors {400: If the service was supplied invalid data., 401: If credentials supplied were invalid., 402: Error code meaning that the operation was aborted due to insufficient credits., 500: If an unexpected exception occurred whilst processing the request.}\n\n@endpoint GET /api/images/selfie/{registrationId}\n@desc Retrieve the selfie image associated with a registration.\n@required {registrationId: any # The id of the registration.}\n@returns(200) Response containing the selfie image details.\n@errors {400: If the service was supplied invalid data., 401: If credentials supplied were invalid., 403: If requesting entity have no permission to access the resource., 500: If an unexpected exception occurred whilst processing the request.}\n\n@endpoint POST /api/images/selfie\n@desc Add a selfie image to the registration.\n@optional {selfie: map # Object containing the selfie image and registration id.}\n@returns(200) Result of uploading selfie image; including liveness check indicator.\n@errors {400: If the service was supplied invalid data., 401: If credentials supplied were invalid., 500: If an unexpected exception occurred whilst processing the request.}\n\n@endpoint GET /api/images/liveness/{registrationId}\n@desc Retrieve the liveness action image (UAP) associated with a registration.\n@required {registrationId: any # The id of the registration.}\n@returns(200) Response containing Liveness image details.\n@errors {400: If the service was supplied invalid data., 401: If credentials supplied were invalid., 403: If requesting entity have no permission to access the resource., 500: If an unexpected exception occurred whilst processing the request.}\n\n@endpoint POST /api/images/liveness\n@desc Add a liveness image (UAP) to the specified registration.\n@optional {liveness: map # Object containing the liveness image and registration id.}\n@returns(200) OK response indicating a successful action.\n@errors {400: If the service was supplied invalid data., 401: If credentials supplied were invalid., 500: If an unexpected exception occurred whilst processing the request.}\n\n@endpoint GET /api/images/liveness-performed/{registrationId}\n@desc Retrieve the liveness performed image associated with a registration.\n@required {registrationId: any # The id of the registration.}\n@returns(200) Response containing Liveness performed image details.\n@errors {400: If the service was supplied invalid data., 401: If credentials supplied were invalid., 403: If requesting entity have no permission to access the resource., 404: If the liveness performed image doesn't exist., 500: If an unexpected exception occurred whilst processing the request.}\n\n@endpoint GET /api/images/id-document/{registrationId}\n@desc Get all id document images associated with a registration.\n@required {registrationId: any # The id of the registration.}\n@returns(200) Details of the id documents associated with the registration.\n@errors {400: If the service was supplied invalid data., 401: If credentials supplied were invalid., 403: If requesting entity have no permission to access the resource., 500: If an unexpected exception occurred whilst processing the request.}\n\n@endpoint POST /api/images/id-document\n@desc Add an id document image to the specified registration.\n@optional {idDocument: map # Object containing the id document image and registration id.}\n@returns(200) Details of the processed id document.\n@errors {400: If the service was supplied invalid data., 401: If credentials supplied were invalid., 402: Error code meaning that the operation was aborted due to insufficient credits., 500: If an unexpected exception occurred whilst processing the request.}\n\n@endpoint GET /api/images/scan-report-pdf/{scanId}\n@desc Returns a detailed report on the analysis that has taken place of a scanned document\n@required {scanId: any # Id of the individual scanned document}\n@returns(200) PDF document containing detail analysis of scanned documents as a byte stream.\n@errors {400: If the service was supplied invalid data., 401: If credentials supplied were invalid., 403: If requesting entity have no permission to access the resource., 404: If scan matching the scanId was not found., 500: If an unexpected exception occurred whilst processing the request.}\n\n@endpoint POST /api/property-register\n@desc Creates new property registry check against the registration.\n@optional {request: map # Object containing check details.}\n@returns(200) Details of newly added data check.\n@errors {400: If the service was supplied invalid data., 401: If credentials supplied were invalid., 402: Error code meaning that the operation was aborted due to insufficient credits., 500: If an unexpected exception occurred whilst processing the request.}\n\n@endpoint GET /api/property-register/{id}\n@desc Retrieves property registry check associated with the registration.\n@required {id: any # Id of the registration.}\n@returns(200) Details of the property register check.\n@errors {400: If the service was supplied invalid data., 401: If credentials supplied were invalid., 404: If registration does not have associated property register check., 500: If an unexpected exception occurred whilst processing the request.}\n\n@endpoint POST /api/registrations/instant\n@desc Creates new registration record, adds an ID document and optional selfie image in one go.\n@optional {request: map # The Credas.Api.Models.Registrations.AddInstantRegistrationRequest object containing required data.}\n@returns(200) OK response with object containing the document information.\n@errors {400: If the service was supplied invalid data., 401: If credentials supplied were invalid., 500: If an unexpected exception occurred whilst processing the request.}\n\n@endpoint POST /api/registrations\n@desc Creates new registration.\n@optional {registration: map # Object containing registration details.}\n@returns(200) Details of newly added registration.\n@errors {400: If the service was supplied invalid data., 401: If credentials supplied were invalid., 402: Error code meaning that the operation was aborted due to insufficient credits., 500: If an unexpected exception occurred whilst processing the request.}\n\n@endpoint GET /api/registrations/{id}/check-submitted-id-documents\n@desc Checks if submitted documents are sufficient to complete registration.\n@required {id: any # Id of the registration.}\n@returns(200) OK response with object containing the result of the document check.\n@errors {400: If the service was supplied invalid data., 401: If credentials supplied were invalid., 500: If an unexpected exception occurred whilst processing the request.}\n\n@endpoint GET /api/registrations/referenceid/{referenceId}/summary\n@desc Finds registrations by the ReferenceId.\n@required {referenceId: any # ReferenceId - from external system to match Registrations on.}\n@returns(200) Collection of Registration summary objects.\n@errors {400: If the service was supplied invalid data., 401: If credentials supplied were invalid., 403: If requesting entity have no permission to access the resource., 404: If registration matching the RegCode was not found., 500: If an unexpected exception occurred whilst processing the request.}\n\n@endpoint GET /api/registrations/{id}/summary\n@desc Finds a registration by the Id.\n@required {id: any # Id of the registration.}\n@returns(200) Registration summary object.\n@errors {400: If the service was supplied invalid data., 401: If credentials supplied were invalid., 403: If requesting entity have no permission to access the resource., 404: If registration matching the Id was not found., 500: If an unexpected exception occurred whilst processing the request.}\n\n@endpoint GET /api/registrations/regcode/{regCode}/summary\n@desc Finds a registration by the RegCode.\n@required {regCode: any # RegCode - short unique identifier.}\n@returns(200) Registration summary object.\n@errors {400: If the service was supplied invalid data., 401: If credentials supplied were invalid., 403: If requesting entity have no permission to access the resource., 404: If registration matching the RegCode was not found., 500: If an unexpected exception occurred whilst processing the request.}\n\n@endpoint GET /api/registrations/{id}/supported-id-documents\n@desc Get a list of supported id document for the specified registration id.\n@required {id: any # Id of the registration.}\n@returns(200) List of supported id document objects.\n@errors {400: If the service was supplied invalid data., 401: If credentials supplied were invalid., 403: If requesting entity have no permission to access the resource., 404: If registration matching the Id was not found., 500: If an unexpected exception occurred whilst processing the request.}\n\n@endpoint PUT /api/registrations/{id}/status\n@desc Updates the status of the registration to one specified in the request.\n@required {id: any # Id of the registration.}\n@optional {request: map # Request object containing the details.}\n@returns(200) Update was successful.\n@errors {400: If the service was supplied invalid data., 401: If credentials supplied were invalid., 404: If the registration was not found., 500: If an unexpected exception occurred whilst processing the request.}\n\n@endpoint GET /api/registrations/{id}/pdf-export\n@desc Returns PDF export for a given registration.\n@required {id: any # Id of the registration.}\n@returns(200) PDF document containing registration extract as byte stream.\n@errors {400: If the service was supplied invalid data., 401: If credentials supplied were invalid., 403: If requesting entity have no permission to access the resource., 404: If registration matching the Id was not found., 500: If an unexpected exception occurred whilst processing the request.}\n\n@endpoint GET /api/registrations/{id}/pdf-export-sections\n@desc Returns a PDF report for a given registration containing specified sections\n@required {id: any # Id of the registration.}\n@optional {Comments: any, ContactDetails: any, StandardChecks: any, PepSanctionChecks: any, ProofOfOwnership: any, BankAccountCheck: any, CreditStatusCheck: any, Liveness: any, ExcludeSelfie: any, ExcludeIDDocuments: any, DIATFSection: any, SafeHarbourSection: any}\n@returns(200) PDF document containing registration extract as byte stream.\n@errors {400: If the service was supplied invalid data., 401: If credentials supplied were invalid., 403: If requesting entity have no permission to access the resource., 404: If registration matching the Id was not found., 500: If an unexpected exception occurred whilst processing the request.}\n\n@endpoint PUT /api/registrations/{id}/override-check-status\n@desc Sets an override for a specific check on the registration.\n@required {id: any # Id of the registration.}\n@optional {request: map # Request data.}\n@returns(200) Status of the operation.\n@errors {400: If the service was supplied invalid data., 401: If credentials supplied were invalid., 403: If requesting entity have no permission to access the resource., 404: If registration matching the Id was not found., 500: If an unexpected exception occurred whilst processing the request.}\n\n@endpoint POST /api/registrations/{id}/resend-invitation\n@desc Resends any invitation for the specified registration.\n@required {id: any # Id of the registration.}\n@returns(200) Invitation sent.\n@errors {400: If the service was supplied invalid data., 401: If credentials supplied were invalid., 403: If requesting entity have no permission to access the resource., 404: If registration matching the Id was not found., 500: If an unexpected exception occurred whilst processing the request.}\n\n@endpoint GET /api/registrations/{id}/settings\n@desc Gets registration settings or nothing if there are no settings associated with the registration.\n@required {id: any # Id of the registration.}\n@returns(200) Registration settings updated.\n@errors {400: If the service was supplied invalid data., 401: If credentials supplied were invalid., 403: If requesting entity have no permission to access the resource., 404: If registration matching the Id was not found., 500: If an unexpected exception occurred whilst processing the request.}\n\n@endpoint PUT /api/registrations/{id}/settings\n@desc Updates registration settings.\n@required {id: any # Id of the registration.}\n@optional {settings: map # Object containing registration settings.}\n@returns(200) Registration settings updated.\n@errors {400: If the service was supplied invalid data., 401: If credentials supplied were invalid., 403: If requesting entity have no permission to access the resource., 404: If registration matching the Id was not found., 500: If an unexpected exception occurred whilst processing the request.}\n\n@endpoint PUT /api/registrations/{id}/contact-details\n@desc Updates a registration's contact details.\n@required {id: any # Id of the registration.}\n@optional {details: map # Object containing contact details.}\n@returns(200) Registration contact details updated.\n@errors {400: If the service was supplied invalid data., 401: If credentials supplied were invalid., 403: If requesting entity have no permission to access the resource., 404: If registration matching the Id was not found., 500: If an unexpected exception occurred whilst processing the request.}\n\n@endpoint GET /api/registrations/search\n@desc Gets paged registration list by search criteria or nothing if there are no matching fields.\n@optional {pageNum: any # Zero-based page number to retrieve., pageSize: any # Number of records to return on each request (Maximum value is 50)., forename: any # Search by forename., surname: any # Search by surname., email: any # Search by user email., dob: any # Date of birth in (yyyy-MM-dd) format}\n@returns(200) Registration summary object list.\n@errors {400: If the service was supplied invalid data., 401: If credentials supplied were invalid., 403: If requesting entity have no permission to access the resource., 404: If registration matching the Id was not found., 500: If an unexpected exception occurred whilst processing the request.}\n\n@endpoint GET /api/registrations/{id}/pdf-settlement-status\n@desc Returns settlement status PDF (Share Code) for a given registration.\n@required {id: any # Id of the registration.}\n@returns(200) PDF document containing settlement status information extract as byte stream.\n@errors {400: If the service was supplied invalid data., 401: If credentials supplied were invalid., 403: If requesting entity have no permission to access the resource., 404: If registration matching the Id was not found., 500: If an unexpected exception occurred whilst processing the request.}\n\n@endpoint GET /api/reg-types\n@desc Gets all available RegTypes.\n@returns(200) A collection of available RegTypes.\n@errors {401: If credentials supplied were invalid., 500: If an unexpected exception occurred whilst processing the request.}\n\n@endpoint POST /api/report-view/by-referenceid\n@desc Retrieves secure links to registration details pages searching by the Reference Id.\n@optional {request: map # Request object}\n@returns(200) Results of the query\n@errors {400: If the service was supplied invalid data., 401: If credentials supplied were invalid., 500: If an unexpected exception occurred whilst processing the request.}\n\n@endpoint POST /api/report-view/by-registrationid\n@desc Retrieves secure link to registration details page searching by the Registration Id.\n@optional {request: map # Request object}\n@returns(200) Results of the query\n@errors {400: If the service was supplied invalid data., 401: If credentials supplied were invalid., 500: If an unexpected exception occurred whilst processing the request.}\n\n@endpoint POST /api/web-verifications/by-referenceid\n@desc Retrieves secure links to web verification pages searching by the Reference Id.\n@optional {request: map}\n@returns(200) Results of the query\n@errors {400: If the service was supplied invalid data., 401: If credentials supplied were invalid., 500: If an unexpected exception occurred whilst processing the request.}\n\n@endpoint POST /api/web-verifications/by-registrationid\n@desc Retrieves secure link to web verification page searching by the Registration Id.\n@optional {request: map}\n@returns(200) Results of the query\n@errors {400: If the service was supplied invalid data., 401: If credentials supplied were invalid., 500: If an unexpected exception occurred whilst processing the request.}\n\n@end\n"}