Troubleshooting Guide | API

Prior to contacting Credas you should complete the following troubleshooting steps, failure to do this will result in an increased resolution time.

Where an error is encountered via the API we will return a HTTP response code and where applicable an error description.

1.Check your base URL 

Your base URL will determine the environment you are pointed at.

Values such as your API key, journeyId & actorId are environment specific e.g. your demo API key is only valid for the demo environment.

Credas production – https://portal.credas.com/api/v2/ci/
Credas demo - https://portal.credasdemo.com/api/v2/ci/ 

2.Check your endpoint

All Credas endpoints start with /api/v2/ci, the format after this will vary depending on the action you are attempting.

When combining your Base URL and your endpoint the overall URL should look like this example:

https://portal.credasdemo.com/api/v2/ci/processes 

3. Check your method 

The Credas API uses a combination of GET, POST & PUT requests. You can confirm the acceptable method for the endpoint you are calling via our swagger page. 

Credas production – https://portal.credas.com/SWAGGER/index.html
Credas demo - https://portal.credasdemo.com/SWAGGER/index.html

4. Check your request body

Example request bodies for all requests can be found within the swagger pages referenced above.

You can use our schema to confirm the correct type of data is being passed (e.g. string), all mandatory fields are included and only the acceptable fields are null.

Additional request & response information can be found within our online API documentation. 

5. Contact Credas

If you have completed your troubleshooting and are still experiencing issues please raise a support ticket via our website https://credas.com/contact/, email [email protected] or contact your nominated technical contact.

Please include the following information as part of your ticket:

• Error received
• Replication steps
• Troubleshooting completed
• Credas environment & endpoint
• Example Credas Id’s (e.g. processId, entityId, reg-code etc.)
• Screenshots (where applicable & excluding PII)

Failure to include this information will result in an increased resolution time.