Sign in

v1

latestOpenAPI 3.1.02026-07-241695611.0 MB
People

Create Person

Creates a new person record in the database.

post/people

Request body

first_namestring required

The first name of the person

last_namestring required

The last name of the person

middle_namestring nullable

The middle name of the person

phone_numberstring nullable

The phone number of the person. Area code is mandatory.

emailstring nullable

The email address of the person

date_of_birthstring date nullable

The date of birth of the person

gender'M' | 'F'
marital_status'married' | 'single' | 'divorced' | 'widowed' | 'separated' | 'domestic_partner' | 'civil_union' | 'other'
suffixstring nullable

The suffix of the person

titlestring nullable

The title of the person

Example request

{
  "first_name": "John",
  "last_name": "Doe",
  "middle_name": "Michael",
  "phone_number": "+14013059855",
  "email": "john.doe@example.com",
  "date_of_birth": "1990-01-15",
  "ssn": "123456789",
  "suffix": "Jr.",
  "title": "Mr."
}

Response

Person created successfully.

idstring uuid required

The unique identifier of the person

first_namestring required

The first name of the person

last_namestring required

The last name of the person

ssnstring required

The social security number of the person

middle_namestring nullable

The middle name of the person

suffixstring nullable

The suffix of the person

titlestring nullable

The title of the person

created_atstring date-time required

When the person record was created

updated_atstring date-time nullable

When the person record was last updated

Example response

{
  "id": "9789c913-f51d-4e20-a914-e64b80731df0",
  "first_name": "John",
  "last_name": "Doe",
  "ssn": "XXXXX1234",
  "middle_name": "Michael",
  "suffix": "Jr.",
  "title": "Mr.",
  "created_at": "2025-01-15T12:00:00Z",
  "updated_at": "2025-01-15T12:00:00Z"
}