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.

Headers

X-Workspace-Id
string<uuid>

Partner / ISV only: UUID of the workspace that owns the client company. Required together with X-Acting-Company-Id when scoping product APIs to a merchant. See /getting-started/multi-tenancy.

X-Acting-Company-Id
string<uuid>

Partner / ISV only: UUID of the client company to act on. Must belong to the workspace in X-Workspace-Id.

Body

application/json
deliveryMethod
enum<string>
required

Delivery method

Available options:
ACCOUNT
Example:

"ACCOUNT"

destinationEntityCode
string
required

Destination entity code

Example:

"ECOBANK"

accountNo
string
required

Account number

Example:

"3441002127474"

destinationCountry
string
required

Destination country

Example:

"GH"

requestId
string
required

Request ID

Example:

"23100191000000002"

secureHash
string
required

Secure hash for request validation

Response

Name enquiry result

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