DKBSignDocs

API reference

POSTRequires Bearer token

Create a typology

/api/edm/typologies

Submit /api/edm/typologies. Authenticated routes need Authorization: Bearer {token} from POST /api/v1/login.

Path parameters

This endpoint has no path parameters.

Query parameters

This endpoint has no query parameters.

Request body

FieldTypeDescription
name
Required
stringLabel.
e.g. "Contract"
code
Required
stringUnique code.
e.g. "CONTRAT"
description
stringDescription.
retention_years
integerRetention period.
e.g. 10
sealed
booleanSealed typology (vault).
e.g. false
metadata_fields
arrayCustom metadata keys.
color
stringUI color.
e.g. "#1877F2"

Responses

StatusMeaning
201Typology created
401Missing or invalid Bearer token.

Request

curl
curl -X POST 'https://api.dkbsigns.com/api/edm/typologies' \
  -H 'Authorization: Bearer $DKBSIGN_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"name":"Contract","code":"CONTRAT","retention_years":10,"sealed":false,"color":"#1877F2"}'

Response 201

json
{
  "id": "typ-1",
  "name": "Contract",
  "code": "CONTRAT"
}