Consent Prompt APIs

Provides access to consent and privacy operations.

Retrieve consent prompts for a specific user.

post

This endpoint provides the available consent prompts tailored for the user based on their consent history and applicable business rules. It may return zero, one, or multiple prompts that the user needs to review and respond to. The prompts can vary in scope, including application-wide consents or specific acknowledgments.

💻 Service Credentials is required to access this service.

Authorizations

clientCredentials

OAuth2authorizationCodeRequired

An OIDC service account that was authenticated.

Token URL:

Body

application/json

subject_idstringRequired

Subject identitifer to get consent prompts for.

client_idstringRequired

Client to get consent prompts against.

experiment_idstringOptional

Optional experiment ID to ask for consent against.

agreementsstring[]Optional

Optional the type of agreements you want to prompt against.

scopesstring[]Required

Consent scopes being requested by the application or service.

localestringOptional

The locale of the current user for internationalization.

Responses

200

The consent prompt information to collect from the user.

*/*

401

Unauthorized

*/*

post

/consent/admin/{userId}/prompts

HTTPcURLJavaScriptPython

POST /consent/admin/{userId}/prompts HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 189

{
  "subject_id": "text",
  "delegate": {
    "subject_id": "text",
    "client_id": "text",
    "scopes": [
      "text"
    ]
  },
  "client_id": "text",
  "experiment_id": "text",
  "agreements": [
    "text"
  ],
  "scopes": [
    "text"
  ],
  "locale": "text"
}

{
  "supervisor": {
    "id": "text",
    "traits": {
      "name": {
        "given_name": "text",
        "family_name": "text",
        "middle_name": "text"
      },
      "birthdate": "2025-12-16",
      "email": "text",
      "username": "text",
      "gender": "male",
      "citizenship": "text",
      "locale": "text"
    },
    "metadata_public": {
      "picture": "text"
    }
  },
  "organization": {
    "id": "text",
    "name": "text"
  },
  "prompts": [
    {
      "skip": true,
      "path": "text",
      "type": "text",
      "scopes": [
        "text"
      ],
      "agreement": {
        "id": "text",
        "name": "text",
        "version": {
          "id": "text",
          "version_number": "text",
          "version_type": "minor",
          "modified_date": "2025-12-16T22:14:25.796Z",
          "effective_date": "2025-12-16T22:14:25.796Z",
          "scopes": [
            {
              "id": "text",
              "sensitivity": "text",
              "purpose": [
                "COLLECTION"
              ]
            }
          ],
          "content": [
            {
              "url": "text",
              "title": "text",
              "locale": "text",
              "mime_type": "text",
              "date_created": "2025-12-16T22:14:25.796Z",
              "date_modified": "2025-12-16T22:14:25.796Z"
            }
          ],
          "status": "draft"
        }
      },
      "opted_in": true,
      "resign": true
    }
  ],
  "identity": {
    "id": "text",
    "traits": {
      "name": {
        "given_name": "text",
        "family_name": "text",
        "middle_name": "text"
      },
      "birthdate": "2025-12-16",
      "email": "text",
      "username": "text",
      "gender": "male",
      "citizenship": "text",
      "locale": "text"
    },
    "metadata_public": {
      "picture": "text"
    }
  },
  "existing_scopes": [
    "text"
  ],
  "existing_experiments": [
    "text"
  ],
  "client": {
    "client_name": "text",
    "policy_uri": "text",
    "tos_uri": "text",
    "client_uri": "text",
    "logo_uri": "text",
    "metadata": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  }
}

Admin submits onboarding agreement prompt for user.

post

This endpoint allows administrators to submit onboarding agreement prompts for users. It handles the necessary logic for delivering agreements and ensures compliance with privacy and consent regulations. Use this API to manage user consent effectively and maintain clear communication regarding onboarding processes.

💻 Service Credentials is required to access this service.

🔒 Permission: user.consent.update is required in order for the call to succeed. You must configure permissions for the person or service calling this endpoint and add this permission to their identity.

Authorizations

clientCredentials

OAuth2authorizationCodeRequired

An OIDC service account that was authenticated.

Token URL:

Body

application/json

idstringOptional

ipstringOptional

session_idstringOptional

subject_idstringOptional

actstringOptional

client_idstringOptional

timestampstring · date-timeOptional

skippedbooleanOptional

scopesstring[]Optional

Responses

200

Handles the logic for when onboarding agreements are delivered.

No content

401

Unauthorized

*/*

post

/consent/admin/{userId}/prompts/agreements

HTTPcURLJavaScriptPython

POST /consent/admin/{userId}/prompts/agreements HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1050

{
  "id": "text",
  "ip": "text",
  "session_id": "text",
  "subject_id": "text",
  "act": "text",
  "client_id": "text",
  "timestamp": "2025-12-16T22:14:25.796Z",
  "agent": {
    "os": {
      "name": "text",
      "short_name": "text",
      "version": "text",
      "platform": "text",
      "family": "text"
    },
    "client": {
      "name": "text",
      "short_name": "text",
      "version": "text",
      "engine": "text",
      "engine_version": "text",
      "family": "text"
    },
    "device": {
      "id": "text",
      "type": "text",
      "brand": "text",
      "model": "text",
      "code": "text",
      "trusted": "text"
    },
    "header": "text"
  },
  "prompt": {
    "skip": true,
    "path": "text",
    "type": "text",
    "scopes": [
      "text"
    ],
    "agreement": {
      "id": "text",
      "name": "text",
      "version": {
        "id": "text",
        "version_number": "text",
        "version_type": "minor",
        "modified_date": "2025-12-16T22:14:25.796Z",
        "effective_date": "2025-12-16T22:14:25.796Z",
        "scopes": [
          {
            "id": "text",
            "sensitivity": "text",
            "purpose": [
              "COLLECTION"
            ]
          }
        ],
        "content": [
          {
            "url": "text",
            "title": "text",
            "locale": "text",
            "mime_type": "text",
            "date_created": "2025-12-16T22:14:25.796Z",
            "date_modified": "2025-12-16T22:14:25.796Z"
          }
        ],
        "status": "draft"
      }
    },
    "opted_in": true,
    "resign": true
  },
  "skipped": true,
  "scopes": [
    "text"
  ]
}

No content

Admin submits application consent prompt.

post

This endpoint allows an admin to submit a consent prompt for an application. It processes the necessary onboarding information related to user consent. Ensure that the appropriate permissions are in place to access this functionality.

💻 Service Credentials is required to access this service.

🔒 Permission: user.consent.update is required in order for the call to succeed. You must configure permissions for the person or service calling this endpoint and add this permission to their identity.

Authorizations

clientCredentials

OAuth2authorizationCodeRequired

An OIDC service account that was authenticated.

Token URL:

Body

application/json

idstringOptional

ipstringOptional

session_idstringOptional

subject_idstringOptional

actstringOptional

client_idstringOptional

timestampstring · date-timeOptional

skippedbooleanOptional

scopesstring[]Optional

Responses

200

Handles the logic for when consenting to an applications consent.

No content

401

Unauthorized

*/*

post

/consent/admin/{userId}/prompts/apps

HTTPcURLJavaScriptPython

POST /consent/admin/{userId}/prompts/apps HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 760

{
  "id": "text",
  "ip": "text",
  "session_id": "text",
  "subject_id": "text",
  "act": "text",
  "client_id": "text",
  "timestamp": "2025-12-16T22:14:25.796Z",
  "agent": {
    "os": {
      "name": "text",
      "short_name": "text",
      "version": "text",
      "platform": "text",
      "family": "text"
    },
    "client": {
      "name": "text",
      "short_name": "text",
      "version": "text",
      "engine": "text",
      "engine_version": "text",
      "family": "text"
    },
    "device": {
      "id": "text",
      "type": "text",
      "brand": "text",
      "model": "text",
      "code": "text",
      "trusted": "text"
    },
    "header": "text"
  },
  "prompt": {
    "skip": true,
    "path": "text",
    "type": "text",
    "scopes": [
      {
        "id": "text",
        "category": "text",
        "subcategory": "text",
        "label": {
          "en": "text",
          "jp": "text"
        },
        "org_id": "text",
        "status": "test",
        "description": {
          "en": "text",
          "jp": "text"
        },
        "sensitivity": "High",
        "visible": true
      }
    ]
  },
  "skipped": true,
  "scopes": [
    "text"
  ]
}

No content

Submit consent for experiment prompts as an admin.

post

This endpoint processes consent for experiment prompts specifically for admin users. It ensures that the necessary privacy and consent protocols are followed when handling user experiment data. Use this API to manage experiment-related consent effectively.

💻 Service Credentials is required to access this service.

🔒 Permission: user.consent.update is required in order for the call to succeed. You must configure permissions for the person or service calling this endpoint and add this permission to their identity.

Authorizations

clientCredentials

OAuth2authorizationCodeRequired

An OIDC service account that was authenticated.

Token URL:

Body

application/json

idstringOptional

ipstringOptional

session_idstringOptional

subject_idstringOptional

actstringOptional

client_idstringOptional

timestampstring · date-timeOptional

skippedbooleanOptional

scopesstring[]Optional

Responses

200

Handles the logic for when consenting to experiments.

No content

401

Unauthorized

*/*

post

/consent/admin/{userId}/prompts/experiments

HTTPcURLJavaScriptPython

POST /consent/admin/{userId}/prompts/experiments HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1267

{
  "id": "text",
  "ip": "text",
  "session_id": "text",
  "subject_id": "text",
  "act": "text",
  "client_id": "text",
  "timestamp": "2025-12-16T22:14:25.796Z",
  "agent": {
    "os": {
      "name": "text",
      "short_name": "text",
      "version": "text",
      "platform": "text",
      "family": "text"
    },
    "client": {
      "name": "text",
      "short_name": "text",
      "version": "text",
      "engine": "text",
      "engine_version": "text",
      "family": "text"
    },
    "device": {
      "id": "text",
      "type": "text",
      "brand": "text",
      "model": "text",
      "code": "text",
      "trusted": "text"
    },
    "header": "text"
  },
  "prompt": {
    "skip": true,
    "path": "text",
    "type": "text",
    "scopes": [
      {
        "id": "text",
        "category": "text",
        "subcategory": "text",
        "label": {
          "en": "text",
          "jp": "text"
        },
        "org_id": "text",
        "status": "test",
        "description": {
          "en": "text",
          "jp": "text"
        },
        "sensitivity": "High",
        "visible": true
      }
    ],
    "experiment": {
      "id": "text",
      "name": "text",
      "tags": [
        "text"
      ],
      "creation_date": "2025-12-16T22:14:25.796Z",
      "start_date": "2025-12-16T22:14:25.796Z",
      "stop_date": "2025-12-16T22:14:25.796Z",
      "description": "text",
      "media": {
        "hero_image_url": "text"
      },
      "status": "published",
      "owner": "text",
      "project_id": "text",
      "org_id": "text",
      "external_id": "text",
      "external_source": "text",
      "scopes": [
        {
          "id": "text"
        }
      ],
      "privacy_url": "text",
      "tos_url": "text",
      "info_url": "text"
    },
    "impressions": 1,
    "remaining_impressions": 1,
    "opted_in": true,
    "inactive": true
  },
  "skipped": true,
  "scopes": [
    "text"
  ]
}

No content

Admin submits onboarding response for user prompts.

post

This endpoint allows administrators to process onboarding responses related to user prompts. It ensures that the necessary onboarding information is handled efficiently. Use this API to manage consent and privacy operations effectively within the admin context.

💻 Service Credentials is required to access this service.

🔒 Permission: user.consent.update is required in order for the call to succeed. You must configure permissions for the person or service calling this endpoint and add this permission to their identity.

Authorizations

clientCredentials

OAuth2authorizationCodeRequired

An OIDC service account that was authenticated.

Token URL:

Body

application/json

idstringOptional

ipstringOptional

session_idstringOptional

subject_idstringOptional

actstringOptional

client_idstringOptional

skippedbooleanOptional

timestampstring · date-timeOptional

promptone ofOptional

or

or

or

Responses

200

Handles the logic for when onboarding prompts are delivered.

No content

401

Unauthorized

*/*

post

/consent/admin/{userId}/prompts/onboarding

HTTPcURLJavaScriptPython

POST /consent/admin/{userId}/prompts/onboarding HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 632

{
  "id": "text",
  "ip": "text",
  "session_id": "text",
  "subject_id": "text",
  "act": "text",
  "client_id": "text",
  "skipped": true,
  "timestamp": "2025-12-16T22:14:25.796Z",
  "agent": {
    "os": {
      "name": "text",
      "short_name": "text",
      "version": "text",
      "platform": "text",
      "family": "text"
    },
    "client": {
      "name": "text",
      "short_name": "text",
      "version": "text",
      "engine": "text",
      "engine_version": "text",
      "family": "text"
    },
    "device": {
      "id": "text",
      "type": "text",
      "brand": "text",
      "model": "text",
      "code": "text",
      "trusted": "text"
    },
    "header": "text"
  },
  "prompt": {
    "skip": true,
    "path": "text",
    "type": "text",
    "done": true,
    "given_name": "text",
    "family_name": "text",
    "year": 1,
    "month": 1,
    "day": 1,
    "gender": "text"
  }
}

No content

Admin submits supervised account prompt for approval

post

This operation allows an admin to submit a request for a supervised account to seek approval from the account owner. It is specifically designed for age-restricted accounts, ensuring that parental consent is obtained before granting access. This enhances the safety and compliance of child accounts in the system.

💻 Service Credentials is required to access this service.

🔒 Permission: user.consent.update is required in order for the call to succeed. You must configure permissions for the person or service calling this endpoint and add this permission to their identity.

Authorizations

clientCredentials

OAuth2authorizationCodeRequired

An OIDC service account that was authenticated.

Token URL:

Body

application/json

idstringOptional

ipstringOptional

session_idstringOptional

subject_idstringOptional

actstringOptional

client_idstringOptional

timestampstring · date-timeOptional

challenge_idstringOptional

skippedbooleanOptional

scopesstring[]Optional

Responses

200

Will request to the supervised account owner of this account to approve the login or access. This is for age restricted accounts.

No content

401

Unauthorized

*/*

post

/consent/admin/{userId}/prompts/supervised

HTTPcURLJavaScriptPython

POST /consent/admin/{userId}/prompts/supervised HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 806

{
  "id": "text",
  "ip": "text",
  "session_id": "text",
  "subject_id": "text",
  "act": "text",
  "client_id": "text",
  "timestamp": "2025-12-16T22:14:25.796Z",
  "agent": {
    "os": {
      "name": "text",
      "short_name": "text",
      "version": "text",
      "platform": "text",
      "family": "text"
    },
    "client": {
      "name": "text",
      "short_name": "text",
      "version": "text",
      "engine": "text",
      "engine_version": "text",
      "family": "text"
    },
    "device": {
      "id": "text",
      "type": "text",
      "brand": "text",
      "model": "text",
      "code": "text",
      "trusted": "text"
    },
    "header": "text"
  },
  "prompt": {
    "skip": true,
    "path": "text",
    "type": "text",
    "scopes": [
      "text"
    ],
    "request": true,
    "supervisor": {
      "name": {
        "given_name": "text",
        "family_name": "text",
        "middle_name": "text"
      },
      "birthdate": "2025-12-16",
      "email": "text",
      "username": "text",
      "gender": "male",
      "citizenship": "text",
      "locale": "text"
    }
  },
  "challenge_id": "text",
  "skipped": true,
  "scopes": [
    "text"
  ]
}

No content