@adcp/client API Reference - v4.19.0
    Preparing search index...

    Interface SIIdentity

    User identity shared with brand agent (with explicit consent)

    interface SIIdentity {
        consent_granted: boolean;
        consent_timestamp?: string;
        consent_scope?: (
            "email"
            | "name"
            | "phone"
            | "shipping_address"
            | "locale"
        )[];
        privacy_policy_acknowledged?: {
            brand_policy_url?: string;
            brand_policy_version?: string;
        };
        user?: {
            email?: string;
            name?: string;
            locale?: string;
            phone?: string;
            shipping_address?: {
                street?: string;
                city?: string;
                state?: string;
                postal_code?: string;
                country?: string;
            };
        };
        anonymous_session_id?: string;
    }
    Index

    Properties

    consent_granted consent_timestamp? consent_scope? privacy_policy_acknowledged? user? anonymous_session_id?

    Properties

    consent_granted: boolean

    Whether user consented to share identity

    consent_timestamp?: string

    When consent was granted (ISO 8601)

    consent_scope?: ("email" | "name" | "phone" | "shipping_address" | "locale")[]

    What data was consented to share

    privacy_policy_acknowledged?: {
        brand_policy_url?: string;
        brand_policy_version?: string;
    }

    Brand privacy policy acknowledgment

    Type Declaration

    • Optionalbrand_policy_url?: string

      URL to brand's privacy policy

    • Optionalbrand_policy_version?: string

      Version of policy acknowledged

    user?: {
        email?: string;
        name?: string;
        locale?: string;
        phone?: string;
        shipping_address?: {
            street?: string;
            city?: string;
            state?: string;
            postal_code?: string;
            country?: string;
        };
    }

    User data (only present if consent_granted is true)

    Type Declaration

    • Optionalemail?: string

      User's email address

    • Optionalname?: string

      User's display name

    • Optionallocale?: string

      User's locale (e.g., en-US)

    • Optionalphone?: string

      User's phone number

    • Optionalshipping_address?: {
          street?: string;
          city?: string;
          state?: string;
          postal_code?: string;
          country?: string;
      }

      User's shipping address for accurate pricing

    anonymous_session_id?: string

    Session ID for anonymous users (when consent_granted is false)

    Settings

    Member Visibility

    On This Page

    Properties