@adcp/sdk API Reference - v14.3.0
    Preparing search index...

    Interface AcquireRightsAcquired

    interface AcquireRightsAcquired {
        rights_id: string;
        rights_status: "acquired";
        brand_id: string;
        terms: RightsTerms;
        generation_credentials: GenerationCredential[];
        restrictions?: string[];
        disclosure?: { required: boolean; text?: string };
        approval_webhook?: PushNotificationConfig;
        usage_reporting_url?: string;
        rights_constraint: {
            rights_id: string;
            rights_agent: { url: string; id: string };
            rights_holder?: BrandReference;
            valid_from?: string;
            valid_until?: string;
            uses: [RightUse, ...RightUse[]];
            countries?: string[];
            excluded_countries?: string[];
            impression_cap?: number;
            right_type?: RightType;
            approval_status?: "rejected" | "approved" | "pending";
            grant_status?: "active" | "paused" | "revoked";
            restrictions?: [string, ...string[]];
            disclosure?: {};
            creative_approval_required?: boolean;
            verification_url?: string;
            content_digest?: string;
            attestation_refs?: (
                {
                    issuer: AttestationIssuer;
                    claim_type: string;
                    subject: AttestationSubject;
                    locator?: | AttestationCredentialUriLocator
                    | AttestationIssuerCredentialIdLocator;
                    embedded_credential?: {
                        format: string;
                        value: string
                        | {};
                        ext?: ExtensionObject;
                    };
                    content_digest?: string;
                    credential_version?: string;
                    validity_hint?: { not_before?: string; expires_at?: string };
                    verify_agent?: { agent_url: string };
                    ext?: ExtensionObject;
                } & {
                    issuer?: { type: "brand"; brand: BrandReference };
                    claim_type?: "https://adcontextprotocol.org/claims/rights/grant";
                    subject?: {
                        type: "resource";
                        resource_type: "https://adcontextprotocol.org/claims/subjects/rights-grant";
                    };
                }
            )[];
            ext?: ExtensionObject;
        } & {
            rights_id: string;
            rights_agent: { url: string; id: string };
            rights_holder?: BrandReference;
            valid_from?: string;
            valid_until?: string;
            uses: [RightUse, ...RightUse[]];
            countries?: string[];
            excluded_countries?: string[];
            impression_cap?: number;
            right_type?: RightType;
            approval_status?: "rejected" | "approved" | "pending";
            grant_status?: "active" | "paused" | "revoked";
            restrictions?: [string, ...string[]];
            disclosure?: {};
            creative_approval_required?: boolean;
            verification_url?: string;
            content_digest?: string;
            attestation_refs?: (
                {
                    issuer: AttestationIssuer;
                    claim_type: string;
                    subject: AttestationSubject;
                    locator?: | AttestationCredentialUriLocator
                    | AttestationIssuerCredentialIdLocator;
                    embedded_credential?: {
                        format: string;
                        value: string
                        | {};
                        ext?: ExtensionObject;
                    };
                    content_digest?: string;
                    credential_version?: string;
                    validity_hint?: { not_before?: string; expires_at?: string };
                    verify_agent?: { agent_url: string };
                    ext?: ExtensionObject;
                } & {
                    issuer?: { type: "brand"; brand: BrandReference };
                    claim_type?: "https://adcontextprotocol.org/claims/rights/grant";
                    subject?: {
                        type: "resource";
                        resource_type: "https://adcontextprotocol.org/claims/subjects/rights-grant";
                    };
                }
            )[];
            ext?: ExtensionObject;
        };
        context?: ContextObject;
        ext?: ExtensionObject;
    }
    Index
    rights_id: string

    Rights grant identifier

    rights_status: "acquired"

    Rights have been cleared and credentials issued. Renamed from status in 3.1 to free the top-level status key for the envelope task-status (TaskStatus) under MCP flat-on-the-wire serialization (#4878).

    brand_id: string

    Brand identifier of the rights subject

    generation_credentials: GenerationCredential[]

    Scoped credentials for generating rights-cleared content

    restrictions?: string[]

    Usage restrictions and requirements

    disclosure?: { required: boolean; text?: string }

    Required disclosure for creatives using these rights

    Type Declaration

    • required: boolean

      Whether disclosure is required

    • Optionaltext?: string

      Disclosure text to include with the creative

    approval_webhook?: PushNotificationConfig
    usage_reporting_url?: string

    Endpoint for reporting usage against these rights

    rights_constraint: {
        rights_id: string;
        rights_agent: { url: string; id: string };
        rights_holder?: BrandReference;
        valid_from?: string;
        valid_until?: string;
        uses: [RightUse, ...RightUse[]];
        countries?: string[];
        excluded_countries?: string[];
        impression_cap?: number;
        right_type?: RightType;
        approval_status?: "rejected" | "approved" | "pending";
        grant_status?: "active" | "paused" | "revoked";
        restrictions?: [string, ...string[]];
        disclosure?: {};
        creative_approval_required?: boolean;
        verification_url?: string;
        content_digest?: string;
        attestation_refs?: (
            {
                issuer: AttestationIssuer;
                claim_type: string;
                subject: AttestationSubject;
                locator?: | AttestationCredentialUriLocator
                | AttestationIssuerCredentialIdLocator;
                embedded_credential?: {
                    format: string;
                    value: string
                    | {};
                    ext?: ExtensionObject;
                };
                content_digest?: string;
                credential_version?: string;
                validity_hint?: { not_before?: string; expires_at?: string };
                verify_agent?: { agent_url: string };
                ext?: ExtensionObject;
            } & {
                issuer?: { type: "brand"; brand: BrandReference };
                claim_type?: "https://adcontextprotocol.org/claims/rights/grant";
                subject?: {
                    type: "resource";
                    resource_type: "https://adcontextprotocol.org/claims/subjects/rights-grant";
                };
            }
        )[];
        ext?: ExtensionObject;
    } & {
        rights_id: string;
        rights_agent: { url: string; id: string };
        rights_holder?: BrandReference;
        valid_from?: string;
        valid_until?: string;
        uses: [RightUse, ...RightUse[]];
        countries?: string[];
        excluded_countries?: string[];
        impression_cap?: number;
        right_type?: RightType;
        approval_status?: "rejected" | "approved" | "pending";
        grant_status?: "active" | "paused" | "revoked";
        restrictions?: [string, ...string[]];
        disclosure?: {};
        creative_approval_required?: boolean;
        verification_url?: string;
        content_digest?: string;
        attestation_refs?: (
            {
                issuer: AttestationIssuer;
                claim_type: string;
                subject: AttestationSubject;
                locator?: | AttestationCredentialUriLocator
                | AttestationIssuerCredentialIdLocator;
                embedded_credential?: {
                    format: string;
                    value: string
                    | {};
                    ext?: ExtensionObject;
                };
                content_digest?: string;
                credential_version?: string;
                validity_hint?: { not_before?: string; expires_at?: string };
                verify_agent?: { agent_url: string };
                ext?: ExtensionObject;
            } & {
                issuer?: { type: "brand"; brand: BrandReference };
                claim_type?: "https://adcontextprotocol.org/claims/rights/grant";
                subject?: {
                    type: "resource";
                    resource_type: "https://adcontextprotocol.org/claims/subjects/rights-grant";
                };
            }
        )[];
        ext?: ExtensionObject;
    }

    Pre-built rights constraint for embedding in creative manifests. Populated from the agreed terms — the buyer does not need to construct it manually.

    Type Declaration

    • rights_id: string

      Rights grant identifier from the acquire_rights response

    • rights_agent: { url: string; id: string }

      The agent that granted these rights

      • url: string

        MCP endpoint URL of the rights agent

      • id: string

        Agent identifier

    • Optionalrights_holder?: BrandReference
    • Optionalvalid_from?: string

      Start of the rights validity period

    • Optionalvalid_until?: string

      End of the rights validity period. Creative should not be served after this time.

    • uses: [RightUse, ...RightUse[]]

      Rights uses covered by this constraint

      1

    • Optionalcountries?: string[]

      Countries where this creative may be served under these rights (ISO 3166-1 alpha-2). If omitted, no country restriction. When both countries and excluded_countries are present, the effective set is countries minus excluded_countries.

    • Optionalexcluded_countries?: string[]

      Countries excluded from rights availability (ISO 3166-1 alpha-2). Use when the grant is worldwide except specific markets.

    • Optionalimpression_cap?: number

      Maximum total impressions allowed for the full validity period (valid_from to valid_until). This is the absolute cap across all creatives using this rights grant, not a per-creative or per-period limit.

    • Optionalright_type?: RightType
    • Optionalapproval_status?: "rejected" | "approved" | "pending"

      Approval status from the rights holder at manifest creation time (snapshot, not a live value)

    • Optionalgrant_status?: "active" | "paused" | "revoked"

      Authoritative lifecycle state bound into the grant digest and credential status evidence. Only active can evaluate to verified. paused and revoked credentials are ineligible for serving; resumption issues a fresh active credential and reference.

    • Optionalrestrictions?: [string, ...string[]]

      Normalized enforceable content and usage restrictions issued with the grant. When present these values are part of content_digest and cannot be omitted or changed without invalidating the attestation.

      1

    • Optionaldisclosure?: {}

      Disclosure obligation issued with the grant and bound by content_digest.

    • Optionalcreative_approval_required?: boolean

      Whether each creative produced under this grant requires holder approval before distribution. This enforceable term is bound by content_digest.

    • Optionalverification_url?: string

      DEPRECATED legacy informational locator. It is not proof of grant status, a revocation source, a credential locator, or permission to make a network request. Receivers MUST NOT fetch it during rights evaluation, and HTTP status codes have no AdCP authorization meaning. Rights authorization uses attestation_refs and a verifier-of-record evaluation under evaluator-owned policy.

    • Optionalcontent_digest?: string

      SHA-256 of UTF8(JCS(rights_constraint minus content_digest, attestation_refs, and verification_url)), formatted as sha256:. This binds all serving-relevant grant fields, including future extension fields, while deliberately excluding the legacy non-authoritative URL.

    • Optionalattestation_refs?: (
          {
              issuer: AttestationIssuer;
              claim_type: string;
              subject: AttestationSubject;
              locator?: | AttestationCredentialUriLocator
              | AttestationIssuerCredentialIdLocator;
              embedded_credential?: {
                  format: string;
                  value: string
                  | {};
                  ext?: ExtensionObject;
              };
              content_digest?: string;
              credential_version?: string;
              validity_hint?: { not_before?: string; expires_at?: string };
              verify_agent?: { agent_url: string };
              ext?: ExtensionObject;
          } & {
              issuer?: { type: "brand"; brand: BrandReference };
              claim_type?: "https://adcontextprotocol.org/claims/rights/grant";
              subject?: {
                  type: "resource";
                  resource_type: "https://adcontextprotocol.org/claims/subjects/rights-grant";
              };
          }
      )[]

      Alternative portable presentations of a holder-issued rights-grant credential signed by its authorized rights agent. The buyer carries references only; the serving party remains verifier-of-record. At least one reference must evaluate to verified and match rights_holder, rights_id, rights_agent, content_digest, validity, revocation state, and local policy before this constraint can contribute to serving eligibility.

      1

      4

    • Optionalext?: ExtensionObject
    • rights_id: string

      Rights grant identifier from the acquire_rights response

    • rights_agent: { url: string; id: string }

      The agent that granted these rights

      • url: string

        MCP endpoint URL of the rights agent

      • id: string

        Agent identifier

    • Optionalrights_holder?: BrandReference
    • Optionalvalid_from?: string

      Start of the rights validity period

    • Optionalvalid_until?: string

      End of the rights validity period. Creative should not be served after this time.

    • uses: [RightUse, ...RightUse[]]

      Rights uses covered by this constraint

      1

    • Optionalcountries?: string[]

      Countries where this creative may be served under these rights (ISO 3166-1 alpha-2). If omitted, no country restriction. When both countries and excluded_countries are present, the effective set is countries minus excluded_countries.

    • Optionalexcluded_countries?: string[]

      Countries excluded from rights availability (ISO 3166-1 alpha-2). Use when the grant is worldwide except specific markets.

    • Optionalimpression_cap?: number

      Maximum total impressions allowed for the full validity period (valid_from to valid_until). This is the absolute cap across all creatives using this rights grant, not a per-creative or per-period limit.

    • Optionalright_type?: RightType
    • Optionalapproval_status?: "rejected" | "approved" | "pending"

      Approval status from the rights holder at manifest creation time (snapshot, not a live value)

    • Optionalgrant_status?: "active" | "paused" | "revoked"

      Authoritative lifecycle state bound into the grant digest and credential status evidence. Only active can evaluate to verified. paused and revoked credentials are ineligible for serving; resumption issues a fresh active credential and reference.

    • Optionalrestrictions?: [string, ...string[]]

      Normalized enforceable content and usage restrictions issued with the grant. When present these values are part of content_digest and cannot be omitted or changed without invalidating the attestation.

      1

    • Optionaldisclosure?: {}

      Disclosure obligation issued with the grant and bound by content_digest.

    • Optionalcreative_approval_required?: boolean

      Whether each creative produced under this grant requires holder approval before distribution. This enforceable term is bound by content_digest.

    • Optionalverification_url?: string

      DEPRECATED legacy informational locator. It is not proof of grant status, a revocation source, a credential locator, or permission to make a network request. Receivers MUST NOT fetch it during rights evaluation, and HTTP status codes have no AdCP authorization meaning. Rights authorization uses attestation_refs and a verifier-of-record evaluation under evaluator-owned policy.

    • Optionalcontent_digest?: string

      SHA-256 of UTF8(JCS(rights_constraint minus content_digest, attestation_refs, and verification_url)), formatted as sha256:. This binds all serving-relevant grant fields, including future extension fields, while deliberately excluding the legacy non-authoritative URL.

    • Optionalattestation_refs?: (
          {
              issuer: AttestationIssuer;
              claim_type: string;
              subject: AttestationSubject;
              locator?: | AttestationCredentialUriLocator
              | AttestationIssuerCredentialIdLocator;
              embedded_credential?: {
                  format: string;
                  value: string
                  | {};
                  ext?: ExtensionObject;
              };
              content_digest?: string;
              credential_version?: string;
              validity_hint?: { not_before?: string; expires_at?: string };
              verify_agent?: { agent_url: string };
              ext?: ExtensionObject;
          } & {
              issuer?: { type: "brand"; brand: BrandReference };
              claim_type?: "https://adcontextprotocol.org/claims/rights/grant";
              subject?: {
                  type: "resource";
                  resource_type: "https://adcontextprotocol.org/claims/subjects/rights-grant";
              };
          }
      )[]

      Alternative portable presentations of a holder-issued rights-grant credential signed by its authorized rights agent. The buyer carries references only; the serving party remains verifier-of-record. At least one reference must evaluate to verified and match rights_holder, rights_id, rights_agent, content_digest, validity, revocation state, and local policy before this constraint can contribute to serving eligibility.

      1

      4

    • Optionalext?: ExtensionObject
    context?: ContextObject