Sign Message Challenge
Starts a challenge for signing a plain text or hex-encoded message with a customer wallet.
path Parameters
idCustomer ID
Headers
PLANBOK-X-API-KEYAPI key for authentication
Sign Message Challenge › Request Body
walletIdWallet ID
messageMessage to sign
redirectUrlURL to redirect to after challenge completion.
encodedByHexBoolean to indicate if message is hex encoded. Default is false.
memoHuman readable explanation for message signing action.
Sign Message Challenge › Responses
Sign message challenge created
successstatusmessageSign Transaction Challenge
Starts a challenge for signing a transaction with a customer wallet.
path Parameters
idCustomer ID
Headers
PLANBOK-X-API-KEYAPI key for authentication
Sign Transaction Challenge › Request Body
walletIdWallet ID
redirectUrlURL to redirect to after challenge completion.
rawTransactionRaw unsigned transaction string to sign (base64 for non-EVM, hex for EVM). Required in the absence of transaction object.
transactionTransaction object (JSON string). Required in the absence of rawTransaction.
memoHuman readable explanation for message signing action.
broadcastBoolean to indicate if transaction should be broadcasted after signing. Default is false.
Sign Transaction Challenge › Responses
Sign transaction challenge created
successstatusmessageSign Typed Data Challenge
Starts a challenge for signing EIP-712 typed data.
path Parameters
idCustomer ID
Headers
PLANBOK-X-API-KEYAPI key for authentication
Sign Typed Data Challenge › Request Body
walletIdWallet ID
typedDataEIP-712 typed data (JSON string)
redirectUrlURL to redirect to after challenge completion.
memoHuman readable explanation for typed data signing action.
Sign Typed Data Challenge › Responses
Sign typed data challenge created
successstatusmessageSign Delegate Action Challenge
Starts a challenge for signing a protocol delegate action.
path Parameters
idCustomer ID
Headers
PLANBOK-X-API-KEYAPI key for authentication
Sign Delegate Action Challenge › Request Body
walletIdWallet ID
unsignedDelegateActionBase64 of the NEP-461 prefixed Borsh DelegateAction (6e010040 || borsh(DelegateAction)), which is what near-api-js's encodeDelegateAction produces. The action's senderId must be the wallet's account and its publicKey must be the wallet's key, or the request is refused. The NEP-461 hash is computed by the platform; do not send the hash.
redirectUrlURL to redirect to after challenge completion.
Optional. Names the relayer that will submit the meta transaction; the response then includes the unsigned outer transaction for them to sign and broadcast. The relayer's private key never reaches the platform.
Sign Delegate Action Challenge › Responses
Sign delegate action challenge created
successstatusmessageCreate Challenge to Sign SEP10 Web Authentication Challenge
Starts a challenge for signing an SEP10 web authentication challenge.
path Parameters
idCustomer ID
Headers
PLANBOK-X-API-KEYAPI key for authentication
Create Challenge to Sign SEP10 Web Authentication Challenge › Request Body
walletIdWallet ID
challengeXdrBase64 challenge transaction XDR received from the anchor/service.
serverAccountIdThe anchor/service's known signing account (G...) - NOT the wallet's own account.
homeDomainsExpected home domain(s) - must match what the challenge actually contains.
webAuthDomainExpected web_auth_domain, per SEP-10.
redirectUrlURL to redirect to after challenge completion.
Create Challenge to Sign SEP10 Web Authentication Challenge › Responses
Sign SEP10 web auth XDR challenge created
successstatusmessage