POST/api/partner/v1/violations/notice/read

Read a ticket photo

Read a photo or PDF of a mailed ticket and get its fields back. Saves nothing.

Returns what the ticket says for you to check and send to POST /violations. Saves nothing.

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.

Body

multipart/form-data

filefilerequired

JPEG, PNG, WebP, HEIC photo or PDF, up to 10 MB.

Response

200 · application/json

successbooleanrequired

dataobject

citationNumberstring

pinstring

issuedLocalstring

amountnumber

dueDatestring

licensePlatestring

plateStatestring

agencystring

issuingStatestring

paymentUrlstring

violationTypestring

Allowed values:parkingred_lightspeedtollother

locationstring

errorstringnullable

Status codes

200The fields read off the ticket.

400Validation error.

401Missing, unknown or revoked API key.

422Nothing readable was found in the file.

503Ticket reading is temporarily unavailable; enter the ticket by hand.