If your organisation has an application you would like to exchange data with Credentially, you will need our API.
Authorisation
You will need an API_KEY to access API.
If you need a new key for your organisation, request an API key at support@credentially.io or from your dedicated Customer Success Manager.
Keep your key strictly confidential since all your staff members' documents and data can be accessed with it.
You can test public API flow following Credentially documentation (or using curl or any other rest client). Please see the up-to-date Credentially documentation below:
Documentation for UK-based Customers
Documentation for US-based Customers
Documentation for Canada-based Customers
How to use the API key following the Credentially documentation?
Once you have received the API key and have followed the link to the corresponding documentation, you will see the Credentially REST API page.
Click "Authorize" to insert the API key and insert the key as "Bearer {your API key}":
Confirm value by pressing "Authorize"
Click on one of the endpoints with the "Get" type (e.g. employee-public-api-resource) to test it by pressing "Trying it out"
4. We recommend that you change the value in the "Size" field from 1 to 30 value to support high-speed loading.
5. You should receive the "Code: 200" result, which means it works as expected. If you receive any other results, please contact support@credentially.io to report the code result you have received.
Important: Please be careful using "POST", "PUT", and "PATCH" methods since, if used, data to your Credentially system will be modified.