Add Business Owner
Add a beneficial owner to an existing business. Required for KYB verification of businesses that have owners above the disclosure threshold.
Authentication: send the program API key either in the api_key HTTP header or as an api_key JSON body field.
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"
}
'import requests
url = "https://api.sdev.banking.ingopayments.tech/api/v4/business/add-business-owner"
payload = {
"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"
}
headers = {
"Authorization": "Bearer <token>",
"api_key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
api_key: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
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'
})
};
fetch('https://api.sdev.banking.ingopayments.tech/api/v4/business/add-business-owner', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sdev.banking.ingopayments.tech/api/v4/business/add-business-owner",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"api_key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.sdev.banking.ingopayments.tech/api/v4/business/add-business-owner"
payload := strings.NewReader("{\n \"api_key\": \"YOUR_API_KEY\",\n \"user_id\": \"user-8f3a2b1c-0e44-4f2d-9a11-7b23cc90d1ef\",\n \"business_id\": \"buss-2ef94c60-5a11-4d72-a3c1-5be7fab0123e\",\n \"name\": \"Jane Doe\",\n \"email\": \"jane.doe@example.com\",\n \"address\": \"123 Example Street\",\n \"phone_number\": \"+15555551234\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("api_key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.sdev.banking.ingopayments.tech/api/v4/business/add-business-owner")
.header("Authorization", "Bearer <token>")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"api_key\": \"YOUR_API_KEY\",\n \"user_id\": \"user-8f3a2b1c-0e44-4f2d-9a11-7b23cc90d1ef\",\n \"business_id\": \"buss-2ef94c60-5a11-4d72-a3c1-5be7fab0123e\",\n \"name\": \"Jane Doe\",\n \"email\": \"jane.doe@example.com\",\n \"address\": \"123 Example Street\",\n \"phone_number\": \"+15555551234\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sdev.banking.ingopayments.tech/api/v4/business/add-business-owner")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["api_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"api_key\": \"YOUR_API_KEY\",\n \"user_id\": \"user-8f3a2b1c-0e44-4f2d-9a11-7b23cc90d1ef\",\n \"business_id\": \"buss-2ef94c60-5a11-4d72-a3c1-5be7fab0123e\",\n \"name\": \"Jane Doe\",\n \"email\": \"jane.doe@example.com\",\n \"address\": \"123 Example Street\",\n \"phone_number\": \"+15555551234\"\n}"
response = http.request(request)
puts response.read_body{
"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"
}
}
}{
"status": "error",
"message": "Something went wrong",
"data": "<unknown>",
"status_code": {
"status_code": 1000,
"message": "Resource not found",
"description": "The requested resource does not exist"
}
}{
"status": "error",
"message": "Something went wrong",
"data": "<unknown>",
"status_code": {
"status_code": 1000,
"message": "Resource not found",
"description": "The requested resource does not exist"
}
}{
"status": "error",
"message": "Something went wrong",
"data": "<unknown>",
"status_code": {
"status_code": 1000,
"message": "Resource not found",
"description": "The requested resource does not exist"
}
}Authorizations
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
Identifier of the target user. Required when the endpoint operates on a specific user.
"user-8f3a2b1c-0e44-4f2d-9a11-7b23cc90d1ef"
Identifier of the target business. Required when the endpoint operates on a specific business.
"buss-2ef94c60-5a11-4d72-a3c1-5be7fab0123e"
Display name.
Email address.
"jane.doe@example.com"
Street address.
Phone number in E.164 format.
"+12125551234"
Program API key. Accepted either in the api_key HTTP header or as this body field.
Social security number. Encrypted at rest.
URL or token of a selfie image used for identity verification.
Role of the owner within the business (for example director, officer).
Ownership percentage held by this owner (0 to 100).
Street address.
ISO 3166-2 two-letter state/region code.
City.
5-digit US ZIP code.
ISO 3166-1 alpha-2 country code.
Date of birth in YYYY-MM-DD format.
"1990-04-15"
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"
}
'import requests
url = "https://api.sdev.banking.ingopayments.tech/api/v4/business/add-business-owner"
payload = {
"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"
}
headers = {
"Authorization": "Bearer <token>",
"api_key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
api_key: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
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'
})
};
fetch('https://api.sdev.banking.ingopayments.tech/api/v4/business/add-business-owner', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sdev.banking.ingopayments.tech/api/v4/business/add-business-owner",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"api_key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.sdev.banking.ingopayments.tech/api/v4/business/add-business-owner"
payload := strings.NewReader("{\n \"api_key\": \"YOUR_API_KEY\",\n \"user_id\": \"user-8f3a2b1c-0e44-4f2d-9a11-7b23cc90d1ef\",\n \"business_id\": \"buss-2ef94c60-5a11-4d72-a3c1-5be7fab0123e\",\n \"name\": \"Jane Doe\",\n \"email\": \"jane.doe@example.com\",\n \"address\": \"123 Example Street\",\n \"phone_number\": \"+15555551234\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("api_key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.sdev.banking.ingopayments.tech/api/v4/business/add-business-owner")
.header("Authorization", "Bearer <token>")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"api_key\": \"YOUR_API_KEY\",\n \"user_id\": \"user-8f3a2b1c-0e44-4f2d-9a11-7b23cc90d1ef\",\n \"business_id\": \"buss-2ef94c60-5a11-4d72-a3c1-5be7fab0123e\",\n \"name\": \"Jane Doe\",\n \"email\": \"jane.doe@example.com\",\n \"address\": \"123 Example Street\",\n \"phone_number\": \"+15555551234\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sdev.banking.ingopayments.tech/api/v4/business/add-business-owner")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["api_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"api_key\": \"YOUR_API_KEY\",\n \"user_id\": \"user-8f3a2b1c-0e44-4f2d-9a11-7b23cc90d1ef\",\n \"business_id\": \"buss-2ef94c60-5a11-4d72-a3c1-5be7fab0123e\",\n \"name\": \"Jane Doe\",\n \"email\": \"jane.doe@example.com\",\n \"address\": \"123 Example Street\",\n \"phone_number\": \"+15555551234\"\n}"
response = http.request(request)
puts response.read_body{
"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"
}
}
}{
"status": "error",
"message": "Something went wrong",
"data": "<unknown>",
"status_code": {
"status_code": 1000,
"message": "Resource not found",
"description": "The requested resource does not exist"
}
}{
"status": "error",
"message": "Something went wrong",
"data": "<unknown>",
"status_code": {
"status_code": 1000,
"message": "Resource not found",
"description": "The requested resource does not exist"
}
}{
"status": "error",
"message": "Something went wrong",
"data": "<unknown>",
"status_code": {
"status_code": 1000,
"message": "Resource not found",
"description": "The requested resource does not exist"
}
}