Send Questionnaire
Use this endpoint to send questionnaires and identity checks for the clients to complete.
Send the client(s) a questionnaire for completion, this method also has optional fields that are relevant when trying to pre populate the ID Questionnaire
Request parameters
{
"externalCaseRef": "ABC123-1",
"sender": "Barbara Jenkins",
"replyTo": "case_handler@example.com",
"subject": "Client Information Form",
"message": "Please complete the attached questionnaire",
"templateId": 123,
"sendPushNotification": true,
"externalClientRef": "ABC123-1/CIF",
"countSignaturesRequired": 91,
"tagIdentifier": "Welcome Pack",
"tagRecipients": "case_handler@example.com, welcomepackteam@example.com",
"idTitle": "Mr",
"idForename": "John",
"idMiddleNames": "James",
"idSurname": "Smith",
"idHouseNameOrNumber": "1",
"idStreet": "High Street",
"idCity": "London",
"idPostcode": "SW1A 1AA",
"idDateOfBirth": "1970-01-14",
"questionnaireData": [
{
"tag": "client-name",
"values": [
[
"Mr",
"John",
"James",
"Smith"
]
]
}
]
}
Responses
{
"id": 91,
"createdAt": "1971-04-26T12:26:06Z",
"updatedAt": "1971-04-26T12:26:06Z",
"completedAt": "1971-04-26T12:26:06Z",
"name": "example",
"templateId": 91,
"updateId": 91
}
02 July 2026