Verify or link UPA email
curl --request POST \
--url https://prod-api.stableyard.fi/v2/accounts/{accountId}/email/verification-challenges \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"email": "[email protected]",
"verification": {
"method": "partner_asserted",
"verifiedAt": "2026-08-28T10:00:00.000Z",
"reference": "example"
}
}
'import requests
url = "https://prod-api.stableyard.fi/v2/accounts/{accountId}/email/verification-challenges"
payload = {
"email": "[email protected]",
"verification": {
"method": "partner_asserted",
"verifiedAt": "2026-08-28T10:00:00.000Z",
"reference": "example"
}
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Basic <encoded-value>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
email: '[email protected]',
verification: {
method: 'partner_asserted',
verifiedAt: '2026-08-28T10:00:00.000Z',
reference: 'example'
}
})
};
fetch('https://prod-api.stableyard.fi/v2/accounts/{accountId}/email/verification-challenges', 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://prod-api.stableyard.fi/v2/accounts/{accountId}/email/verification-challenges",
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' => '[email protected]',
'verification' => [
'method' => 'partner_asserted',
'verifiedAt' => '2026-08-28T10:00:00.000Z',
'reference' => 'example'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-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://prod-api.stableyard.fi/v2/accounts/{accountId}/email/verification-challenges"
payload := strings.NewReader("{\n \"email\": \"[email protected]\",\n \"verification\": {\n \"method\": \"partner_asserted\",\n \"verifiedAt\": \"2026-08-28T10:00:00.000Z\",\n \"reference\": \"example\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("Authorization", "Basic <encoded-value>")
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://prod-api.stableyard.fi/v2/accounts/{accountId}/email/verification-challenges")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"[email protected]\",\n \"verification\": {\n \"method\": \"partner_asserted\",\n \"verifiedAt\": \"2026-08-28T10:00:00.000Z\",\n \"reference\": \"example\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://prod-api.stableyard.fi/v2/accounts/{accountId}/email/verification-challenges")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"[email protected]\",\n \"verification\": {\n \"method\": \"partner_asserted\",\n \"verifiedAt\": \"2026-08-28T10:00:00.000Z\",\n \"reference\": \"example\"\n }\n}"
response = http.request(request)
puts response.read_body{
"contact": {
"id": "account_contact_123",
"type": "email",
"email": "al***@example.com",
"status": "pending_verification",
"verifiedAt": "2026-08-28T10:00:00.000Z",
"verificationMethod": "stableyard_email_otp",
"createdAt": "2026-08-28T10:00:00.000Z",
"updatedAt": "2026-08-28T10:00:00.000Z"
},
"challenge": {
"id": "account_email_123",
"email": "al***@example.com",
"status": "pending",
"verificationMethod": "stableyard_email_otp",
"attemptsRemaining": 0,
"expiresAt": "2026-08-28T10:00:00.000Z",
"verifiedAt": "2026-08-28T10:00:00.000Z"
},
"nextAction": {
"type": "none"
}
}{
"error": {
"code": "bad_request",
"message": "The request is invalid",
"details": "example"
}
}{
"error": {
"code": "bad_request",
"message": "The request is invalid",
"details": "example"
}
}{
"error": {
"code": "bad_request",
"message": "The request is invalid",
"details": "example"
}
}{
"error": {
"code": "bad_request",
"message": "The request is invalid",
"details": "example"
}
}{
"error": {
"code": "bad_request",
"message": "The request is invalid",
"details": "example"
}
}{
"error": {
"code": "bad_request",
"message": "The request is invalid",
"details": "example"
}
}{
"error": {
"code": "bad_request",
"message": "The request is invalid",
"details": "example"
}
}Email verification
Verify or link an account email
Start email verification for a UPA, or link an email you already verified.
POST
/
v2
/
accounts
/
{accountId}
/
email
/
verification-challenges
Verify or link UPA email
curl --request POST \
--url https://prod-api.stableyard.fi/v2/accounts/{accountId}/email/verification-challenges \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"email": "[email protected]",
"verification": {
"method": "partner_asserted",
"verifiedAt": "2026-08-28T10:00:00.000Z",
"reference": "example"
}
}
'import requests
url = "https://prod-api.stableyard.fi/v2/accounts/{accountId}/email/verification-challenges"
payload = {
"email": "[email protected]",
"verification": {
"method": "partner_asserted",
"verifiedAt": "2026-08-28T10:00:00.000Z",
"reference": "example"
}
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Basic <encoded-value>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
email: '[email protected]',
verification: {
method: 'partner_asserted',
verifiedAt: '2026-08-28T10:00:00.000Z',
reference: 'example'
}
})
};
fetch('https://prod-api.stableyard.fi/v2/accounts/{accountId}/email/verification-challenges', 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://prod-api.stableyard.fi/v2/accounts/{accountId}/email/verification-challenges",
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' => '[email protected]',
'verification' => [
'method' => 'partner_asserted',
'verifiedAt' => '2026-08-28T10:00:00.000Z',
'reference' => 'example'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-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://prod-api.stableyard.fi/v2/accounts/{accountId}/email/verification-challenges"
payload := strings.NewReader("{\n \"email\": \"[email protected]\",\n \"verification\": {\n \"method\": \"partner_asserted\",\n \"verifiedAt\": \"2026-08-28T10:00:00.000Z\",\n \"reference\": \"example\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("Authorization", "Basic <encoded-value>")
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://prod-api.stableyard.fi/v2/accounts/{accountId}/email/verification-challenges")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"[email protected]\",\n \"verification\": {\n \"method\": \"partner_asserted\",\n \"verifiedAt\": \"2026-08-28T10:00:00.000Z\",\n \"reference\": \"example\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://prod-api.stableyard.fi/v2/accounts/{accountId}/email/verification-challenges")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"[email protected]\",\n \"verification\": {\n \"method\": \"partner_asserted\",\n \"verifiedAt\": \"2026-08-28T10:00:00.000Z\",\n \"reference\": \"example\"\n }\n}"
response = http.request(request)
puts response.read_body{
"contact": {
"id": "account_contact_123",
"type": "email",
"email": "al***@example.com",
"status": "pending_verification",
"verifiedAt": "2026-08-28T10:00:00.000Z",
"verificationMethod": "stableyard_email_otp",
"createdAt": "2026-08-28T10:00:00.000Z",
"updatedAt": "2026-08-28T10:00:00.000Z"
},
"challenge": {
"id": "account_email_123",
"email": "al***@example.com",
"status": "pending",
"verificationMethod": "stableyard_email_otp",
"attemptsRemaining": 0,
"expiresAt": "2026-08-28T10:00:00.000Z",
"verifiedAt": "2026-08-28T10:00:00.000Z"
},
"nextAction": {
"type": "none"
}
}{
"error": {
"code": "bad_request",
"message": "The request is invalid",
"details": "example"
}
}{
"error": {
"code": "bad_request",
"message": "The request is invalid",
"details": "example"
}
}{
"error": {
"code": "bad_request",
"message": "The request is invalid",
"details": "example"
}
}{
"error": {
"code": "bad_request",
"message": "The request is invalid",
"details": "example"
}
}{
"error": {
"code": "bad_request",
"message": "The request is invalid",
"details": "example"
}
}{
"error": {
"code": "bad_request",
"message": "The request is invalid",
"details": "example"
}
}{
"error": {
"code": "bad_request",
"message": "The request is invalid",
"details": "example"
}
}By default this creates a single-use email OTP challenge, valid for ten minutes, for an unverified UPA. Complete it with Confirm an account email verification.
If the app environment’s account email policy is
partner_asserted, send verification.method: partner_asserted to link an email you already verified. Stableyard marks the email verified without sending its own OTP.
Once verified, the UPA email cannot be changed through partner APIs: requesting the same email is an idempotent no-op, and a different email returns 409 conflict. Corrections need a privileged, audited operations workflow. Idempotency-Key is required; reuse it only with the identical email and assertion fields.Authorizations
HTTP Basic auth. Username is the Stableyard app ID. Password is the app secret. The optional Stableyard-Version request header must match the environment pin.
Headers
Use this for retry-safe payment operations from your backend.
Example:
"payment-request-001"
Optional contract-version assertion. Omit it to use the app environment's pinned version. A different supported version is accepted only after that environment is explicitly migrated.
Available options:
2026-09-09 Path Parameters
Canonical account id returned by the Accounts API.
Example:
"acct_123"
Body
application/json
Maximum string length:
320Example:
Show child attributes
Show child attributes