Skip to main content
POST
/
kyb
/
forms
/
Create new KYB form
curl --request POST \
  --url https://ivs.idenfy.com/kyb/forms/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "company": {
    "companyName": "<string>",
    "registrationNumber": "<string>",
    "region": "<string>",
    "type": "<string>",
    "phone": "<string>",
    "website": "<string>",
    "email": "jsmith@example.com",
    "brandNames": [],
    "activityCode": "<string>",
    "tin": "<string>",
    "operatingAddress": "<string>",
    "postalAddress": "<string>",
    "postcode": "<string>",
    "street": "<string>",
    "city": "<string>",
    "additionalInfo": {}
  },
  "documents": [
    {
      "file": "aSDinaTvuI8gbWludGxpZnk=",
      "filename": "<string>"
    }
  ],
  "beneficiaries": [
    {
      "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
    }
  ],
  "clientSystem": {
    "ipAddress": "<string>",
    "timeZone": "<string>"
  }
}
'
import requests

url = "https://ivs.idenfy.com/kyb/forms/"

payload = {
    "company": {
        "companyName": "<string>",
        "registrationNumber": "<string>",
        "region": "<string>",
        "type": "<string>",
        "phone": "<string>",
        "website": "<string>",
        "email": "jsmith@example.com",
        "brandNames": [],
        "activityCode": "<string>",
        "tin": "<string>",
        "operatingAddress": "<string>",
        "postalAddress": "<string>",
        "postcode": "<string>",
        "street": "<string>",
        "city": "<string>",
        "additionalInfo": {}
    },
    "documents": [
        {
            "file": "aSDinaTvuI8gbWludGxpZnk=",
            "filename": "<string>"
        }
    ],
    "beneficiaries": [
        {
            "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
        }
    ],
    "clientSystem": {
        "ipAddress": "<string>",
        "timeZone": "<string>"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    company: {
      companyName: '<string>',
      registrationNumber: '<string>',
      region: '<string>',
      type: '<string>',
      phone: '<string>',
      website: '<string>',
      email: 'jsmith@example.com',
      brandNames: [],
      activityCode: '<string>',
      tin: '<string>',
      operatingAddress: '<string>',
      postalAddress: '<string>',
      postcode: '<string>',
      street: '<string>',
      city: '<string>',
      additionalInfo: {}
    },
    documents: [{file: 'aSDinaTvuI8gbWludGxpZnk=', filename: '<string>'}],
    beneficiaries: [
      {
        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
      }
    ],
    clientSystem: {ipAddress: '<string>', timeZone: '<string>'}
  })
};

fetch('https://ivs.idenfy.com/kyb/forms/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
HttpResponse<String> response = Unirest.post("https://ivs.idenfy.com/kyb/forms/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"company\": {\n    \"companyName\": \"<string>\",\n    \"registrationNumber\": \"<string>\",\n    \"region\": \"<string>\",\n    \"type\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"website\": \"<string>\",\n    \"email\": \"jsmith@example.com\",\n    \"brandNames\": [],\n    \"activityCode\": \"<string>\",\n    \"tin\": \"<string>\",\n    \"operatingAddress\": \"<string>\",\n    \"postalAddress\": \"<string>\",\n    \"postcode\": \"<string>\",\n    \"street\": \"<string>\",\n    \"city\": \"<string>\",\n    \"additionalInfo\": {}\n  },\n  \"documents\": [\n    {\n      \"file\": \"aSDinaTvuI8gbWludGxpZnk=\",\n      \"filename\": \"<string>\"\n    }\n  ],\n  \"beneficiaries\": [\n    {\n      \"info\": {\n        \"name\": \"<string>\",\n        \"surname\": \"<string>\",\n        \"email\": \"jsmith@example.com\",\n        \"phone\": \"<string>\",\n        \"dateOfBirth\": \"2023-12-25\",\n        \"documentNumber\": \"<string>\",\n        \"personalNumber\": \"<string>\",\n        \"residentialAddress\": \"<string>\",\n        \"postcode\": \"<string>\",\n        \"address\": \"<string>\",\n        \"street\": \"<string>\",\n        \"city\": \"<string>\",\n        \"tin\": \"<string>\",\n        \"selfDeclaredPep\": true,\n        \"additionalInfo\": {}\n      },\n      \"beneficiaryTypes\": [],\n      \"positions\": [],\n      \"formFiller\": true,\n      \"ownershipPercentage\": 50\n    }\n  ],\n  \"clientSystem\": {\n    \"ipAddress\": \"<string>\",\n    \"timeZone\": \"<string>\"\n  }\n}")
  .asString();
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ivs.idenfy.com/kyb/forms/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'company' => [
        'companyName' => '<string>',
        'registrationNumber' => '<string>',
        'region' => '<string>',
        'type' => '<string>',
        'phone' => '<string>',
        'website' => '<string>',
        'email' => 'jsmith@example.com',
        'brandNames' => [
                
        ],
        'activityCode' => '<string>',
        'tin' => '<string>',
        'operatingAddress' => '<string>',
        'postalAddress' => '<string>',
        'postcode' => '<string>',
        'street' => '<string>',
        'city' => '<string>',
        'additionalInfo' => [
                
        ]
    ],
    'documents' => [
        [
                'file' => 'aSDinaTvuI8gbWludGxpZnk=',
                'filename' => '<string>'
        ]
    ],
    'beneficiaries' => [
        [
                '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
        ]
    ],
    'clientSystem' => [
        'ipAddress' => '<string>',
        'timeZone' => '<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/")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"company\": {\n    \"companyName\": \"<string>\",\n    \"registrationNumber\": \"<string>\",\n    \"region\": \"<string>\",\n    \"type\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"website\": \"<string>\",\n    \"email\": \"jsmith@example.com\",\n    \"brandNames\": [],\n    \"activityCode\": \"<string>\",\n    \"tin\": \"<string>\",\n    \"operatingAddress\": \"<string>\",\n    \"postalAddress\": \"<string>\",\n    \"postcode\": \"<string>\",\n    \"street\": \"<string>\",\n    \"city\": \"<string>\",\n    \"additionalInfo\": {}\n  },\n  \"documents\": [\n    {\n      \"file\": \"aSDinaTvuI8gbWludGxpZnk=\",\n      \"filename\": \"<string>\"\n    }\n  ],\n  \"beneficiaries\": [\n    {\n      \"info\": {\n        \"name\": \"<string>\",\n        \"surname\": \"<string>\",\n        \"email\": \"jsmith@example.com\",\n        \"phone\": \"<string>\",\n        \"dateOfBirth\": \"2023-12-25\",\n        \"documentNumber\": \"<string>\",\n        \"personalNumber\": \"<string>\",\n        \"residentialAddress\": \"<string>\",\n        \"postcode\": \"<string>\",\n        \"address\": \"<string>\",\n        \"street\": \"<string>\",\n        \"city\": \"<string>\",\n        \"tin\": \"<string>\",\n        \"selfDeclaredPep\": true,\n        \"additionalInfo\": {}\n      },\n      \"beneficiaryTypes\": [],\n      \"positions\": [],\n      \"formFiller\": true,\n      \"ownershipPercentage\": 50\n    }\n  ],\n  \"clientSystem\": {\n    \"ipAddress\": \"<string>\",\n    \"timeZone\": \"<string>\"\n  }\n}"

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


var options = new RestClientOptions("https://ivs.idenfy.com/kyb/forms/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n  \"company\": {\n    \"companyName\": \"<string>\",\n    \"registrationNumber\": \"<string>\",\n    \"region\": \"<string>\",\n    \"type\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"website\": \"<string>\",\n    \"email\": \"jsmith@example.com\",\n    \"brandNames\": [],\n    \"activityCode\": \"<string>\",\n    \"tin\": \"<string>\",\n    \"operatingAddress\": \"<string>\",\n    \"postalAddress\": \"<string>\",\n    \"postcode\": \"<string>\",\n    \"street\": \"<string>\",\n    \"city\": \"<string>\",\n    \"additionalInfo\": {}\n  },\n  \"documents\": [\n    {\n      \"file\": \"aSDinaTvuI8gbWludGxpZnk=\",\n      \"filename\": \"<string>\"\n    }\n  ],\n  \"beneficiaries\": [\n    {\n      \"info\": {\n        \"name\": \"<string>\",\n        \"surname\": \"<string>\",\n        \"email\": \"jsmith@example.com\",\n        \"phone\": \"<string>\",\n        \"dateOfBirth\": \"2023-12-25\",\n        \"documentNumber\": \"<string>\",\n        \"personalNumber\": \"<string>\",\n        \"residentialAddress\": \"<string>\",\n        \"postcode\": \"<string>\",\n        \"address\": \"<string>\",\n        \"street\": \"<string>\",\n        \"city\": \"<string>\",\n        \"tin\": \"<string>\",\n        \"selfDeclaredPep\": true,\n        \"additionalInfo\": {}\n      },\n      \"beneficiaryTypes\": [],\n      \"positions\": [],\n      \"formFiller\": true,\n      \"ownershipPercentage\": 50\n    }\n  ],\n  \"clientSystem\": {\n    \"ipAddress\": \"<string>\",\n    \"timeZone\": \"<string>\"\n  }\n}", false);
var response = await client.PostAsync(request);

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

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

func main() {

	url := "https://ivs.idenfy.com/kyb/forms/"

	payload := strings.NewReader("{\n  \"company\": {\n    \"companyName\": \"<string>\",\n    \"registrationNumber\": \"<string>\",\n    \"region\": \"<string>\",\n    \"type\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"website\": \"<string>\",\n    \"email\": \"jsmith@example.com\",\n    \"brandNames\": [],\n    \"activityCode\": \"<string>\",\n    \"tin\": \"<string>\",\n    \"operatingAddress\": \"<string>\",\n    \"postalAddress\": \"<string>\",\n    \"postcode\": \"<string>\",\n    \"street\": \"<string>\",\n    \"city\": \"<string>\",\n    \"additionalInfo\": {}\n  },\n  \"documents\": [\n    {\n      \"file\": \"aSDinaTvuI8gbWludGxpZnk=\",\n      \"filename\": \"<string>\"\n    }\n  ],\n  \"beneficiaries\": [\n    {\n      \"info\": {\n        \"name\": \"<string>\",\n        \"surname\": \"<string>\",\n        \"email\": \"jsmith@example.com\",\n        \"phone\": \"<string>\",\n        \"dateOfBirth\": \"2023-12-25\",\n        \"documentNumber\": \"<string>\",\n        \"personalNumber\": \"<string>\",\n        \"residentialAddress\": \"<string>\",\n        \"postcode\": \"<string>\",\n        \"address\": \"<string>\",\n        \"street\": \"<string>\",\n        \"city\": \"<string>\",\n        \"tin\": \"<string>\",\n        \"selfDeclaredPep\": true,\n        \"additionalInfo\": {}\n      },\n      \"beneficiaryTypes\": [],\n      \"positions\": [],\n      \"formFiller\": true,\n      \"ownershipPercentage\": 50\n    }\n  ],\n  \"clientSystem\": {\n    \"ipAddress\": \"<string>\",\n    \"timeZone\": \"<string>\"\n  }\n}")

	req, _ := http.NewRequest("POST", 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  \"company\": {\n    \"companyName\": \"<string>\",\n    \"registrationNumber\": \"<string>\",\n    \"region\": \"<string>\",\n    \"type\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"website\": \"<string>\",\n    \"email\": \"jsmith@example.com\",\n    \"brandNames\": [],\n    \"activityCode\": \"<string>\",\n    \"tin\": \"<string>\",\n    \"operatingAddress\": \"<string>\",\n    \"postalAddress\": \"<string>\",\n    \"postcode\": \"<string>\",\n    \"street\": \"<string>\",\n    \"city\": \"<string>\",\n    \"additionalInfo\": {}\n  },\n  \"documents\": [\n    {\n      \"file\": \"aSDinaTvuI8gbWludGxpZnk=\",\n      \"filename\": \"<string>\"\n    }\n  ],\n  \"beneficiaries\": [\n    {\n      \"info\": {\n        \"name\": \"<string>\",\n        \"surname\": \"<string>\",\n        \"email\": \"jsmith@example.com\",\n        \"phone\": \"<string>\",\n        \"dateOfBirth\": \"2023-12-25\",\n        \"documentNumber\": \"<string>\",\n        \"personalNumber\": \"<string>\",\n        \"residentialAddress\": \"<string>\",\n        \"postcode\": \"<string>\",\n        \"address\": \"<string>\",\n        \"street\": \"<string>\",\n        \"city\": \"<string>\",\n        \"tin\": \"<string>\",\n        \"selfDeclaredPep\": true,\n        \"additionalInfo\": {}\n      },\n      \"beneficiaryTypes\": [],\n      \"positions\": [],\n      \"formFiller\": true,\n      \"ownershipPercentage\": 50\n    }\n  ],\n  \"clientSystem\": {\n    \"ipAddress\": \"<string>\",\n    \"timeZone\": \"<string>\"\n  }\n}")
val request = Request.Builder()
  .url("https://ivs.idenfy.com/kyb/forms/")
  .post(body)
  .addHeader("Authorization", "Bearer <token>")
  .addHeader("Content-Type", "application/json")
  .build()

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

let parameters = [
  "company": [
    "companyName": "<string>",
    "registrationNumber": "<string>",
    "region": "<string>",
    "type": "<string>",
    "phone": "<string>",
    "website": "<string>",
    "email": "jsmith@example.com",
    "brandNames": [],
    "activityCode": "<string>",
    "tin": "<string>",
    "operatingAddress": "<string>",
    "postalAddress": "<string>",
    "postcode": "<string>",
    "street": "<string>",
    "city": "<string>",
    "additionalInfo": []
  ],
  "documents": [
    [
      "file": "aSDinaTvuI8gbWludGxpZnk=",
      "filename": "<string>"
    ]
  ],
  "beneficiaries": [
    [
      "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
    ]
  ],
  "clientSystem": [
    "ipAddress": "<string>",
    "timeZone": "<string>"
  ]
] as [String : Any?]

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

let url = URL(string: "https://ivs.idenfy.com/kyb/forms/")!
var request = URLRequest(url: url)
request.httpMethod = "POST"
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>",
  "company": {
    "companyName": "<string>",
    "registrationNumber": "<string>",
    "region": "<string>",
    "type": "<string>",
    "phone": "<string>",
    "website": "<string>",
    "email": "jsmith@example.com",
    "brandNames": [],
    "activityCode": "<string>",
    "tin": "<string>",
    "operatingAddress": "<string>",
    "postalAddress": "<string>",
    "postcode": "<string>",
    "street": "<string>",
    "city": "<string>",
    "additionalInfo": {}
  },
  "meta": {
    "submissionTime": "2023-11-07T05:31:56Z",
    "soleProprietor": true
  },
  "documents": [
    {
      "id": "<string>",
      "file": "<string>",
      "filename": "<string>"
    }
  ],
  "beneficiaries": [
    {
      "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
    }
  ],
  "clientSystem": {
    "ipAddress": "<string>",
    "timeZone": "<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.

Body

application/json
​
company
object
required
​
documents
object[]
​
beneficiaries
object[]
​
clientSystem
object

Response

201 - application/json
​
id
string
required
read-only
​
company
object
required
​
meta
object
required
​
documents
object[]
​
beneficiaries
object[]
​
clientSystem
object