Specifying a brand/client name and logo | API

Created by Kevin Smith, Modified on Fri, 16 Aug, 2024 at 12:36 PM by Hannah Rowe

 

If you deal with multiple clients/brands, you may want to specify a logo and company name when you create the Process.  This logo and company name will be reflected in the email that is sent to the end user, and also within the mobile app / web app that they see.


NOTE: If you are a reseller you should consider setting up 'child portals' and applying full branding to each as relevant.


To use a specific client name/logo for your end user interaction, you need to add the following parameters into the ProcessEntities section of the POST /Process:

"clientAliasName": "string",

"clientAliasLogoBase64": "string"

For example:

{

    "title": "Example title",

    "journeyId": "guid",

    "webhookUrl": "string",

    "webhookStepUrl": "string",

    "userGroupId": "guid",

    "processEntities": [

        {

            "firstName": "John",

            "surname": "Smith",

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

            "phoneNumber": "07496701000",

            "reference": "Your customer reference",

            "actorId": 123,

            "contactViaEmail": true,

            "contactViaSms": true,

            "inPerson": false,

            "clientAliasName": "string",

            "clientAliasLogoBase64": "string" 

        }

    ]

}



Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article

Join our live training sessions

Whether you're new to Credas or simply looking for a refresher, we’ve got you covered! We now offer regular training sessions designed to help you get the most out of the Credas platform. These sessions are tailored to different product areas, including:

- AML / ID verification
- Right to Work
- Our brand-new Credas Lettings solution
- Admin / advanced training

In each session we will walk you through how platform works and answer any questions you may have.

See our full training schedule