@adcp/sdk API Reference - v7.9.0
    Preparing search index...

    Interface GetBrandIdentityRequest

    Request brand identity data from a brand agent. Core identity (house, names, description, logos) is always public. Linked accounts get deeper data: high-res assets, voice configs, tone guidelines, and rights availability.

    interface GetBrandIdentityRequest {
        adcp_major_version?: number;
        brand_id: string;
        fields?: (
            | "description"
            | "industries"
            | "keller_type"
            | "logos"
            | "colors"
            | "fonts"
            | "visual_guidelines"
            | "tone"
            | "tagline"
            | "voice_synthesis"
            | "assets"
            | "rights"
        )[];
        use_case?: string;
        context?: ContextObject;
        ext?: ExtensionObject;
    }
    Index

    Properties

    adcp_major_version?: number

    The AdCP major version the buyer's payloads conform to. Sellers validate against their supported major_versions and return VERSION_UNSUPPORTED if unsupported. When omitted, the seller assumes its highest supported version.

    1

    99

    brand_id: string

    Brand identifier from brand.json brands array

    fields?: (
        | "description"
        | "industries"
        | "keller_type"
        | "logos"
        | "colors"
        | "fonts"
        | "visual_guidelines"
        | "tone"
        | "tagline"
        | "voice_synthesis"
        | "assets"
        | "rights"
    )[]

    Optional identity sections to include in the response. When omitted, all sections the caller is authorized to see are returned. Core fields (brand_id, house, names) are always returned and do not need to be requested.

    use_case?: string

    Intended use case, so the agent can tailor the response. A 'voice_synthesis' use case returns voice configs; a 'likeness' use case returns high-res photos and appearance guidelines.

    context?: ContextObject
    ext?: ExtensionObject