Our RESTful API allows you to send and receive applicants’ data and documents for verification.
The Credas API responds with JSON payload unless stated otherwise. Where payload data should be provided the API expects the body to be passed in valid JSON unless stated otherwise.
Your content-type header should be set as application/json when sending these requests.
We have two environments:
- Demo (sandbox): this is provided to enable you to perform your testing & integration with Credas.
- Production: to provide you with access to the production environment we require your integration to be performed and tested in demo first. All checks performed within production are chargeable unless stated otherwise.
Both environments have their own ‘base’ urls:
- Demo: https://portal.credasdemo.com/
- Production: https://portal.credas.com/
API access is controlled using API keys, your API key should be set using the x-api-key header. You will have a different key for your demo & production environments.
Documentation
Our API documentation is hosted online within this knowledge base.
Postman
We have created a sample postman collection that allows you to send invites and retrieve results. You will need to select whether you use the demo or production postman environments. This can be requested from your assigned Technical Implementation Consultant.
Within these environments you must set the following values:
- API key
- JourneyId
- ActorId
- Webhook URL
You can find more information in postman’s documents on how to get started or use postman environments.
Swagger
We have a swagger page for both our demo and production environments. Our swagger page contains a list of all available endpoints and is complete with all Enum values.
You can access our swagger pages through the below URLs:
- Demo: https://portal.credasdemo.com/swagger/index.html
- Production: https://portal.credas.com/swagger/index.html
Please be aware that your integration is likely to only require a handful of these endpoints. Due to our user friendly API design most of our customers utilise less than 10 endpoints for their integration.
Errors
Our API errors are returned in line with the standard HTTP standard codes.
We have created a useful troubleshooting guide and http status guide to assist with any errors returned via our API.
Please refer to our troubleshooting guide prior to raising any issues with your technical contact or Credas support.
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article