Skip to main content
POST
Enable cNGN (BVN onboard)

Authorizations

Authorization
string
header
required

API key created in the Remitflex Dashboard at dashboard.remitflex.io (rmf_live_... or rmf_test_...). Key management endpoints require a dashboard JWT and are not part of this reference.

Headers

Idempotency-Key
string
required

Unique key for safe retries on mutating API-key requests. Cached for 24 hours per org, method, and path.

Maximum string length: 255
Example:

"7f3c2a1b-4e5d-6c7b-8a9f-0e1d2c3b4a5f"

Path Parameters

id
string<uuid>
required

Body

application/json
bvn
string
required

Nigerian BVN (11 digits).

Pattern: ^\d{11}$
email
string<email>

Optional. Defaults to the customer's email.

phoneNumber
string

Optional phone number.

Response

200 - application/json

Onboarding started

status
string
Example:

"success"

message
string
data
object