Skip to main content
PATCH
/
kyb
/
forms
/
{companyId}
/
beneficiaries
/
{beneficiaryId}
/
documents
/
{id}
Partially update beneficiary document
curl --request PATCH \
  --url https://ivs.idenfy.com/kyb/forms/{companyId}/beneficiaries/{beneficiaryId}/documents/{id}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "filename": "<string>"
}
'
{
  "id": "<string>",
  "file": "<string>",
  "filename": "<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

​
beneficiaryId
string
required
​
companyId
string
required
​
id
string
required

A unique value identifying this KYB Document.

Body

application/json
​
type
enum<string>
Available options:
IDENTITY_DOCUMENT,
PROOF_OF_ADDRESS,
OTHER
​
filename
string | null
Maximum string length: 100

Response

200 - application/json
​
id
string
required
read-only
​
type
enum<string>
required
Available options:
IDENTITY_DOCUMENT,
PROOF_OF_ADDRESS,
OTHER
​
file
string<uri>
required
read-only

Base64 encoded document file. Can be: jpeg, jpg, png, gif, webp, heic, heif, pdf files.

​
filename
string | null
Maximum string length: 100