Skip to main content
POST
/
clients
curl -X POST "https://api.wizlo.example.com/clients" \
  -H "Authorization: Bearer <your_access_token>" \
  -H "Content-Type: application/json" \
  -d '{
  "firstName": "Jaime",
  "lastName": "Reyes",
  "dateOfBirth": "1992-01-01",
  "email": "blue.beetle3@reachtech.org",
  "gender": "male",
  "countryCode": "+1",
  "phone": "5556667777"
}'

{
  "user_id": "acf919e9-4661-444f-8496-afb07e731a6f",
  "firstName": "Jaime",
  "lastName": "Reyes",
  "email": "blue.beetle@reachtech.org",
  "dateOfBirth": "1992-01-01T00:00:00.000Z",
  "sex": "male",
  "phone": "5556667777",
  "countryCode": "+1",
  "isVerified": "NOTVERIFIED",
  "address1": "1 El Paso Street",
  "address2": null,
  "cityId": null,
  "stateId": null,
  "countryId": null,
  "postal": "79901",
  "metadata": null,
  "createdAt": "2025-11-27T10:22:57.894Z",
  "updatedAt": "2025-11-27T10:22:57.894Z"
}

​
Overview

This endpoint allows authorized staff or external systems to create a new patient profile within the clinic. Behavior:
  • Identity Check: Checks if a patient with the provided email already exists in the current tenant.
  • Record Creation:
    • If email is unique: Creates a new User account and Patient Profile.
    • If email exists: Returns a 409 Conflict error. This endpoint does not update existing records.

​
Headers

This endpoint uses Machine-to-Machine (M2M) authentication.
​
Authorization
string
required
Standard Bearer token (e.g., Bearer <your_access_token>). See the M2M Authentication guide for details on generating this token.
​
Content-Type
string
required
Must be set to application/json.

​
Body Parameters

​
firstName
string
required
The patient’s first name.
​
lastName
string
required
The patient’s last name.
​
email
string
required
The patient’s email address. Must be unique within the clinic.
​
dateOfBirth
string
required
The patient’s date of birth in YYYY-MM-DD format.
​
countryCode
string
required
The country dialing code for the phone number (e.g., “+1”).
​
phone
string
required
The patient’s primary phone number (digits only).

​
Optional Fields

​
gender
string
The patient’s gender (Accepted values: “male”, “female”, “other”).
​
address
string
Primary street address (Line 1).
​
address2
string
Secondary address information (Line 2, Apt/Suite).
​
postalCode
string
Zip or Postal code.
​
cityId
string
Unique identifier (UUID) of the city.
​
stateId
string
Unique identifier (UUID) of the state.
​
countryId
string
Unique identifier (UUID) of the country.
​
gfeStateId
string
Unique identifier (UUID) of the state relevant for the Good Faith Estimate (GFE).
​
notes
string
General notes regarding the patient.
​
emergencyContact
string
Phone number for the emergency contact.
​
emergencyContactCode
string
Country dialing code for the emergency contact (e.g., “+1”).
​
emergencyContactName
string
Full name of the emergency contact.
​
employer
string
Name of the patient’s employer.
​
workMobile
string
Work phone number.
​
maritalStatus
string
Marital status (e.g., “single”, “married”, “divorced”).
​
isHomeAddressSameAsShipping
boolean
default:"true"
Flag indicating if the shipping address matches the home address.
​
insuranceInfo
string
Free text field for insurance details.
​
medicalHistory
string
Free text field for medical history.

​
Response Parameters

​
user_id
string
The unique UUID assigned to the new patient.
​
firstName
string
Patient First Name.
​
lastName
string
Patient Last Name.
​
email
string
Patient Email.
​
sex
string
Patient gender.
​
address1
string
Primary street address.
​
postal
string
Zip or Postal code.
​
isVerified
string
Identity verification status (e.g., “NOTVERIFIED”, “VERIFIED”, “INVITED”).
​
metadata
object
JSON object for storing additional dynamic data.
​
createdAt
string
ISO 8601 timestamp of creation.
​
updatedAt
string
ISO 8601 timestamp of last update.

​
Status Codes

StatusDescription
201Created. The patient profile was successfully created.
400Bad Request. Missing required fields or invalid data formats (e.g., invalid email).
401Unauthorized. Invalid or missing authentication token.
409Conflict. A patient with this email address already exists.
curl -X POST "https://api.wizlo.example.com/clients" \
  -H "Authorization: Bearer <your_access_token>" \
  -H "Content-Type: application/json" \
  -d '{
  "firstName": "Jaime",
  "lastName": "Reyes",
  "dateOfBirth": "1992-01-01",
  "email": "blue.beetle3@reachtech.org",
  "gender": "male",
  "countryCode": "+1",
  "phone": "5556667777"
}'

{
  "user_id": "acf919e9-4661-444f-8496-afb07e731a6f",
  "firstName": "Jaime",
  "lastName": "Reyes",
  "email": "blue.beetle@reachtech.org",
  "dateOfBirth": "1992-01-01T00:00:00.000Z",
  "sex": "male",
  "phone": "5556667777",
  "countryCode": "+1",
  "isVerified": "NOTVERIFIED",
  "address1": "1 El Paso Street",
  "address2": null,
  "cityId": null,
  "stateId": null,
  "countryId": null,
  "postal": "79901",
  "metadata": null,
  "createdAt": "2025-11-27T10:22:57.894Z",
  "updatedAt": "2025-11-27T10:22:57.894Z"
}