Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

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

X-Fluide-Api-Key
string
header
default:fl_dev_your_key
required

Developer API key (fl_dev_...). Required on every API call with a machine access token.

X-Fluide-Client-Id
string
header
default:fluide-developer
required

First-party client audience. Must match the fluide_client_id claim on the JWT. Use fluide-developer for Connect.

Query Parameters

applicantType
enum<string>
default:COMPANY
Available options:
COMPANY,
REFERRAL_PARTNER,
SERVICE_PARTNER_FIRM,
SERVICE_PARTNER_INDIVIDUAL
tier
enum<string>
default:SILVER
Available options:
SILVER,
GOLD,
PLATINUM
countryCode
string

ISO 3166-1 alpha-2 country code. Defaults to the current company country when omitted.

Example:

"CM"

Response

Successful response

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