Remove an address from a gtoken allowlist

curl --request DELETE \
  --url https://sandbox.groundtech.co/v2/gvaults/{gVaultId}/allowlist/{address} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://sandbox.groundtech.co/v2/gvaults/{gVaultId}/allowlist/{address}"

headers = {"Authorization": "Bearer <token>"}

response = requests.delete(url, headers=headers)

print(response.text)

const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};

fetch('https://sandbox.groundtech.co/v2/gvaults/{gVaultId}/allowlist/{address}', 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://sandbox.groundtech.co/v2/gvaults/{gVaultId}/allowlist/{address}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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://sandbox.groundtech.co/v2/gvaults/{gVaultId}/allowlist/{address}"

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://sandbox.groundtech.co/v2/gvaults/{gVaultId}/allowlist/{address}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "status": "confirmed",
  "allowed": true,
  "canManage": true
}

{
  "status": "submitted",
  "allowed": false,
  "canManage": true,
  "transactionHash": "0xabababababababababababababababababababababababababababababababab"
}

{
  "error": "<string>",
  "code": "validation_error"
}

{
  "error": "Unauthenticated request",
  "message": "Missing or invalid bearer token"
}

{
  "error": "<string>",
  "code": "validation_error"
}

{
  "error": "<string>",
  "code": "validation_error"
}

{
  "error": "<string>",
  "code": "validation_error"
}

{
  "error": "Service temporarily unavailable",
  "code": "service_temporarily_unavailable",
  "retryable": true
}

DELETE

gvaults

{gVaultId}

allowlist

{address}

Remove an address from a gtoken allowlist

curl --request DELETE \
  --url https://sandbox.groundtech.co/v2/gvaults/{gVaultId}/allowlist/{address} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://sandbox.groundtech.co/v2/gvaults/{gVaultId}/allowlist/{address}"

headers = {"Authorization": "Bearer <token>"}

response = requests.delete(url, headers=headers)

print(response.text)

const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};

fetch('https://sandbox.groundtech.co/v2/gvaults/{gVaultId}/allowlist/{address}', 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://sandbox.groundtech.co/v2/gvaults/{gVaultId}/allowlist/{address}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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://sandbox.groundtech.co/v2/gvaults/{gVaultId}/allowlist/{address}"

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://sandbox.groundtech.co/v2/gvaults/{gVaultId}/allowlist/{address}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "status": "confirmed",
  "allowed": true,
  "canManage": true
}

{
  "status": "submitted",
  "allowed": false,
  "canManage": true,
  "transactionHash": "0xabababababababababababababababababababababababababababababababab"
}

{
  "error": "<string>",
  "code": "validation_error"
}

{
  "error": "Unauthenticated request",
  "message": "Missing or invalid bearer token"
}

{
  "error": "<string>",
  "code": "validation_error"
}

{
  "error": "<string>",
  "code": "validation_error"
}

{
  "error": "<string>",
  "code": "validation_error"
}

{
  "error": "Service temporarily unavailable",
  "code": "service_temporarily_unavailable",
  "retryable": true
}

The managing organization can remove an address’s access. Poll the access endpoint until the change confirms. Removal does not burn the address’s shares. Access removal depends on the source’s interface:

ground_ustb_v1: removing deposit access leaves existing shares redeemable, subject to liquidity, pauses, and any separate wallet freeze.
tempo_earn_v1: removing access blocks deposits, share transfers, and redemptions. Restore access and wait for confirmation before trying again.

See Manage gtoken access for the procedure.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

gVaultId

enum<string>

required

Source ID returned by the gtoken catalogue. Source ID returned by the gtoken yield-source catalogue.

Available options:

ground-ustb-vault,

ground-tempo-prime-vault

Example:

"ground-ustb-vault"

address

string

required

Nonzero EVM EOA or contract address. Valid nonzero EVM EOA or contract address. Mixed-case values must use a valid EIP-55 checksum.

Required string length: 42

Pattern: ^0x(?!0{40}$)[0-9a-fA-F]{40}$

Example:

"0x3bf25a73a1f1033c2d50ac65f3c9d6a44123db81"

Response

Already confirmed.

status

enum<string>

required

Available options:

screening,

queued,

submitting,

submitted,

confirmed,

failed,

reconciliation_required,

pending,

unmanaged,

not_allowlisted

allowed

boolean

required

canManage

boolean

required

transactionHash

string | null

EVM transaction hash, or null when no transaction was submitted.

Required string length: 66

Pattern: ^0x[0-9a-fA-F]{64}$

Example:

"0xabababababababababababababababababababababababababababababababab"

Getting Started

Integration Guides

Integration Examples

Operations

Resources

API Reference

Remove an address from a gtoken allowlist

Authorizations

Path Parameters

Response