Skip to main content
POST
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.

Body

application/json
tier
enum<string>
required

Verification tier. For partner profiles this is still required for scoring/policy alignment, even when requirement sets are role-specific.

Available options:
SILVER,
GOLD,
PLATINUM
documents
object[]
required

Uploaded documents. Use document keys that match the selected applicantType requirement set.

applicantType
enum<string>

Submission profile. COMPANY is default for org KYB; partner values are for referral/service partner KYC-KYB.

Available options:
COMPANY,
REFERRAL_PARTNER,
SERVICE_PARTNER_FIRM,
SERVICE_PARTNER_INDIVIDUAL
Example:

"COMPANY"

countryCode
string

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

Example:

"CM"

Response

Created successfully

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