OpenAPI SpecificationJSON
API Reference

Inbox

An inbox object enables email ingestion to a related queue We enforce email domain to match Rossum domain (e.g. example.rossum.app). email_prefix may be used to construct unique email address.

Please note that due to security reasons, emails from Rossum do not contain processed files. This feature can be enabled upon request by customer support.

The filters attribute allows filtering of incoming emails and documents:

  • allowed_senders and denied_senders settings allow filtering based on sender email address using wildcards (* matches everything, ? matches any single character)
  • document_rejection_conditions defines rules for filtering incoming documents via email. See document rejection conditions object

Several bounce-related attributes are deprecated and their configuration has moved to Email notifications settings.

Inbox

Attribute
Type
Description
id*
read-only
integer (int64)

ID of the inbox.

name*
string

Name of the inbox (not visible in UI).

url*
read-only
string (url)

URL of the inbox.

queues*
list[string (url)]

Queue that receives documents from inbox. Queue has to be passed in list due to backward compatibility. It is possible to have only one queue per inbox.

email*
string (email)

Rossum email address (e.g. east-west-trading-co-a34f3a@example.rossum.app).

email_prefix*
string

Rossum email address prefix (e.g. east-west-trading-co). Maximum length allowed is 57 chars.

maxLength: 57
bounce_email_to*
deprecated
string,null (email)

(Deprecated) Email address to send notifications to (e.g. about failed import). Configuration moved to Email notifications settings.

bounce_unprocessable_attachments*
deprecated
boolean

(Deprecated) Whether return back unprocessable attachments (e.g. MS Word docx) or just silently ignore them. When true, minimum image size requirement does not apply. Configuration moved to Email notifications settings.

Default: false
bounce_postponed_annotations*
deprecated
boolean

(Deprecated) Whether to send notification when annotation is postponed. Configuration moved to Email notifications settings.

Default: false
bounce_deleted_annotations*
deprecated
boolean

(Deprecated) Whether to send notification when annotation is deleted. Configuration moved to Email notifications settings.

Default: false
bounce_email_with_no_attachments*
deprecated
boolean

(Deprecated) Whether to send notification when no processable documents were found. Configuration moved to Email notifications settings.

Default: true
metadata*
object

Client data. May be used to store e.g. external system object IDs. See Metadata for more details.

Default: {}
filters*
object

Filtering of incoming emails and documents. allowed_senders and denied_senders settings allow filtering of incoming emails based on sender email address. Filters can be specified by exact email addresses as well as using expressions containing wildcards:

  • * matches everything (e.g. *@rossum.ai matches every email from rossum.ai domain)
  • ? matches any single character (e.g. john?doe@rossum.ai matches john.doe@rossum.ai as well as john-doe@rossum.ai) document_rejection_conditions defines rules for filtering incoming documents via email.
allowed_senders
list[string]

Only emails with matching sender's address will be processed. If empty all senders all allowed.

Default: []
denied_senders
list[string]

Incoming emails from email address matching one of these will be ignored.

Default: []
document_rejection_conditions
object

Rules for filtering out documents coming to Rossum smart inbox. If it's enabled document will be rejected once it satisfied at least one of defined conditions.

Setting attribute value to null (or empty list in case of mime_types, file_name_regexes) will turn that specific filtering feature off.

enabled
boolean

Whether the document rejection feature is enabled.

Default: true
resolution_lower_than_px
list[integer]

Resolution [width, height] in pixels. A file will be filtered out if both of the dimensions are smaller than the limits.

Default: [1200,600]
file_size_less_than_b
integer | null

Size of document in bytes. A file with smaller size will be filtered out.

Default: null
mime_types
list[string]

List of mime types to filter out (must match ^.+/.+$).

Default: ["image/gif"]
file_name_regexes
object

Regular expressions in re2 format (for more info about syntax see docs). A file with matching name will be filtered out.

Default: null

Type: string

Type: null

dmarc_check_action*
"accept" | "drop"

Decides what to do with incoming emails, that don't pass the DMARC check.

Default: "accept"
modified_by*
read-only
URL

User that last modified the object.

modified_at*
read-only
datetime

Timestamp of last modification.

List inboxes

GET api / v1 / inboxes

Retrieve all inbox objects.

GET
/api/v1/inboxes
curl -X GET "https://example.rossum.app/api/v1/inboxes"
{
  "results": [
    {
      "id": 1234,
      "name": "Receipts",
      "url": "https://example.rossum.app/api/v1/inboxes/1234",
      "queues": [
        "https://example.rossum.app/api/v1/queues/8199"
      ],
      "email": "east-west-trading-co-a34f3a@example.rossum.app",
      "email_prefix": "east-west-trading-co",
      "bounce_email_to": "bounces@east-west.com",
      "bounce_unprocessable_attachments": false,
      "bounce_postponed_annotations": false,
      "bounce_deleted_annotations": false,
      "bounce_email_with_no_attachments": true,
      "metadata": {
        "some_key": "some_value"
      },
      "filters": {
        "allowed_senders": [
          "*@rossum.ai",
          "john.doe@company.com",
          "john.doe@company.??"
        ],
        "denied_senders": [
          "spam@*"
        ],
        "document_rejection_conditions": {
          "enabled": true,
          "resolution_lower_than_px": [
            1200,
            600
          ],
          "file_size_less_than_b": null,
          "mime_types": [
            "image/gif"
          ],
          "file_name_regexes": null
        }
      },
      "dmarc_check_action": "accept",
      "modified_by": "https://example.rossum.app/api/v1/users/10775",
      "modified_at": "2021-04-26T10:08:03.856648Z"
    }
  ],
  "pagination": {
    "next": null,
    "previous": null
  }
}
{
  "detail": "Bad Request.",
  "code": "bad_request"
}
{
  "detail": "Invalid token.",
  "code": "authentication_failed"
}
{
  "detail": "Access to the requested resource is forbidden.",
  "code": "access_forbidden"
}
{
  "detail": "Not found.",
  "code": "not_found"
}
{
  "detail": "Conflict.",
  "code": "conflict_status"
}
{
  "detail": "Request was rate limited.",
  "code": "rate_limited",
  "url": "https://rossum.app/api/docs/openapi/guides/overview/#rate-limiting"
}
{
  "detail": "Server error.",
  "code": "error"
}
{
  "detail": "Bad Gateway.",
  "code": "bad_gateway"
}
{
  "detail": "Service Unavailable.",
  "code": "service_unavailable"
}
{
  "detail": "Gateway timeout.",
  "code": "gateway_timeout"
}

Response

200OK

OK

Attribute
Type
Description
results
list[inbox]
id*
read-only
integer (int64)

ID of the inbox.

name*
string

Name of the inbox (not visible in UI).

url*
read-only
string (url)

URL of the inbox.

queues*
list[string (url)]

Queue that receives documents from inbox. Queue has to be passed in list due to backward compatibility. It is possible to have only one queue per inbox.

email*
string (email)

Rossum email address (e.g. east-west-trading-co-a34f3a@example.rossum.app).

email_prefix*
string

Rossum email address prefix (e.g. east-west-trading-co). Maximum length allowed is 57 chars.

maxLength: 57
bounce_email_to*
deprecated
string,null (email)

(Deprecated) Email address to send notifications to (e.g. about failed import). Configuration moved to Email notifications settings.

bounce_unprocessable_attachments*
deprecated
boolean

(Deprecated) Whether return back unprocessable attachments (e.g. MS Word docx) or just silently ignore them. When true, minimum image size requirement does not apply. Configuration moved to Email notifications settings.

Default: false
bounce_postponed_annotations*
deprecated
boolean

(Deprecated) Whether to send notification when annotation is postponed. Configuration moved to Email notifications settings.

Default: false
bounce_deleted_annotations*
deprecated
boolean

(Deprecated) Whether to send notification when annotation is deleted. Configuration moved to Email notifications settings.

Default: false
bounce_email_with_no_attachments*
deprecated
boolean

(Deprecated) Whether to send notification when no processable documents were found. Configuration moved to Email notifications settings.

Default: true
metadata*
object

Client data. May be used to store e.g. external system object IDs. See Metadata for more details.

Default: {}
filters*
object

Filtering of incoming emails and documents. allowed_senders and denied_senders settings allow filtering of incoming emails based on sender email address. Filters can be specified by exact email addresses as well as using expressions containing wildcards:

  • * matches everything (e.g. *@rossum.ai matches every email from rossum.ai domain)
  • ? matches any single character (e.g. john?doe@rossum.ai matches john.doe@rossum.ai as well as john-doe@rossum.ai) document_rejection_conditions defines rules for filtering incoming documents via email.
allowed_senders
list[string]

Only emails with matching sender's address will be processed. If empty all senders all allowed.

Default: []
denied_senders
list[string]

Incoming emails from email address matching one of these will be ignored.

Default: []
document_rejection_conditions
object

Rules for filtering out documents coming to Rossum smart inbox. If it's enabled document will be rejected once it satisfied at least one of defined conditions.

Setting attribute value to null (or empty list in case of mime_types, file_name_regexes) will turn that specific filtering feature off.

enabled
boolean

Whether the document rejection feature is enabled.

Default: true
resolution_lower_than_px
list[integer]

Resolution [width, height] in pixels. A file will be filtered out if both of the dimensions are smaller than the limits.

Default: [1200,600]
file_size_less_than_b
integer | null

Size of document in bytes. A file with smaller size will be filtered out.

Default: null
mime_types
list[string]

List of mime types to filter out (must match ^.+/.+$).

Default: ["image/gif"]
file_name_regexes
object

Regular expressions in re2 format (for more info about syntax see docs). A file with matching name will be filtered out.

Default: null

Type: string

Type: null

dmarc_check_action*
"accept" | "drop"

Decides what to do with incoming emails, that don't pass the DMARC check.

Default: "accept"
modified_by*
read-only
URL

User that last modified the object.

modified_at*
read-only
datetime

Timestamp of last modification.

pagination
pagination
next
URL

URL for the next page of results. Contains an opaque signed cursor query parameter. Use this URL directly to fetch the next page — do not attempt to construct or modify the cursor value.

previous
URL

URL for the previous page of results. Contains an opaque signed cursor query parameter. Use this URL directly to fetch the previous page — do not attempt to construct or modify the cursor value.

400Bad Request

Invalid input data.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

401Unauthorized

The username/password is invalid or token is invalid (e.g. expired).

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

403Forbidden

Insufficient permission, missing authentication, invalid CSRF token and similar issue.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

404Not Found

The specified resource was not found.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

409Conflict

Conflict

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

429Too Many Requests

Request rate is too high, wait before sending more requests. See Rate Limiting for more details.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

url
read-only
string

Link to the rate limiting documentation

500Internal Server Error

Server failure while processing the request.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

502Bad Gateway

Invalid response from the upstream server.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

503Service Unavailable

We're temporarily offline for maintenance. Please try again later.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

504

Upstream server could not complete the request in time.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

Create inbox

POST api / v1 / inboxes

Create a new inbox object.

POST
/api/v1/inboxes
curl -X POST "https://example.rossum.app/api/v1/inboxes" \  -H "Content-Type: application/json" \  -d '{    "name": "Receipts",    "queues": [      "https://example.rossum.app/api/v1/queues/8199"    ],    "email_prefix": "east-west-trading-co"  }'
{
  "id": 1234,
  "name": "Receipts",
  "url": "https://example.rossum.app/api/v1/inboxes/1234",
  "queues": [
    "https://example.rossum.app/api/v1/queues/8199"
  ],
  "email": "east-west-trading-co-a34f3a@example.rossum.app",
  "email_prefix": "east-west-trading-co",
  "bounce_email_to": "bounces@east-west.com",
  "bounce_unprocessable_attachments": false,
  "bounce_postponed_annotations": false,
  "bounce_deleted_annotations": false,
  "bounce_email_with_no_attachments": true,
  "metadata": {
    "some_key": "some_value"
  },
  "filters": {
    "allowed_senders": [
      "*@rossum.ai",
      "john.doe@company.com",
      "john.doe@company.??"
    ],
    "denied_senders": [
      "spam@*"
    ],
    "document_rejection_conditions": {
      "enabled": true,
      "resolution_lower_than_px": [
        1200,
        600
      ],
      "file_size_less_than_b": null,
      "mime_types": [
        "image/gif"
      ],
      "file_name_regexes": null
    }
  },
  "dmarc_check_action": "accept",
  "modified_by": "https://example.rossum.app/api/v1/users/10775",
  "modified_at": "2021-04-26T10:08:03.856648Z"
}
{
  "detail": "Bad Request.",
  "code": "bad_request"
}
{
  "detail": "Invalid token.",
  "code": "authentication_failed"
}
{
  "detail": "Access to the requested resource is forbidden.",
  "code": "access_forbidden"
}
{
  "detail": "Not found.",
  "code": "not_found"
}
{
  "detail": "Conflict.",
  "code": "conflict_status"
}
{
  "detail": "Payload Too Large.",
  "code": "payload_too_large"
}
{
  "detail": "Request was rate limited.",
  "code": "rate_limited",
  "url": "https://rossum.app/api/docs/openapi/guides/overview/#rate-limiting"
}
{
  "detail": "Server error.",
  "code": "error"
}
{
  "detail": "Bad Gateway.",
  "code": "bad_gateway"
}
{
  "detail": "Service Unavailable.",
  "code": "service_unavailable"
}
{
  "detail": "Gateway timeout.",
  "code": "gateway_timeout"
}

Request Body

application/json

Attribute
Type
Description
name*
string

Name of the inbox (not visible in UI).

queues*
list[string (url)]

Queue that receives documents from inbox. Queue has to be passed in list due to backward compatibility. It is possible to have only one queue per inbox.

email
string (email)

Rossum email address (e.g. east-west-trading-co-a34f3a@example.rossum.app).

email_prefix*
string

Rossum email address prefix (e.g. east-west-trading-co). Maximum length allowed is 57 chars.

maxLength: 57
bounce_email_to
deprecated
string,null (email)

(Deprecated) Email address to send notifications to (e.g. about failed import). Configuration moved to Email notifications settings.

bounce_unprocessable_attachments
deprecated
boolean

(Deprecated) Whether return back unprocessable attachments (e.g. MS Word docx) or just silently ignore them. When true, minimum image size requirement does not apply. Configuration moved to Email notifications settings.

Default: false
bounce_postponed_annotations
deprecated
boolean

(Deprecated) Whether to send notification when annotation is postponed. Configuration moved to Email notifications settings.

Default: false
bounce_deleted_annotations
deprecated
boolean

(Deprecated) Whether to send notification when annotation is deleted. Configuration moved to Email notifications settings.

Default: false
bounce_email_with_no_attachments
deprecated
boolean

(Deprecated) Whether to send notification when no processable documents were found. Configuration moved to Email notifications settings.

Default: true
metadata
object

Client data. May be used to store e.g. external system object IDs. See Metadata for more details.

Default: {}
filters
object

Filtering of incoming emails and documents. allowed_senders and denied_senders settings allow filtering of incoming emails based on sender email address. Filters can be specified by exact email addresses as well as using expressions containing wildcards:

  • * matches everything (e.g. *@rossum.ai matches every email from rossum.ai domain)
  • ? matches any single character (e.g. john?doe@rossum.ai matches john.doe@rossum.ai as well as john-doe@rossum.ai) document_rejection_conditions defines rules for filtering incoming documents via email.
allowed_senders
list[string]

Only emails with matching sender's address will be processed. If empty all senders all allowed.

Default: []
denied_senders
list[string]

Incoming emails from email address matching one of these will be ignored.

Default: []
document_rejection_conditions
object

Rules for filtering out documents coming to Rossum smart inbox. If it's enabled document will be rejected once it satisfied at least one of defined conditions.

Setting attribute value to null (or empty list in case of mime_types, file_name_regexes) will turn that specific filtering feature off.

enabled
boolean

Whether the document rejection feature is enabled.

Default: true
resolution_lower_than_px
list[integer]

Resolution [width, height] in pixels. A file will be filtered out if both of the dimensions are smaller than the limits.

Default: [1200,600]
file_size_less_than_b
integer | null

Size of document in bytes. A file with smaller size will be filtered out.

Default: null
mime_types
list[string]

List of mime types to filter out (must match ^.+/.+$).

Default: ["image/gif"]
file_name_regexes
object

Regular expressions in re2 format (for more info about syntax see docs). A file with matching name will be filtered out.

Default: null

Type: string

Type: null

dmarc_check_action
"accept" | "drop"

Decides what to do with incoming emails, that don't pass the DMARC check.

Default: "accept"

Response

201Created

Created

Attribute
Type
Description
id*
read-only
integer (int64)

ID of the inbox.

name*
string

Name of the inbox (not visible in UI).

url*
read-only
string (url)

URL of the inbox.

queues*
list[string (url)]

Queue that receives documents from inbox. Queue has to be passed in list due to backward compatibility. It is possible to have only one queue per inbox.

email*
string (email)

Rossum email address (e.g. east-west-trading-co-a34f3a@example.rossum.app).

email_prefix*
string

Rossum email address prefix (e.g. east-west-trading-co). Maximum length allowed is 57 chars.

maxLength: 57
bounce_email_to*
deprecated
string,null (email)

(Deprecated) Email address to send notifications to (e.g. about failed import). Configuration moved to Email notifications settings.

bounce_unprocessable_attachments*
deprecated
boolean

(Deprecated) Whether return back unprocessable attachments (e.g. MS Word docx) or just silently ignore them. When true, minimum image size requirement does not apply. Configuration moved to Email notifications settings.

Default: false
bounce_postponed_annotations*
deprecated
boolean

(Deprecated) Whether to send notification when annotation is postponed. Configuration moved to Email notifications settings.

Default: false
bounce_deleted_annotations*
deprecated
boolean

(Deprecated) Whether to send notification when annotation is deleted. Configuration moved to Email notifications settings.

Default: false
bounce_email_with_no_attachments*
deprecated
boolean

(Deprecated) Whether to send notification when no processable documents were found. Configuration moved to Email notifications settings.

Default: true
metadata*
object

Client data. May be used to store e.g. external system object IDs. See Metadata for more details.

Default: {}
filters*
object

Filtering of incoming emails and documents. allowed_senders and denied_senders settings allow filtering of incoming emails based on sender email address. Filters can be specified by exact email addresses as well as using expressions containing wildcards:

  • * matches everything (e.g. *@rossum.ai matches every email from rossum.ai domain)
  • ? matches any single character (e.g. john?doe@rossum.ai matches john.doe@rossum.ai as well as john-doe@rossum.ai) document_rejection_conditions defines rules for filtering incoming documents via email.
allowed_senders
list[string]

Only emails with matching sender's address will be processed. If empty all senders all allowed.

Default: []
denied_senders
list[string]

Incoming emails from email address matching one of these will be ignored.

Default: []
document_rejection_conditions
object

Rules for filtering out documents coming to Rossum smart inbox. If it's enabled document will be rejected once it satisfied at least one of defined conditions.

Setting attribute value to null (or empty list in case of mime_types, file_name_regexes) will turn that specific filtering feature off.

enabled
boolean

Whether the document rejection feature is enabled.

Default: true
resolution_lower_than_px
list[integer]

Resolution [width, height] in pixels. A file will be filtered out if both of the dimensions are smaller than the limits.

Default: [1200,600]
file_size_less_than_b
integer | null

Size of document in bytes. A file with smaller size will be filtered out.

Default: null
mime_types
list[string]

List of mime types to filter out (must match ^.+/.+$).

Default: ["image/gif"]
file_name_regexes
object

Regular expressions in re2 format (for more info about syntax see docs). A file with matching name will be filtered out.

Default: null

Type: string

Type: null

dmarc_check_action*
"accept" | "drop"

Decides what to do with incoming emails, that don't pass the DMARC check.

Default: "accept"
modified_by*
read-only
URL

User that last modified the object.

modified_at*
read-only
datetime

Timestamp of last modification.

400Bad Request

Invalid input data.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

401Unauthorized

The username/password is invalid or token is invalid (e.g. expired).

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

403Forbidden

Insufficient permission, missing authentication, invalid CSRF token and similar issue.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

404Not Found

The specified resource was not found.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

409Conflict

Conflict

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

413

Payload too large (especially for files uploaded).

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

429Too Many Requests

Request rate is too high, wait before sending more requests. See Rate Limiting for more details.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

url
read-only
string

Link to the rate limiting documentation

500Internal Server Error

Server failure while processing the request.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

502Bad Gateway

Invalid response from the upstream server.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

503Service Unavailable

We're temporarily offline for maintenance. Please try again later.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

504

Upstream server could not complete the request in time.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

Retrieve inbox

GET api / v1 / inboxes / {inboxID}

Get an inbox object.

GET
/api/v1/inboxes/{inboxID}
curl -X GET "https://example.rossum.app/api/v1/inboxes/0"
{
  "id": 1234,
  "name": "Receipts",
  "url": "https://example.rossum.app/api/v1/inboxes/1234",
  "queues": [
    "https://example.rossum.app/api/v1/queues/8199"
  ],
  "email": "east-west-trading-co-a34f3a@example.rossum.app",
  "email_prefix": "east-west-trading-co",
  "bounce_email_to": "bounces@east-west.com",
  "bounce_unprocessable_attachments": false,
  "bounce_postponed_annotations": false,
  "bounce_deleted_annotations": false,
  "bounce_email_with_no_attachments": true,
  "metadata": {
    "some_key": "some_value"
  },
  "filters": {
    "allowed_senders": [
      "*@rossum.ai",
      "john.doe@company.com",
      "john.doe@company.??"
    ],
    "denied_senders": [
      "spam@*"
    ],
    "document_rejection_conditions": {
      "enabled": true,
      "resolution_lower_than_px": [
        1200,
        600
      ],
      "file_size_less_than_b": null,
      "mime_types": [
        "image/gif"
      ],
      "file_name_regexes": null
    }
  },
  "dmarc_check_action": "accept",
  "modified_by": "https://example.rossum.app/api/v1/users/10775",
  "modified_at": "2021-04-26T10:08:03.856648Z"
}
{
  "detail": "Bad Request.",
  "code": "bad_request"
}
{
  "detail": "Invalid token.",
  "code": "authentication_failed"
}
{
  "detail": "Access to the requested resource is forbidden.",
  "code": "access_forbidden"
}
{
  "detail": "Not found.",
  "code": "not_found"
}
{
  "detail": "Conflict.",
  "code": "conflict_status"
}
{
  "detail": "Request was rate limited.",
  "code": "rate_limited",
  "url": "https://rossum.app/api/docs/openapi/guides/overview/#rate-limiting"
}
{
  "detail": "Server error.",
  "code": "error"
}
{
  "detail": "Bad Gateway.",
  "code": "bad_gateway"
}
{
  "detail": "Service Unavailable.",
  "code": "service_unavailable"
}
{
  "detail": "Gateway timeout.",
  "code": "gateway_timeout"
}

Response

200OK

OK

Attribute
Type
Description
id*
read-only
integer (int64)

ID of the inbox.

name*
string

Name of the inbox (not visible in UI).

url*
read-only
string (url)

URL of the inbox.

queues*
list[string (url)]

Queue that receives documents from inbox. Queue has to be passed in list due to backward compatibility. It is possible to have only one queue per inbox.

email*
string (email)

Rossum email address (e.g. east-west-trading-co-a34f3a@example.rossum.app).

email_prefix*
string

Rossum email address prefix (e.g. east-west-trading-co). Maximum length allowed is 57 chars.

maxLength: 57
bounce_email_to*
deprecated
string,null (email)

(Deprecated) Email address to send notifications to (e.g. about failed import). Configuration moved to Email notifications settings.

bounce_unprocessable_attachments*
deprecated
boolean

(Deprecated) Whether return back unprocessable attachments (e.g. MS Word docx) or just silently ignore them. When true, minimum image size requirement does not apply. Configuration moved to Email notifications settings.

Default: false
bounce_postponed_annotations*
deprecated
boolean

(Deprecated) Whether to send notification when annotation is postponed. Configuration moved to Email notifications settings.

Default: false
bounce_deleted_annotations*
deprecated
boolean

(Deprecated) Whether to send notification when annotation is deleted. Configuration moved to Email notifications settings.

Default: false
bounce_email_with_no_attachments*
deprecated
boolean

(Deprecated) Whether to send notification when no processable documents were found. Configuration moved to Email notifications settings.

Default: true
metadata*
object

Client data. May be used to store e.g. external system object IDs. See Metadata for more details.

Default: {}
filters*
object

Filtering of incoming emails and documents. allowed_senders and denied_senders settings allow filtering of incoming emails based on sender email address. Filters can be specified by exact email addresses as well as using expressions containing wildcards:

  • * matches everything (e.g. *@rossum.ai matches every email from rossum.ai domain)
  • ? matches any single character (e.g. john?doe@rossum.ai matches john.doe@rossum.ai as well as john-doe@rossum.ai) document_rejection_conditions defines rules for filtering incoming documents via email.
allowed_senders
list[string]

Only emails with matching sender's address will be processed. If empty all senders all allowed.

Default: []
denied_senders
list[string]

Incoming emails from email address matching one of these will be ignored.

Default: []
document_rejection_conditions
object

Rules for filtering out documents coming to Rossum smart inbox. If it's enabled document will be rejected once it satisfied at least one of defined conditions.

Setting attribute value to null (or empty list in case of mime_types, file_name_regexes) will turn that specific filtering feature off.

enabled
boolean

Whether the document rejection feature is enabled.

Default: true
resolution_lower_than_px
list[integer]

Resolution [width, height] in pixels. A file will be filtered out if both of the dimensions are smaller than the limits.

Default: [1200,600]
file_size_less_than_b
integer | null

Size of document in bytes. A file with smaller size will be filtered out.

Default: null
mime_types
list[string]

List of mime types to filter out (must match ^.+/.+$).

Default: ["image/gif"]
file_name_regexes
object

Regular expressions in re2 format (for more info about syntax see docs). A file with matching name will be filtered out.

Default: null

Type: string

Type: null

dmarc_check_action*
"accept" | "drop"

Decides what to do with incoming emails, that don't pass the DMARC check.

Default: "accept"
modified_by*
read-only
URL

User that last modified the object.

modified_at*
read-only
datetime

Timestamp of last modification.

400Bad Request

Invalid input data.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

401Unauthorized

The username/password is invalid or token is invalid (e.g. expired).

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

403Forbidden

Insufficient permission, missing authentication, invalid CSRF token and similar issue.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

404Not Found

The specified resource was not found.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

409Conflict

Conflict

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

429Too Many Requests

Request rate is too high, wait before sending more requests. See Rate Limiting for more details.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

url
read-only
string

Link to the rate limiting documentation

500Internal Server Error

Server failure while processing the request.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

502Bad Gateway

Invalid response from the upstream server.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

503Service Unavailable

We're temporarily offline for maintenance. Please try again later.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

504

Upstream server could not complete the request in time.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

Partial update inbox

PATCH api / v1 / inboxes / {inboxID}

Update a part of inbox object.

PATCH
/api/v1/inboxes/{inboxID}
curl -X PATCH "https://example.rossum.app/api/v1/inboxes/0" \  -H "Content-Type: application/json" \  -d '{}'
{
  "id": 1234,
  "name": "Receipts",
  "url": "https://example.rossum.app/api/v1/inboxes/1234",
  "queues": [
    "https://example.rossum.app/api/v1/queues/8199"
  ],
  "email": "east-west-trading-co-a34f3a@example.rossum.app",
  "email_prefix": "east-west-trading-co",
  "bounce_email_to": "bounces@east-west.com",
  "bounce_unprocessable_attachments": false,
  "bounce_postponed_annotations": false,
  "bounce_deleted_annotations": false,
  "bounce_email_with_no_attachments": true,
  "metadata": {
    "some_key": "some_value"
  },
  "filters": {
    "allowed_senders": [
      "*@rossum.ai",
      "john.doe@company.com",
      "john.doe@company.??"
    ],
    "denied_senders": [
      "spam@*"
    ],
    "document_rejection_conditions": {
      "enabled": true,
      "resolution_lower_than_px": [
        1200,
        600
      ],
      "file_size_less_than_b": null,
      "mime_types": [
        "image/gif"
      ],
      "file_name_regexes": null
    }
  },
  "dmarc_check_action": "accept",
  "modified_by": "https://example.rossum.app/api/v1/users/10775",
  "modified_at": "2021-04-26T10:08:03.856648Z"
}
{
  "detail": "Bad Request.",
  "code": "bad_request"
}
{
  "detail": "Invalid token.",
  "code": "authentication_failed"
}
{
  "detail": "Access to the requested resource is forbidden.",
  "code": "access_forbidden"
}
{
  "detail": "Not found.",
  "code": "not_found"
}
{
  "detail": "Conflict.",
  "code": "conflict_status"
}
{
  "detail": "Payload Too Large.",
  "code": "payload_too_large"
}
{
  "detail": "Request was rate limited.",
  "code": "rate_limited",
  "url": "https://rossum.app/api/docs/openapi/guides/overview/#rate-limiting"
}
{
  "detail": "Server error.",
  "code": "error"
}
{
  "detail": "Bad Gateway.",
  "code": "bad_gateway"
}
{
  "detail": "Service Unavailable.",
  "code": "service_unavailable"
}
{
  "detail": "Gateway timeout.",
  "code": "gateway_timeout"
}

Request Body

application/json

Attribute
Type
Description
name
string

Name of the inbox (not visible in UI).

queues
list[string (url)]

Queue that receives documents from inbox. Queue has to be passed in list due to backward compatibility. It is possible to have only one queue per inbox.

email
string (email)

Rossum email address (e.g. east-west-trading-co-a34f3a@example.rossum.app).

email_prefix
string

Rossum email address prefix (e.g. east-west-trading-co). Maximum length allowed is 57 chars.

maxLength: 57
bounce_email_to
deprecated
string,null (email)

(Deprecated) Email address to send notifications to (e.g. about failed import). Configuration moved to Email notifications settings.

bounce_unprocessable_attachments
deprecated
boolean

(Deprecated) Whether return back unprocessable attachments (e.g. MS Word docx) or just silently ignore them. When true, minimum image size requirement does not apply. Configuration moved to Email notifications settings.

Default: false
bounce_postponed_annotations
deprecated
boolean

(Deprecated) Whether to send notification when annotation is postponed. Configuration moved to Email notifications settings.

Default: false
bounce_deleted_annotations
deprecated
boolean

(Deprecated) Whether to send notification when annotation is deleted. Configuration moved to Email notifications settings.

Default: false
bounce_email_with_no_attachments
deprecated
boolean

(Deprecated) Whether to send notification when no processable documents were found. Configuration moved to Email notifications settings.

Default: true
metadata
object

Client data. May be used to store e.g. external system object IDs. See Metadata for more details.

Default: {}
filters
object

Filtering of incoming emails and documents. allowed_senders and denied_senders settings allow filtering of incoming emails based on sender email address. Filters can be specified by exact email addresses as well as using expressions containing wildcards:

  • * matches everything (e.g. *@rossum.ai matches every email from rossum.ai domain)
  • ? matches any single character (e.g. john?doe@rossum.ai matches john.doe@rossum.ai as well as john-doe@rossum.ai) document_rejection_conditions defines rules for filtering incoming documents via email.
allowed_senders
list[string]

Only emails with matching sender's address will be processed. If empty all senders all allowed.

Default: []
denied_senders
list[string]

Incoming emails from email address matching one of these will be ignored.

Default: []
document_rejection_conditions
object

Rules for filtering out documents coming to Rossum smart inbox. If it's enabled document will be rejected once it satisfied at least one of defined conditions.

Setting attribute value to null (or empty list in case of mime_types, file_name_regexes) will turn that specific filtering feature off.

enabled
boolean

Whether the document rejection feature is enabled.

Default: true
resolution_lower_than_px
list[integer]

Resolution [width, height] in pixels. A file will be filtered out if both of the dimensions are smaller than the limits.

Default: [1200,600]
file_size_less_than_b
integer | null

Size of document in bytes. A file with smaller size will be filtered out.

Default: null
mime_types
list[string]

List of mime types to filter out (must match ^.+/.+$).

Default: ["image/gif"]
file_name_regexes
object

Regular expressions in re2 format (for more info about syntax see docs). A file with matching name will be filtered out.

Default: null

Type: string

Type: null

dmarc_check_action
"accept" | "drop"

Decides what to do with incoming emails, that don't pass the DMARC check.

Default: "accept"

Response

200OK

OK

Attribute
Type
Description
id*
read-only
integer (int64)

ID of the inbox.

name*
string

Name of the inbox (not visible in UI).

url*
read-only
string (url)

URL of the inbox.

queues*
list[string (url)]

Queue that receives documents from inbox. Queue has to be passed in list due to backward compatibility. It is possible to have only one queue per inbox.

email*
string (email)

Rossum email address (e.g. east-west-trading-co-a34f3a@example.rossum.app).

email_prefix*
string

Rossum email address prefix (e.g. east-west-trading-co). Maximum length allowed is 57 chars.

maxLength: 57
bounce_email_to*
deprecated
string,null (email)

(Deprecated) Email address to send notifications to (e.g. about failed import). Configuration moved to Email notifications settings.

bounce_unprocessable_attachments*
deprecated
boolean

(Deprecated) Whether return back unprocessable attachments (e.g. MS Word docx) or just silently ignore them. When true, minimum image size requirement does not apply. Configuration moved to Email notifications settings.

Default: false
bounce_postponed_annotations*
deprecated
boolean

(Deprecated) Whether to send notification when annotation is postponed. Configuration moved to Email notifications settings.

Default: false
bounce_deleted_annotations*
deprecated
boolean

(Deprecated) Whether to send notification when annotation is deleted. Configuration moved to Email notifications settings.

Default: false
bounce_email_with_no_attachments*
deprecated
boolean

(Deprecated) Whether to send notification when no processable documents were found. Configuration moved to Email notifications settings.

Default: true
metadata*
object

Client data. May be used to store e.g. external system object IDs. See Metadata for more details.

Default: {}
filters*
object

Filtering of incoming emails and documents. allowed_senders and denied_senders settings allow filtering of incoming emails based on sender email address. Filters can be specified by exact email addresses as well as using expressions containing wildcards:

  • * matches everything (e.g. *@rossum.ai matches every email from rossum.ai domain)
  • ? matches any single character (e.g. john?doe@rossum.ai matches john.doe@rossum.ai as well as john-doe@rossum.ai) document_rejection_conditions defines rules for filtering incoming documents via email.
allowed_senders
list[string]

Only emails with matching sender's address will be processed. If empty all senders all allowed.

Default: []
denied_senders
list[string]

Incoming emails from email address matching one of these will be ignored.

Default: []
document_rejection_conditions
object

Rules for filtering out documents coming to Rossum smart inbox. If it's enabled document will be rejected once it satisfied at least one of defined conditions.

Setting attribute value to null (or empty list in case of mime_types, file_name_regexes) will turn that specific filtering feature off.

enabled
boolean

Whether the document rejection feature is enabled.

Default: true
resolution_lower_than_px
list[integer]

Resolution [width, height] in pixels. A file will be filtered out if both of the dimensions are smaller than the limits.

Default: [1200,600]
file_size_less_than_b
integer | null

Size of document in bytes. A file with smaller size will be filtered out.

Default: null
mime_types
list[string]

List of mime types to filter out (must match ^.+/.+$).

Default: ["image/gif"]
file_name_regexes
object

Regular expressions in re2 format (for more info about syntax see docs). A file with matching name will be filtered out.

Default: null

Type: string

Type: null

dmarc_check_action*
"accept" | "drop"

Decides what to do with incoming emails, that don't pass the DMARC check.

Default: "accept"
modified_by*
read-only
URL

User that last modified the object.

modified_at*
read-only
datetime

Timestamp of last modification.

400Bad Request

Invalid input data.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

401Unauthorized

The username/password is invalid or token is invalid (e.g. expired).

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

403Forbidden

Insufficient permission, missing authentication, invalid CSRF token and similar issue.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

404Not Found

The specified resource was not found.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

409Conflict

Conflict

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

413

Payload too large (especially for files uploaded).

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

429Too Many Requests

Request rate is too high, wait before sending more requests. See Rate Limiting for more details.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

url
read-only
string

Link to the rate limiting documentation

500Internal Server Error

Server failure while processing the request.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

502Bad Gateway

Invalid response from the upstream server.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

503Service Unavailable

We're temporarily offline for maintenance. Please try again later.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

504

Upstream server could not complete the request in time.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

Delete inbox

DELETE api / v1 / inboxes / {inboxID}

Delete inbox object.

DELETE
/api/v1/inboxes/{inboxID}
curl -X DELETE "https://example.rossum.app/api/v1/inboxes/0"
Empty
{
  "detail": "Bad Request.",
  "code": "bad_request"
}
{
  "detail": "Invalid token.",
  "code": "authentication_failed"
}
{
  "detail": "Access to the requested resource is forbidden.",
  "code": "access_forbidden"
}
{
  "detail": "Not found.",
  "code": "not_found"
}
{
  "detail": "Conflict.",
  "code": "conflict_status"
}
{
  "detail": "Request was rate limited.",
  "code": "rate_limited",
  "url": "https://rossum.app/api/docs/openapi/guides/overview/#rate-limiting"
}
{
  "detail": "Server error.",
  "code": "error"
}
{
  "detail": "Bad Gateway.",
  "code": "bad_gateway"
}
{
  "detail": "Service Unavailable.",
  "code": "service_unavailable"
}
{
  "detail": "Gateway timeout.",
  "code": "gateway_timeout"
}

Response

204No Content

No Content

No response body.

400Bad Request

Invalid input data.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

401Unauthorized

The username/password is invalid or token is invalid (e.g. expired).

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

403Forbidden

Insufficient permission, missing authentication, invalid CSRF token and similar issue.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

404Not Found

The specified resource was not found.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

409Conflict

Conflict

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

429Too Many Requests

Request rate is too high, wait before sending more requests. See Rate Limiting for more details.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

url
read-only
string

Link to the rate limiting documentation

500Internal Server Error

Server failure while processing the request.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

502Bad Gateway

Invalid response from the upstream server.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

503Service Unavailable

We're temporarily offline for maintenance. Please try again later.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

504

Upstream server could not complete the request in time.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

Update inbox

PUT api / v1 / inboxes / {inboxID}

Update inbox object.

PUT
/api/v1/inboxes/{inboxID}
curl -X PUT "https://example.rossum.app/api/v1/inboxes/0" \  -H "Content-Type: application/json" \  -d '{    "name": "Receipts",    "queues": [      "https://example.rossum.app/api/v1/queues/8199"    ],    "email_prefix": "east-west-trading-co"  }'
{
  "id": 1234,
  "name": "Receipts",
  "url": "https://example.rossum.app/api/v1/inboxes/1234",
  "queues": [
    "https://example.rossum.app/api/v1/queues/8199"
  ],
  "email": "east-west-trading-co-a34f3a@example.rossum.app",
  "email_prefix": "east-west-trading-co",
  "bounce_email_to": "bounces@east-west.com",
  "bounce_unprocessable_attachments": false,
  "bounce_postponed_annotations": false,
  "bounce_deleted_annotations": false,
  "bounce_email_with_no_attachments": true,
  "metadata": {
    "some_key": "some_value"
  },
  "filters": {
    "allowed_senders": [
      "*@rossum.ai",
      "john.doe@company.com",
      "john.doe@company.??"
    ],
    "denied_senders": [
      "spam@*"
    ],
    "document_rejection_conditions": {
      "enabled": true,
      "resolution_lower_than_px": [
        1200,
        600
      ],
      "file_size_less_than_b": null,
      "mime_types": [
        "image/gif"
      ],
      "file_name_regexes": null
    }
  },
  "dmarc_check_action": "accept",
  "modified_by": "https://example.rossum.app/api/v1/users/10775",
  "modified_at": "2021-04-26T10:08:03.856648Z"
}
{
  "detail": "Bad Request.",
  "code": "bad_request"
}
{
  "detail": "Invalid token.",
  "code": "authentication_failed"
}
{
  "detail": "Access to the requested resource is forbidden.",
  "code": "access_forbidden"
}
{
  "detail": "Not found.",
  "code": "not_found"
}
{
  "detail": "Conflict.",
  "code": "conflict_status"
}
{
  "detail": "Payload Too Large.",
  "code": "payload_too_large"
}
{
  "detail": "Request was rate limited.",
  "code": "rate_limited",
  "url": "https://rossum.app/api/docs/openapi/guides/overview/#rate-limiting"
}
{
  "detail": "Server error.",
  "code": "error"
}
{
  "detail": "Bad Gateway.",
  "code": "bad_gateway"
}
{
  "detail": "Service Unavailable.",
  "code": "service_unavailable"
}
{
  "detail": "Gateway timeout.",
  "code": "gateway_timeout"
}

Request Body

application/json

Attribute
Type
Description
name*
string

Name of the inbox (not visible in UI).

queues*
list[string (url)]

Queue that receives documents from inbox. Queue has to be passed in list due to backward compatibility. It is possible to have only one queue per inbox.

email
string (email)

Rossum email address (e.g. east-west-trading-co-a34f3a@example.rossum.app).

email_prefix*
string

Rossum email address prefix (e.g. east-west-trading-co). Maximum length allowed is 57 chars.

maxLength: 57
bounce_email_to
deprecated
string,null (email)

(Deprecated) Email address to send notifications to (e.g. about failed import). Configuration moved to Email notifications settings.

bounce_unprocessable_attachments
deprecated
boolean

(Deprecated) Whether return back unprocessable attachments (e.g. MS Word docx) or just silently ignore them. When true, minimum image size requirement does not apply. Configuration moved to Email notifications settings.

Default: false
bounce_postponed_annotations
deprecated
boolean

(Deprecated) Whether to send notification when annotation is postponed. Configuration moved to Email notifications settings.

Default: false
bounce_deleted_annotations
deprecated
boolean

(Deprecated) Whether to send notification when annotation is deleted. Configuration moved to Email notifications settings.

Default: false
bounce_email_with_no_attachments
deprecated
boolean

(Deprecated) Whether to send notification when no processable documents were found. Configuration moved to Email notifications settings.

Default: true
metadata
object

Client data. May be used to store e.g. external system object IDs. See Metadata for more details.

Default: {}
filters
object

Filtering of incoming emails and documents. allowed_senders and denied_senders settings allow filtering of incoming emails based on sender email address. Filters can be specified by exact email addresses as well as using expressions containing wildcards:

  • * matches everything (e.g. *@rossum.ai matches every email from rossum.ai domain)
  • ? matches any single character (e.g. john?doe@rossum.ai matches john.doe@rossum.ai as well as john-doe@rossum.ai) document_rejection_conditions defines rules for filtering incoming documents via email.
allowed_senders
list[string]

Only emails with matching sender's address will be processed. If empty all senders all allowed.

Default: []
denied_senders
list[string]

Incoming emails from email address matching one of these will be ignored.

Default: []
document_rejection_conditions
object

Rules for filtering out documents coming to Rossum smart inbox. If it's enabled document will be rejected once it satisfied at least one of defined conditions.

Setting attribute value to null (or empty list in case of mime_types, file_name_regexes) will turn that specific filtering feature off.

enabled
boolean

Whether the document rejection feature is enabled.

Default: true
resolution_lower_than_px
list[integer]

Resolution [width, height] in pixels. A file will be filtered out if both of the dimensions are smaller than the limits.

Default: [1200,600]
file_size_less_than_b
integer | null

Size of document in bytes. A file with smaller size will be filtered out.

Default: null
mime_types
list[string]

List of mime types to filter out (must match ^.+/.+$).

Default: ["image/gif"]
file_name_regexes
object

Regular expressions in re2 format (for more info about syntax see docs). A file with matching name will be filtered out.

Default: null

Type: string

Type: null

dmarc_check_action
"accept" | "drop"

Decides what to do with incoming emails, that don't pass the DMARC check.

Default: "accept"

Response

200OK

OK

Attribute
Type
Description
id*
read-only
integer (int64)

ID of the inbox.

name*
string

Name of the inbox (not visible in UI).

url*
read-only
string (url)

URL of the inbox.

queues*
list[string (url)]

Queue that receives documents from inbox. Queue has to be passed in list due to backward compatibility. It is possible to have only one queue per inbox.

email*
string (email)

Rossum email address (e.g. east-west-trading-co-a34f3a@example.rossum.app).

email_prefix*
string

Rossum email address prefix (e.g. east-west-trading-co). Maximum length allowed is 57 chars.

maxLength: 57
bounce_email_to*
deprecated
string,null (email)

(Deprecated) Email address to send notifications to (e.g. about failed import). Configuration moved to Email notifications settings.

bounce_unprocessable_attachments*
deprecated
boolean

(Deprecated) Whether return back unprocessable attachments (e.g. MS Word docx) or just silently ignore them. When true, minimum image size requirement does not apply. Configuration moved to Email notifications settings.

Default: false
bounce_postponed_annotations*
deprecated
boolean

(Deprecated) Whether to send notification when annotation is postponed. Configuration moved to Email notifications settings.

Default: false
bounce_deleted_annotations*
deprecated
boolean

(Deprecated) Whether to send notification when annotation is deleted. Configuration moved to Email notifications settings.

Default: false
bounce_email_with_no_attachments*
deprecated
boolean

(Deprecated) Whether to send notification when no processable documents were found. Configuration moved to Email notifications settings.

Default: true
metadata*
object

Client data. May be used to store e.g. external system object IDs. See Metadata for more details.

Default: {}
filters*
object

Filtering of incoming emails and documents. allowed_senders and denied_senders settings allow filtering of incoming emails based on sender email address. Filters can be specified by exact email addresses as well as using expressions containing wildcards:

  • * matches everything (e.g. *@rossum.ai matches every email from rossum.ai domain)
  • ? matches any single character (e.g. john?doe@rossum.ai matches john.doe@rossum.ai as well as john-doe@rossum.ai) document_rejection_conditions defines rules for filtering incoming documents via email.
allowed_senders
list[string]

Only emails with matching sender's address will be processed. If empty all senders all allowed.

Default: []
denied_senders
list[string]

Incoming emails from email address matching one of these will be ignored.

Default: []
document_rejection_conditions
object

Rules for filtering out documents coming to Rossum smart inbox. If it's enabled document will be rejected once it satisfied at least one of defined conditions.

Setting attribute value to null (or empty list in case of mime_types, file_name_regexes) will turn that specific filtering feature off.

enabled
boolean

Whether the document rejection feature is enabled.

Default: true
resolution_lower_than_px
list[integer]

Resolution [width, height] in pixels. A file will be filtered out if both of the dimensions are smaller than the limits.

Default: [1200,600]
file_size_less_than_b
integer | null

Size of document in bytes. A file with smaller size will be filtered out.

Default: null
mime_types
list[string]

List of mime types to filter out (must match ^.+/.+$).

Default: ["image/gif"]
file_name_regexes
object

Regular expressions in re2 format (for more info about syntax see docs). A file with matching name will be filtered out.

Default: null

Type: string

Type: null

dmarc_check_action*
"accept" | "drop"

Decides what to do with incoming emails, that don't pass the DMARC check.

Default: "accept"
modified_by*
read-only
URL

User that last modified the object.

modified_at*
read-only
datetime

Timestamp of last modification.

400Bad Request

Invalid input data.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

401Unauthorized

The username/password is invalid or token is invalid (e.g. expired).

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

403Forbidden

Insufficient permission, missing authentication, invalid CSRF token and similar issue.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

404Not Found

The specified resource was not found.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

409Conflict

Conflict

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

413

Payload too large (especially for files uploaded).

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

429Too Many Requests

Request rate is too high, wait before sending more requests. See Rate Limiting for more details.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

url
read-only
string

Link to the rate limiting documentation

500Internal Server Error

Server failure while processing the request.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

502Bad Gateway

Invalid response from the upstream server.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

503Service Unavailable

We're temporarily offline for maintenance. Please try again later.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

504

Upstream server could not complete the request in time.

Attribute
Type
Description
detail
read-only
string

Detail of the error

code
read-only
string

Code of the error

GETRetrieve hook template

Previous Page

GETList inboxes

Next Page