Read the account's guardian declaration
curl --request GET \
--url https://app.sideshift.app/api/embed/accounts/{id}/guardian \
--header 'x-api-key: <api-key>'import requests
url = "https://app.sideshift.app/api/embed/accounts/{id}/guardian"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://app.sideshift.app/api/embed/accounts/{id}/guardian', 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://app.sideshift.app/api/embed/accounts/{id}/guardian",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://app.sideshift.app/api/embed/accounts/{id}/guardian"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.sideshift.app/api/embed/accounts/{id}/guardian")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.sideshift.app/api/embed/accounts/{id}/guardian")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"guardian": {
"declaration": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"companyId": "<string>",
"creatorId": "<string>",
"sandbox": true,
"provider": "<string>",
"providerAccountId": "<string>",
"providerVerificationId": "<string>",
"relationship": "parent",
"creatorFirstName": "<string>",
"creatorLastName": "<string>",
"creatorDateOfBirth": "2023-12-25",
"guardianFirstName": "<string>",
"guardianLastName": "<string>",
"attestationVersion": "<string>",
"attestedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"writtenByKind": "<string>",
"runId": "<string>"
},
"currentIdentityAndDestination": {
"firstName": "<string>",
"lastName": "<string>",
"verified": true,
"verificationId": "<string>",
"payoutMethodId": "<string>",
"payoutMethodType": "<string>",
"payoutMethodCountry": "<string>",
"payoutMethodNickname": "<string>",
"payoutMethodPayerName": "<string>"
}
}
}
}Read the account's guardian declaration
Returns the stated guardian relationship owned by your company and the current stored identity and payout-method summary. A declaration is not proof of legal guardianship or successful KYC. Current provider projections may lag updates. The identity summary is returned only when its stored verification ID matches the declaration’s latest verification ID. Both fields are null if an accessible account has no declaration owned by your company. Another linked company cannot read the owner’s declaration. Uses the SideShift account ID. Sandbox requests, inaccessible accounts, and accounts without a provider account return 404.
GET
/
accounts
/
{id}
/
guardian
Read the account's guardian declaration
curl --request GET \
--url https://app.sideshift.app/api/embed/accounts/{id}/guardian \
--header 'x-api-key: <api-key>'import requests
url = "https://app.sideshift.app/api/embed/accounts/{id}/guardian"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://app.sideshift.app/api/embed/accounts/{id}/guardian', 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://app.sideshift.app/api/embed/accounts/{id}/guardian",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://app.sideshift.app/api/embed/accounts/{id}/guardian"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.sideshift.app/api/embed/accounts/{id}/guardian")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.sideshift.app/api/embed/accounts/{id}/guardian")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"guardian": {
"declaration": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"companyId": "<string>",
"creatorId": "<string>",
"sandbox": true,
"provider": "<string>",
"providerAccountId": "<string>",
"providerVerificationId": "<string>",
"relationship": "parent",
"creatorFirstName": "<string>",
"creatorLastName": "<string>",
"creatorDateOfBirth": "2023-12-25",
"guardianFirstName": "<string>",
"guardianLastName": "<string>",
"attestationVersion": "<string>",
"attestedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"writtenByKind": "<string>",
"runId": "<string>"
},
"currentIdentityAndDestination": {
"firstName": "<string>",
"lastName": "<string>",
"verified": true,
"verificationId": "<string>",
"payoutMethodId": "<string>",
"payoutMethodType": "<string>",
"payoutMethodCountry": "<string>",
"payoutMethodNickname": "<string>",
"payoutMethodPayerName": "<string>"
}
}
}
}