Default values | API

Created by Tomas Gibbons, Modified on Fri, 16 Aug, 2024 at 12:35 PM by Hannah Rowe


Default values can be used to pre-populate fields within forms - for example, forename, surname etc.. 


Default values can be included when creating a process. To do this you must add the default values request section as in the example body below. 


{

    "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 referece Reference ref",

            "actorId": 123,

            "contactViaEmail": false,

            "contactViaSms": false,

            "inPerson": false

        }     ],

    "defaultFormValues": [

        {

            "reference": "exampleFirstName",

            "value": "John"

        },         {

            "reference": "exampleLastName",

            "value": "Smith"

        }     

    ]

 }



Default values references

The four most common default values (as used in the public journeys which include Address/International Screening checks) are:

  • "reference": "forename" (e.g. "Kevin")
  • "reference": "surname" (e.g. "Smith")
  • "reference": "dob" (e.g. "1964-06-19")
  • "reference": "address" (e.g. "{\"addressLine1\":\"example house name\", \"addressLine2\":\"Example area\", \"town\":\"Example town\", \"county\":\"Example County\", \"postcode\":\"Example postcode\"}




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