Skip to main content

Process a Business Card

POST 
/api/v7/partner/business-cards

Veryfi's Process a Business Card endpoint allows you to submit and extract data from unstructured documents into valuable business insights. The Process a Business Card endpoint enables you to submit supported file formats and retrieve extracted data in JSON format.

See Business Card FAQ for more information such as common business card fields, and how Veryfi handles them.

Request​

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.

    auto_delete boolean

    Default value: false

    Delete this business_card from Veryfi after data has been extracted

Responses​

Processed Business Card response

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

    organization stringrequired

    The name of the business found on the document.

    logo_url uri

    Possible values: non-empty and <= 2083 characters

    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.

    person stringrequired

    The full name of the individual found on the document.

    parsed_name object
    family_name stringrequired

    The last name or found on the document.

    given_name stringrequired

    The first name found on the document.

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

Loading...