Document Recognition

Send Document to Recognition

Use this method to be able to extract information from a document

SecuritybearerAuth

Request

header Parameters

Content-Type	string Example: application/json
Authorization	string Example: Bearer APIKey

Request Body schema: application/json

Any of:

url

required

string

Responses

200

Success

post/scan

Request samples

Payload

application/json

{"url": "https://templates.invoicehome.com/invoice-template-us-band-blue-750px.png"
}

Response samples

application/json

[{"faces": {"left": 62,
"top": 165,
"width": 130,
"height": 166,
"confidence": 0.9,
"pageNumber": 0,
"image": "data:image/png;base64,/9j/2wBDAAYEBQYFBAYGBQYHBwYIChAKCgkJChQODwwQFxQYGBcUFhYaHSUfGhsjHBYWICwgIyYnK...",
"bottom": 331,
"right": 192,
"topLeft": {"x": 62,
"y": 165
},
"topRight": {"x": 192,
"y": 165
},
"bottomLeft": {"x": 62,
"y": 331
},
"bottomRight": {"x": 192,
"y": 331
}
},
"fields": {"documentType": {"key": "Document type",
"type": "static",
"value": "Driver license",
"isValid": true,
"confidence": 1
},
"countryName": {"key": "Country name",
"value": "United States of America",
"isValid": true,
"type": "static",
"confidence": 1
},
"countryCode": {"key": "Country code",
"value": "USA",
"isValid": true,
"type": "static",
"confidence": 1
},
"stateName": {"key": "State name",
"value": "New York",
"isValid": true,
"type": "static",
"confidence": 1
},
"stateCode": {"key": "State code",
"value": "NY",
"type": "static",
"confidence": 1
},
"driverLicenseType": {"key": "Driver license type",
"value": "Learner permit",
"confidence": 0.98,
"location": {"topLeft": {"x": 205,
"y": 69
},
"topRight": {"x": 444,
"y": 69
},
"bottomLeft": {"x": 205,
"y": 89
},
"bottomRight": {"x": 444,
"y": 89
},
"pageNumber": 0
}
},
"class": {"key": "Class",
"value": "D",
"confidence": 0.99,
"location": {"topLeft": {"x": 241,
"y": 93
},
"topRight": {"x": 400,
"y": 93
},
"bottomLeft": {"x": 241,
"y": 111
},
"bottomRight": {"x": 400,
"y": 111
},
"pageNumber": 0
}
},
"givenName": {"key": "Given name",
"value": "COMMERCIAL",
"confidence": 0.64,
"location": {"topLeft": {"x": 7,
"y": 155
},
"topRight": {"x": 47,
"y": 155
},
"bottomLeft": {"x": 7,
"y": 212
},
"bottomRight": {"x": 47,
"y": 212
},
"pageNumber": 0
}
},
"familyName": {"key": "Family name",
"value": "MICHAEL, M",
"confidence": 0.99,
"location": {"topLeft": {"x": 236,
"y": 149
},
"topRight": {"x": 353,
"y": 149
},
"bottomLeft": {"x": 236,
"y": 169
},
"bottomRight": {"x": 353,
"y": 169
},
"pageNumber": 0
}
},
"address": {"key": "Address",
"value": "2345 ANYWHERE STREET\nYOUR CITY, NY 12345",
"confidence": 1,
"location": {"topLeft": {"x": 235,
"y": 182
},
"topRight": {"x": 448,
"y": 182
},
"bottomLeft": {"x": 235,
"y": 199
},
"bottomRight": {"x": 448,
"y": 199
},
"pageNumber": 0
}
},
"licenseNumber": {"key": "License number",
"value": "123456789",
"confidence": 0.98,
"isValid": true,
"location": {"topLeft": {"x": 493,
"y": 104
},
"topRight": {"x": 646,
"y": 104
},
"bottomLeft": {"x": 493,
"y": 125
},
"bottomRight": {"x": 646,
"y": 125
},
"pageNumber": 0
}
},
"sex": {"key": "Sex",
"value": "Male",
"isValid": true,
"confidence": 1
},
"age": {"key": "Age",
"type": "number",
"value": 40,
"isValid": true,
"confidence": 1
},
"dateOfBirth": {"key": "Date of birth",
"value": "1982-08-31",
"confidence": 0.99,
"isValid": true,
"ocrText": "08/31/1982",
"type": "date",
"location": {"topLeft": {"x": 265,
"y": 290
},
"topRight": {"x": 382,
"y": 290
},
"bottomLeft": {"x": 265,
"y": 309
},
"bottomRight": {"x": 382,
"y": 309
},
"pageNumber": 0
}
},
"issueDate": {"key": "Issue date",
"value": "2013-08-31",
"confidence": 0.99,
"isValid": true,
"ocrText": "08/31/2013",
"type": "date",
"location": {"topLeft": {"x": 277,
"y": 394
},
"topRight": {"x": 390,
"y": 394
},
"bottomLeft": {"x": 277,
"y": 413
},
"bottomRight": {"x": 390,
"y": 413
},
"pageNumber": 0
}
},
"expirationDate": {"key": "Expiration date",
"value": "2018-08-31",
"confidence": 0.99,
"isValid": false,
"ocrText": "08/31/2018",
"type": "date",
"location": {"topLeft": {"x": 279,
"y": 316
},
"topRight": {"x": 394,
"y": 316
},
"bottomLeft": {"x": 279,
"y": 335
},
"bottomRight": {"x": 394,
"y": 335
},
"pageNumber": 0
}
},
"isFrontSide": {"key": "Is front side",
"value": "Yes",
"isValid": true,
"type": "boolean",
"confidence": 1,
"location": {"topLeft": {"x": 385,
"y": 264
},
"topRight": {"x": 414,
"y": 264
},
"bottomLeft": {"x": 385,
"y": 282
},
"bottomRight": {"x": 414,
"y": 282
},
"pageNumber": 0
}
},
"isRealId": {"key": "Is Real ID?",
"type": "boolean",
"value": "Yes",
"confidence": 1,
"location": {"topLeft": {"x": 385,
"y": 264
},
"topRight": {"x": 414,
"y": 264
},
"bottomLeft": {"x": 385,
"y": 282
},
"bottomRight": {"x": 414,
"y": 282
},
"pageNumber": 0
}
},
"isEnhancedId": {"key": "Is Enhanced ID?",
"type": "boolean",
"value": "Yes",
"confidence": 1,
"location": {"topLeft": {"x": 385,
"y": 264
},
"topRight": {"x": 414,
"y": 264
},
"bottomLeft": {"x": 385,
"y": 282
},
"bottomRight": {"x": 414,
"y": 282
},
"pageNumber": 0
}
}
},
"ocr": "NEW YORK STATE\nLEARNER PERMIT\nENHANCED\nUSA\nBarbara J. Fiala\nCommissioner off Motor Vehicles\nCOMME\nCOLLE\nA\nID 123 456 789\nMOTORIST\nClass\nD\nMICHAEL, M\nCOMMERCIAL\n2345 ANYWHERE STREET\nYOUR CITY, NY 12345\nCOMMERCIA\nMERCIAL \nCAS\nMo\nSex M Height 5'-08\" Eyes BRO\nDAJne82 MICHAŁY\nDOB 08/31/1982\nSAMPLE\nExpires 08/31/2018\nE NONE\nMichael Motorist\nCOMME\nRestrictions\nR B\nCTOR\nAUG ₿2\nIssued\n08/31/2013\nABC3456789",
"properties": {"height": 459,
"width": 900,
"pageCount": 1,
"mimeType": "image/png",
"rotationAngle": 0,
"isGlareFree": true,
"isInFocus": true
},
"model": {"name": "New York driver license",
"confidence": 1,
"type": "driver_license/usa/ny",
"isValid": true
},
"signatures": [{"left": 31,
"top": 350,
"width": 191,
"height": 35,
"confidence": 0.87,
"pageNumber": 0,
"image": "data:image/png;base64,/9j/2wBDAAYEBQYFBAYGBQYHBwYIChAKCgkJChQODwwQFxQYGBcUFhYaHSUfGhsjHBYWICwgIyYnKSopGR8tM..",
"bottom": 385,
"right": 222,
"topLeft": {"x": 31,
"y": 350
},
"topRight": {"x": 222,
"y": 350
},
"bottomLeft": {"x": 31,
"y": 385
},
"bottomRight": {"x": 222,
"y": 385
}
}
]
}
]