Skip to main content
GET
/
kyb
/
forms
/
{companyId}
/
beneficiaries
List beneficiaries
curl --request GET \
  --url https://ivs.idenfy.com/kyb/forms/{companyId}/beneficiaries/ \
  --header 'Authorization: Bearer <token>'
[
  {
    "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

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