Acceptable header values
Last updated
Last updated
Acceptable Value
Description
Content-type
multipart/form-data
Authorization
You need to add the word Bearer Infront of this string when sending. Use the Above call to obtain this token.
UseV2
Set to True to use new document extraction model
DocumentType
A list of different document type that this service supports. This can be omitted for documents that support auto classification. The supported document types can be found here.
CountryCode
This is the code of the county whose document you want to scan. It can be omitted for documents that support auto classification. The supported country codes can be found here.
CorrelationID
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.
FrontImageHash
This value is used by the Sybrin SDKs to ensure the font document image is coming from the same source it was capture by.
BackImageHash
This value is used by the Sybrin SDKs to ensure the back document image is coming from the same source it was capture by.
UseSegmentationBeforeOCR
A header value used to determine if document segmentation should be done before text extraction.
ValidateBackFront
A header value used to determine if document validation should be done.
ExtractionConfidenceThreshold
A header value that allows a user to define a confidence threshold between 0 and 100, determining how confident the system should be in extracting attributes. The lower the threshold, the more likely it is to extract a value, but it also increases the likelihood of the extracted value being incorrect. The default is set to 65
StrictValidation
A header value that allows users to enable or disable strict validation. If strict validation is enabled, the extracted attribute must pass all validation checks to be included in the response. If strict validation is not enabled, the attribute can be passed through without meeting all validation checks. The default is set to true