PApayabli
Businesses

Link a person to a business

Changed on

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

post/v2/businesses/{businessReference}/people

Request

  • Base URL
    https://api-sandbox.payabli.com/api
  • URL
    https://api-sandbox.payabli.com/api/v2/businesses/{businessReference}/people
  • Auth
    HTTP bearer

Path parameters

businessReferencestring required

The business reference (businessUuid).

Request body

personReferencestring required

The reference of the person to link.

personType'Owner' | 'Director' | 'Contact' | 'Signer' | 'AuthorizedUser' | 'Employee'

The role a person plays on a business. Applies only when the person is linked to a business. Application validation holds every role except Employee to the owner requirements. Link anyone who doesn't own part of the business, such as a contact, as an Employee.

ownershipPercentagenumber double

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.

isPrimaryControllerboolean

Whether the person is the business's primary controller.

isSignerboolean

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.

titlestring

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.

primaryEmailstring

The relationship's primary email address.

secondaryEmailstring

The relationship's secondary email address.

primaryPhoneNumberstring

The relationship's primary phone number.

secondaryPhoneNumberstring

The relationship's secondary phone number.

Response

The person was linked to the business.

successboolean required

Whether the request succeeded.

messagestring nullable required

A human-readable result message.

traceIdstring nullable required

The trace identifier for the request, useful for support.

Changes