Update document type

Update an existing document type with new information. For example, use this endpoint to add validations:

curl --location --request PUT 'https://api.sensible.so/v0/document_types/<TYPE_ID>' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{"schema":{"validations":[{"description":"example validation to test broker email format","condition":{"match":[{"var":"broker\\.email.value"},"^\\S+\\@\\S+$"]},"severity":"warning","fields":["test"]}]}} '

curl --location --request PUT 'https://api.sensible.so/v0/document_types/<TYPE_ID>' \
--header 'Authorization: Bearer <YOUR_API_TOKEN>' \
--header 'Content-Type: application/json' \
--data-raw '{"schema":{"validations":[{"description":"example validation to test broker email format","condition":{"match":[{"var":"broker\\.email.value"},"^\\S+\\@\\S+$"]},"severity":"warning","fields":["test"]}]}} '

Authorizations

Authorization

string

header

required

Sensible uses API keys to authenticate requests. Keep your API keys secure and do not share them publicly accessible areas such as GitHub, client-side code, etc. Authentication to the API is performed via Bearer Authentication. Provide your API key as the bearer auth value.

Path Parameters

type-id

string

required

The unique document type identifier in v4 UUID format. Find IDs using the /document_types endpoint.

Body

application/json

name

string

User-friendly name

Required string length: 3 - 128

schema

object

Show child attributes

schema.fingerprint_mode

enum<string>

The Sensible app defaults to fallback_to_all.

Available options:

fallback_to_all,

strict

schema.ocr_engine

enum<string>

For information about each OCR engine, see OCR engine.

Available options:

microsoft,

amazon,

google,

lazarus

schema.ocr_level

enum<number>

See OCR level.

Available options:

0,

2,

4,

5

schema.prevent_default_merge_lines

boolean

Prevents the built-in line merging that occurs before the Merge Lines preprocessor.

schema.validations

object[]

Array of validations. See https://docs.sensible.so/docs/validate-extractions

Show child attributes

schema.validations.condition

object

required

The test for extraction written in JsonLogic.

schema.validations.description

string

required

User-friendly description for the test

schema.validations.fields

string[]

Skip this test unless prerequisite fields are non-null.

schema.validations.severity

enum<string>

Severity of the failing test

Available options:

warning,

error

Response

200 - application/json

created

string

required

ISO 8601 date-time.

id

string

required

Unique identifier

name

string

required

Unique user-friendly name for a document type

schema

object

required

Show child attributes

schema.fingerprint_mode

enum<string>

The Sensible app defaults to fallback_to_all.

Available options:

fallback_to_all,

strict

schema.ocr_engine

enum<string>

For information about each OCR engine, see OCR engine.

Available options:

microsoft,

amazon,

google,

lazarus

schema.ocr_level

enum<number>

See OCR level.

Available options:

0,

2,

4,

5

schema.prevent_default_merge_lines

boolean

Prevents the built-in line merging that occurs before the Merge Lines preprocessor.

schema.validations

object[]

Array of validations. See https://docs.sensible.so/docs/validate-extractions

Show child attributes

schema.validations.condition

object

required

The test for extraction written in JsonLogic.

schema.validations.description

string

required

User-friendly description for the test

schema.validations.fields

string[]

Skip this test unless prerequisite fields are non-null.

schema.validations.severity

enum<string>

Severity of the failing test

Available options:

warning,

error