Skip to main content
POST
/
api
/
v1
/
business-partners
cURL
curl -sS -X POST "$FLUIDE_BASE_URL/api/v1/business-partners" \
  -H "Authorization: Bearer $FLUIDE_ACCESS_TOKEN" \
  -H "X-Fluide-Api-Key: $FLUIDE_API_KEY" \
  -H "X-Fluide-Client-Id: fluide-developer" \
  -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.

​
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
​
type
enum<string>
required
Available options:
CUSTOMER,
VENDOR,
PARTNER,
MERCHANT,
SERVICE_PROVIDER,
OTHER
​
displayName
string
required
Maximum string length: 200
Example:

"Acme Ltd"

​
legalName
string
Maximum string length: 200
​
email
string<email>
Maximum string length: 256
​
phone
string
Maximum string length: 64
​
taxId
string
Maximum string length: 80
​
defaultCurrency
string
Maximum string length: 3
Example:

"USD"

​
address
object
​
payoutDetails
object

Optional payout details for AP disbursement

​
metadata
object

Response

Quick-add a business partner — created

​
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