Identity
Get Profile
Return the user profile that owns the supplied API key.
Endpoint
GET /api/v1/profile
Headers
| Header | Required | Value |
|---|---|---|
X-API-KEY | Yes | netconnect_live_... or netconnect_test_... |
Response
Returns the authenticated user profile:
{
"success": true,
"data": {
"_creationTime": 1769108357246.0674,
"_id": "user_profile_abc123",
"countryCode": "",
"countryISO": "GH",
"countryName": "Ghana",
"createdAt": 1769108357649,
"creatorId": "user_creator_xyz789",
"email": "contact@acmetelecoms.example",
"firstName": "Lorem",
"fullName": "Lorem Net",
"gender": "Male",
"lastName": "Net",
"middleName": "",
"phoneNumber": "+233201234567",
"referralCode": "JA1234",
"registeredAt": 1769109065157,
"role": "SuperAgent",
"status": "Active",
"uniqueId": "000001",
"updateMeta": {
"action": "update",
"name": "Lorem Net",
"userId": "user_update_def456"
},
"updatedAt": 1774989265345,
"userId": "user_id_abc123",
"walletAvailableBalance": 0,
"walletHeldBalance": 0,
"walletTotalBalance": 0
}
}Response fields
| Field | Type | Notes |
|---|---|---|
_id | string | Profile identifier |
_creationTime | number | Creation timestamp (unix ms) |
userId | string | User identifier |
firstName | string | First name |
middleName | string | Middle name |
lastName | string | Last name |
fullName | string | Full name |
gender | string | Gender |
phoneNumber | string | Contact phone (GH format) |
email | string | Contact email address |
role | string | Agent, SuperAgent, Customer, or Staff |
status | string | Account status (Active, Suspended, etc.) |
countryCode | string | Country dial code |
countryISO | string | ISO country code (e.g., GH) |
countryName | string | Country name |
referralCode | string | Unique referral code |
uniqueId | string | Internal unique identifier |
creatorId | string | ID of the user who created this profile |
registeredAt | number | Registration timestamp (unix ms) |
createdAt | number | Record creation timestamp (unix ms) |
updatedAt | number | Last update timestamp (unix ms) |
updateMeta | object | Metadata about the last update (action, name, userId) |
walletAvailableBalance | number | Funds immediately spendable (GHS) |
walletHeldBalance | number | Funds reserved for pending orders (GHS) |
walletTotalBalance | number | Sum of available and held (GHS) |
Use Cases
- Handshake validation: Verify API key is active and belongs to expected party
- Profile lookup: Get current storefront identity and business info
- KYC status check: Confirm verification status before operations
- Onboarding: First call to confirm partner setup is complete
Errors
401- Missing or invalid API key403- Profile has been suspended
Sample request
curl -X GET "https://api.netconnectgh.online/api/v1/profile" \
-H "X-API-KEY: netconnect_live_your_secret_here" \
-H "Content-Type: application/json"