Mobile Locker JavaScript SDK
    Preparing search index...

    Interface BusinessCard

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

    interface BusinessCard {
        address: string;
        attendee_id: string | null;
        company: string;
        created_at: string | null;
        crm_id: string;
        crm_object_type: string;
        email: string;
        event_id: number;
        first_name: string;
        http_status: number;
        id: string;
        image_back_uri: string | null;
        image_back_url: string | null;
        image_front_uri: string | null;
        image_front_url: string | null;
        job_title: string;
        last_name: string;
        name: string;
        phone: string;
        raw_string: string;
        source: string;
        status: string;
        team_id: number;
        title: string;
        updated_at: string | null;
        url: string;
        user_id: number;
        verified: boolean;
        website: string;
    }
    Index

    Properties

    address attendee_id company created_at crm_id crm_object_type email event_id first_name http_status id image_back_uri image_back_url image_front_uri image_front_url job_title last_name name phone raw_string source status team_id title updated_at url user_id verified website

    Properties

    address: string
    attendee_id: string | null

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

    company: string
    created_at: string | null
    crm_id: string

    CRM record ID this card was matched to.

    crm_object_type: string

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

    email: string
    event_id: number
    first_name: string
    http_status: number
    id: string
    image_back_uri: string | null
    image_back_url: string | null
    image_front_uri: string | null
    image_front_url: string | null
    job_title: string

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

    last_name: string
    name: string
    phone: string
    raw_string: string

    Raw JSON string of the original scanned data.

    source: string

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

    status: string
    team_id: number
    title: string
    updated_at: string | null
    url: string

    URL to the scanned card image.

    user_id: number
    verified: boolean

    Whether the card data has been verified against CRM records.

    website: string

    Settings

    Member Visibility

    On This Page

    Properties