to the DIVE API
Differences in how the Request's are made
The ID Parsing Web Service can be used in one of two ways
- An image of the back of a Driver's License can be submitted for parsing
- The barcode data can be submitted to be parsed
The DIVE API takes both the image of the back of the driver's license and the barcode data in the same request and must have two parameters set to false to make only the back image of the driver's license required and to ensure that the barcode data is parsed and no other verification checks are done.
ID Parsing Web Service Requests
The request for the ID Parsing Web Service you are using currently is below
Request to parse the barcode data
POST https://app1.idware.net/DriverLicenseParserRest.svc/Parse HTTP/1.1
Host: app1.idware.net
Content-Type: text/json
Cache-Control: no-cache
{
"authKey": "authKey",
"text": "base-64 encoded driver's license image"
}
Request to parse the image of the back of the driver's license
POST https://app1.idware.net/DriverLicenseParserRest.svc/ParseImage HTTP/1.1
Host: app1.idware.net
Content-Type: text/json
Cache-Control: no-cache
{
"authKey": "authKey",
"data": "base-64 encoded driver license back side image"
}
DIVE
The DIVE API request will parse the barcode data from an image of the back of a driver's license and the barcode data that is returned is shown below for comparison to what is returned now using the ID Parsing Web Service.
POST https://dvs2.idware.net/api/v4/verify HTTP/1.1
Host: dvs2.idware.net
Content-Type: text/json
Authorization: Bearer {token}
{
"documentType": 1,
"frontImageBase64": null,
"backOrSecondImageBase64": "base-64 encoded driver's license image",
"faceImageBase64": null,
"trackString":{
"data": "base-64 encoded barcode data",
"barcodeParams": "base-64 encoded barcode parameters"
},
"overriddenSettings": {
"isOCREnabled": false,
"isBackOrSecondImageProcessingEnabled": true,
"isFaceMatchEnabled": false
}
"captureMethod": "string",
"userAgent": "string"
}
Differences in the Response
ID Parsing Web Service Response
The fields that your application makes use of from the ID Parsing Web Service response are also included in the DIVE response when you are only parsing the barcode data. There is additional data included in the response when using the DIVE API but that additional data can be ignored if it is unneeded.
{
"ParseImageResult": {
"Confidence": 60,
"DriverLicense": {
"Address1": "4802 SHEBOYGAN AVE",
"Address2": "",
"Birthdate": "1994-05-08",
"CardRevisionDate": "2012-03-16",
"City": "MADISON",
"ClassificationCode": "",
"ComplianceType": " ",
"Country": "United States of America",
"CountryCode": "USA",
"DocumentType": "ID",
"EndorsementCodeDescription": "",
"EndorsementsCode": "",
"ExpirationDate": "2020-05-08",
"EyeColor": "Blue",
"FirstName": "CHLOE",
"FullName": "CHLOE A ZZZSAMPLE",
"Gender": "Female",
"HAZMATExpDate": null,
"HairColor": "",
"Height": "070 IN",
"IIN": "636031",
"IssueDate": "2012-04-18",
"IssuedBy": "WI",
"JurisdictionCode": "WI",
"LastName": "ZZZSAMPLE",
"LicenseNumber": "Z5141019466802",
"LimitedDurationDocument": null,
"MiddleName": "A",
"NamePrefix": "",
"NameSuffix": "",
"OrganDonor": null,
"PostalBox": "",
"PostalCode": "53705-2927",
"Race": "",
"RestrictionCode": "",
"RestrictionCodeDescription": "",
"VehicleClassCode": "",
"VehicleClassCodeDescription": "",
"Veteran": null,
"WeightKG": "",
"WeightLBS": ""
},
"ErrorMessage": "OK",
"Reference": "B9A7A0CE9CB078D9DB39F72AD18F35424B58EDA1",
"Success": true,
"ValidationCode": {
"Errors": [
"10202"
],
"IsValid": false
}
}
}
DIVE API Response
{
"requestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"document": {
"abbr3Country": "string",
"abbrCountry": "string",
"address": "string",
"city": "string",
"class": "string",
"country": "string",
"dob": "string",
"expires": "string",
"eyes": "string",
"familyName": "string",
"firstName": "string",
"fullName": "string",
"gender": "string",
"hair": "string",
"height": "string",
"id": "string",
"idType": "string",
"issued": "string",
"middleName": "string",
"postalBox": "string",
"state": "string",
"issuedBy": "string",
"weight": "string",
"zip": "string",
"ssn": "string"
},
"documentVerificationResult": {
"isDocumentExpired": true,
"isOcrSuccess": true,
"isPdf417Success": true,
"isMrzSuccess": true,
"isShuftiSuccess": true,
"isDriversLicenseRealID": true,
"documentConfidence": 0
},
"faceMatchVerificationResult": {
"falseAcceptanceRate": 0,
"faceMatchConfidence": 0,
"isAgeCheckSuccess": true,
"isGenderCheckSuccess": true
},
"antiSpoofingVerificationResult": {
"antiSpoofingFaceImageConfidence": 0,
"isDataFieldsTampered": true,
"isPhotoFromDocumentTampered": true
},
"externalVerificationResults": [
{
"name": "string",
"displayName": "string",
"reason": "string",
"effect": 0,
"values": [
{
"score": 0,
"effect": 0,
"fieldName": "string"
}
],
"status": 0
}
],
"authenticationResults": [
{
"name": "string",
"description": "string",
"response": "string",
"score": 0
}
],
"requestData": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"documentType": 1,
"requestIpAddress": "string",
"geolocation": {
"continentCode": "string",
"continent": "string",
"countryCode": "string",
"country": "string",
"stateCode": "string",
"state": "string",
"city": "string",
"postCode": "string",
"accuracyRadius": 0,
"latitude": 0,
"longitude": 0,
"timeZone": "string",
"network": "string"
},
"trackString": {
"data": "string",
"barcodeParams": "string"
},
"metadata": {
"captureMethod": "string",
"userAgent": "string",
"frontEndMetadata": "string",
"otherMetadata": "string"
},
"settings": {
"isOCREnabled": true,
"isCrossMatchRequired": true,
"isGenderCheckEnabled": true,
"isAgeCheckEnabled": true,
"isDocTypeChangeEnabled": true,
"bothSidedScreeningStrategy": 0,
"oneSidedScreeningStrategy": 0,
"isExternalAddressVerificationEnabled": true,
"isExternalShuftiEnabled": true,
"isFaceMatchOptional": true,
"isBackOrSecondImageProcessingEnabled": true,
"isFaceMatchEnabled": true
}
},
"images": {
"frontImage": "string",
"backOrSecondImage": "string",
"frontImageUv": "string",
"backOrSecondImageUv": "string",
"frontImageIr": "string",
"backOrSecondImageIr": "string",
"faceImage": "string",
"croppedFaceImage": "string",
"croppedFaceImageFromDocument": "string",
"signatureImage": "string"
}
}