Upload a driver license image for a reservation customer

Stores an image of the driver license on the customer of a reservation. Send it as multipart/form-data.

Your account must have a driver license field set in the car rental settings. When that field is an identification field, the image is attached to the customer's driver license identification. Otherwise it goes to the customer image field: the only image field of customers, or the one set as the driver license image field. Without a usable field, the request fails with a business error and nothing is stored. The reservation must have a customer.

Responses

🟢200OK

application/json

The image was stored; data.license is its URL. 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

Image storedNo driver license field configured

{
    "success": true,
    "status_code": 200,
    "errors": [],
    "data": {
        "license": "https://yourcompany.example.com/files/9c1d2e3f-4a5b-6c7d-8e9f-0a1b2c3d4e5f/public"
    }
}

🟠404Record Not Found

🟠422Parameter Error

Upload a driver license image for a reservation customer

Request

Responses