Skip to main content
PUT
/
kyb
/
forms
/
{companyId}
/
documents
/
{id}
/
Update document
curl --request PUT \
  --url https://ivs.idenfy.com/kyb/forms/{companyId}/documents/{id}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "filename": "<string>"
}
'
import requests

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

payload = { "filename": "<string>" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({filename: '<string>'})
};

fetch('https://ivs.idenfy.com/kyb/forms/{companyId}/documents/{id}/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
HttpResponse<String> response = Unirest.put("https://ivs.idenfy.com/kyb/forms/{companyId}/documents/{id}/")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"filename\": \"<string>\"\n}")
.asString();
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://ivs.idenfy.com/kyb/forms/{companyId}/documents/{id}/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'filename' => '<string>'
]),
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}/documents/{id}/")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"filename\": \"<string>\"\n}"

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


var options = new RestClientOptions("https://ivs.idenfy.com/kyb/forms/{companyId}/documents/{id}/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"filename\": \"<string>\"\n}", false);
var response = await client.PutAsync(request);

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

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

func main() {

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

payload := strings.NewReader("{\n \"filename\": \"<string>\"\n}")

req, _ := http.NewRequest("PUT", 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 \"filename\": \"<string>\"\n}")
val request = Request.Builder()
.url("https://ivs.idenfy.com/kyb/forms/{companyId}/documents/{id}/")
.put(body)
.addHeader("Authorization", "Bearer <token>")
.addHeader("Content-Type", "application/json")
.build()

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

let parameters = ["filename": "<string>"] as [String : Any?]

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

let url = URL(string: "https://ivs.idenfy.com/kyb/forms/{companyId}/documents/{id}/")!
var request = URLRequest(url: url)
request.httpMethod = "PUT"
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>",
  "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

companyId
string
required
id
string
required

A unique value identifying this KYB Document.

Body

application/json
type
enum<string>
required
Available options:
INCORPORATION_CERT,
DIRECTOR_CERT,
SHAREHOLDER_CERT,
UBO_CERT,
INCORPORATION_ARTICLES,
SHAREHOLDER_REGISTRY,
DIRECTORS_REGISTRY,
STATE_REGISTRY,
UBO_REGISTRY,
OWNERSHIP_STRUCTURE,
INCUMBENCY_CERT,
TRUST_AGREEMENT,
INFORMATION_STATEMENT,
GOOD_STANDING_CERT,
PROOF_OF_DOMAIN,
PROOF_OF_ADDRESS,
SOURCE_OF_FUNDS,
BANK_STATEMENT,
INVOICE,
ONLINE_PRESENCE,
DIRECTOR_ONLINE_PRESENCE,
SHAREHOLDER_ONLINE_PRESENCE,
WEBSITE_OVERVIEW,
E_SIGNATURE_CERT,
ANNUAL_REPORT,
NAME_CHANGE_PROOF,
TRADING_STATUS_PROOF,
ORG_CHART,
COMPANY_ADVERSE_MEDIA,
INDIVIDUAL_ADVERSE_MEDIA,
EMAIL_CHECK,
SOURCE_OF_WEALTH,
OTHER
filename
string | null
Maximum string length: 100

Response

200 - application/json
id
string
required
read-only
type
enum<string>
required
Available options:
INCORPORATION_CERT,
DIRECTOR_CERT,
SHAREHOLDER_CERT,
UBO_CERT,
INCORPORATION_ARTICLES,
SHAREHOLDER_REGISTRY,
DIRECTORS_REGISTRY,
STATE_REGISTRY,
UBO_REGISTRY,
OWNERSHIP_STRUCTURE,
INCUMBENCY_CERT,
TRUST_AGREEMENT,
INFORMATION_STATEMENT,
GOOD_STANDING_CERT,
PROOF_OF_DOMAIN,
PROOF_OF_ADDRESS,
SOURCE_OF_FUNDS,
BANK_STATEMENT,
INVOICE,
ONLINE_PRESENCE,
DIRECTOR_ONLINE_PRESENCE,
SHAREHOLDER_ONLINE_PRESENCE,
WEBSITE_OVERVIEW,
E_SIGNATURE_CERT,
ANNUAL_REPORT,
NAME_CHANGE_PROOF,
TRADING_STATUS_PROOF,
ORG_CHART,
COMPANY_ADVERSE_MEDIA,
INDIVIDUAL_ADVERSE_MEDIA,
EMAIL_CHECK,
SOURCE_OF_WEALTH,
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