Interface SIIdentity

User identity shared with brand agent (with explicit consent)

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

Indexable

[k: string]: unknown

Index

Properties

consent_granted consent_timestamp? consent_scope? privacy_policy_acknowledged? user? anonymous_session_id?

Properties

consent_granted

consent_granted: boolean

Whether user consented to share identity

`Optional`consent_timestamp

consent_timestamp?: string

When consent was granted (ISO 8601)

`Optional`consent_scope

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

What data was consented to share

`Optional`privacy_policy_acknowledged

privacy_policy_acknowledged?: {
    brand_policy_url?: string;
    brand_policy_version?: string;
    [k: string]: unknown;
}

Brand privacy policy acknowledgment

Type Declaration

[k: string]: unknown
Optionalbrand_policy_url?: string
URL to brand's privacy policy
Optionalbrand_policy_version?: string
Version of policy acknowledged

`Optional`user

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

User data (only present if consent_granted is true)

Type Declaration

[k: string]: unknown
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;
    [k: string]: unknown;
}
User's shipping address for accurate pricing

`Optional`anonymous_session_id

anonymous_session_id?: string

Session ID for anonymous users (when consent_granted is false)

Interface SIIdentity

Indexable

Index

Properties

Properties

consent_granted

`Optional`consent_timestamp

`Optional`consent_scope

`Optional`privacy_policy_acknowledged

Type Declaration

[k: string]: unknown

`Optional`brand_policy_url?: string

`Optional`brand_policy_version?: string

`Optional`user

Type Declaration

[k: string]: unknown

`Optional`email?: string

`Optional`name?: string

`Optional`locale?: string

`Optional`phone?: string

`Optional`shipping_address?: {
    street?: string;
    city?: string;
    state?: string;
    postal_code?: string;
    country?: string;
    [k: string]: unknown;
}

`Optional`anonymous_session_id

Settings

On This Page

Interface SIIdentity

Indexable

Index

Properties

Properties

consent_granted

Optionalconsent_timestamp

Optionalconsent_scope

Optionalprivacy_policy_acknowledged

Type Declaration

[k: string]: unknown

Optionalbrand_policy_url?: string

Optionalbrand_policy_version?: string

Optionaluser

Type Declaration

[k: string]: unknown

Optionalemail?: string

Optionalname?: string

Optionallocale?: string

Optionalphone?: string

Optionalshipping_address?: { street?: string; city?: string; state?: string; postal_code?: string; country?: string; [k: string]: unknown;}

Optionalanonymous_session_id

Settings

On This Page

`Optional`consent_timestamp

`Optional`consent_scope

`Optional`privacy_policy_acknowledged

`Optional`brand_policy_url?: string

`Optional`brand_policy_version?: string

`Optional`user

`Optional`email?: string

`Optional`name?: string

`Optional`locale?: string

`Optional`phone?: string

`Optional`shipping_address?: {
street?: string;
city?: string;
state?: string;
postal_code?: string;
country?: string;
[k: string]: unknown;
}

`Optional`anonymous_session_id