Add Merchant Owner

The Add Owners endpoint allows you to add owner details to a merchant record.

You may add multiple owners to a merchant record, however the API accepts only 1 owner at a time. Use the owner ID in the response to subsequently Add Owner Attachments or Update the Owner in the future.

Use the Add Owner Attachmentendpoint to add owner attachments such as drivers license to the owner record.

📘

Important Notes:

  1. There can be only one primaryRepresentative owners per merchant record.
  2. There may be many significantResponsibility owners per merchant record.
  3. Total ownershipPercentage cannot exceed 100 across all owners.
Path Params
string
required
Body Params
string

First name.

string

Middle name.

string

Last name.

string

Email address.

string

Phone number.

address
object

Address of the contact

string

Business Title.

string
enum

ISO 3166-1 alpha-3 Country Code.

string

Date when an owner became an owner.

string

Date of birth in YYYY-MM-DD format.

string
length between 9 and 9

Social security number.

string
length between 4 and 4

Last 4 digits of social security number.

number

Percentage of ownership as a whole integer.

string
enum

Owner type

Allowed:
boolean
Defaults to false

Publically exposed owner flag.

boolean
Defaults to false

Sponsoring stakeholder from the merchant.

string

Driver License Number

string

Region or State.

string

Drivers License Expiration

boolean
Defaults to true

Significant Responsibility.

Headers
string

Unique key to ensure idempotency of requests. If provided, the server will return the same response for subsequent requests with the same key.

Responses

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