Display a process via a magic link | API

Our 'no contact process' magic link can be used to enable your users to complete their verifications within the web app without the need to interact with an email or SMS invite.

Generating your magic link

To generate an Process magic link you need to perform a GET request to the /api/v2/ci/processes/{processId}/entities/{entityId}/magic-link endpoint.

You will receive a URL that is valid for 30 minutes in response.

NOTE: To generate your processId and entityId values you must first create a no contact process, you can find more information on how to do this here.

Process completion

As with all other processes Credas will provide you with a webhook notification when an end user has completed their verification & the results are ready to retrieve. 

You can find more information on this webhook here.

Example use case

Our process magic link can be used to generate a URL that is displayed within an iFrame on your website. 

You may wish to provide your customers with two options for verification:

Option 1 - if your customer has their ID to hand they can complete their verification via an iFrame in your website, this removes the need for them to leave your ecosystem. 

Option 2 - if you customer does not have their ID to hand you can invite them via email or SMS so they complete their verification when it is convenient for them.