Send ID Check

The following command block is an example of how to request an ID check, this is very similar to sending a questionnaire, but with some extra optional parameters:

--incase-cmd
{types:SEND_ID_CHECK}
{caseReference:ABC123-1}
{sender:Kate Smith}
{title:Identity Check (Julia Jones)}
{message:Please complete the required Identity Check}
{templateId:123}
--incase-cmd-end

When requesting ID Checks for cases with multiple clients, it is recommended to put the clients name in the title so that the clients can easily differentiate between them.

Send ID Check Parameter Definitions

The following table describes the parameters that can be used in the send ID check command block:

Parameter	Type	Required	Default	Repeatable	Description
brackets	Enum: {, [, <	No	{	No	The encapsulating brackets to use
notifySuccess	Email Address	No		No	Who to notify upon successful completion
notifyError	Email Address	No	Email Return Address	No	Who to notify of processing errors, if not specified then the email return address will be used
quietMode	True, False	No	False	No	If true then turn off all notifications
types	SEND_ID_CHECK	Yes		No	The type of command to be performed
caseReference	String	Yes		No	The case reference, a unique identifier you use to identify the case
templateId	Integer	Yes		No	The ID of the questionnaire template that you would like to use
title	String	Yes		No	A brief description of the questionnaire for the client to identify in their todo list
message	String	Yes		No	A brief message to accompany the questionnaire
reference	String	No		No	Your reference for the questionnaire so that you can match it when it is returned completed
sender	String	No	The email sender	No	The sender of the notification that the process step has been completed, defaults to the sender of the email
replyTo	Email Address	No		Yes or comma separated	Set this parameter if you would like to update the case reply to
sendPushNotification	Boolean	No	True	No	Whether to send a notification to the users devices
bundleIdentifier	String	No		No	The bundle identifier to associate to or create an event bundle that this ID Check is attached to, refer to the event bundle documentation for more information
bundleRecipients	Email Addresses (comma separated)	No		No	The bundle recipients, comma separated email addresses, who will receive a notification when the event bundle has been completed
bundleReminder	Reminder String	No		Yes	An event bundle reminder, to be sent when the event bundle has not been completed, please refer to the event bundle documentation
questionnaireData	Combined Pre Population String	No		No	A field to hold the pre-population data, see the section on pre-populating data
question	Pre Population String	No		Yes	A field to hold individual question pre-population data, please see the section on pre-populating data
contactTitle	String	No		No	Pre-populates the contacts title in the ID Check
contactForename	String	No		No	Pre-populates the contacts forename in the ID Check
contactMiddleNames	String	No		No	Pre-populates the contacts middle names in the ID Check
contactSurname	String	No		No	Pre-populates the contacts surname in the ID Check
contactProperty	String	No		No	Pre-populates the contacts property address property line in the ID Check
contactStreet	String	No		No	Pre-populates the contacts property address street line in the ID Check
contactCity	String	No		No	Pre-populates the contacts property address city line in the ID Check
contactPostcode	String	No		No	Pre-populates the contacts property address postcode line in the ID Check
contactDateOfBirth	Date (dd/mm/yyyy)	No		No	Pre-populates the contacts date of birth in the ID Check
contactTelephoneNumber	String	No		No	Pre-populates the contacts telephone number in the ID Check

02 July 2026