Sign in
provider
spakinect

Create Gfe Request

Create a new Good Faith Exam request.

Creates an appointment with SpaKinect and stores the GFE record in the database. The patient will receive notifications at their email/phone to complete the virtual exam.

post/spakinect/gfe

Headers

TENANTstring required

The tenant you are making this request on behalf of

API-KEYstring required

Your api key

Request body

patientIdstring required
locationIdstring required
appointmentTimestring date-time required
requestedTreatmentsstring[] required
patientEmailstring email nullable
patientPhonestring nullable

Response

Successful Response

idstring required
patientIdstring required
spakinectGfeIdstring required
createdDatestring date-time required
updatedDatestring date-time nullable
status'Processing' | 'Pending Review' | 'Approved' | 'Rejected' | 'Completed' | 'Cancelled' | 'Cancelled by client' required

Status values for Good Faith Exam visits from SpaKinect API

requestedTreatmentsstring[] required

Changes

No recorded changes to this endpoint across all 1 revision of this API.