Skip to main content
PUT
Allow an address to deposit into a gtoken backing contract
Grants an EOA, multisig, or contract permission to deposit into an existing Ground vault backing a gtoken. Call this from your backend and keep the API key on the server. For a new external contract address, provide an ownership proof that its ERC-1271 isValidSignature(bytes32,bytes) method accepts. Ground submits the onchain allowlist transaction after verifying the proof and completing screening. See Manage gtoken access.

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"

Body

application/json
ownershipProof
object

Required to establish the managing organization for a new external wallet.

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"