# Get Business Cards

GET## /api/v7/partner/business-cards

Get Business Cards

## Request

### Query Parameters

**page**integer

**Default value:** `1`

The page number. The response is capped to maximum of 50 results per page.

**page_size**integer

**Default value:** `50`

The number of Documents per page.

**Example:**10

**detailed**boolean

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.

**created_date__gt**string

Return documents created after this date and time in ISO 8601 format.

**Example:**2022-05-03 00:00:00

**created_date__lt**string

Return documents created before this date and time in ISO 8601 format.

**Example:**2023-03-23 00:00:00

**created_date__gte**string

Return documents created beginning at this date and time in ISO 8601 format.

**Example:**2022-04-24 00:00:00

**created_date__lte**string

Return documents created on and before this date and time in ISO 8601 format.

**Example:**2020-10-15 00:00:00

**updated_date__gt**string

Return documents updated after this date and time in ISO 8601 format.

**Example:**2023-07-25 00:00:00

**updated_date__lt**string

Return documents updated before this date and time in ISO 8601 format.

**Example:**2019-03-18 00:00:00

**updated_date__gte**string

Return documents updated beginning at this date and time in ISO 8601 format.

**Example:**2020-02-03 00:00:00

**updated_date__lte**string

Return documents updated on and before this date and time in ISO 8601 format.

**Example:**2023-01-03 00:00:00

## Responses

- 200

A list of previously processed Business Cards.

- application/json

- Schema
- Example (from schema)

**Schema**

- W2SResponse
- DetailedChecks
- Array [
- Array [
- MOD1
- MOD2
- Array [
- ]
- ]
- Array [
- ]
- ]
- Array [
- Array [
- MOD1
- MOD2
- ]
- Array [
- MOD1
- MOD2
- ]
- Array [
- MOD1
- MOD2
- ]
- Array [
- MOD1
- MOD2
- ]
- Array [
- MOD1
- MOD2
- ]
- Array [
- MOD1
- MOD2
- ]
- Array [
- MOD1
- MOD2
- ]
- Array [
- MOD1
- MOD2
- ]
- Array [
- MOD1
- MOD2
- ]
- Array [
- MOD1
- MOD2
- ]
- Array [
- MOD1
- MOD2
- ]
- Array [
- MOD1
- MOD2
- ]
- Array [
- MOD1
- MOD2
- ]
- Array [
- MOD1
- MOD2
- ]
- Array [
- MOD1
- MOD2
- ]
- Array [
- MOD1
- MOD2
- ]
- Array [
- MOD1
- MOD2
- ]
- Array [
- MOD1
- MOD2
- ]
- Array [
- MOD1
- MOD2
- ]
- Array [
- MOD1
- MOD2
- ]
- ]

**count**integerrequired

The total number of results retrieved across all pages.

**next**stringrequired

The URL to the next page of results.

**previous**stringrequired

The URL to the previous page of results.

**results** object[]required

The collection of W-2 Documents processed by the W-2 Splitter.

**pdf_url**uri

**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.

**external_id**string

**Possible values:** `non-empty`

A custom identification value. Use this if you would like to assign your own ID to documents. This parameter is useful when mapping this document to a service or resource outside Veryfi.

**created_date**date-timerequired

**updated_date**date-timerequired

**img_thumbnail_url**uri

**Possible values:** `non-empty`

and `<= 2083 characters`

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

**advance_eic_payment**number

The total amount of any Earned Income Credit (EIC) payment found in Box 9 of the W-2.

**employee_ssn**string

The Social Security Number (SSN) found in Box A of the W-2.

**ein**string

The Employer Identification Number (EIN) found in Box B of the W-2.

**employer_name**string

The employer name found in Box C of the W-2.

**employer_address**string

The employer address found in Box C of the W-2.

**control_number**string

The control number found in Box D of the W-2.

**employee_name**string

The full name of the employee found in Box E of the W-2.

**employee_address**string

The address of the employee found in Box F of the W-2.

**wages_other_comps**number

The total taxable income paid found in Box 1 of the W-2.

**federal_income_tax**number

The total amount of federal income tax withheld found in Box of the W-2.

**ss_wages**number

The total wages subject to social security tax found in Box 3 of the W-2.

**ss_tax**number

The amount of social security tax withheld found in Box 4 of the W-2.

**medicare_wages**number

The total wages, tips and other compensation that are subject to Medicare taxes found in Box 5 of the W-2.

**medicare_tax**number

The amount of Medicare tax withheld from your Medicare taxable wages, tips and other compensation found in Box 6 of the W-2.

**ss_tips**number

The amount of earned money through tips found in Box 7 of the W-2.

**allocated_tips**number

The amount the employer allocated to tips found in Box 8 of the W-2.

**dependent_care_benefits**number

The amount the employer provided or paid for dependent care benefits found in Box 10 of the W-2.

**non_qualified_plans**number

The amount of retirement savings the employer sponsored and is tax deferred found in Box 11 of the W-2.

**state**string

The two-letter code representing the state found in Box 15 of the W-2. For example, California would be `CA`

.

**employer_state_id**string

The employer identification number found in Box 15 of the W-2.

**state_wages_tips**number

The employer identification number found in Box 15 of the W-2.

**state_income_tax**number

The total state income taxes that were withheld found in Box 17 of the W-2.

**local_wages_tips**number

The total local taxable gross pay found in Box 18 of the W-2.

**local_income_tax**number

The total local income tax withheld found in Box 19 of the W-2.

**locality_name**string

The locality name found in Box 20 of the W-2.

**field_12a_col1**string

The name of another type of compensation or reduction to taxable income found in Box 12 of the W-2. For example, health savings account contributions, group life insurance, 403(b) contributions, and more.

**field_12a_col2**number

The amount for other types of compensations or reduction to taxable income found in Box 12 of the W-2.

**field_12b_col1**string

The name of another type of compensation or reduction to taxable income found in Box 12 of the W-2. For example, health savings account contributions, group life insurance, 403(b) contributions, and more.

**field_12b_col2**number

The amount for other types of compensations or reduction to taxable income found in Box 12 of the W-2.

**field_12c_col1**string

The name of another type of compensation or reduction to taxable income found in Box 12 of the W-2. For example, health savings account contributions, group life insurance, 403(b) contributions, and more.

**field_12c_col2**number

The amount for other types of compensations or reduction to taxable income found in Box 12 of the W-2.

**field_12d_col1**string

**field_12d_col2**number

**is_13a**boolean

A checkbox field representing if the individual worked as a statutory employee found in Box 13 of the W-2.

**is_13b**boolean

A checkbox field representing if the individual participated in an employer sponsored retirement plan found in Box 13 of the W-2.

**is_13c**boolean

A checkbox field representing if the individual received sick pay through a third party source found in Box 13 of the W-2.

**states** object[]required

A collection of objects that represent state employer id, wages, tips, and more found in Box 15 - 20 of the W-2.

**state**string

The two-letter code representing the state found in Box 15 of the W-2. For example, California would be `CA`

.

**employer_state_id**string

The employer identification number found in Box 15 of the W-2.

**state_wages_tips**number

The total state taxable gross pay found in Box 16 of the W-2.

**state_income_tax**number

The total state income taxes that were withheld found in Box 17 of the W-2.

**local_wages_tips**number

The total local taxable gross pay found in Box 18 of the W-2.

**local_income_tax**number

The total local income tax withheld found in Box 19 of the W-2.

**locality_name** object

The locality name found in Box 20 of the W-2.

string

string

**field_14_other** object[]required

An object representing any other tax information that doesn't fit into other W-2 Boxes. For example, this field can be auto allowance, social club membership, travel reimbursement, and more.

**column_1**string

This field is used for any other tax information that doesn't fit into other W-2 Boxes. For example, this field can be auto allowance, social club membership, travel reimbursement, and more.

**column_2**number

The value for the additional tax information.

**count**integerrequired

The total number of results retrieved across all pages.

**next**stringrequired

The URL to the next page of results.

**previous**stringrequired

The URL to the previous page of results.

**results** object[]required

**pdf_url**uri

**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.

**external_id**string

**Possible values:** `non-empty`

A custom identification value. Use this if you would like to assign your own ID to documents. This parameter is useful when mapping this document to a service or resource outside Veryfi.

**created_date**date-timerequired

**updated_date**date-timerequired

**img_thumbnail_url**uri

**Possible values:** `non-empty`

and `<= 2083 characters`

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

**text**stringrequired

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

**amount** objectrequired

The numeric value representing the amount found on the document.

**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.

number

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

**amount_text** objectrequired

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

**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.

number

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** objectrequired

The address of the bank.

**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.

number

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** objectrequired

The name of the bank.

**bounding_box** object[]

**Possible values:** `>= 5`

, `<= 5`

`[page_number,x1,y1,x2,y2]`

for the extracted field from `img_url`

before any rotation.

number

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`

`value`

symbols. See confidence scores explained for more information.

**score**number

**Possible values:** `<= 1`

`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

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

**bounding_box** object[]

**Possible values:** `>= 5`

, `<= 5`

`[page_number,x1,y1,x2,y2]`

for the extracted field from `img_url`

before any rotation.

number

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`

`value`

symbols. See confidence scores explained for more information.

**score**number

**Possible values:** `<= 1`

`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** objectrequired

The routing number from the found in the `fractional_routing_number`

.

**bounding_box** object[]

**Possible values:** `>= 5`

, `<= 5`

`[page_number,x1,y1,x2,y2]`

for the extracted field from `img_url`

before any rotation.

number

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`

`value`

symbols. See confidence scores explained for more information.

**score**number

**Possible values:** `<= 1`

`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** objectrequired

An object containing the details for the Magnetic ink character recognition.

**routing_number** object

The bank routing number.

**bounding_box** object[]

**Possible values:** `>= 5`

, `<= 5`

`[page_number,x1,y1,x2,y2]`

for the extracted field from `img_url`

before any rotation.

number

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`

`value`

symbols. See confidence scores explained for more information.

**score**number

**Possible values:** `<= 1`

`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`

`[page_number,x1,y1,x2,y2]`

for the extracted field from `img_url`

before any rotation.

number

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`

`value`

symbols. See confidence scores explained for more information.

**score**number

**Possible values:** `<= 1`

`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** object

The serial number on personal checks.

**bounding_box** object[]

**Possible values:** `>= 5`

, `<= 5`

`[page_number,x1,y1,x2,y2]`

for the extracted field from `img_url`

before any rotation.

number

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`

`value`

symbols. See confidence scores explained for more information.

**score**number

**Possible values:** `<= 1`

`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** object

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

**bounding_box** object[]

**Possible values:** `>= 5`

, `<= 5`

`[page_number,x1,y1,x2,y2]`

for the extracted field from `img_url`

before any rotation.

number

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`

`value`

symbols. See confidence scores explained for more information.

**score**number

**Possible values:** `<= 1`

`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** objectrequired

The check number.

**bounding_box** object[]

**Possible values:** `>= 5`

, `<= 5`

`[page_number,x1,y1,x2,y2]`

for the extracted field from `img_url`

before any rotation.

number

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`

`value`

symbols. See confidence scores explained for more information.

**score**number

**Possible values:** `<= 1`

`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** objectrequired

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

**bounding_box** object[]

**Possible values:** `>= 5`

, `<= 5`

`[page_number,x1,y1,x2,y2]`

for the extracted field from `img_url`

before any rotation.

number

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`

`value`

symbols. See confidence scores explained for more information.

**score**number

**Possible values:** `<= 1`

`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** objectrequired

The description found in the memo line of the check.

**bounding_box** object[]

**Possible values:** `>= 5`

, `<= 5`

`[page_number,x1,y1,x2,y2]`

for the extracted field from `img_url`

before any rotation.

number

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`

`value`

symbols. See confidence scores explained for more information.

**score**number

**Possible values:** `<= 1`

`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** objectrequired

The address of the payer.

**bounding_box** object[]

**Possible values:** `>= 5`

, `<= 5`

`[page_number,x1,y1,x2,y2]`

for the extracted field from `img_url`

before any rotation.

number

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`

`value`

symbols. See confidence scores explained for more information.

**score**number

**Possible values:** `<= 1`

`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** objectrequired

The name of the payer.

**bounding_box** object[]

**Possible values:** `>= 5`

, `<= 5`

`[page_number,x1,y1,x2,y2]`

for the extracted field from `img_url`

before any rotation.

number

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`

`value`

symbols. See confidence scores explained for more information.

**score**number

**Possible values:** `<= 1`

`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** objectrequired

The address of the receiver.

**bounding_box** object[]

**Possible values:** `>= 5`

, `<= 5`

`[page_number,x1,y1,x2,y2]`

for the extracted field from `img_url`

before any rotation.

number

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`

`value`

symbols. See confidence scores explained for more information.

**score**number

**Possible values:** `<= 1`

`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** objectrequired

The name of the receiver.

**bounding_box** object[]

**Possible values:** `>= 5`

, `<= 5`

`[page_number,x1,y1,x2,y2]`

for the extracted field from `img_url`

before any rotation.

number

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`

`value`

symbols. See confidence scores explained for more information.

**score**number

**Possible values:** `<= 1`

`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.

**is_endorsed** objectdeprecated

deprecated and will be removed at 2024-11-10. Use endorsement.is_signed instead

**bounding_box** object[]

**Possible values:** `>= 5`

, `<= 5`

`[page_number,x1,y1,x2,y2]`

for the extracted field from `img_url`

before any rotation.

number

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`

`value`

symbols. See confidence scores explained for more information.

**score**number

**Possible values:** `<= 1`

`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**booleanrequired

**endorsement** object

An object containing the endorsement details

**is_signed** object

If check has signature and is endorsed on the back side.

**bounding_box** object[]

**Possible values:** `>= 5`

, `<= 5`

`[page_number,x1,y1,x2,y2]`

for the extracted field from `img_url`

before any rotation.

number

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`

`value`

symbols. See confidence scores explained for more information.

**score**number

**Possible values:** `<= 1`

`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**booleanrequired

**is_mobile_or_remote_deposit_only** object

If check is mobile or remote deposit only

**bounding_box** object[]

**Possible values:** `>= 5`

, `<= 5`

`[page_number,x1,y1,x2,y2]`

for the extracted field from `img_url`

before any rotation.

number

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`

`value`

symbols. See confidence scores explained for more information.

**score**number

**Possible values:** `<= 1`

`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**booleanrequired

`{}`