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

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

Body

application/json
​
info
object
required
​
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
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
​
parent
string | null
Minimum string length: 1

Response

201 - application/json
​
id
string
required
read-only
​
info
object
required
​
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
​
parent
string | null