Success Response

Return Model

Root

At the root level:

Name	Data Type	Description
CorrelationID	String	A property that uniquely identifies the document extraction response.
Results	Array<Object>	A list of file results. One entry for each file that was provided.

File Result

At the file result level, each instance contains the following:

Name	Data Type	Description
Filename	String	The name of the file that was analyzed.
Success	Boolean	Flag to show whether or not IQA succeeded for the file.
DataProperties	Array<Object>	A list of data properties indicating the results of the various quality check modules that were executed. One entry for each module.

Data Property

At the data property level, each instance contains the following:

Name	Data Type	Description
Name	String	The name of the quality check module.
IsValid	Boolean	Flag to show whether or not the check passed.
Message	String	A message detailing the quality assessment result.
DataAttributes	Object	A dynamic object containing additional information pertaining to the specific module's output. Usually, it would contain a Score property (decimal).