Skip to main content
POST
/
api
/
v1
/
auth
/
handoff
cURL
curl -sS -X POST "$FLUIDE_BASE_URL/api/v1/auth/handoff" \
  -H "Authorization: Bearer $FLUIDE_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'
{
  "success": true,
  "message": "Operation completed successfully",
  "data": {}
}

Authorizations

​
Authorization
string
header
required

Access token JWT. Use as Authorization: Bearer . In the API playground, paste the JWT only.

Body

application/json
​
fluideClientId
enum<string>
required
Available options:
fluide-admin,
fluide-capital-admin,
fluide-super,
fluide-developer,
fluide-onboarding,
fluide-pay
​
next
string

Relative in-app path after the target product consumes the handoff code.

Maximum string length: 512
Pattern: /^\/(?!\/).*/
Example:

"/dashboard"

Response

Handoff code for target product

​
success
boolean
required

Whether the request succeeded

Example:

true

​
message
string
required

Human-readable outcome message (localized when i18n is configured)

Example:

"Operation completed successfully"

​
data
object

Endpoint-specific payload