Skip to content
Bottle

Add one camera page to a short-lived capture

POST
/vehicle-document-captures/{token}/pages
curl --request POST \
  --url https://example.com/vehicle-document-captures/example/pages \
  --header 'Content-Type: application/json' \
  --data '{ "data": "example" }'

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
token
required
string
>= 32 characters <= 200 characters

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
data
required
string
<= 3000000 characters /^data:image\/(jpeg|png);base64,[\d+/A-Za-z]+={0,2}$/

Example generated

{
  "data": "example"
}

Responses

Section titled “Responses”

201

Section titled “201”

Page added

Media typeapplication/json
object
id
required

UUID v7

string format: uuid
status
required
string
Allowed values: open ready consumed expired
pageCount
required
integer
<= 5
expiresAt
required
string format: date-time
data
required
string | null
<= 7500000 characters /^data:(application\/pdf|image\/(jpeg|png));base64,[\d+/A-Za-z]+={0,2}$/

Example 

{
  "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
  "status": "open"
}

404

Section titled “404”

No such capture

Media typeapplication/json
object
error
required
string
message
required
string

Example 

{
  "error": "not_found",
  "message": "Customer not found"
}

409

Section titled “409”

The capture is complete or already has 5 pages

Media typeapplication/json
object
error
required
string
message
required
string

Example 

{
  "error": "not_found",
  "message": "Customer not found"
}

422

Section titled “422”

Validation failed

Media typeapplication/json
object
error
required
string
Allowed values: validation
message
required
string
issues
required
Array<object>
object
path
required
string
message
required
string

Example 

{
  "error": "validation",
  "issues": [
    {
      "path": "email",
      "message": "Invalid email"
    }
  ]
}