Skip to main content
POST
Create Person

Authorizations

X-API-Key
string
header
required

Body

application/json
first_name
string
required

The first name of the person

Required string length: 2 - 255
Examples:

"John"

"Jane"

last_name
string
required

The last name of the person

Required string length: 2 - 255
Examples:

"Doe"

"Smith"

ssn
required

The full social security number of the person

Required string length: 9
Example:

"123456789"

middle_name
string | null

The middle name of the person

Required string length: 1 - 255
Example:

"Michael"

phone_number
string | null

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

Required string length: 12 - 30
Pattern: ^\+(?:[1-9]\d{0,2})(?:[ -]?\d{1,4}){1,4}(?:\s?(?:x|ext\.?)\s?\d{1,10})?$
Example:

"+14013059855"

email
string | null

The email address of the person

Required string length: 5 - 255
Pattern: ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$
Example:

"john.doe@example.com"

date_of_birth
string<date> | null

The date of birth of the person

Example:

"1990-01-15"

gender
enum<string> | null

The gender of the person

Available options:
M,
F
Example:

"M"

marital_status
enum<string> | null

The marital status of the person

Available options:
married,
single,
divorced,
widowed,
separated,
domestic_partner,
civil_union,
other
Example:

"married"

suffix
string | null

The suffix of the person

Example:

"Jr."

title
string | null

The title of the person

Example:

"Mr."

Response

Person created successfully.

id
string<uuid>
required

The unique identifier of the person

Example:

"c2fe09a9-2e5c-4254-9b54-2ea3b376a4f7"

first_name
string
required

The first name of the person

Examples:

"John"

"Jane"

last_name
string
required

The last name of the person

Examples:

"Doe"

"Smith"

ssn
string
required

The social security number of the person

Example:

"XXXXX1234"

created_at
string<date-time>
required

When the person record was created

Example:

"2025-01-15T12:00:00Z"

middle_name
string | null

The middle name of the person

Example:

"Michael"

suffix
string | null

The suffix of the person

Example:

"Jr."

title
string | null

The title of the person

Example:

"Mr."

updated_at
string<date-time> | null

When the person record was last updated

Example:

"2025-01-15T12:00:00Z"