@cfxlabsinc/b2b-services
    Preparing search index...

    Interface RepresentativeInput

    interface RepresentativeInput {
        citizenship?: string;
        date_of_birth?: string;
        email: string;
        first_name: string;
        is_signer: boolean;
        job_title?: string;
        last_name: string;
        ownership_percentage?: number;
        phone?: string;
        residential_address?: string;
        residential_address2?: string;
        residential_city?: string;
        residential_country?: string;
        residential_postal_code?: string;
        residential_state_province_region?: string;
        responsibility:
            | "ultimate_beneficial_owner"
            | "authorized_representative"
            | "director";
        tax_number?: string;
    }
    Index
    citizenship? date_of_birth? email first_name is_signer job_title? last_name ownership_percentage? phone? residential_address? residential_address2? residential_city? residential_country? residential_postal_code? residential_state_province_region? responsibility tax_number?
    citizenship?: string

    ISO-3166-1 alpha-2 country of citizenship. Marked optional by RF's schema but demanded at FINALIZE, not at create — finalizeEntity returns it in missingKeys for a representative that lacks it, which is why an entity could be created with every representative accepted and still be refused at submission. The same is true of tax_number, residential_state_province_region, and residential_postal_code.

    date_of_birth?: string
    email: string
    first_name: string
    is_signer: boolean

    Exactly one representative on an entity may be true.

    job_title?: string
    last_name: string
    ownership_percentage?: number
    phone?: string

    Full E.164 phone number, including the leading + — RF derives the representative's country by parsing it (there is no phone_country).

    residential_address?: string
    residential_address2?: string
    residential_city?: string
    residential_country?: string
    residential_postal_code?: string

    RF-required at finalize — see citizenship.

    residential_state_province_region?: string

    e.g. US state. RF-required at finalize — see citizenship.

    responsibility:
        | "ultimate_beneficial_owner"
        | "authorized_representative"
        | "director"
    tax_number?: string

    The representative's own tax identification number (SSN for a US citizen) — NOT the business's. RF-required at finalize; see citizenship.

    Settings
    Member Visibility

    On This Page
    Properties