---
title: "Create an embed session"
method: POST
path: "/embed-sessions"
tags: ["Embed Sessions"]
---

# Create an embed session

`POST /embed-sessions`

## Request

- Base URL: `https://app-sandbox.resolvepay.com/api`
- URL: `https://app-sandbox.resolvepay.com/api/embed-sessions`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/resolvepay/apis/resolve-partners-api-reference/docs/embed-sessions/post.ts> (a function with typed inputs; its response is checked against the schema)

Create a short-lived bearer token for an approved embedded component running for one of your sub-merchants.

This endpoint is available only to partner OAuth bearer tokens. HTTP Basic authentication is not supported. Use the component identifier documented for the embedded-components package version you install.

Use `resolve-api-version: partner-v1` for this request. The resulting embed token is used only with the merchant API version selected by the component.

## Headers

- `resolve-api-version` 'partner-v1', required

## Request body

- EmbedSessionCreateRequest
  - `partner_merchant_ref` string, required: Resolve merchant ID or external ID of a sub-merchant that currently belongs to your partner account.
  - `component` string, required: Embedded component to authorize. Use the identifier documented for the installed embedded-components package version.

## Response `201`

Short-lived embed session created.

- EmbedSessionCreateResponse
  - `session_id` string, required: Persisted session identifier used by Resolve for audit and revocation.
  - `token` string, required: Short-lived bearer token to provide to the embedded component.
  - `expires_at` string, date-time, required: When the embed token expires. Mint a new session after this time.
  - `merchant_id` string, required: Resolve ID of the sub-merchant scoped into the token.
  - `component` string, required: Embedded component authorized by the session.
  - `capabilities` string[], required: Capabilities derived by Resolve for the requested component.

## Other responses

- `400`: Bad request error
- `401`: Unauthorized error
- `404`: Not found error
- `503`: Embed sessions are not configured for this Resolve environment.

---

[API](https://skmtc.dev/resolvepay/apis/resolve-partners-api-reference.md) - [All operations](https://skmtc.dev/resolvepay/apis/resolve-partners-api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/resolvepay/apis/resolve-partners-api-reference/revisions/5a1c75b8b404?raw)