List beneficiaries
curl --request GET \
--url https://ivs.idenfy.com/kyb/forms/{companyId}/beneficiaries/ \
--header 'Authorization: Bearer <token>'import requests
url = "https://ivs.idenfy.com/kyb/forms/{companyId}/beneficiaries/"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://ivs.idenfy.com/kyb/forms/{companyId}/beneficiaries/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.get("https://ivs.idenfy.com/kyb/forms/{companyId}/beneficiaries/")
.header("Authorization", "Bearer <token>")
.asString();<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://ivs.idenfy.com/kyb/forms/{companyId}/beneficiaries/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}require 'uri'
require 'net/http'
url = URI("https://ivs.idenfy.com/kyb/forms/{companyId}/beneficiaries/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_bodyusing RestSharp;
var options = new RestClientOptions("https://ivs.idenfy.com/kyb/forms/{companyId}/beneficiaries/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.GetAsync(request);
Console.WriteLine("{0}", response.Content);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://ivs.idenfy.com/kyb/forms/{companyId}/beneficiaries/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}val client = OkHttpClient()
val request = Request.Builder()
.url("https://ivs.idenfy.com/kyb/forms/{companyId}/beneficiaries/")
.get()
.addHeader("Authorization", "Bearer <token>")
.build()
val response = client.newCall(request).execute()import Foundation
let url = URL(string: "https://ivs.idenfy.com/kyb/forms/{companyId}/beneficiaries/")!
var request = URLRequest(url: url)
request.httpMethod = "GET"
request.timeoutInterval = 10
request.allHTTPHeaderFields = ["Authorization": "Bearer <token>"]
let (data, _) = try await URLSession.shared.data(for: request)
print(String(decoding: data, as: UTF8.self))[
{
"id": "<string>",
"info": {
"name": "<string>",
"surname": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"dateOfBirth": "2023-12-25",
"documentNumber": "<string>",
"personalNumber": "<string>",
"residentialAddress": "<string>",
"postcode": "<string>",
"address": "<string>",
"street": "<string>",
"city": "<string>",
"tin": "<string>",
"selfDeclaredPep": true,
"additionalInfo": {}
},
"parent": "<string>",
"beneficiaryTypes": [],
"positions": [],
"formFiller": true,
"ownershipPercentage": 50
}
]List beneficiaries
GET
/
kyb
/
forms
/
{companyId}
/
beneficiaries
/
List beneficiaries
curl --request GET \
--url https://ivs.idenfy.com/kyb/forms/{companyId}/beneficiaries/ \
--header 'Authorization: Bearer <token>'import requests
url = "https://ivs.idenfy.com/kyb/forms/{companyId}/beneficiaries/"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://ivs.idenfy.com/kyb/forms/{companyId}/beneficiaries/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.get("https://ivs.idenfy.com/kyb/forms/{companyId}/beneficiaries/")
.header("Authorization", "Bearer <token>")
.asString();<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://ivs.idenfy.com/kyb/forms/{companyId}/beneficiaries/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}require 'uri'
require 'net/http'
url = URI("https://ivs.idenfy.com/kyb/forms/{companyId}/beneficiaries/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_bodyusing RestSharp;
var options = new RestClientOptions("https://ivs.idenfy.com/kyb/forms/{companyId}/beneficiaries/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.GetAsync(request);
Console.WriteLine("{0}", response.Content);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://ivs.idenfy.com/kyb/forms/{companyId}/beneficiaries/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}val client = OkHttpClient()
val request = Request.Builder()
.url("https://ivs.idenfy.com/kyb/forms/{companyId}/beneficiaries/")
.get()
.addHeader("Authorization", "Bearer <token>")
.build()
val response = client.newCall(request).execute()import Foundation
let url = URL(string: "https://ivs.idenfy.com/kyb/forms/{companyId}/beneficiaries/")!
var request = URLRequest(url: url)
request.httpMethod = "GET"
request.timeoutInterval = 10
request.allHTTPHeaderFields = ["Authorization": "Bearer <token>"]
let (data, _) = try await URLSession.shared.data(for: request)
print(String(decoding: data, as: UTF8.self))[
{
"id": "<string>",
"info": {
"name": "<string>",
"surname": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"dateOfBirth": "2023-12-25",
"documentNumber": "<string>",
"personalNumber": "<string>",
"residentialAddress": "<string>",
"postcode": "<string>",
"address": "<string>",
"street": "<string>",
"city": "<string>",
"tin": "<string>",
"selfDeclaredPep": true,
"additionalInfo": {}
},
"parent": "<string>",
"beneficiaryTypes": [],
"positions": [],
"formFiller": true,
"ownershipPercentage": 50
}
]Authorizations
kybTokenAuthapiKeyPair
Authentication for actions with all operations associated with KYB form.
Token obtained from KYB form token generation endpoint as tokenString value.
Path Parameters
Response
200 - application/json
- Option 1
- Option 2
Show child attributes
Show child attributes
Available options:
CEO, REPRESENTATIVE, SHAREHOLDER, UBO, ABO Minimum array length:
1Available options:
CEO, REPRESENTATIVE, SHAREHOLDER, UBO, ABO Positions of the beneficiary. Can be shareholder, director, or any other position.
Maximum array length:
3Maximum string length:
50Pattern:
^[^,]+$Indicates whether this beneficiary is the filler of the KYB form.
Required range:
0 <= x <= 100Was this page helpful?
⌘I