Get a Business Card

GET 
/api/v7/partner/business-cards/:document_id

Veryfi's Get a Business Card endpoint allows you to retrieve a previously processed Business Card.

Request

Path Parameters

document_id int64required

The unique identifier of the document.

Query Parameters

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.

Responses

200

Returns a processed Business Card.

application/json

Schema

Schema

anyOf

BusinessCard

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

text stringrequired

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

organization stringrequired

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 stringrequired

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

The last name or found on the document.

given_name string

The first name found on the document.

middle_name string

suffix string

prefix string

title stringrequired

The job title of the person found on the document.

email stringrequired

The email address found on the document.

address stringrequired

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.

city string

The settlement including cities, towns, villages, hamlets, localities, etc.

country string

The sovereign nations and their dependent territories, anything with an ISO-3166 code.

country_alpha_2 string

The detected ISO 3166-1 alpha-2 code for a given country.

postcode string

The postal code used for mail sorting

state string

A first-level administrative division. Scotland, Northern Ireland, Wales, and England in the UK are mapped to "state" as well

street_address string

A sum of house_number road, building, unit.

house string

The venue name e.g. "Brooklyn Academy of Music", and building names e.g. "Empire State Building".

house_number string

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

Street name(s)

unit string

An apartment, unit, office, lot, or other secondary unit designator.

level string

The expressions indicating a floor number e.g. "3rd Floor", "Ground Floor", etc.

staircase string

Numbered/lettered staircase

entrance string

Numbered/lettered entrance

po_box string

The post office box, typically found in non-physical (mail-only) addresses.

suburb string

An unofficial neighborhood name like "Harlem", "South Bronx", or "Crown Heights".

city_district string

The boroughs or districts within a city that serve some official purpose e.g. "Brooklyn" or "Hackney" or "Bratislava IV".

island string

Named islands e.g. "Maui"

state_district string

Usually a second-level administrative division or county.

country_region string

Informal subdivision of a country without any political status.

world_region string

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 stringrequired

The mobile number found on the document.

phone stringrequired

The phone number found on the document.

fax stringrequired

The fax number found on the document.

web stringrequired

The web page found on the document.

DetailedBusinessCardV8

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

text stringrequired

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

organization objectrequired

The name of the business 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.

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.

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.

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.

img_url object required

anyOf

MOD1

string

MOD2

string

person objectrequired

The full name of the individual 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.

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.

parsed_name objectrequired

An object that represents the person found on the document.

family_name string

The last name or found on the document.

given_name string

The first name found on the document.

middle_name string

suffix string

prefix string

title objectrequired

The job title of the person 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.

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.

email objectrequired

The email address 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.

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.

address objectrequired

The address 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.

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.

parsed_address objectrequired

An object representing detailed address-related information on the document, such as the city, state, street address, unit number, etc.

city string

The settlement including cities, towns, villages, hamlets, localities, etc.

country string

The sovereign nations and their dependent territories, anything with an ISO-3166 code.

country_alpha_2 string

The detected ISO 3166-1 alpha-2 code for a given country.

postcode string

The postal code used for mail sorting

state string

A first-level administrative division. Scotland, Northern Ireland, Wales, and England in the UK are mapped to "state" as well

street_address string

A sum of house_number road, building, unit.

house string

The venue name e.g. "Brooklyn Academy of Music", and building names e.g. "Empire State Building".

house_number string

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

Street name(s)

unit string

An apartment, unit, office, lot, or other secondary unit designator.

level string

The expressions indicating a floor number e.g. "3rd Floor", "Ground Floor", etc.

staircase string

Numbered/lettered staircase

entrance string

Numbered/lettered entrance

po_box string

The post office box, typically found in non-physical (mail-only) addresses.

suburb string

An unofficial neighborhood name like "Harlem", "South Bronx", or "Crown Heights".

city_district string

The boroughs or districts within a city that serve some official purpose e.g. "Brooklyn" or "Hackney" or "Bratislava IV".

island string

Named islands e.g. "Maui"

state_district string

Usually a second-level administrative division or county.

country_region string

Informal subdivision of a country without any political status.

world_region string

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 objectrequired

The mobile number 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.

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.

phone objectrequired

The phone number 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.

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.

fax objectrequired

The fax number 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.

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.

web objectrequired

The web page 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.

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)

{}

Loading...