Skip to main content
POST
RUNT Vehicle by Plate

Authorizations

Authorization
string
header
required

Use Authorization: Bearer YOUR_API_KEY

Headers

Idempotency-Key
string

Optional client-chosen key for this request (any string up to 255 characters, e.g. a UUID). Every Croma operation is an idempotent lookup: repeating a request with the same body returns the same result and creates nothing, so retrying after a timeout or network failure is always safe. The key is echoed back in the Idempotency-Key response header so you can correlate a retry with its first attempt. Each attempt that reaches the API counts against the rate limit.

Maximum string length: 255
Example:

"0f8e9a42-6b7c-4d1e-9a3f-2c5d7e8f9a0b"

Prefer
string

Set wait=N to hold the connection up to N seconds for an inline result. If the job finishes in time you get the normal 200 body; otherwise a 202 with a status_url to poll.

Example:

"wait=30"

Body

application/json
plate
string
required

Colombian vehicle plate, e.g. ABC123 or ABC12D.

Required string length: 6
Pattern: ^[A-Za-z]{3}\d{2}[A-Za-z0-9]$
document_number
string
required

Document number (alphanumeric with hyphens allowed).

Required string length: 3 - 30
document_type
enum<string>
default:CC

Colombian document type. Defaults to CC.

Available options:
CC,
CE,
TI,
RC,
PA,
NIT,
PPT
callback_url
string<uri>

POST the job result here when it finishes.

Response

Successful response

data
object
required