Update

cURL

curl -sS -X PATCH "$FLUIDE_BASE_URL/api/v1/companies/string" \
  -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 '{}'

const baseUrl = process.env.FLUIDE_BASE_URL;

const response = await fetch(`${baseUrl}/api/v1/companies/string`, {
  method: 'PATCH',
  headers: {
    Authorization: `Bearer ${process.env.FLUIDE_ACCESS_TOKEN}`,
    'X-Fluide-Api-Key': process.env.FLUIDE_API_KEY,
    'X-Fluide-Client-Id': 'fluide-developer',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
});

if (!response.ok) throw new Error(`HTTP ${response.status}: ${await response.text()}`);
console.log(await response.json());

import os
import requests

base_url = os.environ["FLUIDE_BASE_URL"]
headers = {
        "Authorization": f"Bearer {os.environ['FLUIDE_ACCESS_TOKEN']}",
        "X-Fluide-Api-Key": os.environ["FLUIDE_API_KEY"],
        "X-Fluide-Client-Id": "fluide-developer",
}

response = requests.patch(
    f"{base_url}/api/v1/companies/string",
    headers=headers,
    json={},
    timeout=30,
)
response.raise_for_status()
print(response.json())

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

String baseUrl = System.getenv("FLUIDE_BASE_URL");
HttpClient client = HttpClient.newHttpClient();
HttpRequest.Builder builder = HttpRequest.newBuilder()
    .uri(URI.create(baseUrl + "/api/v1/companies/string"))
    .header("Authorization", "Bearer " + System.getenv("FLUIDE_ACCESS_TOKEN"))
    .header("X-Fluide-Api-Key", System.getenv("FLUIDE_API_KEY"))
    .header("X-Fluide-Client-Id", "fluide-developer")
    .header("Content-Type", "application/json")
    .PATCH(HttpRequest.BodyPublishers.ofString("{}"))
    .build();
HttpResponse<String> response = client.send(builder.build(), HttpResponse.BodyHandlers.ofString());
if (response.statusCode() >= 400) throw new RuntimeException("HTTP " + response.statusCode() + ": " + response.body());
System.out.println(response.body());

<?php
$baseUrl = getenv("FLUIDE_BASE_URL");
$ch = curl_init($baseUrl . "/api/v1/companies/string");
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'PATCH',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('FLUIDE_ACCESS_TOKEN'),
        'X-Fluide-Api-Key: ' . getenv('FLUIDE_API_KEY'),
        'X-Fluide-Client-Id: fluide-developer',
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => "{}",
]);
$response = curl_exec($ch);
if ($response === false) throw new RuntimeException(curl_error($ch));
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
if ($status >= 400) throw new RuntimeException("HTTP $status: $response");
echo $response;

{
  "success": true,
  "message": "Operation completed successfully",
  "data": {}
}

{
  "success": false,
  "message": "Validation failed",
  "code": "VALIDATION_FAILED",
  "statusCode": 400,
  "timestamp": "2026-06-03T12:00:00.000Z",
  "errors": {
    "from": [
      "from must be a valid date"
    ]
  }
}

{
  "success": false,
  "message": "Validation failed",
  "code": "VALIDATION_FAILED",
  "statusCode": 400,
  "timestamp": "2026-06-03T12:00:00.000Z",
  "errors": {
    "from": [
      "from must be a valid date"
    ]
  }
}

{
  "success": false,
  "message": "Validation failed",
  "code": "VALIDATION_FAILED",
  "statusCode": 400,
  "timestamp": "2026-06-03T12:00:00.000Z",
  "errors": {
    "from": [
      "from must be a valid date"
    ]
  }
}

{
  "success": false,
  "message": "Validation failed",
  "code": "VALIDATION_FAILED",
  "statusCode": 400,
  "timestamp": "2026-06-03T12:00:00.000Z",
  "errors": {
    "from": [
      "from must be a valid date"
    ]
  }
}

PATCH

api

companies

{companyId}

cURL

curl -sS -X PATCH "$FLUIDE_BASE_URL/api/v1/companies/string" \
  -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 '{}'

const baseUrl = process.env.FLUIDE_BASE_URL;

const response = await fetch(`${baseUrl}/api/v1/companies/string`, {
  method: 'PATCH',
  headers: {
    Authorization: `Bearer ${process.env.FLUIDE_ACCESS_TOKEN}`,
    'X-Fluide-Api-Key': process.env.FLUIDE_API_KEY,
    'X-Fluide-Client-Id': 'fluide-developer',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
});

if (!response.ok) throw new Error(`HTTP ${response.status}: ${await response.text()}`);
console.log(await response.json());

import os
import requests

base_url = os.environ["FLUIDE_BASE_URL"]
headers = {
        "Authorization": f"Bearer {os.environ['FLUIDE_ACCESS_TOKEN']}",
        "X-Fluide-Api-Key": os.environ["FLUIDE_API_KEY"],
        "X-Fluide-Client-Id": "fluide-developer",
}

response = requests.patch(
    f"{base_url}/api/v1/companies/string",
    headers=headers,
    json={},
    timeout=30,
)
response.raise_for_status()
print(response.json())

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

String baseUrl = System.getenv("FLUIDE_BASE_URL");
HttpClient client = HttpClient.newHttpClient();
HttpRequest.Builder builder = HttpRequest.newBuilder()
    .uri(URI.create(baseUrl + "/api/v1/companies/string"))
    .header("Authorization", "Bearer " + System.getenv("FLUIDE_ACCESS_TOKEN"))
    .header("X-Fluide-Api-Key", System.getenv("FLUIDE_API_KEY"))
    .header("X-Fluide-Client-Id", "fluide-developer")
    .header("Content-Type", "application/json")
    .PATCH(HttpRequest.BodyPublishers.ofString("{}"))
    .build();
HttpResponse<String> response = client.send(builder.build(), HttpResponse.BodyHandlers.ofString());
if (response.statusCode() >= 400) throw new RuntimeException("HTTP " + response.statusCode() + ": " + response.body());
System.out.println(response.body());

<?php
$baseUrl = getenv("FLUIDE_BASE_URL");
$ch = curl_init($baseUrl . "/api/v1/companies/string");
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'PATCH',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('FLUIDE_ACCESS_TOKEN'),
        'X-Fluide-Api-Key: ' . getenv('FLUIDE_API_KEY'),
        'X-Fluide-Client-Id: fluide-developer',
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => "{}",
]);
$response = curl_exec($ch);
if ($response === false) throw new RuntimeException(curl_error($ch));
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
if ($status >= 400) throw new RuntimeException("HTTP $status: $response");
echo $response;

{
  "success": true,
  "message": "Operation completed successfully",
  "data": {}
}

{
  "success": false,
  "message": "Validation failed",
  "code": "VALIDATION_FAILED",
  "statusCode": 400,
  "timestamp": "2026-06-03T12:00:00.000Z",
  "errors": {
    "from": [
      "from must be a valid date"
    ]
  }
}

{
  "success": false,
  "message": "Validation failed",
  "code": "VALIDATION_FAILED",
  "statusCode": 400,
  "timestamp": "2026-06-03T12:00:00.000Z",
  "errors": {
    "from": [
      "from must be a valid date"
    ]
  }
}

{
  "success": false,
  "message": "Validation failed",
  "code": "VALIDATION_FAILED",
  "statusCode": 400,
  "timestamp": "2026-06-03T12:00:00.000Z",
  "errors": {
    "from": [
      "from must be a valid date"
    ]
  }
}

{
  "success": false,
  "message": "Validation failed",
  "code": "VALIDATION_FAILED",
  "statusCode": 400,
  "timestamp": "2026-06-03T12:00:00.000Z",
  "errors": {
    "from": [
      "from must be a valid date"
    ]
  }
}

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.

Path Parameters

companyId

string

required

companyId identifier

Body

application/json

name

string

Legal or display company name.

Minimum string length: 1

Example:

"Fluide SARL"

countryCode

string

ISO 3166-1 alpha-2 country code.

Example:

"CM"

currency

string

Primary company currency using ISO 4217 code.

Example:

"XAF"

registrationNumber

string

Official company registration number.

Example:

"RC-123456"

taxId

string

Tax identifier (e.g. NIU).

Example:

"NIU-7890"

address

string

Registered business address.

Example:

"Bonanjo, Douala"

city

string

Business city.

Example:

"Douala"

logo

string

Public URL for company logo.

Example:

"https://cdn.fluide.com/company/logo.png"

industryCategory

string

Industry or vertical.

Example:

"Fintech"

industry

string

Industry label (alternative to industryCategory).

Example:

"Technology"

businessCreatedAt

string

Business legal creation/incorporation date.

Example:

"2021-04-12"

businessSize

string

Business size bucket.

Minimum string length: 1

Example:

"11-50"

organizationStructure

object

Organization structure details.

Show child attributes

paydays

object

Configured payday(s).

Show child attributes

bankConnection

object

Bank connection checkpoint payload.

Show child attributes

mobileMoneyWallet

object

Mobile money wallet details.

Show child attributes

signatures

object

Signature assets for approvals and generated documents.

Show child attributes

payrollSetup

object

Payroll setup details including groups, allowances and deductions.

Show child attributes

employeeNumberFormat

object

Employee number generation format.

Show child attributes

notificationSettings

object

Notification channel preferences.

Show child attributes

legalAttestations

object

Legal attestations stored on the company row (subsidiary wizard).

Show child attributes

Response

Update

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

Get One Status

Auth API

HR API

Payroll API

Pay API

Books API

Utils API

Authorizations

Path Parameters

Body

Response