Pre-General Availability: 2026-02-23

Jump to

• Request
• Response

Get a wallet by ID

get

/v1/wallets/{walletId}

Retrieves the full custodial wallet record for the specified walletId.

Request

Path Parameters

• walletId(required): string

Header Parameters

• X-Request-Id: string
  Optional request correlation identifier. Echoed in responses when provided and forwarded upstream.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Wallet

Body ()

Root Schema : Wallet

Type: object

Wallet record as returned by the wallet service

Show Source

• address: string
  Wallet address in 0x-prefixed hexadecimal format.
• label: string
  Optional user-defined label.
• orgId: string
  Organization identifier (instance name).
• privateKeyId: string
  Upstream key identifier for custodial storage, when available.
• publicKey: string
  Public key associated with the wallet, when available.
• status: string
  Current wallet status.
• userId: string
  User identifier.
• walletId: string
  Wallet identifier.

{
    "type":"object",
    "description":"Wallet record as returned by the wallet service",
    "properties":{
        "orgId":{
            "type":"string",
            "description":"Organization identifier (instance name)."
        },
        "userId":{
            "type":"string",
            "description":"User identifier."
        },
        "walletId":{
            "type":"string",
            "description":"Wallet identifier."
        },
        "label":{
            "type":"string",
            "nullable":true,
            "description":"Optional user-defined label."
        },
        "address":{
            "type":"string",
            "description":"Wallet address in 0x-prefixed hexadecimal format."
        },
        "publicKey":{
            "type":"string",
            "nullable":true,
            "description":"Public key associated with the wallet, when available."
        },
        "privateKeyId":{
            "type":"string",
            "nullable":true,
            "description":"Upstream key identifier for custodial storage, when available."
        },
        "status":{
            "type":"string",
            "description":"Current wallet status."
        }
    }
}

400 Response

Invalid request

Body ()

Root Schema : ErrorResponse

Type: object

Show Source

• decodedError: object DecodedError
• error: string
  Short error summary suitable for display
• hint: string
  Optional guidance that may help resolve the error
• message: string
  Additional error details, when available
• requestId: string
  Client-provided correlation ID echoed in responses
• upstreamCode: integer
  Upstream node error code (if provided by the RPC endpoint)
• upstreamData: string
  Raw upstream error data payload (0x-hex or JSON), if available

{
    "type":"object",
    "properties":{
        "error":{
            "type":"string",
            "description":"Short error summary suitable for display"
        },
        "message":{
            "type":"string",
            "nullable":true,
            "description":"Additional error details, when available"
        },
        "hint":{
            "type":"string",
            "nullable":true,
            "description":"Optional guidance that may help resolve the error"
        },
        "upstreamCode":{
            "type":"integer",
            "nullable":true,
            "description":"Upstream node error code (if provided by the RPC endpoint)"
        },
        "upstreamData":{
            "type":"string",
            "nullable":true,
            "description":"Raw upstream error data payload (0x-hex or JSON), if available"
        },
        "decodedError":{
            "$ref":"#/components/schemas/DecodedError",
            "nullable":true,
            "description":"Optional decoded revert error when available"
        },
        "requestId":{
            "type":"string",
            "nullable":true,
            "description":"Client-provided correlation ID echoed in responses"
        }
    }
}

Nested Schema : DecodedError

Type: object

Show Source

• customError: object customError
  Decoded custom error as defined in the contract ABI
• standardError: object standardError
  Decoded standard Error(string) revert
• standardPanic: object standardPanic
  Decoded Panic(uint256) revert

{
    "type":"object",
    "properties":{
        "standardError":{
            "nullable":true,
            "type":"object",
            "description":"Decoded standard Error(string) revert",
            "properties":{
                "selector":{
                    "type":"string",
                    "example":"0x08c379a0"
                },
                "message":{
                    "type":"string",
                    "nullable":true,
                    "description":"Revert message string"
                }
            }
        },
        "standardPanic":{
            "nullable":true,
            "type":"object",
            "description":"Decoded Panic(uint256) revert",
            "properties":{
                "selector":{
                    "type":"string",
                    "example":"0x4e487b71"
                },
                "code":{
                    "type":"string",
                    "nullable":true,
                    "description":"Panic code value (hex or decimal string)"
                },
                "meaning":{
                    "type":"string",
                    "nullable":true,
                    "description":"Human-readable interpretation of the panic code, when known"
                }
            }
        },
        "customError":{
            "nullable":true,
            "type":"object",
            "description":"Decoded custom error as defined in the contract ABI",
            "properties":{
                "name":{
                    "type":"string"
                },
                "signature":{
                    "type":"string"
                },
                "selector":{
                    "type":"string"
                },
                "args":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/DecodedArgument"
                    }
                }
            }
        }
    }
}

Nested Schema : customError

Type: object

Decoded custom error as defined in the contract ABI

Show Source

• args: array args
• name: string
• selector: string
• signature: string

{
    "nullable":true,
    "type":"object",
    "description":"Decoded custom error as defined in the contract ABI",
    "properties":{
        "name":{
            "type":"string"
        },
        "signature":{
            "type":"string"
        },
        "selector":{
            "type":"string"
        },
        "args":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DecodedArgument"
            }
        }
    }
}

Nested Schema : standardError

Type: object

Decoded standard Error(string) revert

Show Source

• message: string
  Revert message string
• selector: string
  Example: 0x08c379a0

{
    "nullable":true,
    "type":"object",
    "description":"Decoded standard Error(string) revert",
    "properties":{
        "selector":{
            "type":"string",
            "example":"0x08c379a0"
        },
        "message":{
            "type":"string",
            "nullable":true,
            "description":"Revert message string"
        }
    }
}

Nested Schema : standardPanic

Type: object

Decoded Panic(uint256) revert

Show Source

• code: string
  Panic code value (hex or decimal string)
• meaning: string
  Human-readable interpretation of the panic code, when known
• selector: string
  Example: 0x4e487b71

{
    "nullable":true,
    "type":"object",
    "description":"Decoded Panic(uint256) revert",
    "properties":{
        "selector":{
            "type":"string",
            "example":"0x4e487b71"
        },
        "code":{
            "type":"string",
            "nullable":true,
            "description":"Panic code value (hex or decimal string)"
        },
        "meaning":{
            "type":"string",
            "nullable":true,
            "description":"Human-readable interpretation of the panic code, when known"
        }
    }
}

Nested Schema : args

Type: array

Show Source

• Array of: object DecodedArgument

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/DecodedArgument"
    }
}

Nested Schema : DecodedArgument

Type: object

Show Source

• indexed: boolean
  Only for event parameters
• name: string
  May be empty if unknown
• type: string
  Canonical ABI type (for example, uint256, address, (uint256,address), uint256[])
• value:
  Normalized JSON value (address lowercase hex, bigints as decimal strings, bytes as 0x-hex)

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"May be empty if unknown"
        },
        "type":{
            "type":"string",
            "description":"Canonical ABI type (for example, uint256, address, (uint256,address), uint256[])"
        },
        "value":{
            "nullable":true,
            "description":"Normalized JSON value (address lowercase hex, bigints as decimal strings, bytes as 0x-hex)"
        },
        "indexed":{
            "type":"boolean",
            "nullable":true,
            "description":"Only for event parameters"
        }
    }
}

500 Response

Internal error

Body ()

Root Schema : ErrorResponse

Type: object

Show Source

• decodedError: object DecodedError
• error: string
  Short error summary suitable for display
• hint: string
  Optional guidance that may help resolve the error
• message: string
  Additional error details, when available
• requestId: string
  Client-provided correlation ID echoed in responses
• upstreamCode: integer
  Upstream node error code (if provided by the RPC endpoint)
• upstreamData: string
  Raw upstream error data payload (0x-hex or JSON), if available

{
    "type":"object",
    "properties":{
        "error":{
            "type":"string",
            "description":"Short error summary suitable for display"
        },
        "message":{
            "type":"string",
            "nullable":true,
            "description":"Additional error details, when available"
        },
        "hint":{
            "type":"string",
            "nullable":true,
            "description":"Optional guidance that may help resolve the error"
        },
        "upstreamCode":{
            "type":"integer",
            "nullable":true,
            "description":"Upstream node error code (if provided by the RPC endpoint)"
        },
        "upstreamData":{
            "type":"string",
            "nullable":true,
            "description":"Raw upstream error data payload (0x-hex or JSON), if available"
        },
        "decodedError":{
            "$ref":"#/components/schemas/DecodedError",
            "nullable":true,
            "description":"Optional decoded revert error when available"
        },
        "requestId":{
            "type":"string",
            "nullable":true,
            "description":"Client-provided correlation ID echoed in responses"
        }
    }
}

Nested Schema : DecodedError

Type: object

Show Source

• customError: object customError
  Decoded custom error as defined in the contract ABI
• standardError: object standardError
  Decoded standard Error(string) revert
• standardPanic: object standardPanic
  Decoded Panic(uint256) revert

{
    "type":"object",
    "properties":{
        "standardError":{
            "nullable":true,
            "type":"object",
            "description":"Decoded standard Error(string) revert",
            "properties":{
                "selector":{
                    "type":"string",
                    "example":"0x08c379a0"
                },
                "message":{
                    "type":"string",
                    "nullable":true,
                    "description":"Revert message string"
                }
            }
        },
        "standardPanic":{
            "nullable":true,
            "type":"object",
            "description":"Decoded Panic(uint256) revert",
            "properties":{
                "selector":{
                    "type":"string",
                    "example":"0x4e487b71"
                },
                "code":{
                    "type":"string",
                    "nullable":true,
                    "description":"Panic code value (hex or decimal string)"
                },
                "meaning":{
                    "type":"string",
                    "nullable":true,
                    "description":"Human-readable interpretation of the panic code, when known"
                }
            }
        },
        "customError":{
            "nullable":true,
            "type":"object",
            "description":"Decoded custom error as defined in the contract ABI",
            "properties":{
                "name":{
                    "type":"string"
                },
                "signature":{
                    "type":"string"
                },
                "selector":{
                    "type":"string"
                },
                "args":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/DecodedArgument"
                    }
                }
            }
        }
    }
}

Nested Schema : customError

Type: object

Decoded custom error as defined in the contract ABI

Show Source

• args: array args
• name: string
• selector: string
• signature: string

{
    "nullable":true,
    "type":"object",
    "description":"Decoded custom error as defined in the contract ABI",
    "properties":{
        "name":{
            "type":"string"
        },
        "signature":{
            "type":"string"
        },
        "selector":{
            "type":"string"
        },
        "args":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DecodedArgument"
            }
        }
    }
}

Nested Schema : standardError

Type: object

Decoded standard Error(string) revert

Show Source

• message: string
  Revert message string
• selector: string
  Example: 0x08c379a0

{
    "nullable":true,
    "type":"object",
    "description":"Decoded standard Error(string) revert",
    "properties":{
        "selector":{
            "type":"string",
            "example":"0x08c379a0"
        },
        "message":{
            "type":"string",
            "nullable":true,
            "description":"Revert message string"
        }
    }
}

Nested Schema : standardPanic

Type: object

Decoded Panic(uint256) revert

Show Source

• code: string
  Panic code value (hex or decimal string)
• meaning: string
  Human-readable interpretation of the panic code, when known
• selector: string
  Example: 0x4e487b71

{
    "nullable":true,
    "type":"object",
    "description":"Decoded Panic(uint256) revert",
    "properties":{
        "selector":{
            "type":"string",
            "example":"0x4e487b71"
        },
        "code":{
            "type":"string",
            "nullable":true,
            "description":"Panic code value (hex or decimal string)"
        },
        "meaning":{
            "type":"string",
            "nullable":true,
            "description":"Human-readable interpretation of the panic code, when known"
        }
    }
}

Nested Schema : args

Type: array

Show Source

• Array of: object DecodedArgument

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/DecodedArgument"
    }
}

Nested Schema : DecodedArgument

Type: object

Show Source

• indexed: boolean
  Only for event parameters
• name: string
  May be empty if unknown
• type: string
  Canonical ABI type (for example, uint256, address, (uint256,address), uint256[])
• value:
  Normalized JSON value (address lowercase hex, bigints as decimal strings, bytes as 0x-hex)

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"May be empty if unknown"
        },
        "type":{
            "type":"string",
            "description":"Canonical ABI type (for example, uint256, address, (uint256,address), uint256[])"
        },
        "value":{
            "nullable":true,
            "description":"Normalized JSON value (address lowercase hex, bigints as decimal strings, bytes as 0x-hex)"
        },
        "indexed":{
            "type":"boolean",
            "nullable":true,
            "description":"Only for event parameters"
        }
    }
}

502 Response

Upstream wallet service error

Body ()

Root Schema : ErrorResponse

Type: object

Show Source

• decodedError: object DecodedError
• error: string
  Short error summary suitable for display
• hint: string
  Optional guidance that may help resolve the error
• message: string
  Additional error details, when available
• requestId: string
  Client-provided correlation ID echoed in responses
• upstreamCode: integer
  Upstream node error code (if provided by the RPC endpoint)
• upstreamData: string
  Raw upstream error data payload (0x-hex or JSON), if available

{
    "type":"object",
    "properties":{
        "error":{
            "type":"string",
            "description":"Short error summary suitable for display"
        },
        "message":{
            "type":"string",
            "nullable":true,
            "description":"Additional error details, when available"
        },
        "hint":{
            "type":"string",
            "nullable":true,
            "description":"Optional guidance that may help resolve the error"
        },
        "upstreamCode":{
            "type":"integer",
            "nullable":true,
            "description":"Upstream node error code (if provided by the RPC endpoint)"
        },
        "upstreamData":{
            "type":"string",
            "nullable":true,
            "description":"Raw upstream error data payload (0x-hex or JSON), if available"
        },
        "decodedError":{
            "$ref":"#/components/schemas/DecodedError",
            "nullable":true,
            "description":"Optional decoded revert error when available"
        },
        "requestId":{
            "type":"string",
            "nullable":true,
            "description":"Client-provided correlation ID echoed in responses"
        }
    }
}

Nested Schema : DecodedError

Type: object

Show Source

• customError: object customError
  Decoded custom error as defined in the contract ABI
• standardError: object standardError
  Decoded standard Error(string) revert
• standardPanic: object standardPanic
  Decoded Panic(uint256) revert

{
    "type":"object",
    "properties":{
        "standardError":{
            "nullable":true,
            "type":"object",
            "description":"Decoded standard Error(string) revert",
            "properties":{
                "selector":{
                    "type":"string",
                    "example":"0x08c379a0"
                },
                "message":{
                    "type":"string",
                    "nullable":true,
                    "description":"Revert message string"
                }
            }
        },
        "standardPanic":{
            "nullable":true,
            "type":"object",
            "description":"Decoded Panic(uint256) revert",
            "properties":{
                "selector":{
                    "type":"string",
                    "example":"0x4e487b71"
                },
                "code":{
                    "type":"string",
                    "nullable":true,
                    "description":"Panic code value (hex or decimal string)"
                },
                "meaning":{
                    "type":"string",
                    "nullable":true,
                    "description":"Human-readable interpretation of the panic code, when known"
                }
            }
        },
        "customError":{
            "nullable":true,
            "type":"object",
            "description":"Decoded custom error as defined in the contract ABI",
            "properties":{
                "name":{
                    "type":"string"
                },
                "signature":{
                    "type":"string"
                },
                "selector":{
                    "type":"string"
                },
                "args":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/DecodedArgument"
                    }
                }
            }
        }
    }
}

Nested Schema : customError

Type: object

Decoded custom error as defined in the contract ABI

Show Source

• args: array args
• name: string
• selector: string
• signature: string

{
    "nullable":true,
    "type":"object",
    "description":"Decoded custom error as defined in the contract ABI",
    "properties":{
        "name":{
            "type":"string"
        },
        "signature":{
            "type":"string"
        },
        "selector":{
            "type":"string"
        },
        "args":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DecodedArgument"
            }
        }
    }
}

Nested Schema : standardError

Type: object

Decoded standard Error(string) revert

Show Source

• message: string
  Revert message string
• selector: string
  Example: 0x08c379a0

{
    "nullable":true,
    "type":"object",
    "description":"Decoded standard Error(string) revert",
    "properties":{
        "selector":{
            "type":"string",
            "example":"0x08c379a0"
        },
        "message":{
            "type":"string",
            "nullable":true,
            "description":"Revert message string"
        }
    }
}

Nested Schema : standardPanic

Type: object

Decoded Panic(uint256) revert

Show Source

• code: string
  Panic code value (hex or decimal string)
• meaning: string
  Human-readable interpretation of the panic code, when known
• selector: string
  Example: 0x4e487b71

{
    "nullable":true,
    "type":"object",
    "description":"Decoded Panic(uint256) revert",
    "properties":{
        "selector":{
            "type":"string",
            "example":"0x4e487b71"
        },
        "code":{
            "type":"string",
            "nullable":true,
            "description":"Panic code value (hex or decimal string)"
        },
        "meaning":{
            "type":"string",
            "nullable":true,
            "description":"Human-readable interpretation of the panic code, when known"
        }
    }
}

Nested Schema : args

Type: array

Show Source

• Array of: object DecodedArgument

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/DecodedArgument"
    }
}

Nested Schema : DecodedArgument

Type: object

Show Source

• indexed: boolean
  Only for event parameters
• name: string
  May be empty if unknown
• type: string
  Canonical ABI type (for example, uint256, address, (uint256,address), uint256[])
• value:
  Normalized JSON value (address lowercase hex, bigints as decimal strings, bytes as 0x-hex)

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"May be empty if unknown"
        },
        "type":{
            "type":"string",
            "description":"Canonical ABI type (for example, uint256, address, (uint256,address), uint256[])"
        },
        "value":{
            "nullable":true,
            "description":"Normalized JSON value (address lowercase hex, bigints as decimal strings, bytes as 0x-hex)"
        },
        "indexed":{
            "type":"boolean",
            "nullable":true,
            "description":"Only for event parameters"
        }
    }
}

Back to Top