Skip to main content
POST
Create a document type

Authorizations

Authorization
string
header
required

Basic authentication using an API key, e.g. {Authorization: Bearer aff_0bb4fbdf97b7e4111ff6c0015471094155f91}. You can find your API key within the Settings page of the Affinda web app. You can obtain an API key by signing up for a free trial.

Body

application/json
name
string
required

The name of the document type.

organization
string
required

The identifier of the organization this document type belongs to.

description
string | null

A description of the document type.

Response

Document type created successfully

identifier
string
required

Uniquely identify a document type.

Example:

"mEFayXdO"

name
string
required

The name of the document type.

organization
string
required

The identifier of the organization this document type belongs to.

description
string | null

A description of the document type.

ingest_email
string

The email address that can be used to email documents directly to this document type.