Mobile Locker JavaScript SDK
    Preparing search index...

    Interface BusinessCard

    A business card captured via camera scan. Mirrors the iOS GRDBBusinessCard Swift model.

    interface BusinessCard {
        id: string;
        team_id: number;
        user_id: number;
        event_id: number;
        attendee_id: string | null;
        status: string;
        source: string;
        url: string;
        image_front_uri: string | null;
        image_back_uri: string | null;
        image_front_url: string | null;
        image_back_url: string | null;
        first_name: string;
        last_name: string;
        name: string;
        email: string;
        job_title: string;
        title: string;
        company: string;
        phone: string;
        website: string;
        address: string;
        crm_id: string;
        crm_object_type: string;
        verified: boolean;
        raw_string: string;
        http_status: number;
        created_at: string | null;
        updated_at: string | null;
        job: string | null;
        zip: string | null;
        city: string | null;
        state: string | null;
        country: string | null;
        address1: string | null;
        address2: string | null;
        note: string | null;
        degree: string | null;
        extra_name: string | null;
        phone_body: string | null;
        phone_code: string | null;
        middle_name: string | null;
        company_name: string | null;
        job_position: string | null;
        linkedin_url: string | null;
        mobile_phone: string | null;
        job_department: string | null;
        twitter_handle: string | null;
        linkedin_handle: string | null;
        phone_extension: string | null;
        phone_country_code: string | null;
    }
    Index

    Properties

    id team_id user_id event_id attendee_id status source url image_front_uri image_back_uri image_front_url image_back_url first_name last_name name email job_title title company phone website address crm_id crm_object_type verified raw_string http_status created_at updated_at job zip city state country address1 address2 note degree extra_name phone_body phone_code middle_name company_name job_position linkedin_url mobile_phone job_department twitter_handle linkedin_handle phone_extension phone_country_code

    Properties

    id: string
    team_id: number
    user_id: number
    event_id: number
    attendee_id: string | null

    Associated attendee ID if the card was linked to a badge scan.

    status: string
    source: string

    How the card was captured (e.g. 'scan', 'manual').

    url: string

    URL to the scanned card image.

    image_front_uri: string | null
    image_back_uri: string | null
    image_front_url: string | null
    image_back_url: string | null
    first_name: string
    last_name: string
    name: string

    Full name as parsed by OCR.

    email: string
    job_title: string

    Job title from the scanned card. Also available as title (legacy alias).

    title: string
    company: string
    phone: string
    website: string
    address: string
    crm_id: string

    CRM record ID this card was matched to.

    crm_object_type: string

    CRM object type (e.g. 'Contact', 'Lead').

    verified: boolean

    Whether the card data has been verified against CRM records.

    raw_string: string

    Raw JSON string of the original scanned data.

    http_status: number
    created_at: string | null
    updated_at: string | null
    job: string | null
    zip: string | null
    city: string | null
    state: string | null
    country: string | null
    address1: string | null
    address2: string | null
    note: string | null
    degree: string | null
    extra_name: string | null

    phone_body

    phone_body: string | null
    phone_code: string | null
    middle_name: string | null
    company_name: string | null
    job_position: string | null
    linkedin_url: string | null
    mobile_phone: string | null
    job_department: string | null
    twitter_handle: string | null
    linkedin_handle: string | null
    phone_extension: string | null
    phone_country_code: string | null

    Settings

    Member Visibility

    On This Page

    Properties