Request Third Party ID Check
The following command block is an example of how to request a third party ID check, this allows you to request ID from parties that you do not want to see case details, and do not have to install the app to complete the ID process:
This method will reply with a link for you to send to the party if you set contactCommunicationType to NONE.
Request Third Party ID Check Parameter Definitions
The following table describes the parameters that can be used in the request third party 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 | |
reference | String | No | No | Your reference for the ID Check so that you can match it when it is returned completed | |
notifyCompletion | Email Address | No | The case reply to | No | The email address that you would like the ID Check report to be sent to |
contactName | String | Yes | No | The name of the party you would like to perform the ID check on | |
contactEmail | Email Address | Yes | No | The email address of the party you would like to perform the ID check on | |
contactNumber | Phone Number | No | No | The contact number of the party you would like to perform the ID check on | |
contactCommunicationType | Enum: NONE, EMAIL, SMS, ALL | No | No | How you would like us to contact the party to request their ID |