ReadDocument Endpoint
POST https://ocr.idware.net/api/ocr/ReadDocument
This Web Service endpoint will only read Passport documents submitted to it.
Request Information
| Name |
Description |
Type |
Additional information |
| Authorization |
|
ApiKey XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX |
Required |
Request Content (multipart/form-data)
| Name |
Description |
Type |
Additional information |
|
|
File |
Collection of image/jpeg |
| ReturnSignatureImage |
field |
bool |
|
| ReturnPhotoImage |
field |
bool |
|
| Name |
Description |
Type |
Additional information |
| RecognizeResponseItems |
|
Collection of RecognizeResponse |
|
RecognizeResponse
| Name |
Description |
Type |
Additional information |
| ImageId |
|
int |
|
| FileName |
|
string |
|
| Document |
|
RecognizedDocument |
|
| Status |
|
string |
|
| ErrorMsg |
|
string |
|
RecognizedDocument
| Name |
Description |
Type |
Additional information |
| IDType |
|
RecognizedValue |
|
| Country |
|
RecognizedValue |
|
| AbbrCountry |
|
RecognizedValue |
|
| Abbr3Country |
|
RecognizedValue |
|
| ID |
|
RecognizedValue |
|
| DOB |
|
RecognizedValue |
|
| Issued |
|
RecognizedValue |
|
| Expires |
|
RecognizedValue |
|
| FullName |
|
RecognizedValue |
|
| PrivateName |
|
RecognizedValue |
|
| FamilyName |
|
RecognizedValue |
|
| City |
|
RecognizedValue |
|
| State |
|
RecognizedValue |
|
| Zip |
|
RecognizedValue |
|
| Address |
|
RecognizedValue |
|
| Class |
|
RecognizedValue |
|
| Gender |
|
RecognizedValue |
|
| Height |
|
RecognizedValue |
|
| Eyes |
|
RecognizedValue |
|
| Hair |
|
RecognizedValue |
|
| Weight |
|
RecognizedValue |
|
| Template |
|
RecognizedValue |
|
| FirstName |
|
RecognizedValue |
|
| MiddleName |
|
RecognizedValue |
|
| Picture |
|
RecognizedValue |
|
| Signature |
|
RecognizedValue |
|
RecognizedValue
| Name |
Description |
Type |
Additional information |
| Value |
|
string |
|
| ValueMRZ |
|
string |
|
| Confidence |
|
int |
|