Sign in

v1

latestOpenAPI 3.0.0raw.githubusercontent.com2026-04-107095124.5 KB
Wallet management endpoints

An asynchronous request to claim a wallet to self custody

An asynchronous request to claim a wallet to self custody, using a server generated secret.

post/user/wallet/claim

Headers

x-api-keystring required

The server generated secret required to authorize the request. This value should be the same one used returned in the POST response when the wallet was created.

Request body

emailAddressstring

Email address to register

passwordstring

Password to use when creating new wallet

Example request

{
  "emailAddress": "user@email.com",
  "password": "secret-password"
}

Response

Successfully requested to claim the wallet to self custody. The status will of the response will always be PROCESSING. Must use the corresponding GET endpoint to check status to determine when claiming is complete.

secretstring

A secret created by the server and provided to the client only at initial wallet creation

statestring

Indicates custody state of the wallet (CUSTODY or SELF_CUSTODY)

statusstring

Indicates status of the onboarding process

Example response

{
  "secret": "server-generated-secret",
  "state": "SELF_CUSTODY",
  "status": "COMPLETE",
  "addresses": {
    "SYMBOL": "blockchain-address"
  }
}