This method is for testing purposes only. Its parameters, functionality and availability are not guaranteed in future.
The method allows you to recognize a personal ID. Currently the only document type supported is the USA driver's license. The ID pattern of the license in different states is different. The method recognizes almost all standard and some extra ID patterns. For the full list of the recognizable ID patterns see Supported license ID patterns.
The method loads the image, creates a processing task for the image with the specified parameters, and passes the task for processing.
The image file is transmitted in the request body. See the list of supported input formats.
Note: Input PDF format is not supported for this method.
The result of recognition is returned in XML format.
For details on task cost please see billing terms.
|Parameter||Is required||Default value||Description|
|idType||No||"auto"||Specifies the type of a document which must be recognized. The following values can be used:
Specifies the source of the image. It can be either a scanned image, or a photograph created with a digital camera. Special preprocessing operations can be performed with the image depending on the selected source. For example, the system can automatically correct distorted text lines, poor focus and lighting on photos.
The value of this parameter can be one of the following:
|correctOrientation||No||"true"||Specifies whether the orientation of the image should be automatically detected and corrected. It can have one of the following values:
|correctSkew||No||"true"||Specifies whether the skew of the image should be automatically detected and corrected. It can have either true or false value.|
|xml:writeExtendedCharacterInfo||No||"false"||Specifies whether the additional information on the recognized characters (e.g. whether the character is recognized uncertainly) should be written to an output file in XML format. The parameter can have one of the following values:
|description||No||""||Contains the description of the processing task. Cannot contain more than 255 characters.|
|pdfPassword||No||""||Contains a password for accessing password-protected images in PDF format.|
Status codes and response format
General status codes and response format of the method are described in HTTP Status Codes and Response Formats.
The following status codes can be returned when this method is called:
|200||Successful method call.|
|450||Incorrect parameters have been passed. One of the following errors occurred:
An internal program error occurred while processing the image.
An error occurred on the server side:
Output file format
The output XML file has the following format:
<?xml version="1.0" encoding="utf-8"?> <document> <driverLicenseUsa> <firstName>John</firstName> <lastName>Smith</lastName> <birthDate>05-12-79</birthDate> <number>F1234567</number> <expiryDate>06-01-21</expiryDate> <address1>99 Independence str</address1> <address2>Seattle WA 01234</address2> </driverLicenseUsa> </document>
See the XSD scheme of an XML file.
Possible fields of an ID
|birthDate||Date of birth in MM-DD-YY format.|
|number||The driver's license number.|
The date of driver's license expiration in MM-DD-YY format.
|address1||The first line of the address.|
|address2||The second line of the address (contains city, ZIP code and state).|