Workspace
Verify a public workspace signup code
Consumes the code for the normalized email and pending public session ID. Issues a resume credential, or returns HTTP200 existing_account sign-in routing after mailbox ownership is verified.
POST
/
workspace-onboarding
/
self-serve
/
verify-code
Verify a public workspace signup code
curl --request POST \
--url https://api.gratona.com/v1/workspace-onboarding/self-serve/verify-code \
--header 'Content-Type: application/json' \
--data '
{
"public_id": "550e8400-e29b-41d4-a716-446655440000",
"email": "jane@example.org",
"verification_code": "012345"
}
'import requests
url = "https://api.gratona.com/v1/workspace-onboarding/self-serve/verify-code"
payload = {
"public_id": "550e8400-e29b-41d4-a716-446655440000",
"email": "jane@example.org",
"verification_code": "012345"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
public_id: '550e8400-e29b-41d4-a716-446655440000',
email: 'jane@example.org',
verification_code: '012345'
})
};
fetch('https://api.gratona.com/v1/workspace-onboarding/self-serve/verify-code', 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.gratona.com/v1/workspace-onboarding/self-serve/verify-code",
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([
'public_id' => '550e8400-e29b-41d4-a716-446655440000',
'email' => 'jane@example.org',
'verification_code' => '012345'
]),
CURLOPT_HTTPHEADER => [
"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.gratona.com/v1/workspace-onboarding/self-serve/verify-code"
payload := strings.NewReader("{\n \"public_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"email\": \"jane@example.org\",\n \"verification_code\": \"012345\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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.gratona.com/v1/workspace-onboarding/self-serve/verify-code")
.header("Content-Type", "application/json")
.body("{\n \"public_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"email\": \"jane@example.org\",\n \"verification_code\": \"012345\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gratona.com/v1/workspace-onboarding/self-serve/verify-code")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"public_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"email\": \"jane@example.org\",\n \"verification_code\": \"012345\"\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"data": {
"public_id": "550e8400-e29b-41d4-a716-446655440000",
"state": "authenticated",
"brand_id": "gratona",
"email": "jane@example.org",
"answers": {
"primary_goal": "fundraising_campaigns",
"starting_point": "launching_new"
},
"automatic_billing": false,
"qualification": "verify_payment_method",
"expires_at": "2026-10-21T12:00:00Z",
"first_name": "Jane",
"last_name": "Donor",
"organization_name": "Example Nonprofit",
"website": "https://example.org/",
"ein": "123456789",
"country_code": "US",
"phone": "+12025550123",
"questions": [
{
"key": "primary_goal",
"prompt": "What would you like Gratona to help you set up first?",
"type": "single_choice",
"required": true,
"options": [
{
"value": "fundraising_campaigns",
"label": "Fundraising campaigns and donations"
}
]
}
]
},
"session_token": "example-session-token-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}{
"status": "error",
"code": "workspace_onboarding_session_unavailable",
"message": "This setup session is no longer available. Start again."
}{
"status": "error",
"code": "workspace_onboarding_session_unavailable",
"message": "This setup session is no longer available. Start again."
}{
"status": "error",
"code": "workspace_onboarding_session_unavailable",
"message": "This setup session is no longer available. Start again."
}{
"status": "error",
"code": "workspace_onboarding_session_unavailable",
"message": "This setup session is no longer available. Start again."
}{
"status": "error",
"code": "workspace_onboarding_session_unavailable",
"message": "This setup session is no longer available. Start again."
}Body
application/json
Validated request fields for this operation.
Public setup-session UUID.
Example:
"550e8400-e29b-41d4-a716-446655440000"
Mailbox that will own the new workspace.
Maximum string length:
255Example:
"jane@example.org"
Six-digit mailbox verification code; leading zeroes are significant.
Required string length:
6Pattern:
^[0-9]{6}$Example:
"012345"
Response
Operation result.
- Option 1
- Option 2
Available options:
success Example:
"success"
Show child attributes
Show child attributes
Opaque resume credential; send in X-Workspace-Onboarding-Session. Never log it.
Required string length:
64Example:
"example-session-token-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
⌘I
Verify a public workspace signup code
curl --request POST \
--url https://api.gratona.com/v1/workspace-onboarding/self-serve/verify-code \
--header 'Content-Type: application/json' \
--data '
{
"public_id": "550e8400-e29b-41d4-a716-446655440000",
"email": "jane@example.org",
"verification_code": "012345"
}
'import requests
url = "https://api.gratona.com/v1/workspace-onboarding/self-serve/verify-code"
payload = {
"public_id": "550e8400-e29b-41d4-a716-446655440000",
"email": "jane@example.org",
"verification_code": "012345"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
public_id: '550e8400-e29b-41d4-a716-446655440000',
email: 'jane@example.org',
verification_code: '012345'
})
};
fetch('https://api.gratona.com/v1/workspace-onboarding/self-serve/verify-code', 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.gratona.com/v1/workspace-onboarding/self-serve/verify-code",
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([
'public_id' => '550e8400-e29b-41d4-a716-446655440000',
'email' => 'jane@example.org',
'verification_code' => '012345'
]),
CURLOPT_HTTPHEADER => [
"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.gratona.com/v1/workspace-onboarding/self-serve/verify-code"
payload := strings.NewReader("{\n \"public_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"email\": \"jane@example.org\",\n \"verification_code\": \"012345\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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.gratona.com/v1/workspace-onboarding/self-serve/verify-code")
.header("Content-Type", "application/json")
.body("{\n \"public_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"email\": \"jane@example.org\",\n \"verification_code\": \"012345\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gratona.com/v1/workspace-onboarding/self-serve/verify-code")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"public_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"email\": \"jane@example.org\",\n \"verification_code\": \"012345\"\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"data": {
"public_id": "550e8400-e29b-41d4-a716-446655440000",
"state": "authenticated",
"brand_id": "gratona",
"email": "jane@example.org",
"answers": {
"primary_goal": "fundraising_campaigns",
"starting_point": "launching_new"
},
"automatic_billing": false,
"qualification": "verify_payment_method",
"expires_at": "2026-10-21T12:00:00Z",
"first_name": "Jane",
"last_name": "Donor",
"organization_name": "Example Nonprofit",
"website": "https://example.org/",
"ein": "123456789",
"country_code": "US",
"phone": "+12025550123",
"questions": [
{
"key": "primary_goal",
"prompt": "What would you like Gratona to help you set up first?",
"type": "single_choice",
"required": true,
"options": [
{
"value": "fundraising_campaigns",
"label": "Fundraising campaigns and donations"
}
]
}
]
},
"session_token": "example-session-token-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}{
"status": "error",
"code": "workspace_onboarding_session_unavailable",
"message": "This setup session is no longer available. Start again."
}{
"status": "error",
"code": "workspace_onboarding_session_unavailable",
"message": "This setup session is no longer available. Start again."
}{
"status": "error",
"code": "workspace_onboarding_session_unavailable",
"message": "This setup session is no longer available. Start again."
}{
"status": "error",
"code": "workspace_onboarding_session_unavailable",
"message": "This setup session is no longer available. Start again."
}{
"status": "error",
"code": "workspace_onboarding_session_unavailable",
"message": "This setup session is no longer available. Start again."
}