Skip to navigation
APIPay Ops endpointsBusinesses

Link a person to a business

Beta
View as MarkdownOpen in Claude

Links an existing person to a business, setting the relationship’s role, ownership, primary-controller flag, contact fields, and addresses.

Authentication

AuthorizationBearer

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

Path parameters

businessReferencestringRequired

The business reference (businessUuid).

Request

This endpoint expects an object.
personReferencestringRequired
The reference of the person to link.
personTypeenumOptional
The person's role on the business.
ownershipPercentagedoubleOptional

The person’s ownership percentage (0 to 100). Required when personType is Owner, and must be omitted for every other role. If the combined ownership would exceed 100%, the link is rejected with a 400.

isPrimaryControllerbooleanOptional
Whether the person is the business's primary controller.
isSignerbooleanOptional

Whether the person signs the business’s boarding applications. Only an owner can be the signer. Setting isSigner to true on a person with another personType returns 400 with the message Only an owner can be the signer. A business has one signer. Setting isSigner to true on one person removes it from every other person linked to the business.

titlestringOptional<=100 characters

The person’s job title at this business, such as CEO or Managing Member, from 1 to 100 characters. A person linked to more than one business can have a different title at each one. A blank value is treated as not sent.

primaryEmailstringOptional
The relationship's primary email address.
secondaryEmailstringOptional
The relationship's secondary email address.
primaryPhoneNumberstringOptional
The relationship's primary phone number.
secondaryPhoneNumberstringOptional
The relationship's secondary phone number.
billingAddressobjectOptional
The billing address for the relationship.
mailingAddressobjectOptional
The mailing address for the relationship.

Response

The person was linked to the business.
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 business-person link.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
500
Internal Server Error