Caregiver check-out

post

https://{apiHost}/api/v2/public/visits/{visitId}/evv/checkout

Record caregiver departure from client location. Captures GPS coordinates
and optionally signatures. Signature images can be provided as base64-encoded
PNG or JPEG data, with or without a data-URI prefix.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

visitId

string

required

Unique visit identifier

Body Params

time

date-time

required

Check-out time in ISO format

coords

array of numbers

length between 2 and 2

GPS coordinates as [longitude, latitude]

coords

careLocation

string

Location identifier (home, facility, etc.)

reason

string

Reason for early/late check-out

gpsReasonId

string

Attribute ID for GPS bypass reason. Use GET /config/attributes to get valid options.

outOfFenceReason

string

Reason for being outside geo-fence

manual

boolean

Defaults to false

Whether this is a manual entry

signatureText

string

Client signature text (name of the signer)

caregiverSignatureText

string

Caregiver signature text (name of the signer)

signatureImage

string

length ≤ 500000

Client signature as a base64-encoded image (PNG or JPEG).
Accepts raw base64 or data-URI format (e.g. "data:image/png;base64,...").
Maximum size: 500,000 characters (~375KB decoded).
When provided, the image is uploaded to S3 and the signature will
appear in the Viv UI EVV panel.

caregiverSignatureImage

string

length ≤ 500000

Caregiver signature as a base64-encoded image (PNG or JPEG).
Accepts raw base64 or data-URI format (e.g. "data:image/png;base64,...").
Maximum size: 500,000 characters (~375KB decoded).
When provided, the image is uploaded to S3 and the signature will
appear in the Viv UI EVV panel.

locationValidation

object | null

Validation data from mobile client

timeValidation

object | null

Validation data from mobile client

taskValidation

object | null

Validation data from mobile client

Responses

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Check-out recorded

400Request validation failed

401Authentication failed - invalid or missing API key

403Resource is locked and cannot be modified

409Not checked in or already checked out