Process a Check

POST 
/api/v8/partner/checks

Veryfi's Process a Check endpoint allows you to submit and extract data from unstructured documents into valuable business insights. Supports .heif,.zip,.pdf,.heic,.webp,.jpeg,.jpg,.png. Max file size is 20mb.

Request

application/json

Body

file_data string

Used to upload a document via base64 encoded string, could be raw or data URI scheme. This is the least effective way to upload a document for processing. See file_urls or uploading zip files.

file_url string

A URL to a publicly accessible document to be sent to Veryfi for processing.

file_urls string[]

An array of URLs to publicly accessible documents to be sent to Veryfi for processing.

package_path string

A path to a file in an S3 bucket, e.g. 'some/receipt.jpg

bucket string

An S3 bucket for 'package_path', e.g. 'documents'.

file_name string

An optional filename. Useful to determine file type.

detailed booleandeprecated

This field was deprecated on 2023-08-20. Use bounding_boxes and confidence_details.

bounding_boxes boolean

A field used to determine whether or not to return bounding_box and bounding_region for extracted fields in the Document response.

confidence_details boolean

A field used to determine whether or not to return the score and ocr_score fields in the Document response.

multipart/form-data

Body

file_data string

Used to upload a document via base64 encoded string, could be raw or data URI scheme. This is the least effective way to upload a document for processing. See file_urls or uploading zip files.

file_url string

A URL to a publicly accessible document to be sent to Veryfi for processing.

file_urls string[]

An array of URLs to publicly accessible documents to be sent to Veryfi for processing.

package_path string

A path to a file in an S3 bucket, e.g. 'some/receipt.jpg

bucket string

An S3 bucket for 'package_path', e.g. 'documents'.

file_name string

An optional filename. Useful to determine file type.

file binary

A binary file. Submitting zipped documents through this parameter is the fastest way to process any document.

detailed booleandeprecated

This field was deprecated on 2023-08-20. Use bounding_boxes and confidence_details.

bounding_boxes boolean

A field used to determine whether or not to return bounding_box and bounding_region for extracted fields in the Document response.

confidence_details boolean

A field used to determine whether or not to return the score and ocr_score fields in the Document response.

Responses

201

A processed Check response.

application/json

Schema

Schema

anyOf

Check

pdf_url urirequired

Possible values: non-empty and <= 2083 characters

A signed URL to access the auto-generated PDF created from the submitted document. This URL expires 15 minutes after the response object is returned and is resigned during every GET request.

id integerrequired

The unique number created to identify the document.

text stringrequired

The text returned from converting the document into a machine-readable text format.

amount number

Possible values: > 0

The numeric value representing the amount found on the document.

amount_text string

The value as a string representing the amount found on the document.

bank_address string

The address of the bank.

bank_name string

The name of the bank.

fractional_routing_number string

The numbers appearing as the denominator of a fraction that is printed in the upper portion of a check.

routing_from_fractional stringrequired

The routing number from the found in the fractional_routing_number.

micr object

routing_number string

The bank routing number.

account_number string

The bank account number.

serial_number string

The serial number on personal checks.

raw string

The text returned from converting the document into a machine-readable text format.

check_number string

The check number.

date string

The date in ISO 8601 format. Typically found on invoices.

memo string

The description found in the memo line of the check.

payer_address string

The address of the payer.

payer_name string

The name of the payer.

receiver_address string

The address of the receiver.

receiver_name string

The name of the receiver.

DetailedCheck

pdf_url urirequired

Possible values: non-empty and <= 2083 characters

A signed URL to access the auto-generated PDF created from the submitted document. This URL expires 15 minutes after the response object is returned and is resigned during every GET request.

id integerrequired

The unique number created to identify the document.

text stringrequired

The text returned from converting the document into a machine-readable text format.

amount object

bounding_box object[]

Possible values: >= 5, <= 5

An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

Array [

anyOf

MOD1

number

MOD2

integer

]

bounding_region number[]

Possible values: >= 8, <= 8

An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

ocr_score number

Possible values: <= 1

The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

score number

Possible values: <= 1

The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.

rotation integer

Possible values: [0, 90, 180, 270]

The angle of rotation of the document in degrees.

value numberrequired

Possible values: > 0

amount_text object

bounding_box object[]

Possible values: >= 5, <= 5

An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

Array [

anyOf

MOD1

number

MOD2

integer

]

bounding_region number[]

Possible values: >= 8, <= 8

An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

ocr_score number

Possible values: <= 1

The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

score number

Possible values: <= 1

The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.

rotation integer

Possible values: [0, 90, 180, 270]

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

bank_address object

bounding_box object[]

Possible values: >= 5, <= 5

An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

Array [

anyOf

MOD1

number

MOD2

integer

]

bounding_region number[]

Possible values: >= 8, <= 8

An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

ocr_score number

Possible values: <= 1

The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

score number

Possible values: <= 1

The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.

rotation integer

Possible values: [0, 90, 180, 270]

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

bank_name object

bounding_box object[]

Possible values: >= 5, <= 5

An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

Array [

anyOf

MOD1

number

MOD2

integer

]

bounding_region number[]

Possible values: >= 8, <= 8

An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

ocr_score number

Possible values: <= 1

The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

score number

Possible values: <= 1

The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.

rotation integer

Possible values: [0, 90, 180, 270]

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

fractional_routing_number object

bounding_box object[]

Possible values: >= 5, <= 5

An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

Array [

anyOf

MOD1

number

MOD2

integer

]

bounding_region number[]

Possible values: >= 8, <= 8

An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

ocr_score number

Possible values: <= 1

The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

score number

Possible values: <= 1

The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.

rotation integer

Possible values: [0, 90, 180, 270]

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

routing_from_fractional object

bounding_box object[]

Possible values: >= 5, <= 5

An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

Array [

anyOf

MOD1

number

MOD2

integer

]

bounding_region number[]

Possible values: >= 8, <= 8

An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

ocr_score number

Possible values: <= 1

The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

score number

Possible values: <= 1

The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.

rotation integer

Possible values: [0, 90, 180, 270]

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

micr object

routing_number objectrequired

The bank routing number.

bounding_box object[]

Possible values: >= 5, <= 5

An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

Array [

anyOf

MOD1

number

MOD2

integer

]

bounding_region number[]

Possible values: >= 8, <= 8

An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

ocr_score number

Possible values: <= 1

The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

score number

Possible values: <= 1

The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.

rotation integer

Possible values: [0, 90, 180, 270]

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

account_number objectrequired

The bank account number.

bounding_box object[]

Possible values: >= 5, <= 5

An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

Array [

anyOf

MOD1

number

MOD2

integer

]

bounding_region number[]

Possible values: >= 8, <= 8

An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

ocr_score number

Possible values: <= 1

The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

score number

Possible values: <= 1

The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.

rotation integer

Possible values: [0, 90, 180, 270]

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

serial_number objectrequired

The serial number on personal checks.

bounding_box object[]

Possible values: >= 5, <= 5

An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

Array [

anyOf

MOD1

number

MOD2

integer

]

bounding_region number[]

Possible values: >= 8, <= 8

An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

ocr_score number

Possible values: <= 1

The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

score number

Possible values: <= 1

The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.

rotation integer

Possible values: [0, 90, 180, 270]

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

raw objectrequired

The text returned from converting the document into a machine-readable text format.

bounding_box object[]

Possible values: >= 5, <= 5

An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

Array [

anyOf

MOD1

number

MOD2

integer

]

bounding_region number[]

Possible values: >= 8, <= 8

An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

ocr_score number

Possible values: <= 1

The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

score number

Possible values: <= 1

The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.

rotation integer

Possible values: [0, 90, 180, 270]

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

check_number object

bounding_box object[]

Possible values: >= 5, <= 5

An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

Array [

anyOf

MOD1

number

MOD2

integer

]

bounding_region number[]

Possible values: >= 8, <= 8

An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

ocr_score number

Possible values: <= 1

The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

score number

Possible values: <= 1

The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.

rotation integer

Possible values: [0, 90, 180, 270]

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

date object

bounding_box object[]

Possible values: >= 5, <= 5

An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

Array [

anyOf

MOD1

number

MOD2

integer

]

bounding_region number[]

Possible values: >= 8, <= 8

An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

ocr_score number

Possible values: <= 1

The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

score number

Possible values: <= 1

The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.

rotation integer

Possible values: [0, 90, 180, 270]

The angle of rotation of the document in degrees.

value daterequired

memo object

bounding_box object[]

Possible values: >= 5, <= 5

An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

Array [

anyOf

MOD1

number

MOD2

integer

]

bounding_region number[]

Possible values: >= 8, <= 8

An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

ocr_score number

Possible values: <= 1

The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

score number

Possible values: <= 1

The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.

rotation integer

Possible values: [0, 90, 180, 270]

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

payer_address object

bounding_box object[]

Possible values: >= 5, <= 5

An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

Array [

anyOf

MOD1

number

MOD2

integer

]

bounding_region number[]

Possible values: >= 8, <= 8

An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

ocr_score number

Possible values: <= 1

The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

score number

Possible values: <= 1

The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.

rotation integer

Possible values: [0, 90, 180, 270]

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

payer_name object

bounding_box object[]

Possible values: >= 5, <= 5

An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

Array [

anyOf

MOD1

number

MOD2

integer

]

bounding_region number[]

Possible values: >= 8, <= 8

An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

ocr_score number

Possible values: <= 1

The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

score number

Possible values: <= 1

The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.

rotation integer

Possible values: [0, 90, 180, 270]

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

receiver_address object

bounding_box object[]

Possible values: >= 5, <= 5

An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

Array [

anyOf

MOD1

number

MOD2

integer

]

bounding_region number[]

Possible values: >= 8, <= 8

An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

ocr_score number

Possible values: <= 1

The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

score number

Possible values: <= 1

The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.

rotation integer

Possible values: [0, 90, 180, 270]

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

receiver_name object

bounding_box object[]

Possible values: >= 5, <= 5

An array containing relative coordinates in the format [page_number,x1,y1,x2,y2] for the extracted field from img_url before any rotation.

Array [

anyOf

MOD1

number

MOD2

integer

]

bounding_region number[]

Possible values: >= 8, <= 8

An array containing (x,y) coordinates in the format [x1,y1,x2,y2,x3,y3,x4,y4]` for skewed images and handwritten fields. The bounding region is more precise than bounding box, otherwise it's the same.

ocr_score number

Possible values: <= 1

The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.

score number

Possible values: <= 1

The score shows how confident the model is that the predicted value belongs to the field. See confidence scores explained for more information.

rotation integer

Possible values: [0, 90, 180, 270]

The angle of rotation of the document in degrees.

value stringrequired

Possible values: non-empty

The extracted value.

Example (from schema)

{}

400

User error

application/json

Schema

Schema

oneOf

COULDNT_DOWNLOAD_FILE_FROM_PROVIDED_URL

status string

Default value: fail

error string

Default value: Couldn't download file from provided url.

details undefined[]

Default value: [object Object]

RECEIVED_EMPTY_OR_MISSING_DATA

status string

Default value: fail

error string

Default value: Received empty or missing data

Example (from schema)

{}

404

Not found

application/json

Schema

Schema

oneOf

NOT_FOUND

status string

Default value: fail

error string

Default value: Not found.

DOCUMENT_NOT_FOUND

status string

Default value: fail

error string

Default value: Document Not Found

Example (from schema)

{}

429

Rate limit

application/json

Schema

Schema

oneOf

YOU_HAVE_BEEN_RATE_LIMITED

status string

Default value: fail

error string

Default value: You have been rate limited

details undefined[]

Default value: [object Object]

Example (from schema)

{}

499

User error

application/json

Schema

Schema

oneOf

CLIENT_CLOSED_REQUEST_OR_LOST_CONNECTION

status string

Default value: fail

error string

Default value: Client closed request or lost connection

Example (from schema)

{}

503

Service is temporaly unavailable

application/json

Schema

Schema

oneOf

SERVICE_IS_TEMPORALY_UNAVAILABLE_PLEASE_TRY_AGAIN_LATER

status string

Default value: fail

error string

Default value: Service is temporaly unavailable. Please try again later

Example (from schema)

{}

default

OperationStatus

application/json

Schema

Schema

error stringrequired
details object[]
status string

Default value: fail

Example (from schema)

{
  "error": "string",
  "details": [
    {}
  ],
  "status": "fail"
}

Loading...