Skip to main content
POST
/
partner
/
v1
/
userinvites
/
Create User Invite
curl --request POST \
  --url https://api.paywise.de/partner/v1/userinvites/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "email": "[email protected]",
  "success_url": "Max",
  "failure_url": "Mustermann",
  "company": "6196ba03-83f2-46ea-83e1-a087bd0c5acc",
  "first_name": "Max",
  "last_name": "Mustermann"
}'
{
  "id": "c70e7a7b-8495-4a79-920e-25d4d0192511",
  "email": "[email protected]",
  "first_name": "Max",
  "last_name": "Mustermann",
  "company": "d16bfc7a-453c-4ea6-834a-25a586b5e4d6",
  "success_url": "https://app.sample-partner.com/onboarding/success/",
  "failure_url": "https://app.sample-partner.com/onboarding/failure/",
  "invite_url": "http://app.paywise.de/partner/onboarding/c70e7a7b-8495-4a79-920e-25d4d0192511/",
  "expiry": "2024-10-07T11:52:57.968546+02:00",
  "status": "OPEN"
}
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 of the user to invite

Minimum length: 1
​
company
string<uuid>
required

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

​
success_url
string
required

Success URL - the user will be redirected here after successfully completing authentication flow

Minimum length: 1
​
failure_url
string
required

Failure URL - the user will be redirected here if either the flow was cancelled or not completed for any other reason

Minimum length: 1
​
id
string
Minimum length: 1
​
first_name
string

First name of the user

Minimum length: 1
​
last_name
string

Last name of the user

Minimum length: 1

Response

​
email
string
required

E-Mail of the user to invite

​
company
string<uuid>
required

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

​
success_url
string
required

Success URL - the user will be redirected here after successfully completing authentication flow

​
failure_url
string
required

Failure URL - the user will be redirected here if either the flow was cancelled or not completed for any other reason

​
invite_url
string
required

Invite URL - Redirect your User to this URL for tem to complete the onboading process

​
expiry
string<date-time>
required

Expiry date/time of the request. After this timestamp is expired, users will have to be re-registered with a new invite

​
status
string
required

Current status of the User invite

​
id
string
​
first_name
string

First name of the user

​
last_name
string

Last name of the user