Background

There are instances when a client reverses/reconciles/invalidates a complete due to various reasons.

Our platform can now send you server-to-server notifications to inform you of these cases as soon as possible and allow you to take any needed action on your end.

Workflows

The InnovateMR platform supports completes being validated and invalidated. Here are the two flows and the subtle differences.

Invalidations

The invalidation flow is as follows

Respondent A completes Survey 123

Once the survey closes and data is reviewed, Survey 123's Client rejects Respondent A's complete due to a qulity issue. Client informs InnovateMR.

InnovateMR Ops team invalidates Respondent A's complete on Survey 123.

InnovateMR API platform issues a server-to-server notification indicating that the associated complete has been invalidated. The verificationstatus will be 'invalidated'

Validations

Additionally, the InnovateMR Ops team will also validate completes that a Client has verified. In this case the flow is very similar but the payload content is adjusted accordingly.

Respondent B completes Survey 123

Once the survey closes, or before, and data is reviewed, Survey 123's Client validates Respondent B's complete. Client informs InnovateMR.

InnovateMR Ops team validates Respondent B's complete on Survey 123.

InnovateMR API platform issues a server-to-server notification indicating that the associated complete has been validated. The verificationstatus will be 'validated'

Notification Schema

Here's an overview of the notification payload.

Property	Data Type	Description
surveyid	integer	id of survey (group) this complete is associated with
jobid	integer	id of job this complete is associated with
verificationstatus	string	`validated` OR `invalidated`
verificationdatetime	datetime ISO8601	datetime of complete verification
token	string	InnovateMR id of survey transaction
pid	string	unique respondent ID
details	string	details of verification

Notification Example

Invalidated Complete

{
"surveyid": 345133,
"jobid": 874729,
"verificationstatus": "invalidated"
"verificationdatetime": "2021-07-05T16:57:08.143Z",
"token": "T36MxJadfwdjWgviuBLNX8B",
"pid": "respondentabc123",
"details": "open end text was copy pasted"
}

Validated Complete

{
"surveyid": 59989,
"jobid": 14317,
"verificationstatus": "validated"
"verificationdatetime": "2021-07-03T06:08:17.129Z",
"token": "29ddJadfwdjWgviuBLNX8B",
"pid": "ac104b37-29dd-49f0-ada7-720ffc345627",
"details": ""
}

Use the Manage Account Url endpoint to

set the cmplVerificationNotifyURL to the URL that you want to receieve these notifications at

set the cmplVerificationNotifyMethod to POST

Commonly Asked Questions

No. These are optional.

When are these notification sent?

When the InnovateMR Ops team receives the list of validated/invalidated completes from the Client. For some surveys this will be done while the survey is in field, for others this can happen +30 days after the survey has closed. In short - this varies by survey and by client.

Can an Invalidated Complete be re-Validated?

Yes, but these cases are rare and typically involve a human error in the flow in which a mistake has been made when invalidating completes for a Survey.

In these cases the InnovateMR team will re-validate the mistakenly invalidated completes which triggers another round of notifications to be sent.

Complete Validation Notifications

Background#

Workflows#

Invalidations#

Validations#

Notification Schema#

Notification Example#

How to subscribe to these notifications?#

Commonly Asked Questions#

Do I have to subscribe to these?#

When are these notification sent?#

Can an Invalidated Complete be re-Validated?#