---
title: "Register with application"
method: POST
path: "/register"
---

# Register with application

`POST /register`

Supports both json and form request types

## Query parameters

- `next` string

## Request body

- Register
  - `email` string, required — user identifier. This is by default an email address, but can be any (unique) field that is part of the User model and is defined in the USER_IDENTITY_ATTRIBUTES configuration variable. It will also match against numeric User model fields.
  - `password` string, required — Password

## Response `200`

Register response

- DefaultJsonResponse
  - `user` object, required — By default just 'id', and 'authentication_token' are returned. However by overriding _User::get_security_payload()_ any attributes of the User model can be returned.
    - `id` integer, required — Unique user id (primary key)
    - `authentication_token` string — Token to be used in future token-based API calls.
  - `csrf_token` string — Session CSRF token

## Other responses

- `302` — Successful registration with form data body.
- `400` — Errors while validating registration form

## Changes

- **2019-07-23** `11c8459a5c04` — 2 breaking, 1 warning, 4 info
  - the response's body type changed from no type to `object` for status `200` (media type: application/json)
  - the `response/errors` response's property type changed from `array` to `object` for status `400`
  - removed the optional property `response/field_errors` from the response with the `400` status
  - removed `#/components/schemas/BaseJsonResponse, subschema #2` from the response body `allOf` list for the response status `200` (media type: application/json)
  - …3 more

[Change history](https://skmtc.dev/pallets-eco/apis/flask-security-external-api/changes/register/post.md)

---

[API](https://skmtc.dev/pallets-eco/apis/flask-security-external-api.md) · [All operations](https://skmtc.dev/pallets-eco/apis/flask-security-external-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/pallets-eco/flask-security-external-api/revisions/11c8459a5c04/schema)