Skip to main content
PATCH
/
kyb
/
forms
/
{companyId}
/
beneficiaries
/
{id}
/
Partially update beneficiary
curl --request PATCH \
  --url https://ivs.idenfy.com/kyb/forms/{companyId}/beneficiaries/{id}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "beneficiaryTypes": [],
  "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": {}
  },
  "positions": [],
  "formFiller": true,
  "ownershipPercentage": 50
}
'
import requests

url = "https://ivs.idenfy.com/kyb/forms/{companyId}/beneficiaries/{id}/"

payload = {
    "beneficiaryTypes": [],
    "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": {}
    },
    "positions": [],
    "formFiller": True,
    "ownershipPercentage": 50
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    beneficiaryTypes: [],
    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: {}
    },
    positions: [],
    formFiller: true,
    ownershipPercentage: 50
  })
};

fetch('https://ivs.idenfy.com/kyb/forms/{companyId}/beneficiaries/{id}/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
HttpResponse<String> response = Unirest.patch("https://ivs.idenfy.com/kyb/forms/{companyId}/beneficiaries/{id}/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"beneficiaryTypes\": [],\n  \"info\": {\n    \"name\": \"<string>\",\n    \"surname\": \"<string>\",\n    \"email\": \"jsmith@example.com\",\n    \"phone\": \"<string>\",\n    \"dateOfBirth\": \"2023-12-25\",\n    \"documentNumber\": \"<string>\",\n    \"personalNumber\": \"<string>\",\n    \"residentialAddress\": \"<string>\",\n    \"postcode\": \"<string>\",\n    \"address\": \"<string>\",\n    \"street\": \"<string>\",\n    \"city\": \"<string>\",\n    \"tin\": \"<string>\",\n    \"selfDeclaredPep\": true,\n    \"additionalInfo\": {}\n  },\n  \"positions\": [],\n  \"formFiller\": true,\n  \"ownershipPercentage\": 50\n}")
  .asString();
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ivs.idenfy.com/kyb/forms/{companyId}/beneficiaries/{id}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'beneficiaryTypes' => [
        
    ],
    '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' => [
                
        ]
    ],
    'positions' => [
        
    ],
    'formFiller' => true,
    'ownershipPercentage' => 50
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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/{id}/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"beneficiaryTypes\": [],\n  \"info\": {\n    \"name\": \"<string>\",\n    \"surname\": \"<string>\",\n    \"email\": \"jsmith@example.com\",\n    \"phone\": \"<string>\",\n    \"dateOfBirth\": \"2023-12-25\",\n    \"documentNumber\": \"<string>\",\n    \"personalNumber\": \"<string>\",\n    \"residentialAddress\": \"<string>\",\n    \"postcode\": \"<string>\",\n    \"address\": \"<string>\",\n    \"street\": \"<string>\",\n    \"city\": \"<string>\",\n    \"tin\": \"<string>\",\n    \"selfDeclaredPep\": true,\n    \"additionalInfo\": {}\n  },\n  \"positions\": [],\n  \"formFiller\": true,\n  \"ownershipPercentage\": 50\n}"

response = http.request(request)
puts response.read_body
using RestSharp;


var options = new RestClientOptions("https://ivs.idenfy.com/kyb/forms/{companyId}/beneficiaries/{id}/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n  \"beneficiaryTypes\": [],\n  \"info\": {\n    \"name\": \"<string>\",\n    \"surname\": \"<string>\",\n    \"email\": \"jsmith@example.com\",\n    \"phone\": \"<string>\",\n    \"dateOfBirth\": \"2023-12-25\",\n    \"documentNumber\": \"<string>\",\n    \"personalNumber\": \"<string>\",\n    \"residentialAddress\": \"<string>\",\n    \"postcode\": \"<string>\",\n    \"address\": \"<string>\",\n    \"street\": \"<string>\",\n    \"city\": \"<string>\",\n    \"tin\": \"<string>\",\n    \"selfDeclaredPep\": true,\n    \"additionalInfo\": {}\n  },\n  \"positions\": [],\n  \"formFiller\": true,\n  \"ownershipPercentage\": 50\n}", false);
var response = await client.PatchAsync(request);

Console.WriteLine("{0}", response.Content);

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://ivs.idenfy.com/kyb/forms/{companyId}/beneficiaries/{id}/"

	payload := strings.NewReader("{\n  \"beneficiaryTypes\": [],\n  \"info\": {\n    \"name\": \"<string>\",\n    \"surname\": \"<string>\",\n    \"email\": \"jsmith@example.com\",\n    \"phone\": \"<string>\",\n    \"dateOfBirth\": \"2023-12-25\",\n    \"documentNumber\": \"<string>\",\n    \"personalNumber\": \"<string>\",\n    \"residentialAddress\": \"<string>\",\n    \"postcode\": \"<string>\",\n    \"address\": \"<string>\",\n    \"street\": \"<string>\",\n    \"city\": \"<string>\",\n    \"tin\": \"<string>\",\n    \"selfDeclaredPep\": true,\n    \"additionalInfo\": {}\n  },\n  \"positions\": [],\n  \"formFiller\": true,\n  \"ownershipPercentage\": 50\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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))

}
val client = OkHttpClient()

val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n  \"beneficiaryTypes\": [],\n  \"info\": {\n    \"name\": \"<string>\",\n    \"surname\": \"<string>\",\n    \"email\": \"jsmith@example.com\",\n    \"phone\": \"<string>\",\n    \"dateOfBirth\": \"2023-12-25\",\n    \"documentNumber\": \"<string>\",\n    \"personalNumber\": \"<string>\",\n    \"residentialAddress\": \"<string>\",\n    \"postcode\": \"<string>\",\n    \"address\": \"<string>\",\n    \"street\": \"<string>\",\n    \"city\": \"<string>\",\n    \"tin\": \"<string>\",\n    \"selfDeclaredPep\": true,\n    \"additionalInfo\": {}\n  },\n  \"positions\": [],\n  \"formFiller\": true,\n  \"ownershipPercentage\": 50\n}")
val request = Request.Builder()
  .url("https://ivs.idenfy.com/kyb/forms/{companyId}/beneficiaries/{id}/")
  .patch(body)
  .addHeader("Authorization", "Bearer <token>")
  .addHeader("Content-Type", "application/json")
  .build()

val response = client.newCall(request).execute()
import Foundation

let parameters = [
  "beneficiaryTypes": [],
  "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": []
  ],
  "positions": [],
  "formFiller": true,
  "ownershipPercentage": 50
] as [String : Any?]

let postData = try JSONSerialization.data(withJSONObject: parameters, options: [])

let url = URL(string: "https://ivs.idenfy.com/kyb/forms/{companyId}/beneficiaries/{id}/")!
var request = URLRequest(url: url)
request.httpMethod = "PATCH"
request.timeoutInterval = 10
request.allHTTPHeaderFields = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
request.httpBody = postData

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

​
Authorization
string
header
required

Authentication for actions with all operations associated with KYB form.
Token obtained from KYB form token generation endpoint as tokenString value.

Path Parameters

​
companyId
string
required
​
id
string
required

A unique value identifying this beneficiary.

Body

application/json
​
beneficiaryType
enum<string>
Available options:
CEO,
REPRESENTATIVE,
SHAREHOLDER,
UBO,
ABO
​
beneficiaryTypes
enum<string>[]
Minimum array length: 1
Available options:
CEO,
REPRESENTATIVE,
SHAREHOLDER,
UBO,
ABO
​
info
object
​
positions
string[]

Positions of the beneficiary. Can be shareholder, director, or any other position.

Maximum array length: 3
Required string length: 1 - 50
Pattern: ^[^,]+$
​
formFiller
boolean

Indicates whether this beneficiary is the filler of the KYB form.

​
ownershipPercentage
number<double> | null
Required range: 0 <= x <= 100

Response

200 - application/json
​
id
string
required
read-only
​
info
object
required
​
parent
string | null
required
read-only
​
beneficiaryType
enum<string>
Available options:
CEO,
REPRESENTATIVE,
SHAREHOLDER,
UBO,
ABO
​
beneficiaryTypes
enum<string>[]
Minimum array length: 1
Available options:
CEO,
REPRESENTATIVE,
SHAREHOLDER,
UBO,
ABO
​
positions
string[]

Positions of the beneficiary. Can be shareholder, director, or any other position.

Maximum array length: 3
Maximum string length: 50
Pattern: ^[^,]+$
​
formFiller
boolean

Indicates whether this beneficiary is the filler of the KYB form.

​
ownershipPercentage
number<double> | null
Required range: 0 <= x <= 100