API Reference
  1. PCE Boarding APIs
  2. Business Owners

Add an owner

post
https://sandbox-api.prioritycommerce.com/v1/businesses//owners

Adds an owner to a business. Link a person who already exists by sending individualId, or create the person in the same request by sending individual.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

ID of the business, for example bus_3f8a2c71-9d4e-4b6a-8f15-6c2e9a7b4d10.

Body Params

The owner to add. Send either individualId for a person who already exists, or individual to create the person.

string

ID of a person who already exists, for example ind_2b7e4f13-6c9a-4d51-8a3e-9d0f2c6b8e74. Send this or individual, not both.

individual
object

The person. In requests, send this to create the person at the same time; send individualId instead to link a person who already exists. In responses, this is a reference (id and uri) unless full details are included.

string
length ≤ 255

Your own reference for this record, up to 255 characters. Use it to find the record later with the externalId filter.

number
required
0 to 100

Share of the business this person owns, from 0 to 100, with up to two decimal places. The total across all owners cannot exceed 100. For government, nonprofit and tax-exempt businesses, use 0.

boolean

Set to true for the one person who has significant control over the business, such as the CEO or managing member. Exactly one owner or signatory must be the control person, and that person must have an SSN or ITIN.

string
length ≤ 100

The person's job title or role in the business, up to 100 characters. Needed to activate card processing (payin.card).

date

Date the person took on this role, in YYYY-MM-DD format.

date | null

Date the person left this role, in YYYY-MM-DD format. Leave empty while the role is current.

string
enum
Defaults to individual

Type of owner. Only individual is supported.

Allowed:
Headers
string

Optional. A unique value, such as a UUID, that identifies this request. If you retry with the same key, the change is not applied twice.

Responses

Updated about 19 hours ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 19 hours ago

Did this page help you?
.readme-logo { display: none !important; }