Skip to main content
POST
Create a person

Authorizations

Authorization
string
header
required

API key (nlmca_live_…) or OAuth access token

Query Parameters

force
boolean
default:false

Create even when a person with the same email or phone already exists (otherwise 409 duplicate_person with existing_id).

Body

application/json
first_name
string
required

First name.

Maximum string length: 100
last_name
string

Last name.

Maximum string length: 100
email
string

Email. Used to match an existing person and the CRM contact.

Maximum string length: 255
phone
string

Phone, any format. Used to match an existing person and the CRM contact.

Maximum string length: 50
address
string

Street address.

city
string
Maximum string length: 100
state
string

State, e.g. NY.

Maximum string length: 50
zip
string
Maximum string length: 20
dob
string

Date of birth YYYY-MM-DD. Returned only to admin / manager credentials.

Example:

"1980-05-17"

ssn
string
write-only

Social security number (123-45-6789 or 123456789). Write-only: encrypted at rest and never returned; reads expose ssn_masked (***-**-6789).

credit_score
string

Credit score or range as text, e.g. 680 or 650-700.

Maximum string length: 20
business_id
string

Associate the new person with this business (creates the link with role / ownership_percent).

role
enum<string>
default:owner

Role on the business when business_id is given.

Available options:
owner,
co-owner,
bookkeeper,
other
ownership_percent
number

Ownership percentage on the business when business_id is given.

Required range: 0 <= x <= 100

Response

Created

data
object
required
meta
object
required