---
updatedAt: 2026-04-21T10:26:41.000Z
agentTools:
  projectIndex: https://docs.bridgeapi.io/llms.txt
---

# Create a user management session

User management sessions are front-end sessions that allow your users to resolve synchronization issues or add new items for the authenticated user. Within a user management session, a user can start up to four management flows for the same item within a rolling 24-hour period. Once this limit is reached, the user must wait until a slot becomes available before starting another management flow for that item.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Bridge API",
    "version": "2025-01-15",
    "description": "Bridge provides an Open Banking API to initiate payments and aggregate financial data.  \nOur API uses standards such as HTTP verbs, RESTful routing and JSON for payloads.",
    "license": {
      "name": "Proprietary",
      "url": "https://docs.bridgeapi.io"
    },
    "contact": {
      "name": "BridgeAPI",
      "url": "https://bridgeapi.io",
      "email": "support@bridgeapi.io"
    }
  },
  "servers": [
    {
      "description": "Production",
      "url": "https://api.bridgeapi.io"
    }
  ],
  "tags": [
    {
      "name": "User management sessions",
      "description": "User management sessions are front-end sessions that allow your users to resolve synchronization issues or add new items for the authenticated user"
    }
  ],
  "paths": {
    "/v3/aggregation/user-management-sessions": {
      "parameters": [
        {
          "$ref": "#/components/parameters/version"
        }
      ],
      "post": {
        "operationId": "CreateUserManagementSession",
        "summary": "Create a user management session",
        "description": "User management sessions are front-end sessions that allow your users to resolve synchronization issues or add new items for the authenticated user. Within a user management session, a user can start up to four management flows for the same item within a rolling 24-hour period. Once this limit is reached, the user must wait until a slot becomes available before starting another management flow for that item.",
        "tags": [
          "User management sessions"
        ],
        "security": [
          {
            "userTokenBearerAuth": [],
            "clientIdAuth": [],
            "clientSecretAuth": []
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "anyOf": [
                  {
                    "$ref": "#/components/schemas/create-user-management-session"
                  }
                ]
              },
              "example": {
                "user_email": "j.doe@mail.com"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "User management session created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/user-management-session"
                }
              }
            }
          },
          "400": {
            "description": "Error 400",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error-400"
                },
                "example": {
                  "errors": [
                    {
                      "code": "user_session.account_types_invalid",
                      "property": "account_types",
                      "message": "The account_types parameter is invalid. It should be payment or all."
                    }
                  ]
                }
              }
            }
          },
          "401": {
            "description": "Error 401",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error-401"
                },
                "example": {
                  "errors": [
                    {
                      "code": "invalid_authorization_header",
                      "message": "Authorization header has an invalid format"
                    }
                  ]
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "error-401": {
        "title": "Error 401",
        "type": "object",
        "example": {
          "errors": [
            {
              "code": "invalid_client_credentials",
              "message": "client_id and client_secret are invalid"
            }
          ]
        },
        "properties": {
          "errors": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "code": {
                  "description": "Error code",
                  "type": "string"
                },
                "property": {
                  "description": "Property or parameter that is invalid",
                  "type": [
                    "null",
                    "string"
                  ]
                },
                "message": {
                  "description": "Human-readable error description",
                  "type": [
                    "null",
                    "string"
                  ]
                }
              }
            }
          }
        }
      },
      "error-400": {
        "title": "Error 400",
        "type": "object",
        "example": {
          "errors": [
            {
              "code": "invalid_request",
              "message": "Invalid body content"
            }
          ]
        },
        "properties": {
          "errors": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "code": {
                  "description": "Error code",
                  "type": "string"
                },
                "property": {
                  "description": "Property or parameter that is invalid",
                  "type": [
                    "null",
                    "string"
                  ]
                },
                "message": {
                  "description": "Human-readable error description",
                  "type": [
                    "null",
                    "string"
                  ]
                }
              }
            }
          }
        }
      },
      "user-management-session": {
        "title": "User management session resource",
        "description": "Create user management sessions to make your user fix or add new bank connections",
        "type": "object",
        "required": [
          "id",
          "url"
        ],
        "properties": {
          "id": {
            "description": "User management session identifier",
            "type": "string",
            "example": "bf8f3e2a-6b04-412a-b2a3-be7fef470b4a"
          },
          "url": {
            "description": "User management session web funnel URL",
            "type": "string",
            "format": "url",
            "example": "https://connect.bridgeapi.io/user/e953f3c4-d7d9-4161-a50a-f92f330d08ea"
          }
        }
      },
      "create-user-management-session": {
        "title": "Create user management session request",
        "type": "object",
        "properties": {
          "callback_url": {
            "type": "string",
            "description": "Optional callback URL for redirecting the user at the exit of the user management session",
            "format": "url",
            "example": "https://yourcallback.com"
          },
          "context": {
            "type": "string",
            "maxLength": 100,
            "description": "Optional context string to append to the callback URL when exiting the user management session. It can contain up to 100 alphanumeric characters, including the hyphen (-).",
            "example": "abc123"
          },
          "account_types": {
            "type": "string",
            "description": "Minimum account types required. We suggest `payment` to ensure the best user experience",
            "enum": [
              "payment",
              "all"
            ],
            "default": "payment",
            "example": "payment"
          },
          "user_email": {
            "type": "string",
            "format": "email",
            "description": "Mandatory, except in the case of temporary bank synchronization",
            "example": "email@gmail.com"
          },
          "country_code": {
            "type": "string",
            "description": "On the displayed providers list, the country selector will default to the country parameter if provided. If you customize the highlighted banks on the dashboard, this parameter will be disabled.",
            "enum": [
              "FR",
              "ES",
              "IT",
              "PT",
              "DE",
              "BE",
              "NL",
              "LU",
              "PL",
              "HU",
              "IE",
              "MT",
              "CZ",
              "NO",
              "BG",
              "SE",
              "DK",
              "AT",
              "SK",
              "FI",
              "GB",
              "GR",
              "EE",
              "IS",
              "CY",
              "HR",
              "LV",
              "RO"
            ],
            "example": "FR"
          },
          "capabilities": {
            "type": "array",
            "description": "Filter the provider capabilities you need. When multiple values are specified, they are combined using an `AND` operation",
            "items": {
              "type": "string"
            },
            "example": "aggregation"
          },
          "allow_account_selection": {
            "type": "boolean",
            "description": "Allow or disallow the selection of the accounts",
            "example": true
          },
          "show_add_item_button": {
            "type": "boolean",
            "description": "Indicates whether the button for adding an item should be rendered in the UI.",
            "example": true
          }
        }
      }
    },
    "parameters": {
      "version": {
        "in": "header",
        "name": "Bridge-Version",
        "schema": {
          "type": "string",
          "enum": [
            "2025-01-15"
          ],
          "default": "2025-01-15"
        },
        "required": true,
        "description": "The Bridge API version"
      }
    },
    "securitySchemes": {
      "userTokenBearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "description": "Aggregation user access token"
      },
      "clientIdAuth": {
        "type": "apiKey",
        "in": "header",
        "name": "Client-Id"
      },
      "clientSecretAuth": {
        "type": "apiKey",
        "in": "header",
        "name": "Client-Secret"
      }
    }
  },
  "security": [
    {
      "clientIdAuth": [],
      "clientSecretAuth": []
    }
  ],
  "x-readme": {
    "explorer-enabled": false,
    "proxy-enabled": false
  }
}
```