Credas API
Credas API endpoints from Credas
Identity & security#openapi#security
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Credas API endpoints from Credas
Endpoints 37
BankAccounts
- POSTVerifies bank account details.
/api/bank-accounts/verify
Companies
- POSTSearches for a company based on its Company Number and returns its details.
/api/companies?companyNumber=stringIf 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.… - GETGetCompany
/api/companies/:companyId
CreditStatus
- POSTCheck includes identifying bankruptcy, insolvency, CCJ's or Company Directorship.
/api/credit-status/perform
DataChecks
- POSTCreates new data check against a specified registration.
/api/datachecks
Images
- POSTAdd an id document image to the specified registration.
/api/images/id-document - GETGet all id document images associated with a registration.
/api/images/id-document/:registrationId - POSTAdd a liveness image (UAP) to the specified registration.
/api/images/liveness - GETRetrieve the liveness performed image associated with a registration.
/api/images/liveness-performed/:registrationId - GETRetrieve the liveness action image (UAP) associated with a registration.
/api/images/liveness/:registrationId - GETReturns a detailed report on the analysis that has taken place of a scanned document
/api/images/scan-report-pdf/:scanId - POSTAdd a selfie image to the registration.
/api/images/selfie - GETRetrieve the selfie image associated with a registration.
/api/images/selfie/:registrationId
PropertyRegister
- POSTCreates new property registry check against the registration.
/api/property-register - GETRetrieves property registry check associated with the registration.
/api/property-register/:id
RegTypes
- GETGets all available RegTypes.
/api/reg-types
Registrations
- POSTCreates new registration.
/api/registrations - POSTCreates new registration record, adds an ID document and optional selfie image in one go.
/api/registrations/instantIt's designed to provide a quick integration path for external systems which capture these details. - GETFinds registrations by the ReferenceId.
/api/registrations/referenceid/:referenceId/summary - GETFinds a registration by the RegCode.
/api/registrations/regcode/:regCode/summary - GETGets paged registration list by search criteria or nothing if there are no matching fields.
Optional parameters may be appended to the query string.
Maximum page size is 50.
/api/registrations/search?pageNum=0&pageSize=50&forename=string&surname=string&email=string&dob=string - GETChecks if submitted documents are sufficient to complete registration.
/api/registrations/:id/check-submitted-id-documents - PUTUpdates a registration's contact details.
/api/registrations/:id/contact-details - PUTSets an override for a specific check on the registration.
/api/registrations/:id/override-check-status - GETReturns PDF export for a given registration.
/api/registrations/:id/pdf-export - GETReturns a PDF report for a given registration containing specified sections
/api/registrations/:id/pdf-export-sections?Comments=true&ContactDetails=true&StandardChecks=true&PepSanctionChecks=true&ProofOfOwnership=true&BankAccountCheck=true&CreditStatusCheck=true&Liveness=true&ExcludeSelfie=true&ExcludeIDDocuments=true&DIATFSection=true - GETReturns settlement status PDF (Share Code) for a given registration.
/api/registrations/:id/pdf-settlement-status - POSTResends any invitation for the specified registration.
/api/registrations/:id/resend-invitation - GETGets registration settings or nothing if there are no settings associated with the registration.
/api/registrations/:id/settings - PUTUpdates registration settings.
/api/registrations/:id/settings - PUTUpdates the status of the registration to one specified in the request.
/api/registrations/:id/status - GETFinds a registration by the Id.
/api/registrations/:id/summary - GETGet a list of supported id document for the specified registration id.
/api/registrations/:id/supported-id-documents
ReportView
- POSTRetrieves secure links to registration details pages searching by the Reference Id.
/api/report-view/by-referenceidIt may return none, one or many (up to 20) matching results. Each result contains a secure url; UTC date/time of when the link expires; name details of a… - POSTRetrieves secure link to registration details page searching by the Registration Id.
/api/report-view/by-registrationidIt may return none or one matching result. Each result contains a secure url; UTC date/time of when the link expires; name details of a person associated with…
WebVerifications
- POSTRetrieves secure links to web verification pages searching by the Reference Id.
/api/web-verifications/by-referenceidIt may return none, one or many (up to 20) matching results. Each result contains a secure url; UTC date/time of when the link expires; name details of a… - POSTRetrieves secure link to web verification page searching by the Registration Id.
/api/web-verifications/by-registrationidIt may return none or one matching result. Each result contains a secure url; UTC date/time of when the link expires; name details of a person associated with…
API details
- Authentication
- None declared in the description
- Operations
- 37 operations on 36 pathsGET 18POST 15PUT 4
- Main resources
- Registrations 17Images 8Companies 2PropertyRegister 2ReportView 2WebVerifications 2BankAccounts 1CreditStatus 1DataChecks 1RegTypes 1
- Response formats
application/jsonapplication/xmltext/json- Description format
- OpenAPI 3.0.0, API version
v1 - Links
- OpenAPI document
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the Credas API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Credas API collection, without the publisher's secrets.
- Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
- Send a requestPick an endpoint, for example “Verifies bank account details.” (POST /api/bank-accounts/verify), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Credas API?
Credas API endpoints from Credas It is listed under Identity & security and has 37 endpoints.
Who publishes the Credas API?
It is listed from Credas's public API description (an OpenAPI document), not published by Credas on Swastik Codes. Anyone who controls credas.co.uk can claim the profile by adding a DNS TXT record.
How do I authenticate with the Credas API?
Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.
How many endpoints does the Credas API have?
37 operations on 36 paths (18 GET, 15 POST, 4 PUT). The largest groups are Registrations, Images, Companies, PropertyRegister.
Is forking the Credas API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.