Skip to main content
POST
/
stellar
/
onboard
/
build
Error
A valid request URL is required to generate request examples
{
  "ok": true,
  "unsignedTxXdr": "<string>",
  "nothingToDo": true
}

Authorizations

​
x-api-key
string
header
required

Server-held API key. Injected by the BFF (createRelayRoute / createSignerProxyRoute from @buckspay/nextjs). This key must only appear in server-side code and must never be shipped to a browser bundle.

Body

application/json
​
publicKey
string
required

G-address of the account to onboard.

Pattern: ^G[A-Z2-7]{55}$
​
chain
enum<string>
required

Stellar network identifier used in facilitator requests.

Available options:
stellar-testnet,
stellar-pubnet

Response

Onboarding transaction built or account already onboarded.

Response from POST /stellar/onboard/build.

​
ok
boolean

Optional status flag.

​
unsignedTxXdr
string

Unsigned onboarding transaction as base64 XDR. Present when the account is not yet fully onboarded. Sign with the user's key and submit via POST /stellar/onboard/submit.

​
nothingToDo
boolean

When true, the account is already onboarded. No XDR needs to be signed or submitted.