Skip to main content
POST
/
partner
/
v1
/
users
Create user
curl --request POST \
  --url https://api.paywise.de/partner/v1/users/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "company": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "id": "<string>",
  "notification_channels": [
    {
      "channel_type": "EMAIL",
      "value": "<string>",
      "notification_types": [
        "STATUS_UPDATE"
      ]
    }
  ],
  "skip_email_verification": false
}
'
{
  "href": "https://api.paywise.de/partner/v1/users/ab5fc850-7bb3-4c33-9741-d1305dfa41d9/",
  "id": "ab5fc850-7bb3-4c33-9741-d1305dfa41d9",
  "email": "[email protected]",
  "first_name": "Max",
  "last_name": "Mustermann",
  "company": "6196ba03-83f2-46ea-83e1-a087bd0c5acc",
  "email_verified": true,
  "notification_channels": [
    {
      "channel_type": "EMAIL",
      "value": "[email protected]",
      "notification_types": [
        "REQUESTS_TO_CLIENT",
        "STATUS_UPDATE",
        "STATEMENTS"
      ]
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.paywise.de/llms.txt

Use this file to discover all available pages before exploring further.

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

Authorizations

​
Authorization
string
header
required

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

Body

​
email
string
required

E-Mail des Benutzers

Minimum string length: 1
​
first_name
string
required

Vorname des Benutzers

Minimum string length: 1
​
last_name
string
required

Nachname des Benutzers

Minimum string length: 1
​
company
string<uuid>
required

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
default: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

Response

​
href
string<uri>
required
read-only
​
email
string
required

E-Mail des Benutzers

​
first_name
string
required

Vorname des Benutzers

​
last_name
string
required

Nachname des Benutzers

​
company
string<uuid>
required

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

​
email_verified
boolean
required
read-only
​
id
string
​
notification_channels
object[]

Notification settings for the user