Create rental agreement

Generate a rental agreement for the booking and return its signing link.

Authorization

X-Api-Key header

Send your partner key on every request. An owner key acts for its one owner; an integration token also needs the owner's id in the X-Owner-Id header.

Path parameters

bookingIdstringpathrequired

Response

200 · application/json

successbooleanrequired

dataobject

bookingIdstring

agreementUrlstring <uri>

driverNamestringnullable

driverEmailstringnullable

errorstringnullable

Status codes

200The agreement link.

400Validation error.

401Missing, unknown or revoked API key.

404The resource does not exist under this owner.

POST/api/partner/v1/bookings/{bookingId}/agreement

curl -X POST "https://owner.myeztoll.com/api/partner/v1/bookings/BK-88301/agreement" \
  -H "X-Api-Key: $AEGIS_API_KEY"

Base URL

Response

{
  "success": true,
  "data": {
    "bookingId": "BK-88301",
    "agreementUrl": "https://owner.myeztoll.com/agreement/2f9c1a7e",
    "driverName": "Maria Alvarez",
    "driverEmail": "maria.alvarez@example.com"
  },
  "error": null
}