---
title: "Get one document type capability record."
method: GET
path: "/v1/document-types/{code}"
tags: ["Document types"]
---

# Get one document type capability record.

`GET /v1/document-types/{code}`

## Request

- Base URL: `https://signaledi.com/api`
- URL: `https://signaledi.com/api/v1/document-types/{code}`
- Auth: none required

Public and unauthenticated; throttled at 300 requests per minute per client IP.

## Path parameters

- `code` string, required

## Query parameters

- `standard` 'x12' | 'edifact'

## Response `200`

Document type capability record.

- DocumentTypeResult
  - `ok` true, required
  - `documentType` DocumentTypeDefinition, required
    - `code` string, required
    - `standard` 'x12' | 'edifact', required
    - `name` string, required
    - `title` string, required
    - `category` string, required
    - `directions` string[], required
    - `schemaVersion` string, required
    - `phi` boolean, required
    - `acknowledgedBy` string[], required
    - `capabilities` DocumentTypeCapabilities, required
      - `recognize` boolean, required
      - `rawSend` boolean, required
      - `rawReceive` boolean, required
      - `typedSend` boolean, required
      - `typedReceive` boolean, required
      - `mappedReceive` boolean, required
      - `semanticValidation` 'supported' | 'unsupported', required
    - `schema` object
    - `example` object
    - `links` object, required
      - `self` string, required
      - `schema` string

## Other responses

- `400`: Request body failed validation (`code` e.g. VALIDATION_ERROR, NO_WORKSPACE, BATCH_TOO_LARGE).
- `404`: Unknown document type (`code` UNKNOWN_DOCUMENT_TYPE), or the /v1 platform is disabled (NOT_FOUND).
- `429`: Rate limit exceeded (`code` RATE_LIMITED).
- `500`: Unexpected server error (`code` e.g. PARSE_FAILED, VALIDATE_FAILED, OUTBOUND_FAILED, INBOUND_FAILED, BATCH_FAILED, TRANSACTIONS_FAILED, DOCUMENT_RECEIPT_FAILED, DOCUMENT_PAYLOAD_FAILED). Sanitized bodies carry an opaque `correlationId` to quote to support; internal error text is never echoed.

---

[API](https://skmtc.dev/signaledi/apis/signaledi-developer-api.md) · [All operations](https://skmtc.dev/signaledi/apis/signaledi-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/signaledi/apis/signaledi-developer-api/revisions/9bc596644a10?raw)