> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.withverifa.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.withverifa.com/_mcp/server.

# Update a document type

PATCH https://api.withverifa.com/api/v1/settings/document-types/{type_id}
Content-Type: application/json

Updates mutable fields on a custom document type.

**Required scope:** `settings:write` (or legacy `documents:write`).


Reference: https://docs.withverifa.com/api-reference/document-types/update-document-type

## Authentication

- `X-API-Key` header (required) — Organization API key. Keys are prefixed with `vk_live_` (production) or `vk_sandbox_` (sandbox).

## Request

### Path parameters

- `type_id` (string, required) — Document type ID.

### Headers

- `Verifa-Version` (date, optional) — API version date string (e.g. `2026-02-01`). If omitted, the version pinned to your API key is used.

### Body (application/json)

This endpoint expects an object.

- `label` (string, optional) — Human-readable display label.
- `description` (string, optional, nullable) — Description of this document type.
- `category` (string, optional) — Document category.
- `extraction_hints` (map from string to any, optional, nullable) — OCR and extraction configuration hints.
- `check_suite` (map from string to any, optional, nullable) — Verification check suite configuration.
- `is_active` (boolean, optional) — Whether this document type is active.

## Response

### 200

Document type updated.

- `id` (string, required) — Document type ID.
- `org_id` (string, required) — Organization ID.
- `slug` (string, required) — URL-safe identifier for this document type.
- `label` (string, required) — Human-readable display label.
- `category` (string, required) — Parent category for grouping in the dashboard. One of: `financial`, `corporate`, `identity`, `address`, `vehicle`, `government`, or `other`.
- `is_active` (boolean, required) — Whether this document type is active.
- `created_at` (datetime, required)
- `updated_at` (datetime, required)
- `description` (string, optional, nullable) — Free-text visual + content description of this document type. Used by Verifa's document classifier to recognize uploaded documents and pick this type when it matches. Be specific about logos, layouts, and prominent fields — clearer descriptions give better classification accuracy.
- `extraction_hints` (map from string to string, optional, nullable) — Map of `{field_name: hint}` describing the structured fields to extract from documents of this type. Each hint is a short free-text description of how to identify the field — including common synonyms, expected format, and any disambiguation tips ("Member ID, sometimes labeled 'Subscriber ID' or 'Policy #'"). When set, uploaded documents of this type are passed through Verifa's document extractor and the resulting fields appear on the document's `extracted_fields` response field. All extraction runs on Verifa's private infrastructure — document content is never sent to third-party services.
- `check_suite` (list of list of string, optional, nullable) — Optional override of the verification check suite for documents of this type. Each entry is a `[check_name, category, requirement]` tuple. When set, this overrides the org-level check_config and the hardcoded default suite for the matching classification.

## Errors

### 400 Bad Request Error

Invalid request parameters.

- `error` (string, required) — Short error code.
- `status_code` (integer, required) — HTTP status code.
- `detail` (string, optional) — Human-readable error description.

### 401 Unauthorized Error

Missing or invalid API key.

- `error` (string, required) — Short error code.
- `status_code` (integer, required) — HTTP status code.
- `detail` (string, optional) — Human-readable error description.

### 404 Not Found Error

Resource not found.

- `error` (string, required) — Short error code.
- `status_code` (integer, required) — HTTP status code.
- `detail` (string, optional) — Human-readable error description.

### 422 Unprocessable Entity Error

Request validation failed.

- `error` (string, required) — Short error code.
- `status_code` (integer, required) — HTTP status code.
- `detail` (string, optional) — Human-readable error description.

## Examples

**Request**

```json
{}
```

**Response**

```json
{
  "id": "string",
  "org_id": "string",
  "slug": "string",
  "label": "string",
  "category": "string",
  "is_active": true,
  "created_at": "2024-01-15T09:30:00Z",
  "updated_at": "2024-01-15T09:30:00Z",
  "description": "Auto insurance proof-of-coverage card showing policy number, VIN, named insured, and effective and expiration dates of coverage.",
  "extraction_hints": {
    "vin": "Vehicle Identification Number, 17 alphanumeric characters",
    "policy_number": "Insurance policy reference number",
    "issue_date": "Effective start date of the policy (YYYY-MM-DD)",
    "expiry_date": "End date of the policy coverage (YYYY-MM-DD)"
  },
  "check_suite": [
    [
      "string"
    ]
  ]
}
```

**SDK Code**

```python
import requests

url = "https://api.withverifa.com/api/v1/settings/document-types/type_id"

payload = {}
headers = {
    "X-API-Key": "<apiKey>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.withverifa.com/api/v1/settings/document-types/type_id';
const options = {
  method: 'PATCH',
  headers: {'X-API-Key': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.withverifa.com/api/v1/settings/document-types/type_id"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("X-API-Key", "<apiKey>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.withverifa.com/api/v1/settings/document-types/type_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.patch("https://api.withverifa.com/api/v1/settings/document-types/type_id")
  .header("X-API-Key", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://api.withverifa.com/api/v1/settings/document-types/type_id', [
  'body' => '{}',
  'headers' => [
    'Content-Type' => 'application/json',
    'X-API-Key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.withverifa.com/api/v1/settings/document-types/type_id");
var request = new RestRequest(Method.PATCH);
request.AddHeader("X-API-Key", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "X-API-Key": "<apiKey>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.withverifa.com/api/v1/settings/document-types/type_id")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```