A valid request URL is required to generate request examples{
"ok": true,
"unsignedTxXdr": "<string>",
"nothingToDo": true
}{
"error": "build_failed"
}{
"error": "<string>",
"message": "<string>",
"details": {}
}{
"error": "<string>",
"message": "<string>",
"details": {}
}Build onboarding transaction
Build the sponsor-funded onboarding transaction for a classic G-address: creates the account if needed and establishes the USDC trustline. The facilitator returns the unsigned transaction XDR for the user to sign and submit via POST /stellar/onboard/submit.
If the account is already fully onboarded, nothingToDo: true is returned and no XDR needs to be signed.
A valid request URL is required to generate request examples{
"ok": true,
"unsignedTxXdr": "<string>",
"nothingToDo": true
}{
"error": "build_failed"
}{
"error": "<string>",
"message": "<string>",
"details": {}
}{
"error": "<string>",
"message": "<string>",
"details": {}
}Authorizations
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
Response
Onboarding transaction built or account already onboarded.
Response from POST /stellar/onboard/build.
Optional status flag.
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.
When true, the account is already onboarded. No XDR needs to be signed or submitted.