Skip to main content
POST
Create user
This page documents a frozen v1 API. It receives only critical correctness or security corrections. For new integrations, use the current API and follow the linked migration guide.
Note that this endpoint requires the permission API_ONLY_ONBOARDING on your API Key
This endpoint will return a 400 Status Code in case the email address provided is already in use
Since September 02, 2026 the email field is validated for syntax. A malformed address is rejected with a 400 Status Code and the field-level error {"email": ["Invalid email address. Please provide a valid address."]}, and no user, membership, notification channel or invitation is created.Addresses longer than 128 characters are rejected the same way. The address is copied into several columns during onboarding, the narrowest of which hold 128 characters; a longer address previously created a user that could not be completed.Before this change the endpoint accepted any string. A malformed address was stored, the invitation email silently failed to deliver, and every later claim submitted for that company failed. If your integration forwards addresses typed by end users, expect a 400 where you previously received a 201.
This endpoint returns a 400 Status Code if the company has been offboarded (permanently closed) on paywise. Offboarded companies no longer accept new users or invitations.

Autorisierungen

Authorization
string
header
erforderlich

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

email
string
erforderlich

E-Mail des Benutzers

Minimum string length: 1
first_name
string
erforderlich

Vorname des Benutzers

Minimum string length: 1
last_name
string
erforderlich

Nachname des Benutzers

Minimum string length: 1
company
string<uuid>
erforderlich

UUID of the company that the user is going to be part of

id
string
Minimum string length: 1
notification_channels
object[]

Notification settings for the user

skip_email_verification
boolean
Standard:false
write-only

Use this flag to indicate that you already validated the user's email address in advance. This way you can start sending claims right away, without waiting for user opt-in

Antwort

href
string<uri>
erforderlich
read-only
email
string
erforderlich

E-Mail des Benutzers

first_name
string
erforderlich

Vorname des Benutzers

last_name
string
erforderlich

Nachname des Benutzers

company
string<uuid>
erforderlich

UUID of the company that the user is going to be part of

email_verified
boolean
erforderlich
read-only
id
string
notification_channels
object[]

Notification settings for the user