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": "<string>",
"company": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"success_url": "<string>",
"failure_url": "<string>",
"id": "<string>",
"first_name": "<string>",
"last_name": "<string>"
}
'import requests
url = "https://api.paywise.de/partner/v1/userinvites/"
payload = {
"email": "<string>",
"company": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"success_url": "<string>",
"failure_url": "<string>",
"id": "<string>",
"first_name": "<string>",
"last_name": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
email: '<string>',
company: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
success_url: '<string>',
failure_url: '<string>',
id: '<string>',
first_name: '<string>',
last_name: '<string>'
})
};
fetch('https://api.paywise.de/partner/v1/userinvites/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.paywise.de/partner/v1/userinvites/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'email' => '<string>',
'company' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'success_url' => '<string>',
'failure_url' => '<string>',
'id' => '<string>',
'first_name' => '<string>',
'last_name' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.paywise.de/partner/v1/userinvites/"
payload := strings.NewReader("{\n \"email\": \"<string>\",\n \"company\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"success_url\": \"<string>\",\n \"failure_url\": \"<string>\",\n \"id\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.paywise.de/partner/v1/userinvites/")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"<string>\",\n \"company\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"success_url\": \"<string>\",\n \"failure_url\": \"<string>\",\n \"id\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.paywise.de/partner/v1/userinvites/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"<string>\",\n \"company\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"success_url\": \"<string>\",\n \"failure_url\": \"<string>\",\n \"id\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"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"
}{
"message": "<string>"
}{
"detail": "<string>"
}User Invites
Create User Invite
Start onboarding of a new user in a company.
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": "<string>",
"company": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"success_url": "<string>",
"failure_url": "<string>",
"id": "<string>",
"first_name": "<string>",
"last_name": "<string>"
}
'import requests
url = "https://api.paywise.de/partner/v1/userinvites/"
payload = {
"email": "<string>",
"company": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"success_url": "<string>",
"failure_url": "<string>",
"id": "<string>",
"first_name": "<string>",
"last_name": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
email: '<string>',
company: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
success_url: '<string>',
failure_url: '<string>',
id: '<string>',
first_name: '<string>',
last_name: '<string>'
})
};
fetch('https://api.paywise.de/partner/v1/userinvites/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.paywise.de/partner/v1/userinvites/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'email' => '<string>',
'company' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'success_url' => '<string>',
'failure_url' => '<string>',
'id' => '<string>',
'first_name' => '<string>',
'last_name' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.paywise.de/partner/v1/userinvites/"
payload := strings.NewReader("{\n \"email\": \"<string>\",\n \"company\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"success_url\": \"<string>\",\n \"failure_url\": \"<string>\",\n \"id\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.paywise.de/partner/v1/userinvites/")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"<string>\",\n \"company\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"success_url\": \"<string>\",\n \"failure_url\": \"<string>\",\n \"id\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.paywise.de/partner/v1/userinvites/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"<string>\",\n \"company\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"success_url\": \"<string>\",\n \"failure_url\": \"<string>\",\n \"id\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"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"
}{
"message": "<string>"
}{
"detail": "<string>"
}This endpoint will return a 400 Status Code in case the email address provided is already in use
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."]}.Since September 02, 2026 this endpoint accepts a slightly wider range of valid addresses than
before, for example addresses containing an apostrophe in the local part or a non-ASCII domain.
Addresses that were accepted before are still accepted. Addresses longer than 128 characters are
now rejected with the same error; previously they were accepted here and failed later when the
invitation was stored.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, and no invite is created.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/jsonapplication/x-www-form-urlencodedmultipart/form-data
E-Mail of the user to invite
Minimum string length:
1UUID of the company that the user is going to be part of
Success URL - the user will be redirected here after successfully completing authentication flow
Minimum string length:
1Failure URL - the user will be redirected here if either the flow was cancelled or not completed for any other reason
Minimum string length:
1Minimum string length:
1First name of the user
Minimum string length:
1Last name of the user
Minimum string length:
1Response
E-Mail of the user to invite
UUID of the company that the user is going to be part of
Success URL - the user will be redirected here after successfully completing authentication flow
Failure URL - the user will be redirected here if either the flow was cancelled or not completed for any other reason
Invite URL - Redirect your User to this URL for tem to complete the onboading process
Expiry date/time of the request. After this timestamp is expired, users will have to be re-registered with a new invite
Current status of the User invite
First name of the user
Last name of the user