Set document category
curl --request PATCH \
--url https://api.korint.io/documents/{documentId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'tenant: <tenant>' \
--data '
{
"category": "kbis"
}
'import requests
url = "https://api.korint.io/documents/{documentId}"
payload = { "category": "kbis" }
headers = {
"tenant": "<tenant>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
tenant: '<tenant>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({category: 'kbis'})
};
fetch('https://api.korint.io/documents/{documentId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.korint.io/documents/{documentId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'category' => 'kbis'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"tenant: <tenant>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.korint.io/documents/{documentId}"
payload := strings.NewReader("{\n \"category\": \"kbis\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("tenant", "<tenant>")
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))
}HttpResponse<String> response = Unirest.patch("https://api.korint.io/documents/{documentId}")
.header("tenant", "<tenant>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"category\": \"kbis\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.korint.io/documents/{documentId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["tenant"] = '<tenant>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"category\": \"kbis\"\n}"
response = http.request(request)
puts response.read_body{}{
"code": "DUPLICATE_NON_DELEGATED_DOCUMENT_TYPE",
"message": "Duplicate non delegated document type: {documentType}",
"details": {}
}{
"code": "FORBIDDEN",
"message": "Forbidden",
"details": {}
}{
"code": "DOCUMENT_NOT_FOUND",
"message": "Document {id} not found ({policyId})",
"details": {}
}documents
Set document category
Updates the category metadata of a document. Requires SET_DOCUMENT_CATEGORY permission.
PATCH
/
documents
/
{documentId}
Set document category
curl --request PATCH \
--url https://api.korint.io/documents/{documentId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'tenant: <tenant>' \
--data '
{
"category": "kbis"
}
'import requests
url = "https://api.korint.io/documents/{documentId}"
payload = { "category": "kbis" }
headers = {
"tenant": "<tenant>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
tenant: '<tenant>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({category: 'kbis'})
};
fetch('https://api.korint.io/documents/{documentId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.korint.io/documents/{documentId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'category' => 'kbis'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"tenant: <tenant>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.korint.io/documents/{documentId}"
payload := strings.NewReader("{\n \"category\": \"kbis\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("tenant", "<tenant>")
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))
}HttpResponse<String> response = Unirest.patch("https://api.korint.io/documents/{documentId}")
.header("tenant", "<tenant>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"category\": \"kbis\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.korint.io/documents/{documentId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["tenant"] = '<tenant>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"category\": \"kbis\"\n}"
response = http.request(request)
puts response.read_body{}{
"code": "DUPLICATE_NON_DELEGATED_DOCUMENT_TYPE",
"message": "Duplicate non delegated document type: {documentType}",
"details": {}
}{
"code": "FORBIDDEN",
"message": "Forbidden",
"details": {}
}{
"code": "DOCUMENT_NOT_FOUND",
"message": "Document {id} not found ({policyId})",
"details": {}
}Authorizations
oauth2bearerAuth
Machine-to-machine clients use the OAuth 2.0 client credentials grant. Each tenant has its own authorization server: in the token URL below, replace tenant with your tenant identifier.
Headers
Your tenant identifier. Requests without it are rejected.
Path Parameters
the document id to patch metadata
Pattern:
^document(_test)?_[346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz]{21}$Body
application/json
Response
The response is of type object.
Was this page helpful?
⌘I

