Testing Document Analysis in Sandbox

This guide will explain how to test the Document Analysis without incurring charges in the Sandbox environment.

In the Sandbox, we do not perform real extraction and but we will provide you a simulated experience that closely mirrors the production behavior.

When initiating an Document Analysis, you must upload a file with a specific filename using the file parameter. This filename determines the status result that will be simulated and the data that would be extracted.

Status simulation	Filename	Checks	Result description
done	done.pdf	no	Data were successfully extracted
done	done.pdf	checksuide will ex = “John” checksthe Documen = “Doe”	Data were successfully extracted and `match_level` was `close`
inconclusive	inconclusive.pdf	no	Status is inconclusive with fake data missing
inconclusive	inconclusive.pdf	checksuide will ex = “John” checksthe Documen = “Doe”	Status is inconclusive and extracted data are missing and checks is null
failed.pdf	failed.pdf	checksuide will ex = “John” checksthe Documen = “Doe”	Status is failed and `match_level` for `full_name` is `no_match.`

ℹ️ If you name the test file incorrectly, the API won’t recognize it, and the Document Analysis will fail.

Once the Document Analysis has been done, you can retrieve the results through the designated endpoint.

Also, if you have subscribed in the Sandbox to the document_analysis.done event you will also receive a webhook notification.