Send Document to Recognition
Use this method to be able to extract information from a document
posthttps://api.electroneek.com/v1/intellidocs/scan
Try it
header parameters
cURL
curl --request POST \
--url 'https://api.electroneek.com/v1/intellidocs/scan' \
--header 'Content-Type: application/json' \
--data '{"url": "https://templates.invoicehome.com/invoice-template-us-band-blue-750px.png"}'Authentication
Use the API Key from your Document Stream. IntelliDocs is a single global API, so the key is not tied to a region — see managing API keys.
header parameters
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type | string | no |
Request body
one of 7 shapes
scanUrlobject
urlstringrequiredscanUrlsobject
urlsarray of itemsrequiredscanImageobject
imagestringrequiredscanImagesobject
imagesarray of itemsrequiredscanFullTextPagesobject
fullTextPagesarray of itemsrequiredscanVaccineCardobject
idImagestringrequiredvaccineCardImagestringrequiredscanAccordobject
urlstringrequiredvalidationUrlstringResponse
200Success
Example response
[
{
"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",
"faces": {
"top": 165,
"left": 62,
"image": "data:image/png;base64,/9j/2wBDAAYEBQYFBAYGBQYHBwYIChAKCgkJChQODwwQFxQYGBcUFhYaHSUfGhsjHBYWICwgIyYnK...",
"right": 192,
"width": 130,
"bottom": 331,
"height": 166,
"topLeft": {
"x": 62,
"y": 165
},
"topRight": {
"x": 192,
"y": 165
},
"bottomLeft": {
"x": 62,
"y": 331
},
"confidence": 0.9,
"pageNumber": 0,
"bottomRight": {
"x": 192,
"y": 331
}
},
"model": {
"name": "New York driver license",
"type": "driver_license/usa/ny",
"isValid": true,
"confidence": 1
},
"fields": {
"age": {
"key": "Age",
"type": "number",
"value": 40,
"isValid": true,
"confidence": 1
},
"sex": {
"key": "Sex",
"value": "Male",
"isValid": true,
"confidence": 1
},
"class": {
"key": "Class",
"value": "D",
"location": {
"topLeft": {
"x": 241,
"y": 93
},
"topRight": {
"x": 400,
"y": 93
},
"bottomLeft": {
"x": 241,
"y": 111
},
"pageNumber": 0,
"bottomRight": {
"x": 400,
"y": 111
}
},
"confidence": 0.99
},
"address": {
"key": "Address",
"value": "2345 ANYWHERE STREET\nYOUR CITY, NY 12345",
"location": {
"topLeft": {
"x": 235,
"y": 182
},
"topRight": {
"x": 448,
"y": 182
},
"bottomLeft": {
"x": 235,
"y": 199
},
"pageNumber": 0,
"bottomRight": {
"x": 448,
"y": 199
}
},
"confidence": 1
},
"isRealId": {
"key": "Is Real ID?",
"type": "boolean",
"value": "Yes",
"location": {
"topLeft": {
"x": 385,
"y": 264
},
"topRight": {
"x": 414,
"y": 264
},
"bottomLeft": {
"x": 385,
"y": 282
},
"pageNumber": 0,
"bottomRight": {
"x": 414,
"y": 282
}
},
"confidence": 1
},
"givenName": {
"key": "Given name",
"value": "COMMERCIAL",
"location": {
"topLeft": {
"x": 7,
"y": 155
},
"topRight": {
"x": 47,
"y": 155
},
"bottomLeft": {
"x": 7,
"y": 212
},
"pageNumber": 0,
"bottomRight": {
"x": 47,
"y": 212
}
},
"confidence": 0.64
},
"issueDate": {
"key": "Issue date",
"type": "date",
"value": "2013-08-31",
"isValid": true,
"ocrText": "08/31/2013",
"location": {
"topLeft": {
"x": 277,
"y": 394
},
"topRight": {
"x": 390,
"y": 394
},
"bottomLeft": {
"x": 277,
"y": 413
},
"pageNumber": 0,
"bottomRight": {
"x": 390,
"y": 413
}
},
"confidence": 0.99
},
"stateCode": {
"key": "State code",
"type": "static",
"value": "NY",
"confidence": 1
},
"stateName": {
"key": "State name",
"type": "static",
"value": "New York",
"isValid": true,
"confidence": 1
},
"familyName": {
"key": "Family name",
"value": "MICHAEL, M",
"location": {
"topLeft": {
"x": 236,
"y": 149
},
"topRight": {
"x": 353,
"y": 149
},
"bottomLeft": {
"x": 236,
"y": 169
},
"pageNumber": 0,
"bottomRight": {
"x": 353,
"y": 169
}
},
"confidence": 0.99
},
"countryCode": {
"key": "Country code",
"type": "static",
"value": "USA",
"isValid": true,
"confidence": 1
},
"countryName": {
"key": "Country name",
"type": "static",
"value": "United States of America",
"isValid": true,
"confidence": 1
},
"dateOfBirth": {
"key": "Date of birth",
"type": "date",
"value": "1982-08-31",
"isValid": true,
"ocrText": "08/31/1982",
"location": {
"topLeft": {
"x": 265,
"y": 290
},
"topRight": {
"x": 382,
"y": 290
},
"bottomLeft": {
"x": 265,
"y": 309
},
"pageNumber": 0,
"bottomRight": {
"x": 382,
"y": 309
}
},
"confidence": 0.99
},
"isFrontSide": {
"key": "Is front side",
"type": "boolean",
"value": "Yes",
"isValid": true,
"location": {
"topLeft": {
"x": 385,
"y": 264
},
"topRight": {
"x": 414,
"y": 264
},
"bottomLeft": {
"x": 385,
"y": 282
},
"pageNumber": 0,
"bottomRight": {
"x": 414,
"y": 282
}
},
"confidence": 1
},
"documentType": {
"key": "Document type",
"type": "static",
"value": "Driver license",
"isValid": true,
"confidence": 1
},
"isEnhancedId": {
"key": "Is Enhanced ID?",
"type": "boolean",
"value": "Yes",
"location": {
"topLeft": {
"x": 385,
"y": 264
},
"topRight": {
"x": 414,
"y": 264
},
"bottomLeft": {
"x": 385,
"y": 282
},
"pageNumber": 0,
"bottomRight": {
"x": 414,
"y": 282
}
},
"confidence": 1
},
"licenseNumber": {
"key": "License number",
"value": "123456789",
"isValid": true,
"location": {
"topLeft": {
"x": 493,
"y": 104
},
"topRight": {
"x": 646,
"y": 104
},
"bottomLeft": {
"x": 493,
"y": 125
},
"pageNumber": 0,
"bottomRight": {
"x": 646,
"y": 125
}
},
"confidence": 0.98
},
"expirationDate": {
"key": "Expiration date",
"type": "date",
"value": "2018-08-31",
"isValid": false,
"ocrText": "08/31/2018",
"location": {
"topLeft": {
"x": 279,
"y": 316
},
"topRight": {
"x": 394,
"y": 316
},
"bottomLeft": {
"x": 279,
"y": 335
},
"pageNumber": 0,
"bottomRight": {
"x": 394,
"y": 335
}
},
"confidence": 0.99
},
"driverLicenseType": {
"key": "Driver license type",
"value": "Learner permit",
"location": {
"topLeft": {
"x": 205,
"y": 69
},
"topRight": {
"x": 444,
"y": 69
},
"bottomLeft": {
"x": 205,
"y": 89
},
"pageNumber": 0,
"bottomRight": {
"x": 444,
"y": 89
}
},
"confidence": 0.98
}
},
"properties": {
"width": 900,
"height": 459,
"mimeType": "image/png",
"isInFocus": true,
"pageCount": 1,
"isGlareFree": true,
"rotationAngle": 0
},
"signatures": [
{
"top": 350,
"left": 31,
"image": "data:image/png;base64,/9j/2wBDAAYEBQYFBAYGBQYHBwYIChAKCgkJChQODwwQFxQYGBcUFhYaHSUfGhsjHBYWICwgIyYnKSopGR8tM..",
"right": 222,
"width": 191,
"bottom": 385,
"height": 35,
"topLeft": {
"x": 31,
"y": 350
},
"topRight": {
"x": 222,
"y": 350
},
"bottomLeft": {
"x": 31,
"y": 385
},
"confidence": 0.87,
"pageNumber": 0,
"bottomRight": {
"x": 222,
"y": 385
}
}
]
}
] Updated