Retrieve beneficiary

get/kyb/forms/{companyId}/beneficiaries/{id}/

Request

Base URL
https://ivs.idenfy.com
Auth
- HTTP bearer
- or HTTP basic
TypeScript
https://skmtc.dev/idenfy/apis/idenfy-ivs-core-api/docs/kyb/forms/:companyId/beneficiaries/:id/get.ts
A function with typed inputs. Its response is checked against the schema.

companyIdstring required

idstring required

A unique value identifying this beneficiary.

idstring required

beneficiaryType'CEO' | 'REPRESENTATIVE' | 'SHAREHOLDER' | 'UBO' | 'ABO'

beneficiaryTypesBeneficiaryTypeEnum[]

positionsstring[]

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

formFillerboolean

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

ownershipPercentagenumber double nullable

parentstring nullable required

No recorded changes to this operation across all 1 revision of this API.