---
title: "Request registration"
method: POST
path: "/api/v1/users/registrations/request"
tags: ["Register"]
---

# Request registration

`POST /api/v1/users/registrations/request`

Signup has to be enabled and require approval on the instance

## Request body

- UserRegistrationRequest
  - `channel` object — channel base information used to create the first channel of the user
    - `displayName` string
    - `name` string — immutable name of the channel, used to interact with its actor
  - `displayName` string — editable name of the user, displayed in its representations
  - `email` string, email, required — email of the user, used for login or service communications
  - `password` string, password, required
  - `username` string, required — immutable name of the user, used to find or mention its actor
  - `registrationReason` string, required — reason for the user to register on the instance

## Response `200`

successful operation

- UserRegistration
  - `accountDisplayName` string
  - `channelDisplayName` string
  - `channelHandle` string
  - `createdAt` string, date-time
  - `email` string, email
  - `emailVerified` boolean
  - `id` integer
  - `moderationResponse` string, nullable
  - `registrationReason` string
  - `state` object
    - `id` 1 | 2 | 3 — The registration state (Pending = `1`, Rejected = `2`, Accepted = `3`)
    - `label` string
  - `updatedAt` string, date-time
  - `user` object, nullable — If the registration has been accepted, this is a partial user object created by the registration
    - `id` integer
  - `username` string

## Other responses

- `400` — request error or signup approval is not enabled on the instance
- `403` — user registration is not enabled, user limit is reached, registration is not allowed for the ip or blocked by a plugin
- `409` — a user or registration with this username, channel name or email already exists

---

[API](https://skmtc.net/cpy/apis/peertube.md) · [All operations](https://skmtc.net/cpy/apis/peertube/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cpy/peertube/versions/efe11b159e43/schema)