Credas API, an HTTP API described by an OpenAPI document.
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
Credas API, an HTTP API described by an OpenAPI document.
| method | path | what the vendor says it does |
|---|---|---|
POST | /api/bank-accounts/verify | Verifies bank account details. BankAccounts |
POST | /api/companies | Searches for a company based on its Company Number and returns its details. If a company appears multiple time |
POST | /api/credit-status/perform | Check includes identifying bankruptcy, insolvency, CCJ's or Company Directorship. CreditStatus |
POST | /api/datachecks | Creates new data check against a specified registration. DataChecks |
POST | /api/images/id-document | Add an id document image to the specified registration. Images |
GET | /api/images/id-document/{registrationId} | Get all id document images associated with a registration. Images |
POST | /api/images/liveness | Add a liveness image (UAP) to the specified registration. Images |
GET | /api/images/liveness-performed/{registrationId} | Retrieve the liveness performed image associated with a registration. Images |
GET | /api/images/liveness/{registrationId} | Retrieve the liveness action image (UAP) associated with a registration. Images |
GET | /api/images/scan-report-pdf/{scanId} | Returns a detailed report on the analysis that has taken place of a scanned document Images |
POST | /api/images/selfie | Add a selfie image to the registration. Images |
GET | /api/images/selfie/{registrationId} | Retrieve the selfie image associated with a registration. Images |
POST | /api/property-register | Creates new property registry check against the registration. PropertyRegister |
GET | /api/property-register/{id} | Retrieves property registry check associated with the registration. PropertyRegister |
GET | /api/reg-types | Gets all available RegTypes. RegTypes |
POST | /api/registrations | Creates new registration. Registrations |
POST | /api/registrations/instant | Creates new registration record, adds an ID document and optional selfie image in one go. It's designed to pro |
GET | /api/registrations/referenceid/{referenceId}/summary | Finds registrations by the ReferenceId. Registrations |
GET | /api/registrations/regcode/{regCode}/summary | Finds a registration by the RegCode. Registrations |
GET | /api/registrations/search | Gets paged registration list by search criteria or nothing if there are no matching fields. Optional paramete |
GET | /api/registrations/{id}/check-submitted-id-documents | Checks if submitted documents are sufficient to complete registration. Registrations |
PUT | /api/registrations/{id}/contact-details | Updates a registration's contact details. Registrations |
PUT | /api/registrations/{id}/override-check-status | Sets an override for a specific check on the registration. Registrations |
GET | /api/registrations/{id}/pdf-export | Returns PDF export for a given registration. Registrations |
GET | /api/registrations/{id}/pdf-export-sections | Returns a PDF report for a given registration containing specified sections Registrations |
GET | /api/registrations/{id}/pdf-settlement-status | Returns settlement status PDF (Share Code) for a given registration. Registrations |
POST | /api/registrations/{id}/resend-invitation | Resends any invitation for the specified registration. Registrations |
GET | /api/registrations/{id}/settings | Gets registration settings or nothing if there are no settings associated with the registration. Registrations |
PUT | /api/registrations/{id}/settings | Updates registration settings. Registrations |
PUT | /api/registrations/{id}/status | Updates the status of the registration to one specified in the request. Registrations |
GET | /api/registrations/{id}/summary | Finds a registration by the Id. Registrations |
GET | /api/registrations/{id}/supported-id-documents | Get a list of supported id document for the specified registration id. Registrations |
POST | /api/report-view/by-referenceid | Retrieves secure links to registration details pages searching by the Reference Id. It may return none, one or |
POST | /api/report-view/by-registrationid | Retrieves secure link to registration details page searching by the Registration Id. It may return none or one |
POST | /api/web-verifications/by-referenceid | Retrieves secure links to web verification pages searching by the Reference Id. It may return none, one or man |
POST | /api/web-verifications/by-registrationid | Retrieves secure link to web verification page searching by the Registration Id. It may return none or one mat |
specification origin: https://pi-api.credas.co.uk/swagger/v1/swagger.json
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.