---
title: "Get Hosted User Experience Configuration"
method: POST
path: "/programs/{programCode}/hosted/ux"
tags: ["HostedUserExperience"]
---

# Get Hosted User Experience Configuration

`POST /programs/{programCode}/hosted/ux`

Retrieves a PCI widget configuration and a hosted user experience URL for the specified activity and program. Validates the activity, finds the product code, and returns a secure URL for embedding in client applications.

## Path parameters

- `programCode` string, required

## Headers

- `X-GD-RequestId` string, required

## Request body

- GetConfigurationRequest — Represents a request to retrieve configuration data for a specific activity. Contains activity details, contextual data, and URLs for success and error handling. Inherits standard request metadata from Gd.Bos.DataTransfer.Request.RequestBase.
  - `activity` string, nullable — The name or type of the activity for which configuration is being requested (e.g., "enrollment", "payment").
  - `activityData` object, nullable — A dictionary of key-value pairs providing additional data or context for the activity.
  - `successUrl` string, nullable — The URL to redirect to or call upon successful completion of the activity.
  - `errorUrl` string, nullable — The URL to redirect to or call if an error occurs during the activity.

## Response `200`

OK

- GetConfigurationResponse — Represents the response returned after retrieving configuration data. Contains a URL for configuration or redirection purposes. Inherits standard response metadata from Gd.Bos.DataTransfer.Response.ResponseBase.
  - `url` string, nullable — The configuration or redirection URL returned by the operation.
  - `responseDetails` ResponseDetail[], nullable — Required: A list of response details providing status codes, descriptions, and additional information about the result of the operation.
    - `code` integer — The primary status or error code for the response (e.g., 200 for success, 400 for validation error).
    - `subCode` integer, nullable — An optional subcode providing more granular detail about the response or error.
    - `description` string, nullable — A human-readable description of the response, error, or status.
    - `url` string, nullable — A URL linking to documentation or a web page with more information about the response code.

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `500` — Internal Server Error
- `503` — Service Unavailable

---

[API](https://skmtc.net/greendot/apis/baas-apis.md) · [All operations](https://skmtc.net/greendot/apis/baas-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/greendot/baas-apis/revisions/666553766b78/schema)