curl --request GET \
--url http://localhost:8000/v1/document-types/{code} \
--header 'Authorization: Bearer <token>'import requests
url = "http://localhost:8000/v1/document-types/{code}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('http://localhost:8000/v1/document-types/{code}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8000",
CURLOPT_URL => "http://localhost:8000/v1/document-types/{code}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "http://localhost:8000/v1/document-types/{code}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:8000/v1/document-types/{code}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8000/v1/document-types/{code}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"category": "fund_operations",
"code": "capital_call",
"description": "Capital call notices from fund managers",
"fields": [
{
"description": "Name of the fund",
"field_name": "fund_name",
"field_type": "string",
"hints": [
"Fund Name",
"Partnership Name"
],
"is_nullable": false,
"severity": "hard"
}
],
"name": "Capital Call Notice",
"schema_version": "1.0.0",
"validations": [
{
"formula": "call_amount_lp ≈ call_amount_fund × ownership %",
"message": "LP call amount should match calculation",
"name": "lp_amount_calculation",
"severity": "soft",
"tolerance": 0.01
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Get document type details
Get the full schema definition for a document type.
Returns the active schema version with all field definitions, validation rules, and extraction hints. Use this to understand what fields will be extracted from a document of this type.
Field severities:
- hard: Extraction fails if field is missing or invalid
- soft: Warning only, extraction continues
Validation rules define cross-field constraints (e.g., amounts should sum).
curl --request GET \
--url http://localhost:8000/v1/document-types/{code} \
--header 'Authorization: Bearer <token>'import requests
url = "http://localhost:8000/v1/document-types/{code}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('http://localhost:8000/v1/document-types/{code}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8000",
CURLOPT_URL => "http://localhost:8000/v1/document-types/{code}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "http://localhost:8000/v1/document-types/{code}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:8000/v1/document-types/{code}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8000/v1/document-types/{code}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"category": "fund_operations",
"code": "capital_call",
"description": "Capital call notices from fund managers",
"fields": [
{
"description": "Name of the fund",
"field_name": "fund_name",
"field_type": "string",
"hints": [
"Fund Name",
"Partnership Name"
],
"is_nullable": false,
"severity": "hard"
}
],
"name": "Capital Call Notice",
"schema_version": "1.0.0",
"validations": [
{
"formula": "call_amount_lp ≈ call_amount_fund × ownership %",
"message": "LP call amount should match calculation",
"name": "lp_amount_calculation",
"severity": "soft",
"tolerance": 0.01
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
API Key authentication. Format: dk_test_ or dk_live_
Path Parameters
Document type code (e.g., 'capital_call', 'k1')
Response
Full schema definition with fields and validations
Response for document type detail (GET /v1/document-types/{code}).
Includes the full schema with all fields and validations.
Unique document type code
Human-readable name
Document category
Active schema version
List of field definitions
Show child attributes
Show child attributes
Cross-field validation rules
Show child attributes
Show child attributes
Brief description