Skip to main content

​
The profile object

Your business profile is the core identity for your Orafi account. It controls API keys, wallets, transactions, and whether you operate in test or live mode.
​
id
string
Unique identifier for the business profile.
​
userId
string
Identifier of the user that owns this profile.
​
businessName
string
Registered name of the business.
​
businessSector
string
Industry or sector the business operates in.
​
country
string
Country where the business is registered.
​
websiteLink
string
Official website URL of the business. Nullable.
​
onboarded
boolean
default:"false"
Whether the business has completed the onboarding process.
​
isLive
boolean
default:"false"
Whether the business is operating in live mode (true) or test mode (false).
A business profile is required before any transaction can be processed. Switching to live mode requires completed onboarding and verification.
{
  "id": "84a9f045-8a21-4ce4-a7a0-828265c0021b",
  "userId": "user_abc123",
  "businessName": "Chidi and Co.",
  "businessSector": "Retail",
  "country": "Nigeria",
  "websiteLink": "https://chidiandco.com",
  "onboarded": true,
  "isLive": false
}

​
Retrieve profile

GET /profile
Returns the authenticated user’s profile including business information and wallet details. 
curl -X GET https://api.orafi.app/v1/profile \
  -H "Content-Type: application/json" \
  -H "x-api-key: ora_test_your_api_key"

​
Request email change

POST /profile/request-email-change
Initiates an email address change. An OTP is sent to the new email for verification.

​
Request body

​
email
string
required
The new email address.
curl -X POST https://api.orafi.app/v1/profile/request-email-change \
  -H "Content-Type: application/json" \
  -H "x-api-key: ora_test_your_api_key" \
  -d '{
    "email": "newemail@example.com"
  }'

​
Verify email change

POST /profile/verify-email-change
Confirms the email change using the OTP sent to the new address.

​
Request body

​
email
string
required
The new email address (must match the one from the request step).
​
otp
string
required
One-time password sent to the new email address.
curl -X POST https://api.orafi.app/v1/profile/verify-email-change \
  -H "Content-Type: application/json" \
  -H "x-api-key: ora_test_your_api_key" \
  -d '{
    "email": "newemail@example.com",
    "otp": "123456"
  }'