Set an image status (BETA)

This call is currently in a restricted BETA status. Contact your Technical Account Manager for more information.

Set the status of a image (familiar, unfamiliar).

Most images in the driver verification workflow can transition between states. Images categorized as Familiar or Unfamiliar are blocked from entering the Pending Review.
Note: The pendingReview status is an internal default and cannot be updated manually.

The following profiles have permission to make this call:

  • partners
  • sub-partners
  • administrators
  • supervisors

Request
Security:
bearerAuth
path Parameters
orgId
required
string

The ID of the organization. Obtain this from GET /organizations.

Example: 62
Request Body schema: application/json
status
required
string

Driver Recognition Status.
- Familiar: The driver is recognized and authorized to drive fleet vehicles.
- Unfamiliar: The driver is not recognized or is unauthorized to drive fleet vehicles.

Enum: "familiar" "unfamiliar"
imageId
required
string

The imageId can be retrieved from the /organization-album/{orgId}/album endpoint (field: id).
It is also available in the metadata of the generated unfamiliarDriver event.

Responses
200

Successful operation

400

Bad request error

401

Unauthorized error

403

Forbidden error

404

Not found error

409

Conflict error

500

Internal server error

post/organization-album/{orgId}/album/status
Request samples
application/json
{
  • "status": "familiar",
  • "imageId": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d"
}
Response samples
    2 more
    409
    500
application/json
{
  • "requestId": "06327cae-e075-42ca-b620-c5cfdd3b4e37"
}