Skip to main content
GET
Read one wallet being created
Walkthrough: Create a wallet.

Authorizations

Authorization
string
header
required

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

Scopes

treasury_read
bearer_auth
treasury_read
api_key

Headers

TetraFi-Version
enum<string>

The dated API version to answer this request in. Without it, an API key's requests use the version the key pinned when it was created, and a member session uses the current version. A value that is not exactly one supported date answers 400 API_VERSION_UNSUPPORTED before anything runs. The response's TetraFi-Version header names the version used.

Available options:
2026-11-17

Path Parameters

workspaceId
string
required

Workspace ID

walletId
string
required

The wallet creation's id

Response

A wallet being created: what was asked for, who is still missing and where it stands.

connectionId
string
required
countedPerMember
string[]
required

The people the creator confirmed count once per member they appear as.

createdAt
string<date-time>
required
displayName
string
required
expiresAt
string<date-time>
required
family
enum<string>
required

A wallet family. Clients must read a family they do not know as one they can't name.

New values may be added; treat unknown values as other.

Available options:
evm,
solana,
tron,
bitcoin
homeProvider
enum<string>
required

The provider that will hold the wallet's key and verify its owners.

Available options:
privy,
turnkey,
lit
id
string
required

The wallet id; it stays the wallet's id once created.

members
object[]
required
missing
string[]
required

The people who have not proven their factors yet.

networks
string[]
required
scope
enum<string>
required

Whose wallet is being created.

New values may be added; treat unknown values as other.

Available options:
personal,
organisation
status
enum<string>
required

The state of a wallet being created. Clients must read a value they do not know as not usable yet.

New values may be added; treat unknown values as other.

Available options:
pending,
creating,
uncertain,
created,
active,
readbackMismatch,
failed,
expired,
cancelled,
declined
threshold
integer<int32>
required
Required range: x >= 0
workspaceId
string
required
address
string | null

The family address, once the provider created the wallet.

approvalUrl
string | null

The wallet's approval page in TetraFi: each person of it (a personal wallet's one owner too) opens this link, signs in, and proves or confirms their own part on the signing page.

createdBy
string

The workspace user who started the creation.

creatorTradeGrant
null | object

An organisation wallet's creator trade grant chosen with tradeFromThisWallet (notRequested when it was not), read back from the registered wallet's installed access policy; pending until the wallet is registered and its creator acts on it in their own session. Absent for a personal wallet.

endedBy
string | null

The id of the person who ended it before it was created: the creator who cancelled it, or an invited owner who declined it. Absent otherwise.

failureCode
string | null

The named code of a failed or mismatched creation.

home
null | object

Where the provider holds the wallet, once it created it (status created or later): a pointer for reading its owners back, never proof of who owns it.

networkNames
object

The display name of each network in networks, keyed by its CAIP-2 id, as the platform's network registry names it. A network the registry does not name is absent here; it is never given a made-up label.

registeredAt
string<date-time> | null

When the active wallet was registered in the wallet directory, where it is listed and used like any other wallet; absent until then.

registrationFailure
string | null

Why the active wallet's last registration was refused (for example WALLET_REGISTRATION_AUTHORITY_LOST); it is retried while absent from the directory. Absent once registered.

returnTo
null | object

Where the approval page sends a person back, when the creation named a returnUrl.

signingRequestId
string | null

The caller's own signing request, present only while the caller is a person of this wallet who still has to act on it (the creator included, until they complete it). Mint its capability with POST …/signing-requests/{signingRequestId}/capabilities; a read never mints one. Another person's request is never shown.

startedWithApiKey
null | object

The API key its creator (createdBy) asked with; absent when they asked in a signed-in session.