Get Business Cards

GET 
/api/v8/partner/business-cards

Get Business Cards

Request

Query Parameters

meta.tags array
Return documents containing these tags.
Example: a
meta.external_id string
Return documents with this meta.external_id.
Example: 123f-2aa-33cc
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
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
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.

q string
Case sensitive. Return documents with this text or any extracted fields matching the value. Use asterisk for partial matches, e.g. q=Walmart* will return documents with either Walmart in ocr text or any extracted field containing Walmart.
Example: Starbucks
track_total_results boolean

Whether to always return accurate count of results, true makes it slower.

Responses

200

A list of Business Cards

application/json

Schema

Schema

anyOf
API_V8_PARTNER_BUSINESSCARDS_LISTRESPONSESCHEMA
count integerrequired
The total number of results retrieved across all pages.
next (string | null)
The URL to the next page of results.
previous (string | null)
The URL to the previous page of results.
results object[]required
The collection of processed Business Card documents
Array [
external_id (string | null)
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.
meta object
external_id (string | null)
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.
pages object[]
Array [
ocr_score (number | null)
Possible values: <= 1
The average OCR score of the page.
width (integer | null)
The width of the page.
height (integer | null)
The height of the page.
]
tags string[]
Possible values: non-empty
Default value: ``
Tags associated with the document.
ocr_score (number | null)
Possible values: <= 1
The average OCR score of the whole document.
model (string | null)
Possible values: non-empty
The version of the model used to process the document.
text (string | null)
The text returned from converting the document into a machine-readable text format.
id integerrequired
The unique number created to identify the document.
created_date date-timerequired
updated_date date-timerequired
organization (string | null)required
The name of the business found on the document.
logo_url object required
A signed URL to the logo for the organization found on the document. The URL expires 15 minutes after the Document Response is returned and is re-assigned on every GET request.
anyOf
MOD1
string
MOD2
string
img_url object required
anyOf
MOD1
string
MOD2
string
person (string | null)required
The full name of the individual found on the document.
parsed_name objectrequired
An object that represents the person found on the document.
family_name (string | null)
The last name or found on the document.
given_name (string | null)
The first name found on the document.
middle_name (string | null)
suffix (string | null)
prefix (string | null)
title (string | null)required
The job title of the person found on the document.
email (string | null)required
The email address found on the document.
address (string | null)required
The address found on the document.
parsed_address objectrequired
An object representing detailed address-related information on the document, such as the city, state, street address, unit number, etc.
building (string | null)
Possible values: non-empty
The building name e.g. 'Project 8' or 'Empire State Building'
city (string | null)
Possible values: non-empty
The settlement including cities, towns, villages, hamlets, localities, etc.
country (string | null)
Possible values: non-empty
The sovereign nations and their dependent territories, anything with an ISO-3166 code.
country_alpha_2 (string | null)
Possible values: non-empty
The detected ISO 3166-1 alpha-2 code for a given country.
postcode (string | null)
Possible values: non-empty
The postal code used for mail sorting
state (string | null)
Possible values: non-empty
A first-level administrative division. Scotland, Northern Ireland, Wales, and England in the UK are mapped to "state" as well
street_address (string | null)
Possible values: non-empty
A sum of house_number road, building, unit.
house (string | null)
Possible values: non-empty
The venue name e.g. "Brooklyn Academy of Music", and building names e.g. "Empire State Building".
house_number (string | null)
Possible values: non-empty
Usually refers to the external (street-facing) building number. In some countries this may be a compound, hyphenated number, which also includes an apartment number, or a block number (a la Japan).
road (string | null)
Possible values: non-empty
Street name(s)
unit (string | null)
Possible values: non-empty
An apartment, unit, office, lot, or other secondary unit designator.
level (string | null)
Possible values: non-empty
The expressions indicating a floor number e.g. "3rd Floor", "Ground Floor", etc.
staircase (string | null)
Possible values: non-empty
Numbered/lettered staircase
entrance (string | null)
Possible values: non-empty
Numbered/lettered entrance
po_box (string | null)
Possible values: non-empty
The post office box, typically found in non-physical (mail-only) addresses.
suburb (string | null)
Possible values: non-empty
An unofficial neighborhood name like "Harlem", "South Bronx", or "Crown Heights".
city_district (string | null)
Possible values: non-empty
The boroughs or districts within a city that serve some official purpose e.g. "Brooklyn" or "Hackney" or "Bratislava IV".
island (string | null)
Possible values: non-empty
Named islands e.g. "Maui"
state_district (string | null)
Possible values: non-empty
Usually a second-level administrative division or county.
country_region (string | null)
Possible values: non-empty
Informal subdivision of a country without any political status.
world_region (string | null)
Possible values: non-empty
Only used for appending "West Indies" after the country name, a pattern frequently used in the English-speaking Caribbean e.g. "Jamaica, West Indies".
mobile (string | null)required
The mobile number found on the document.
phone (string | null)required
The phone number found on the document.
phones string[]
All phone numbers found on the document.
fax (string | null)required
The fax number found on the document.
faxes string[]
All fax numbers found on the document.
web (string | null)required
The web page found on the document.
]
API_V8_PARTNER_BUSINESSCARDS_DETAILEDLISTRESPONSESCHEMA
count integerrequired
The total number of results retrieved across all pages.
next (string | null)
The URL to the next page of results.
previous (string | null)
The URL to the previous page of results.
results object[]required
The collection of processed Business Card documents
Array [
external_id (string | null)
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.
meta object
external_id (string | null)
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.
pages object[]
Array [
ocr_score (number | null)
Possible values: <= 1
The average OCR score of the page.
width (integer | null)
The width of the page.
height (integer | null)
The height of the page.
]
tags string[]
Possible values: non-empty
Default value: ``
Tags associated with the document.
ocr_score (number | null)
Possible values: <= 1
The average OCR score of the whole document.
model (string | null)
Possible values: non-empty
The version of the model used to process the document.
text (string | null)
The text returned from converting the document into a machine-readable text format.
id integerrequired
The unique number created to identify the document.
created_date date-timerequired
updated_date date-timerequired
organization objectrequired
The name of the business found on the document.
score (number | null)
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.
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.
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
]
ocr_score (number | null)
Possible values: <= 1
The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.
rotation (integer | null)
Possible values: [0, 90, 180, 270]
The angle of rotation of the document in degrees.
value (string | null)required
Possible values: non-empty
The extracted value.
logo_url objectrequired
A signed URL to the logo for the organization found on the document. The URL expires 15 minutes after the Document Response is returned and is re-assigned on every GET request.
score (number | null)
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.
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.
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
]
ocr_score (number | null)
Possible values: <= 1
The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.
rotation (integer | null)
Possible values: [0, 90, 180, 270]
The angle of rotation of the document in degrees.
value (string | null)required
Possible values: non-empty
The extracted value.
img_url object required
anyOf
MOD1
string
MOD2
string
person objectrequired
The full name of the individual found on the document.
score (number | null)
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.
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.
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
]
ocr_score (number | null)
Possible values: <= 1
The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.
rotation (integer | null)
Possible values: [0, 90, 180, 270]
The angle of rotation of the document in degrees.
value (string | null)required
Possible values: non-empty
The extracted value.
parsed_name objectrequired
An object that represents the person found on the document.
family_name object
The last name or found on the document.
score (number | null)
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.
value (string | null)required
Possible values: non-empty
The extracted value.
given_name object
The first name found on the document.
score (number | null)
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.
value (string | null)required
Possible values: non-empty
The extracted value.
middle_name object
score (number | null)
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.
value (string | null)required
Possible values: non-empty
The extracted value.
suffix object
score (number | null)
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.
value (string | null)required
Possible values: non-empty
The extracted value.
prefix object
score (number | null)
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.
value (string | null)required
Possible values: non-empty
The extracted value.
title objectrequired
The job title of the person found on the document.
score (number | null)
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.
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.
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
]
ocr_score (number | null)
Possible values: <= 1
The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.
rotation (integer | null)
Possible values: [0, 90, 180, 270]
The angle of rotation of the document in degrees.
value (string | null)required
Possible values: non-empty
The extracted value.
email objectrequired
The email address found on the document.
score (number | null)
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.
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.
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
]
ocr_score (number | null)
Possible values: <= 1
The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.
rotation (integer | null)
Possible values: [0, 90, 180, 270]
The angle of rotation of the document in degrees.
value (string | null)required
Possible values: non-empty
The extracted value.
address objectrequired
The address found on the document.
score (number | null)
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.
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.
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
]
ocr_score (number | null)
Possible values: <= 1
The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.
rotation (integer | null)
Possible values: [0, 90, 180, 270]
The angle of rotation of the document in degrees.
value (string | null)required
Possible values: non-empty
The extracted value.
parsed_address objectrequired
An object representing detailed address-related information on the document, such as the city, state, street address, unit number, etc.
building object
The building name e.g. 'Project 8' or 'Empire State Building'
score (number | null)
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.
value (string | null)required
Possible values: non-empty
The extracted value.
city object
The settlement including cities, towns, villages, hamlets, localities, etc.
score (number | null)
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.
value (string | null)required
Possible values: non-empty
The extracted value.
country object
The sovereign nations and their dependent territories, anything with an ISO-3166 code.
score (number | null)
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.
value (string | null)required
Possible values: non-empty
The extracted value.
country_alpha_2 object
The detected ISO 3166-1 alpha-2 code for a given country.
score (number | null)
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.
value (string | null)required
Possible values: non-empty
The extracted value.
postcode object
The postal code used for mail sorting
score (number | null)
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.
value (string | null)required
Possible values: non-empty
The extracted value.
state object
A first-level administrative division. Scotland, Northern Ireland, Wales, and England in the UK are mapped to "state" as well
score (number | null)
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.
value (string | null)required
Possible values: non-empty
The extracted value.
street_address object
A sum of house_number road, building, unit.
score (number | null)
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.
value (string | null)required
Possible values: non-empty
The extracted value.
house object
The venue name e.g. "Brooklyn Academy of Music", and building names e.g. "Empire State Building".
score (number | null)
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.
value (string | null)required
Possible values: non-empty
The extracted value.
house_number object
Usually refers to the external (street-facing) building number. In some countries this may be a compound, hyphenated number, which also includes an apartment number, or a block number (a la Japan).
score (number | null)
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.
value (string | null)required
Possible values: non-empty
The extracted value.
road object
Street name(s)
score (number | null)
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.
value (string | null)required
Possible values: non-empty
The extracted value.
unit object
An apartment, unit, office, lot, or other secondary unit designator.
score (number | null)
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.
value (string | null)required
Possible values: non-empty
The extracted value.
level object
The expressions indicating a floor number e.g. "3rd Floor", "Ground Floor", etc.
score (number | null)
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.
value (string | null)required
Possible values: non-empty
The extracted value.
staircase object
Numbered/lettered staircase
score (number | null)
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.
value (string | null)required
Possible values: non-empty
The extracted value.
entrance object
Numbered/lettered entrance
score (number | null)
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.
value (string | null)required
Possible values: non-empty
The extracted value.
po_box object
The post office box, typically found in non-physical (mail-only) addresses.
score (number | null)
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.
value (string | null)required
Possible values: non-empty
The extracted value.
suburb object
An unofficial neighborhood name like "Harlem", "South Bronx", or "Crown Heights".
score (number | null)
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.
value (string | null)required
Possible values: non-empty
The extracted value.
city_district object
The boroughs or districts within a city that serve some official purpose e.g. "Brooklyn" or "Hackney" or "Bratislava IV".
score (number | null)
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.
value (string | null)required
Possible values: non-empty
The extracted value.
island object
Named islands e.g. "Maui"
score (number | null)
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.
value (string | null)required
Possible values: non-empty
The extracted value.
state_district object
Usually a second-level administrative division or county.
score (number | null)
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.
value (string | null)required
Possible values: non-empty
The extracted value.
country_region object
Informal subdivision of a country without any political status.
score (number | null)
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.
value (string | null)required
Possible values: non-empty
The extracted value.
world_region object
Only used for appending "West Indies" after the country name, a pattern frequently used in the English-speaking Caribbean e.g. "Jamaica, West Indies".
score (number | null)
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.
value (string | null)required
Possible values: non-empty
The extracted value.
mobile objectrequired
The mobile number found on the document.
score (number | null)
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.
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.
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
]
ocr_score (number | null)
Possible values: <= 1
The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.
rotation (integer | null)
Possible values: [0, 90, 180, 270]
The angle of rotation of the document in degrees.
value (string | null)required
Possible values: non-empty
The extracted value.
phone objectrequired
The phone number found on the document.
score (number | null)
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.
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.
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
]
ocr_score (number | null)
Possible values: <= 1
The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.
rotation (integer | null)
Possible values: [0, 90, 180, 270]
The angle of rotation of the document in degrees.
value (string | null)required
Possible values: non-empty
The extracted value.
phones object[]
All phone numbers found on the document.
Array [
score (number | null)
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.
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.
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
]
ocr_score (number | null)
Possible values: <= 1
The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.
rotation (integer | null)
Possible values: [0, 90, 180, 270]
The angle of rotation of the document in degrees.
value (string | null)required
Possible values: non-empty
The extracted value.
]
fax objectrequired
The fax number found on the document.
score (number | null)
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.
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.
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
]
ocr_score (number | null)
Possible values: <= 1
The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.
rotation (integer | null)
Possible values: [0, 90, 180, 270]
The angle of rotation of the document in degrees.
value (string | null)required
Possible values: non-empty
The extracted value.
faxes object[]
All fax numbers found on the document.
Array [
score (number | null)
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.
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.
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
]
ocr_score (number | null)
Possible values: <= 1
The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.
rotation (integer | null)
Possible values: [0, 90, 180, 270]
The angle of rotation of the document in degrees.
value (string | null)required
Possible values: non-empty
The extracted value.
]
web objectrequired
The web page found on the document.
score (number | null)
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.
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.
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
]
ocr_score (number | null)
Possible values: <= 1
The score which shows how confident the model in recognizing value symbols. See confidence scores explained for more information.
rotation (integer | null)
Possible values: [0, 90, 180, 270]
The angle of rotation of the document in degrees.
value (string | null)required
Possible values: non-empty
The extracted value.
]

Example (from schema)

{}

Loading...