Default values | API

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\"}