@adcp/sdk API Reference - v10.0.1
    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_version?: string;
        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_version?: string

    Release-precision AdCP version (VERSION.RELEASE, e.g. "3.0", "3.1", "3.1-beta"). On a request: the buyer's release pin — the seller validates against its supported_versions and returns VERSION_UNSUPPORTED on cross-major mismatch, or downshifts to the highest supported release within the same major. On a response: the release the seller actually served — clients SHOULD validate the response against that release's schema, not against their pin. Patches are not negotiated; surface them as build_version on capabilities for operational visibility. When omitted, falls back to adcp_major_version (deprecated) or server default. Buyers SHOULD emit both adcp_version and adcp_major_version through 3.x to remain compatible with sellers that only read the legacy field. NORMALIZATION: SDKs that read full-semver values from bundle metadata (e.g. ComplianceIndex.published_version = "3.1.0-beta.1") MUST normalize to release-precision ("3.1-beta.1") before emitting on the wire — meta-field values are NOT valid wire values.

    adcp_major_version?: number

    DEPRECATED in favor of adcp_version (release-precision string). Servers MUST continue to honor this field through 3.x. Removed in 4.0. Original semantics: 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.

    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