Skip to main content
POST
/
business
/
add-business-owner
Add an owner to a business
curl --request POST \
  --url https://api.sdev.banking.ingopayments.tech/api/v4/business/add-business-owner \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "api_key": "YOUR_API_KEY",
  "user_id": "user-8f3a2b1c-0e44-4f2d-9a11-7b23cc90d1ef",
  "business_id": "buss-2ef94c60-5a11-4d72-a3c1-5be7fab0123e",
  "name": "Jane Doe",
  "email": "jane.doe@example.com",
  "address": "123 Example Street",
  "phone_number": "+15555551234"
}
'
{
  "status": "success",
  "message": "operation completed",
  "data": {
    "items": [
      {
        "id": "bown-...",
        "business_id": "buss-2ef94c60-5a11-4d72-a3c1-5be7fab0123e",
        "first_name": "<string>",
        "last_name": "<string>",
        "email": "jane.doe@example.com",
        "phone_number": "+12125551234",
        "date_of_birth": "1990-04-15",
        "ownership_percent": 25.5,
        "kyc_status": "verified"
      }
    ],
    "pagination": {
      "page": 1,
      "per_page": 25,
      "total": 100,
      "sort": "created_at:desc",
      "search": "jane"
    }
  }
}

Authorizations

​
api_key
string
header
required

Program API key identifying your integration. Pass as the api_key HTTP header (preferred) or as an api_key field in the JSON request body. Required on every request in addition to the HMAC Authorization header.

Body

application/json
​
user_id
string
required

Identifier of the target user. Required when the endpoint operates on a specific user.

Example:

"user-8f3a2b1c-0e44-4f2d-9a11-7b23cc90d1ef"

​
business_id
string
required

Identifier of the target business. Required when the endpoint operates on a specific business.

Example:

"buss-2ef94c60-5a11-4d72-a3c1-5be7fab0123e"

​
name
string
required

Display name.

​
email
string<email>
required

Email address.

Example:

"jane.doe@example.com"

​
address
string
required

Street address.

​
phone_number
string
required

Phone number in E.164 format.

Example:

"+12125551234"

​
api_key
string

Program API key. Accepted either in the api_key HTTP header or as this body field.

​
ssn
string

Social security number. Encrypted at rest.

​
selfie
string

URL or token of a selfie image used for identity verification.

​
role
string

Role of the owner within the business (for example director, officer).

​
ownership_percent
number

Ownership percentage held by this owner (0 to 100).

​
street
string

Street address.

​
state
string

ISO 3166-2 two-letter state/region code.

​
city
string

City.

​
zipcode
string

5-digit US ZIP code.

​
country
string

ISO 3166-1 alpha-2 country code.

​
date_of_birth
string<date>

Date of birth in YYYY-MM-DD format.

Example:

"1990-04-15"

Response

Success.

​
status
enum<string>
required
Available options:
success
​
message
string
required
Example:

"operation completed"

​
data
object

Endpoint-specific payload; shape varies per operation.