Process Barcode

Send an AAMVA-compliant barcode for data extraction and verification of the authenticity of the encoded information.

POST /v1/Document/ProcessBarcode

Parameters

Name	In	Type	Required	Description
`traceId`	query	string	optional	A string provided by a programmer and echoed back unchanged in the response, designed to facilitate easier tracking of requests and responses.
`dateFormat`	query	string	optional	The format in which dates will be returned in the retrieved data.
`returnFieldLabels`	query	boolean	optional	Field labels are user-friendly descriptions of the field type, which can be displayed on a webpage or shown to the customer. This input parameter indicates whether to include field labels for each field in the response.
`returnFieldValidations`	query	boolean	optional	Indicates whether to perform validation on the data fields encoded in the submitted AAMVA-compliant barcode.
`returnCalculatedFields`	query	boolean	optional	Calculated fields are fields that are not explicitly encoded in the AAMVA-compliant barcode but are inferred from the information contained in it. For example, the age field can be calculated from the encoded date of birth. This input parameter is used to decide whether to include calculated fields in the response.
`returnDocumentForensicAuthentications`	query	boolean	optional	This field is used to decide whether to perform forensic authentication of the content encoded in an AAMVA-compliant barcode.
`shouldFailExpiredDocuments`	query	boolean	optional	When forensic authentication is performed on the content of an AAMVA-compliant barcode, this field determines whether the authentication should automatically fail when the expiration date encoded in the barcode indicates that the document is expired (when this field is set to true), or whether the expiration status should be ignored when calculating the authentication score (when this field is set to false). In either case, a warning will be issued indicating that the document is expired. The default value is true.
`ageLimit`	query	integer / int32	optional	This field is used to verify whether the age of the person identified by the data encoded in the AAMVA-compliant barcode is below the specified age entered in this field. The validation result will be included in the response as a field named "IsBelowAgeLimit", indicating whether the condition is met.

Request body

optional (1)

Name	Type	Required	Description
`barcodeContentBase64`	string	optional	The Base64-encoded content of an AAMVA-compliant barcode.

Code sample language

curl -X POST "{{API.SANDBOX_BASE_URL}}/Document/ProcessBarcode" \
  -H "x-api-key: YOUR_API_KEY" \
  -F "barcodeContentBase64=BARCODECONTENTBASE64"

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("x-api-key", "YOUR_API_KEY");
using var content = new MultipartFormDataContent();
content.Add(new StringContent("BARCODECONTENTBASE64"), "barcodeContentBase64");
var response = await client.PostAsync("{{API.SANDBOX_BASE_URL}}/Document/ProcessBarcode", content);
var result = await response.Content.ReadAsStringAsync();

import requests

headers = {"x-api-key": "YOUR_API_KEY"}
data = {"barcodeContentBase64": "BARCODECONTENTBASE64"}
response = requests.post("{{API.SANDBOX_BASE_URL}}/Document/ProcessBarcode", headers=headers, data=data)
print(response.json())

// Each *File below is a File or Blob holding the image.
const form = new FormData();
form.append("barcodeContentBase64", "BARCODECONTENTBASE64");
const response = await fetch("{{API.SANDBOX_BASE_URL}}/Document/ProcessBarcode", {
  method: "POST",
  headers: { "x-api-key": "YOUR_API_KEY" },
  body: form
});
const result = await response.json();

Responses

`200`	OK