Skip to main content
POST
/
auth
/
email
Error
A valid request URL is required to generate request examples
{
  "publicKey": "<string>",
  "provider": "<string>",
  "expiresAt": 123
}

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

Provider-specific authentication payload. The BFF (createSignerProxyRoute) validates only that the body is a JSON object and proxies it transparently to the facilitator. Fields are provider-specific (social: idToken + verifier; email: email + code).

Response

OTP verified. Returns the derived Stellar public key.

Successful auth response. Mirrors the SDK AuthDetails type from @buckspay/core. The response is a transparent proxy of the facilitator's body.

publicKey
string
required

Derived Stellar G-address for this identity. Stable across sessions for the same provider + user.

Pattern: ^G[A-Z2-7]{55}$
provider
string
required

Provider identifier (e.g. google, email).

expiresAt
integer

Unix timestamp (seconds) after which the derived key session should be refreshed. Omitted if the provider does not issue expiring sessions.