What does a typical integration look like?

Please see our Typical implementation flows section for more details on this.

Do you have a swagger page?

Yes, we have a swagger page for both our demo & live environments. You can find the relevant pages below:

Demo - https://portal.credasdemo.com/SWAGGER/index.html
Live - https://portal.credas.com/SWAGGER/index.html

Is there a mobile SDK?

No, we do not currently have a mobile SDK. However, you can use our Credas app to conduct verifications and all our pages are mobile optimized. 

How do I authenticate my requests?

An API key is required to authenticate any requests. This API key will use the permissions assigned to your client or client user and will be valid for either our demo or live environment. 

Your API key can be generated via the Credas portal.

What is an entity?

An entity is the individual you are seeking to verify e.g. Joe Bloggs.

You’ll need to create an entity for each customer, we use this entity to perform verifications & provide you with the results. 

What is a journey?

A journey is a collection of different products & services that are ordered through the use of journey steps. Examples of journey steps include data capture forms, sanctions checks & identity verifications. 

Journeys will determine the checks & steps your customers follow, each journey has a unique ID which is used as part of a customer invite.

What is an actor?

An actor is a value that is defined within your journey. We use this value to determine if we are interacting with a customer or an agent of yours. 

What is a process?

A process combines both an entity and a journey, this is the stage where we invite your customer to complete their verification. 

We can associate multiple processes to an entity, this is enables you to perform several different checks and access the results in the same place. 

What is a magic link?

A magic link is short-life URL that is returned via the Credas API. These can be used to display both the Credas portal & end user process as a redirect, iFrame etc. 

More information can be found in the Embedding Credas into your application section.

How can I obtain the results of any checks?

You can access the results of a check via the portal, raw API data, PDF download or magic link. 

What data can I use for my testing?

This will depend on the services you are using however, you should use valid ID documents for your testing when using the identity verification services. 

Your technical contact will share more information on this with you. 

Where can I find information on webhooks?

Information on webhooks can be found in the Webooks (notifications) section.

Can you set custom webhook headers?

Yes, custom headers can be set by your technical contact.