Create a refresh request
curl --request POST \
--url https://tally-platform-api-xwka6vu2kq-ue.a.run.app/v1/subjects/{subject_type}/{subject_id}/refresh-requests \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"requesting_tenant_id": "<string>",
"reason_code": "annual_review",
"message": "<string>",
"requested_paths": [
"/attributes/identifiers/0",
"/attributes/legal/date_of_incorporation"
]
}
'import requests
url = "https://tally-platform-api-xwka6vu2kq-ue.a.run.app/v1/subjects/{subject_type}/{subject_id}/refresh-requests"
payload = {
"requesting_tenant_id": "<string>",
"reason_code": "annual_review",
"message": "<string>",
"requested_paths": ["/attributes/identifiers/0", "/attributes/legal/date_of_incorporation"]
}
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({
requesting_tenant_id: '<string>',
reason_code: 'annual_review',
message: '<string>',
requested_paths: ['/attributes/identifiers/0', '/attributes/legal/date_of_incorporation']
})
};
fetch('https://tally-platform-api-xwka6vu2kq-ue.a.run.app/v1/subjects/{subject_type}/{subject_id}/refresh-requests', 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://tally-platform-api-xwka6vu2kq-ue.a.run.app/v1/subjects/{subject_type}/{subject_id}/refresh-requests",
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([
'requesting_tenant_id' => '<string>',
'reason_code' => 'annual_review',
'message' => '<string>',
'requested_paths' => [
'/attributes/identifiers/0',
'/attributes/legal/date_of_incorporation'
]
]),
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://tally-platform-api-xwka6vu2kq-ue.a.run.app/v1/subjects/{subject_type}/{subject_id}/refresh-requests"
payload := strings.NewReader("{\n \"requesting_tenant_id\": \"<string>\",\n \"reason_code\": \"annual_review\",\n \"message\": \"<string>\",\n \"requested_paths\": [\n \"/attributes/identifiers/0\",\n \"/attributes/legal/date_of_incorporation\"\n ]\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://tally-platform-api-xwka6vu2kq-ue.a.run.app/v1/subjects/{subject_type}/{subject_id}/refresh-requests")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"requesting_tenant_id\": \"<string>\",\n \"reason_code\": \"annual_review\",\n \"message\": \"<string>\",\n \"requested_paths\": [\n \"/attributes/identifiers/0\",\n \"/attributes/legal/date_of_incorporation\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://tally-platform-api-xwka6vu2kq-ue.a.run.app/v1/subjects/{subject_type}/{subject_id}/refresh-requests")
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 \"requesting_tenant_id\": \"<string>\",\n \"reason_code\": \"annual_review\",\n \"message\": \"<string>\",\n \"requested_paths\": [\n \"/attributes/identifiers/0\",\n \"/attributes/legal/date_of_incorporation\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"refresh_request": {
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"subject_type": "<string>",
"subject_id": "<string>",
"requesting_tenant_id": "<string>",
"reason_code": "<string>",
"message": "<string>",
"requested_paths": [
"<string>"
],
"fulfilled_snapshot_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"fulfilled_at": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "validation_error",
"message": "Request body failed schema validation.",
"details": [
{
"path": "/subject_id",
"message": "subject_id is required."
}
]
}
}{
"error": {
"code": "unauthorized",
"message": "Authentication required."
}
}{
"error": {
"code": "forbidden",
"message": "Owner or grant required."
}
}Refresh Requests
Create Refresh Request
A counterparty (or owner) submits a request asking the subject owner to
update or confirm specific identity attributes. The requesting_tenant_id
must be set to the caller’s tenant. Requires an active grant or ownership.
POST
/
v1
/
subjects
/
{subject_type}
/
{subject_id}
/
refresh-requests
Create a refresh request
curl --request POST \
--url https://tally-platform-api-xwka6vu2kq-ue.a.run.app/v1/subjects/{subject_type}/{subject_id}/refresh-requests \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"requesting_tenant_id": "<string>",
"reason_code": "annual_review",
"message": "<string>",
"requested_paths": [
"/attributes/identifiers/0",
"/attributes/legal/date_of_incorporation"
]
}
'import requests
url = "https://tally-platform-api-xwka6vu2kq-ue.a.run.app/v1/subjects/{subject_type}/{subject_id}/refresh-requests"
payload = {
"requesting_tenant_id": "<string>",
"reason_code": "annual_review",
"message": "<string>",
"requested_paths": ["/attributes/identifiers/0", "/attributes/legal/date_of_incorporation"]
}
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({
requesting_tenant_id: '<string>',
reason_code: 'annual_review',
message: '<string>',
requested_paths: ['/attributes/identifiers/0', '/attributes/legal/date_of_incorporation']
})
};
fetch('https://tally-platform-api-xwka6vu2kq-ue.a.run.app/v1/subjects/{subject_type}/{subject_id}/refresh-requests', 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://tally-platform-api-xwka6vu2kq-ue.a.run.app/v1/subjects/{subject_type}/{subject_id}/refresh-requests",
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([
'requesting_tenant_id' => '<string>',
'reason_code' => 'annual_review',
'message' => '<string>',
'requested_paths' => [
'/attributes/identifiers/0',
'/attributes/legal/date_of_incorporation'
]
]),
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://tally-platform-api-xwka6vu2kq-ue.a.run.app/v1/subjects/{subject_type}/{subject_id}/refresh-requests"
payload := strings.NewReader("{\n \"requesting_tenant_id\": \"<string>\",\n \"reason_code\": \"annual_review\",\n \"message\": \"<string>\",\n \"requested_paths\": [\n \"/attributes/identifiers/0\",\n \"/attributes/legal/date_of_incorporation\"\n ]\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://tally-platform-api-xwka6vu2kq-ue.a.run.app/v1/subjects/{subject_type}/{subject_id}/refresh-requests")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"requesting_tenant_id\": \"<string>\",\n \"reason_code\": \"annual_review\",\n \"message\": \"<string>\",\n \"requested_paths\": [\n \"/attributes/identifiers/0\",\n \"/attributes/legal/date_of_incorporation\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://tally-platform-api-xwka6vu2kq-ue.a.run.app/v1/subjects/{subject_type}/{subject_id}/refresh-requests")
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 \"requesting_tenant_id\": \"<string>\",\n \"reason_code\": \"annual_review\",\n \"message\": \"<string>\",\n \"requested_paths\": [\n \"/attributes/identifiers/0\",\n \"/attributes/legal/date_of_incorporation\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"refresh_request": {
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"subject_type": "<string>",
"subject_id": "<string>",
"requesting_tenant_id": "<string>",
"reason_code": "<string>",
"message": "<string>",
"requested_paths": [
"<string>"
],
"fulfilled_snapshot_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"fulfilled_at": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "validation_error",
"message": "Request body failed schema validation.",
"details": [
{
"path": "/subject_id",
"message": "subject_id is required."
}
]
}
}{
"error": {
"code": "unauthorized",
"message": "Authentication required."
}
}{
"error": {
"code": "forbidden",
"message": "Owner or grant required."
}
}Authorizations
Firebase Auth JWT issued by Google Identity Platform.
Obtain a token by signing in at your app domain and calling
firebase.auth().currentUser.getIdToken().
Path Parameters
Subject type discriminator.
Available options:
individual, organization Stable subject identifier within its type namespace.
Body
application/json
Response
Refresh request created.
Show child attributes
Show child attributes
⌘I