Create Onboarding Token
curl --request POST \
--url https://api.ever.day/onboarding/token \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"publicIdentifier": "john-doe-1234",
"redirectUrl": "https://platform.client.com/complete"
}
'import requests
url = "https://api.ever.day/onboarding/token"
payload = {
"publicIdentifier": "john-doe-1234",
"redirectUrl": "https://platform.client.com/complete"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
publicIdentifier: 'john-doe-1234',
redirectUrl: 'https://platform.client.com/complete'
})
};
fetch('https://api.ever.day/onboarding/token', 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.ever.day/onboarding/token",
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([
'publicIdentifier' => 'john-doe-1234',
'redirectUrl' => 'https://platform.client.com/complete'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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.ever.day/onboarding/token"
payload := strings.NewReader("{\n \"publicIdentifier\": \"john-doe-1234\",\n \"redirectUrl\": \"https://platform.client.com/complete\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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.ever.day/onboarding/token")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"publicIdentifier\": \"john-doe-1234\",\n \"redirectUrl\": \"https://platform.client.com/complete\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ever.day/onboarding/token")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"publicIdentifier\": \"john-doe-1234\",\n \"redirectUrl\": \"https://platform.client.com/complete\"\n}"
response = http.request(request)
puts response.read_body{
"signature": "a1b2c3d4...",
"status": "pending",
"link": "https://onboarding.ever.day/243324-234324-123123?signature=a1b2c3..."
}onboarding
Create Onboarding Token
Generates an onboarding token, returning a unique link with a signature. The API consumer is responsible for sending the invitation or redirecting users to this link.
POST
/
onboarding
/
token
Create Onboarding Token
curl --request POST \
--url https://api.ever.day/onboarding/token \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"publicIdentifier": "john-doe-1234",
"redirectUrl": "https://platform.client.com/complete"
}
'import requests
url = "https://api.ever.day/onboarding/token"
payload = {
"publicIdentifier": "john-doe-1234",
"redirectUrl": "https://platform.client.com/complete"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
publicIdentifier: 'john-doe-1234',
redirectUrl: 'https://platform.client.com/complete'
})
};
fetch('https://api.ever.day/onboarding/token', 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.ever.day/onboarding/token",
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([
'publicIdentifier' => 'john-doe-1234',
'redirectUrl' => 'https://platform.client.com/complete'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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.ever.day/onboarding/token"
payload := strings.NewReader("{\n \"publicIdentifier\": \"john-doe-1234\",\n \"redirectUrl\": \"https://platform.client.com/complete\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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.ever.day/onboarding/token")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"publicIdentifier\": \"john-doe-1234\",\n \"redirectUrl\": \"https://platform.client.com/complete\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ever.day/onboarding/token")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"publicIdentifier\": \"john-doe-1234\",\n \"redirectUrl\": \"https://platform.client.com/complete\"\n}"
response = http.request(request)
puts response.read_body{
"signature": "a1b2c3d4...",
"status": "pending",
"link": "https://onboarding.ever.day/243324-234324-123123?signature=a1b2c3..."
}Authorizations
Include your API key in the x-api-key header to authenticate requests. Each organisation is provided with a unique API key. If your key is lost or compromised, contact support to request a new one.
Body
application/json
Response
Onboarding token successfully created.
A unique signature used for verifying the onboarding link.
Example:
"a1b2c3d4..."
The status of the onboarding process.
Available options:
pending, completed, revoked Example:
"pending"
The generated onboarding link for the user. Null if revoked.
Example:
"https://onboarding.ever.day/243324-234324-123123?signature=a1b2c3..."