Document Entity Extraction

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

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.

Replace https://soma.sybrin.com/ with relevant base URL.

Extract Document Entities

POST https://soma.sybrin.com/api/DocumentCapture/ExtractDocumentEntities

Headers

NameTypeDescription

Authorization*

String

You need to add the word Bearer Infront of this string when sending. Use the Above call to obtain this token.

DocumentType*

String

A list of different document type that this service supports.

CountryCode*

String

This is the code of the county documents you want to scan. Use ZAF

CorrelationID

String

This value is managed by the consumer of this API. When this value is set and there is a forwarding service all facial data will be passed to the forwarding service with the CorrelationID to manage the response. This is a security option to store data on another service as the data on the consuming UI could be tampered with.

Content-type

multipart/form-data

BackImageHash

String

This value is used by the Sybrin SDKs to ensure the back document image is coming from the same source it was capture by.

FrontImageHash

String

This value is used by the Sybrin SDKs to ensure the font document image is coming from the same source it was capture by.

UseV2

String

Set to True to use new document extraction model

Request Body

NameTypeDescription

No Post body is required