Skip to main content
POST
/
stellar
/
onboard
/
submit
Error
A valid request URL is required to generate request examples
{
  "ok": 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 being onboarded.

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

Stellar network identifier used in facilitator requests.

Available options:
stellar-testnet,
stellar-pubnet
​
signedTxXdr
string
required

User-signed transaction XDR from the unsignedTxXdr field of the build response.

Response

Onboarding transaction submitted successfully.

​
ok
boolean
required

Always true on success.