---
updatedAt: 2025-03-05T16:48:57.000Z
agentTools:
  projectIndex: https://docs.staxpayments.com/llms.txt
---

# Create a New Team Member

This creates a whole new user account in your merchant team.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "stax-api",
    "version": "0.1"
  },
  "servers": [
    {
      "url": "https://apiprod.fattlabs.com/"
    }
  ],
  "components": {
    "securitySchemes": {
      "ApiKeyAuth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT",
        "description": "API key for merchant-level operations. Provides access to merchant-specific endpoints including transactions, payments, customer management, and merchant account settings. This key is scoped to a single merchant account and cannot access partner-level functionality."
      }
    }
  },
  "security": [
    {
      "ApiKeyAuth": []
    }
  ],
  "paths": {
    "/team/user": {
      "post": {
        "summary": "Create a New Team Member",
        "description": "This creates a whole new user account in your merchant team.",
        "operationId": "create-a-new-team-member",
        "parameters": [
          {
            "name": "email",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "password",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "password_confirmation",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "name",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "team_role",
            "in": "query",
            "schema": {
              "type": "string",
              "enum": [
                "admin",
                "staff",
                "full",
                "sales",
                "reporting"
              ]
            }
          },
          {
            "name": "team_enabled",
            "in": "query",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "send_verification_email",
            "in": "query",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "url",
            "in": "query",
            "schema": {
              "type": "string",
              "default": "https://app.staxpayments.com/#/verify/"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"id\": \"21a64e9e-3c13-4b85-9f85-67cb4fda808a\",\n  \"system_admin\": false,\n  \"name\": \"James\",\n  \"email\": \"fatttest737@gmail.com\",\n  \"email_verification_sent_at\": null,\n  \"email_verified_at\": null,\n  \"created_at\": \"2017-05-15 19:31:35\",\n  \"updated_at\": \"2017-05-15 19:31:35\",\n  \"deleted_at\": null,\n  \"gravatar\": \"//www.gravatar.com/avatar/52b3ef2ae70945ce0fca14086443dc1a\",\n  \"team_role\": \"full\",\n  \"team_admin\": false,\n  \"team_enabled\": true\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string",
                      "example": "21a64e9e-3c13-4b85-9f85-67cb4fda808a"
                    },
                    "system_admin": {
                      "type": "boolean",
                      "example": false,
                      "default": true
                    },
                    "name": {
                      "type": "string",
                      "example": "James"
                    },
                    "email": {
                      "type": "string",
                      "example": "fatttest737@gmail.com"
                    },
                    "email_verification_sent_at": {},
                    "email_verified_at": {},
                    "created_at": {
                      "type": "string",
                      "example": "2017-05-15 19:31:35"
                    },
                    "updated_at": {
                      "type": "string",
                      "example": "2017-05-15 19:31:35"
                    },
                    "deleted_at": {},
                    "gravatar": {
                      "type": "string",
                      "example": "//www.gravatar.com/avatar/52b3ef2ae70945ce0fca14086443dc1a"
                    },
                    "team_role": {
                      "type": "string",
                      "example": "full"
                    },
                    "team_admin": {
                      "type": "boolean",
                      "example": false,
                      "default": true
                    },
                    "team_enabled": {
                      "type": "boolean",
                      "example": true,
                      "default": true
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "401",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "[\n  \"not team admin\"\n]"
                  }
                },
                "schema": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "example": "not team admin"
                  }
                }
              }
            }
          },
          "422": {
            "description": "422",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"name\": [\n    \"The name field is required.\"\n  ],\n  \"email\": [\n    \"The email field is required.\"\n  ],\n  \"password\": [\n    \"The password field is required.\"\n  ]\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "name": {
                      "type": "array",
                      "items": {
                        "type": "string",
                        "example": "The name field is required."
                      }
                    },
                    "email": {
                      "type": "array",
                      "items": {
                        "type": "string",
                        "example": "The email field is required."
                      }
                    },
                    "password": {
                      "type": "array",
                      "items": {
                        "type": "string",
                        "example": "The password field is required."
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```