Link a document to a KYB record

POST /kyb/{kybId}/documents

Parameters

kybId string Required path

The unique ID of the current KYB record for an entity. Same as currentKybId on the entity object.

documentId string Required

The unique ID of a document. Returned by POST /user-documents / POST /tenant-documents / POST /files. Listed by the corresponding GET endpoints.

documentType enum Required

No description.

Possible values: commercial_licensecertificate_of_incorporationincumbency_or_share_registermoa_aoatrust_deedfoundation_charterpassports_of_ubosproof_of_addressvat_certificatestructure_chartpoa_if_applicableadditional_document

x-tenant-id string Required header

Tenant identifier. Required on all tenant-scoped routes.

More parameters Expand all

notes string

No description.

curl -X POST "https://heimdall.qa.zoniqx.com/kyb/<kybId>/documents" \ -H "Authorization: Bearer <accessToken>" \ -H "x-tenant-id: <your-tenant-id>" \ -H "Content-Type: application/json" \ -d '{ "documentId": "string", "documentType": "commercial_license", "notes": "string" }'

const response = await fetch("https://heimdall.qa.zoniqx.com/kyb/<kybId>/documents", { method: "POST", headers: { "Authorization": "Bearer <accessToken>", "x-tenant-id": "<your-tenant-id>", "Content-Type": "application/json", }, body: JSON.stringify({ "documentId": "string", "documentType": "commercial_license", "notes": "string" }), }); const data = await response.json();

type KybController_linkDocumentToKybResponse = Record<string, unknown>; const response = await fetch("https://heimdall.qa.zoniqx.com/kyb/<kybId>/documents", { method: "POST", headers: { Authorization: "Bearer <accessToken>", "x-tenant-id": "<your-tenant-id>", "Content-Type": "application/json", }, body: JSON.stringify({ "documentId": "string", "documentType": "commercial_license", "notes": "string" }), }); const data: KybController_linkDocumentToKybResponse = await response.json();

import requests url = "https://heimdall.qa.zoniqx.com/kyb/<kybId>/documents" headers = { "Authorization": "Bearer <accessToken>", "x-tenant-id": "<your-tenant-id>", } payload = { "documentId": "string", "documentType": "commercial_license", "notes": "string" } response = requests.post(url, headers=headers, json=payload) data = response.json()