Extract Document

This request will execute OCR detection, using the images provided, and parse them into an understandable model.

Before making the request, please ensure you meet the following prerequisites:

1. Visit Licensing to see how to get your credentials.

2. Please ensure that the images follows our input guidelines!

3. We only support the following image formats: .jpeg, .jpg, .png

Checkout acceptable header values to see what values we accept for each header.

Extract Document

POST https://sybrinocr.sybrin.com/api/OCRAPI/ExtractDocument

Headers

Name	Type	Description
CountryCode	string	The country you would like to scan for.
DocumentType	string	The document type you would like to scan for.
APIKey	string	An API key, checkout Licensing on how to get one.
ReturnType	string	The format in which you would like the document model to be returned. Defaults to "STRING" if no value is supplied.

Request Body

Name	Type	Description
FrontImage	string	This should be an image file. The front image of the document that you would like to scan for. If multiple images are supplied, only the first will be used. Make sure to follow the input guidelines.
BackImage	object	This should be an image file. The back image of the document that you would like to scan for. If multiple images are supplied, only the first will be used. Make sure to follow the input guidelines. This parameter is only required if the document requires a back image, otherwise this parameter may be omitted. Check out the specific model to see if you need to include the back image or not.

200 A successful response will be returned and the document fields will be populated. Check out return models to see what values will be returned for each country code and document type.

500 If any error has been detected while processing the document, you will be given an error object response. The message will indicate what went wrong, while additional information will be included in the details. The security check will indicate whether the images have been verified or not.

{
    "error_message": "No FrontImage found",
    "error_details": null,
    "security_check_success": false
}