---
updatedAt: 2026-05-27T08:29:42.000Z
agentTools:
  projectIndex: https://docs.bridgeapi.io/llms.txt
---

# Create a user

Create a new user

# 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": "Users",
      "description": "A Bridge user represents your user or customer who connects their bank accounts"
    }
  ],
  "paths": {
    "/v3/aggregation/users": {
      "parameters": [
        {
          "$ref": "#/components/parameters/version"
        }
      ],
      "post": {
        "operationId": "CreateUser",
        "summary": "Create a user",
        "description": "Create a new user",
        "tags": [
          "Users"
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/create-user"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "User created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/user"
                }
              }
            }
          },
          "400": {
            "description": "Error 400",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error-400"
                }
              }
            }
          },
          "401": {
            "description": "Error 401",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error-401"
                }
              }
            }
          }
        }
      }
    }
  },
  "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"
                  ]
                }
              }
            }
          }
        }
      },
      "create-user": {
        "title": "Create user request",
        "type": "object",
        "properties": {
          "external_user_id": {
            "type": "string",
            "description": "Your own user ID (format: [a-zA-Z0-9-_]{1,128})",
            "example": "user-001"
          }
        }
      },
      "user": {
        "title": "User resource",
        "description": "A Bridge user represents your user or customer who connects their bank accounts",
        "type": "object",
        "required": [
          "uuid"
        ],
        "properties": {
          "uuid": {
            "type": "string",
            "description": "A Universally Unique IDentifier (UUID) as a human-readable string using hexadecimal text with inserted hyphen characters",
            "example": "de305d54-75b4-431b-adb2-eb6b9e546014"
          },
          "external_user_id": {
            "type": "string",
            "description": "Your own user ID (format: [a-zA-Z0-9-_]{1,128})",
            "example": "user-001"
          }
        }
      }
    },
    "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": {
      "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
  }
}
```