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.

Filename	type	Status simulation	Checks	Result description
done.pdf	social_security	done	no	Data were successfully extracted
done.pdf	social_security	done	checks[first_name] = “John” checks[last_name] = “Doe”	Data were successfully extracted and `match_level` was `close`
inconclusive.pdf	social_security	inconclusive	no	Status is inconclusive with fake data missing
inconclusive.pdf	social_security	inconclusive	checks[first_name] = “John” checks[last_name] = “Doe”	Status is inconclusive and extracted data are missing and checks is null
failed.pdf	social_security	failed.pdf	checks[first_name] = “John” checks[last_name] = “Doe”	Status is failed and `match_level` for `full_name` is `no_match.`
done.pdf	company_certificate	done.pdf	no	Status is done, and fake data are extracted
failed.pdf	company_certificate	failed.pdf	checks[legal_representatives][0][first_name]="John" checks[legal_representatives][0][first_name]="Doe"	Status is failed, `match_level` is `exact`but document is expired so status code is : `DA1002`

ℹ️ 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.