Skip to main content
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/lei",
    "/attributes/formation_date"
  ]
}
'
{
  "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"
  }
}

Authorizations

​
Authorization
string
header
required

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
enum<string>
required

Subject type discriminator.

Available options:
entity,
individual
​
subject_id
string
required

Stable subject identifier within its type namespace.

Body

application/json
​
requesting_tenant_id
string
required
​
reason_code
string | null
Example:

"annual_review"

​
message
string | null
​
requested_paths
string[] | null

JSON Pointer paths to specific attributes being requested.

Example:
[
  "/attributes/lei",
  "/attributes/formation_date"
]

Response

Refresh request created.

​
refresh_request
object