Returns a list of all available API endpoints grouped and described for customer use.
List of Available API for Customer
This endpoint returns an enumerated list of all API operations available for customers on the Netevia Banking platform. Each item in the list includes a name, numeric identifier, description, group classification, and the associated endpoint paths. Use this endpoint to dynamically discover which APIs are accessible for a given customer context.
Endpoint
GET /api/enums/customerAPI
Authentication
Bearer token required. Obtain via:
POST https://api.banking.netevia.dev/api/auth/v2
Include in header: Authorization: Bearer {token}
Token lifetime: 10 minutes. Refresh via POST /api/auth/refresh.
When to use
Use this endpoint when building a dynamic integration that needs to programmatically discover the full set of customer-facing API operations. It is particularly useful during onboarding or when constructing permission-aware UI components that surface only the APIs relevant to a given customer type. Partners can also use this to validate that a specific API is available before making a call.
Response
200 OK
Returns an array of enumdescription objects, each describing one available customer API.
| Field | Type | Description |
|---|---|---|
| name | string (nullable) | The human-readable name of the API or operation |
| id | integer (int32) | Numeric identifier for the enum entry |
| description | string (nullable) | A brief description of what the API does |
| groupName | string (nullable) | The logical group or category the API belongs to |
| endpoints | array of string (nullable) | List of endpoint paths associated with this API entry |
[
{
"name": "GetCustomerProfile",
"id": 1,
"description": "Retrieve the profile details of a customer",
"groupName": "CustomerManagement",
"endpoints": [
"/api/customer/profile/{profileId}"
]
},
{
"name": "ListFinancialAccounts",
"id": 2,
"description": "List all financial accounts belonging to a customer",
"groupName": "FinancialAccounts",
"endpoints": [
"/api/financial-accounts/{profileId}"
]
},
{
"name": "InitiateTransfer",
"id": 3,
"description": "Initiate an ACH or internal transfer from a customer account",
"groupName": "Transfers",
"endpoints": [
"/api/transfers/ach",
"/api/transfers/internal"
]
}
]Error Codes
| Code | When it happens |
|---|---|
| 401 | Token missing, expired, or invalid |
| 403 | Insufficient permissions |
| 500 | Internal server error |
Common Mistakes
- Calling this endpoint without a valid Bearer token will return a 401 even though no customer-specific data is being requested — authentication is always required.
- Assuming the
idvalues are stable across environments; always resolve names and descriptions at runtime rather than hardcoding numeric IDs. - Ignoring the
groupNamefield — it provides useful context for categorizing APIs when building permission-aware interfaces.
Related Endpoints
GET /api/enums/partnerAPI— Returns the list of available API operations scoped to partner-level accessGET /api/enums/adminAPI— Returns the list of available API operations scoped to administrative access
Example
curl -X GET https://api.banking.netevia.dev/api/enums/customerAPI \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Accept: application/json"