Skip to main content
GET
/
v1
/
document-types
/
{code}
Get document type details
curl --request GET \
  --url http://localhost:8000/v1/document-types/{code} \
  --header 'Authorization: Bearer <token>'
{
  "code": "<string>",
  "name": "<string>",
  "category": "<string>",
  "schema_version": "<string>",
  "fields": [
    {
      "field_name": "<string>",
      "field_type": "<string>",
      "severity": "hard",
      "is_nullable": true,
      "description": "<string>",
      "pattern": "<string>",
      "hints": [
        "<string>"
      ]
    }
  ],
  "validations": [
    {
      "name": "<string>",
      "severity": "hard",
      "message": "<string>",
      "formula": "<string>",
      "tolerance": 123
    }
  ],
  "description": "<string>"
}

Authorizations

Authorization
string
header
required

API Key authentication. Format: dk_test_ or dk_live_

Path Parameters

code
string
required

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.

code
string
required

Unique document type code

name
string
required

Human-readable name

category
string
required

Document category

schema_version
string
required

Active schema version

fields
SchemaFieldResponse · object[]
required

List of field definitions

validations
SchemaValidationResponse · object[]
required

Cross-field validation rules

description
string | null

Brief description