Entity profile magic link | API

The entity profile magic link can be used to generate a link for a specific entity within the Credas portal. However, users will not be restricted to viewing this entity only. 

Generating your magic link

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

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

Request body

{
  "userGroupId": "3sd85f64-5717-4962-b3fc-6c963f66afa6",
  "emailAddress": "credastest@credas.com",
  "showClientLogo": true,
  "showNavigationMenu": true,
  "showUserProfileButton": true,
  "entityId": "3sd85f64-5717-4962-b3fc-6c963f66afa6"
}

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

entityId - determines the entityId displayed via the magic link.

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.

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

Our entity profile magic link can be useful for clients who are integrating with the CRM and wish to provide their agents with the ability to remediate results within the Credas portal. 

Utilising the Credas portal for any investigatory or remediation work should also reduce the need for bespoke UI development within your existing CRM.