New invite wizard - magic link | API

The new invite wizard magic link can be used to generate a link for the Credas Entity invite wizard, which guides a user through the process of creating a new Entity and sending them an invite to complete a Process.

Generating your magic link

To generate an entity module magic link you need to perform a POST request to the /api/v2/ci/magic-links/invite-wizard endpoint with a valid request body.

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

Request body

{

  "userGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

  "emailAddress": "user@example.com",

  "showClientLogo": true,

  "showNavigationMenu": true,

  "showUserProfileButton": true,

  "showViewProfileButton": true,

  "showSendNewInviteButton": true,

  "showCloseButton": true,

  "showLogoutButton": true

}

emailAddress - this must correspond with a valid & properly permissioned user of the Credas portal.

showClientLogo - toggles on/off the client logo in the Credas portal.

showNavigationMenu - toggles on/off the navigation bar in the Credas portal.

showUserProfileButton - toggles on/off the user profile button in the Credas portal.

showViewProfileButton - toggles on/off the view profile button in the Credas portal.

showCloseButton - toggles on/off the close 'X' on the invite wizard window.

showLogoutButton - toggles on/off the user logout button.

userGroupId - must correspond to the correct user group for the user. If you are not using user groups this can be removed or set as null in your request.

Audit trail

Any action taken within the Credas portal will be recorded against the user email address provided as part of the request body. 

To comply with Credas's terms & conditions you must use a user per person and not utilise shared accounts.

Example use case

From within a CRM system, when a user wants to send out an Identity Check to a new End User, this Magic Link can be used to return a URL which can be rendered within an iframe, and will provide all the UI to allow the user to create the Entity, select the required Process(es) and send out the invite.