Skip to navigation
APIPay Ops endpointsPeople

Create a person

Beta
View as MarkdownOpen in Claude

Creates a person, an individual associated with a business such as an owner, director, or signer. Include a businessRelationship object to link the person to a business on create; the business reference, role (personType), and ownershipPercentage go inside that object.

A person’s job title and whether they’re the signer (isSigner) also belong to the business link, so send them inside businessRelationship. A top-level title returns a 400 with the message title moved into the businessRelationship object; send them there instead of at the top level.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
firstNamestringRequired1-100 characters
The person's first name.
lastNamestringRequired1-100 characters
The person's last name.
middleNamestringOptional1-100 characters
The person's middle name.
primaryEmailstringOptional
The person's primary email address.
secondaryEmailstringOptional
The person's secondary email address.
primaryPhoneNumberstringOptional7-20 characters
The person's primary phone number.
secondaryPhoneNumberstringOptional7-20 characters
The person's secondary phone number.
dateOfBirthstringOptional

The person’s date of birth (YYYY-MM-DD).

ssnstringOptional

The person’s US Social Security Number, in XXX-XX-XXXX or XXXXXXXXX format. Applies when nationality is US, and needed to validate a US owner. Create doesn’t enforce it. For any other nationality, send nationalIdNumber and nationalIdIssuer instead.

nationalitystringOptional=2 characters

The person’s nationality, as a two-letter ISO 3166-1 alpha-2 country code. Needed to validate an owner, but create doesn’t enforce it. Nationality selects which identity number applies. US uses ssn, and any other value uses nationalIdNumber and nationalIdIssuer.

nationalIdNumberstringOptional1-100 characters

The person’s national identification number, for an individual whose nationality is not US. Send it with nationalIdIssuer when nationality is non-US. Create doesn’t enforce it.

nationalIdIssuerstringOptional1-100 characters

The authority that issued the national ID, for example the two-letter country code. Send it with nationalIdNumber when nationality is non-US. Create doesn’t enforce it.

driversLicenseNumberstringOptional1-50 characters
The person's driver's license number.
driversLicenseStatestringOptional

The two-letter state code for the driver’s license.

externalIdstringOptional1-255 characters
Your own identifier for the person.
customDatamap from strings to anyOptional

Arbitrary key-value data you attach to the person. Payabli stores an owner’s answers to a boarding template’s custom questions under the templateAnswers key.

addresseslist of objectsOptional
Postal addresses associated with the person.
identificationDocumentslist of objectsOptional

Government-issued identification documents for the person.

businessRelationshipobjectOptional

Links the person to a business as you create them. The link’s role, ownership, primary-controller flag, contact fields, and addresses go here. These relationship contact fields are separate from the person’s own top-level contact fields above.

Response

Person created.
successboolean
Whether the request succeeded.
messagestring or null

A human-readable result message.

traceIdstring or null
The trace identifier for the request, useful for support.
dataobject or null
The person detail.
warningslist of objects or null

Non-blocking warnings, such as a business link that didn’t complete.

Errors

400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error