---
updatedAt: 2026-08-06T13:23:30.000Z
agentTools:
  projectIndex: https://docs.data.one/llms.txt
---

# Create User

Create a user in the DataOne system.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "info": {
    "version": "v1",
    "title": "Hosted Web Journey",
    "description": "Endpoints relating to creating and managing users and sessions. These are only relevant for usage of the direct connection journey, for more details please see the guides on https://docs.data.one."
  },
  "paths": {
    "/v2/users": {
      "post": {
        "tags": [
          "Users V2"
        ],
        "operationId": "createUserV2",
        "summary": "Create User",
        "description": "Create a user in the DataOne system.",
        "security": [
          {
            "ApiKeyAuth": []
          }
        ],
        "requestBody": {
          "description": "The user to be created.",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateUserRequest"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The successfully created user.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UserResponseV2"
                },
                "example": {
                  "userId": "2590eaff-94dc-43f4-be30-bdab6c2cec8b",
                  "partnerId": "88735265-b560-4151-91b7-5b87c99da0aa",
                  "created": "2022-12-12T13:37:42.123Z",
                  "name": "Jane Doe",
                  "correlationId": "u7741887"
                }
              }
            }
          },
          "400": {
            "description": "User data validation failed."
          },
          "401": {
            "$ref": "#/components/responses/ApiKeyUnauthorizedError"
          },
          "403": {
            "description": "Access is forbidden."
          }
        }
      }
    }
  },
  "servers": [
    {
      "url": "https://api-sandbox.data.one",
      "description": "Hostname for sandbox API"
    }
  ],
  "components": {
    "securitySchemes": {
      "ApiKeyAuth": {
        "type": "apiKey",
        "in": "header",
        "name": "X-API-Key",
        "description": "Secret API key used for authentication."
      }
    },
    "schemas": {
      "CreateUserRequest": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "Full name of the user. This is a required field. This must be 256 characters or less."
          },
          "correlationId": {
            "type": "string",
            "description": "An optional ID that can be used to correlate to a User. This must be 256 characters or less."
          },
          "dataOrigin": {
            "type": "string",
            "description": "An optional string enum which is used to represent the origin of account and transactions data. If not provided, the default value DATA_ONE is used. DATA_ONE dataOrigin users have stored account and transaction data which the DataOne system retrieves via open banking connections from ASPSPs (this is the current default for all existing users). CAAS dataOrigin users have stored account and transaction data which is directly sent to the DataOne system via API by DataOne partners.",
            "enum": [
              "DATA_ONE",
              "CAAS"
            ]
          }
        },
        "example": {
          "name": "Jane Doe",
          "correlationId": "6ba1a32a-43e4-4fd2-942c-58f58bf5fabe",
          "dataOrigin": "DATA_ONE"
        },
        "required": [
          "name"
        ]
      },
      "UserResponseV2": {
        "type": "object",
        "properties": {
          "userId": {
            "type": "string",
            "format": "uuid",
            "description": "User ID used to uniquely identify applicant."
          },
          "partnerId": {
            "type": "string",
            "format": "uuid",
            "description": "The ID of the partner who created the user."
          },
          "created": {
            "type": "string",
            "format": "date-time",
            "description": "The DateTime that the user was created."
          },
          "name": {
            "type": "string",
            "description": "Full name of the user."
          },
          "correlationId": {
            "type": "string",
            "description": "An optional ID that can be used to correlate to a user."
          }
        },
        "required": [
          "userId",
          "partnerId",
          "created"
        ],
        "example": {
          "userId": "2590eaff-94dc-43f4-be30-bdab6c2cec8b",
          "partnerId": "88735265-b560-4151-91b7-5b87c99da0aa",
          "created": "2022-12-12T13:37:42.123Z",
          "name": "Jane Doe",
          "correlationId": "u7741887"
        }
      }
    },
    "responses": {
      "ApiKeyUnauthorizedError": {
        "description": "API key authentication unsuccessful."
      }
    }
  }
}
```