Save a driver license barcode to a reservation customer

Parses the barcode of a US driver license and saves the data on the customer of a reservation: name, gender, birth date, address, and license number, issue and expiry dates. Each value goes to the customer field your account uses for it, and existing values are overwritten. The reservation must have a customer.

Send preview=1 to only parse the barcode: nothing is saved and reservation_id is not needed.

Request

Authorization

Header Params

Body Params application/jsonRequired

Example

{
    "text": "@\n\u001e\rANSI 636014080102DL00410288ZC03290034DLDAQD1234562\nDCSDOE\nDACJANE\nDADMARIE\nDBD01152022\nDBB06201990\nDBA06202030\nDBC2\nDAG123 MAIN STREET\nDAIMIAMI\nDAJFL\nDAK331420000  \n",
    "reservation_id": 1052,
    "preview": 0
}

Responses

🟢200OK

application/json

The parsed license, saved unless preview was set. HTTP 200 is also used for failures: always check success. When it is false, the body is an ErrorBusinessRule (status_code 410) or an ErrorUnauthorized (status_code 401 or 403).

Bodyapplication/json

Examples

License saved on the customer`text` missing or not a string

{
    "success": true,
    "status_code": 200,
    "errors": [],
    "data": {
        "license": {
            "first_name": "Jane",
            "middle_name": "Marie",
            "last_name": "Doe",
            "sex": "female",
            "birthday": "20-06-1990",
            "street": "123 Main Street",
            "street2": "",
            "state": "FL",
            "zip": "33142",
            "city": "Miami",
            "country": "us",
            "license_number": "D1234562",
            "issued_on": "15-01-2022",
            "expiration_date": "20-06-2030"
        }
    }
}

🟠404Record Not Found