Finish a phone capture

POST

/vehicle-document-captures/{token}/complete

const url = 'https://example.com/vehicle-document-captures/example/complete';
const options = {method: 'POST'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/vehicle-document-captures/example/complete

Parameters

Path Parameters

token

required

string

>= 32 characters <= 200 characters

Responses

200

Capture ready for the office

application/json

object

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

No such capture

application/json

object

error

required

string

message

required

string

Example

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

409

The capture is complete or already has 5 pages

application/json

object

error

required

string

message

required

string

Example

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

422

Validation failed

application/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"
    }
  ]
}