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
firstName
string
required

First name of the account holder

Example:

"Mercy"

middlename
string
required

Middle name of the account holder

Example:

"Ioo"

lastName
string
required

Last name of the account holder

Example:

"Kasumu"

mobileNo
string
required

Mobile number of the account holder

Example:

"237674999999"

email
string<email>
required

email address of the account holder

Example:

"mercy@gmail.com"

gender
enum<string>
required

gender of the account holder

Available options:
MALE,
FEMALE,
M,
F
Example:

"F"

dateOfBirth
string
required

Date of birth in date-time format

Example:

"1990-01-01"

identityType
string
required

ID type of the account holder

Example:

"NATIONAL_ID"

identityNo
string
required

ID number of the account holder

Example:

"A1234567890"

idIssueDate
string
required

ID issue date in date-time format

Example:

"2020-01-01"

idExpiryDate
string
required

ID card expiration date in date-time format

Example:

"2030-01-01"

countryOfResidence
string
required

Country of residence

Example:

"CAMEROON"

city
string
required

city of residence

Example:

"Buea"

state
string
required

state of residence

Example:

"South West"

street
string
required

street address of the account holder

Example:

"123 Main Street"

currency
string
required

Currency code for the account

Example:

"XAF"

Response

Opened Ecobank account

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