Skip to main content
POST
Create Gfe Request

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Body

application/json

Request to create a new Good Faith Exam appointment

patientId
string
required
locationId
string
required
appointmentTime
string<date-time>
required
requestedTreatments
string[]
required
patientEmail
string<email> | null
patientPhone
string | null

Response

Successful Response

Detailed Good Faith Exam information including SpaKinect data

id
string
required
patientId
string
required
spakinectGfeId
string
required
createdDate
string<date-time>
required
status
enum<string>
required

Status values for Good Faith Exam visits from SpaKinect API

Available options:
Processing,
Pending Review,
Approved,
Rejected,
Completed,
Cancelled,
Cancelled by client
requestedTreatments
string[]
required
patientDetails
PatientDetails · object
required
updatedDate
string<date-time> | null
document
DocumentSummary · object | null