Get All Authorized Users (Subprofiles)
This endpoint retrieves detailed information about every authorized user (subprofile) linked to a given business profile. The response consolidates each authorized user's payment cards, financial accounts, and access rights into a single unified view. Use this endpoint to audit and manage subprofile configurations at scale.
Endpoint
GET /netevia/profile/{id}/subProfiles
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 you need a comprehensive snapshot of all authorized users under a business profile — for example, to display a management dashboard, audit access levels, or verify which payment cards and financial accounts are assigned to each authorized user. This endpoint is only applicable to business customers, since subprofiles (authorized users) are a business-only feature.
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer (int32) | Yes | The unique numeric identifier of the parent business profile whose authorized users should be retrieved. |
Response
200 OK
Returns an array of subprofile objects. Each object contains the fields listed below.
Subprofile object (boardingsubprofilemodel)
| Field | Type | Description |
|---|---|---|
| id | integer (int32) | Unique numeric identifier of the authorized user (subprofile). |
| nickName | string | Display name or alias for the authorized user. |
| string | Email address of the authorized user. | |
| givenName | string | First name of the authorized user. |
| familyName | string | Last name of the authorized user. |
| department | string | Department the authorized user belongs to within the business. |
| paymentCards | array of paymentcardmodel | List of payment cards assigned to this authorized user. |
| financialAccounts | array of boardingfinancialaccountmodel | List of financial accounts accessible to this authorized user. |
| accesses | array of string | List of access permission labels granted to this authorized user (e.g., Full, Limited, View-Only, Custom). |
| isMfaEnabled | boolean | Indicates whether multi-factor authentication is enabled for this authorized user. |
| isOtpEnabled | boolean | Indicates whether one-time password authentication is enabled for this authorized user. |
| created | string (date-time) | Timestamp when the authorized user was created. |
| phone | string | Phone number of the authorized user. |
| address | addressinput object | Mailing address of the authorized user. |
Payment card object (paymentcardmodel)
| Field | Type | Description |
|---|---|---|
| id | string | Unique identifier of the payment card. |
| formFactor | string | Card form factor: Physical, Virtual, or Burner. |
| bin | string | Bank Identification Number (first 6 digits) of the card. |
| last4 | string | Last four digits of the card number. |
| status | string | Current status of the card (e.g., ACTIVE, SUSPENDED, TERMINATED). |
| financialAccountId | string | Identifier of the financial account linked to this card. |
| isMainCard | boolean | Indicates whether this is the primary card for the authorized user. |
| network | string | Card network (e.g., Visa, Mastercard). |
| isEmailNotify | boolean | Indicates whether email notifications are enabled for card activity. |
| isPushNotify | boolean | Indicates whether push notifications are enabled for card activity. |
| financialAccount | financialaccountinfo object | Nested object with details about the linked financial account. |
| cardName | string | Custom name or label assigned to the card. |
| expirationDate | string | Card expiration date. |
Financial account object (boardingfinancialaccountmodel)
| Field | Type | Description |
|---|---|---|
| id | string | Unique identifier of the financial account. |
| name | string | Display name of the financial account. |
| last4 | string | Last four digits of the account number. |
| routingNumber | string | ABA routing number for the financial account. |
| status | string | Current status of the financial account (e.g., OPEN, CLOSED, SUSPENDED). |
| created | string (date-time) | Timestamp when the financial account was created. |
| availableCash | integer (int64) | Available cash balance in the account, expressed in the smallest currency unit (e.g., cents). |
Address object (addressinput)
| Field | Type | Description |
|---|---|---|
| streetAddress | string | Primary street address line. |
| extendedAddress | string | Secondary address line (suite, apartment, floor, etc.). |
| postalCode | string | ZIP or postal code. |
| locality | string | City or town. |
| region | string | State, province, or region code. |
| countryCodeAlpha3 | string | Three-letter ISO 3166-1 alpha-3 country code (e.g., USA). |
[
{
"id": 1042,
"nickName": "Jane Finance",
"email": "[email protected]",
"givenName": "Jane",
"familyName": "Doe",
"department": "Finance",
"paymentCards": [
{
"id": "card_7a3f8b2e1c904d56",
"formFactor": "Virtual",
"bin": "411111",
"last4": "4242",
"status": "ACTIVE",
"financialAccountId": "acct_9d1e2f3a4b5c6d7e",
"isMainCard": true,
"network": "Visa",
"isEmailNotify": true,
"isPushNotify": false,
"financialAccount": {
"id": "acct_9d1e2f3a4b5c6d7e",
"last4": "7890",
"name": "Operating Account",
"type": "CHECKING",
"accountStatus": "OPEN",
"routingNumber": "021000021",
"clientName": "Acme Corp"
},
"cardName": "Travel Expenses",
"expirationDate": "2027-08"
}
],
"financialAccounts": [
{
"id": "acct_9d1e2f3a4b5c6d7e",
"name": "Operating Account",
"last4": "7890",
"routingNumber": "021000021",
"status": "OPEN",
"created": "2024-03-15T10:30:00Z",
"availableCash": 500000
}
],
"accesses": ["Limited"],
"isMfaEnabled": true,
"isOtpEnabled": false,
"created": "2024-03-15T09:00:00Z",
"phone": "+15555550101",
"address": {
"streetAddress": "123 Main Street",
"extendedAddress": "Suite 400",
"postalCode": "10001",
"locality": "New York",
"region": "NY",
"countryCodeAlpha3": "USA"
}
}
]Error Codes
| Code | When it happens |
|---|---|
| 400 | Missing required fields or validation error |
| 401 | Token missing, expired, or invalid |
| 403 | Insufficient permissions — caller does not have access to the specified profile |
| 404 | Profile not found for the given id |
| 500 | Internal server error |
Common Mistakes
- Passing a personal customer profile
idinstead of a business profileid— subprofiles only exist for business customers; the response will be empty or return a 404. - Using an expired Bearer token — tokens expire after 10 minutes; refresh via
POST /api/auth/refreshbefore making this call. - Treating
availableCashas a dollar amount — it is expressed in the smallest currency unit (cents), so500000equals $5,000.00. - Expecting card numbers in full — the response only returns
last4andbinfor security; full card numbers are never returned by this endpoint.
Related Endpoints
POST /netevia/profile/{id}/subProfile— Create a new authorized user under a business profileGET /netevia/profile/{id}/subProfile/{subProfileId}— Retrieve a single authorized user by subprofile IDPUT /netevia/profile/{id}/subProfile/{subProfileId}— Update an existing authorized user's details or access levelDELETE /netevia/profile/{id}/subProfile/{subProfileId}— Remove an authorized user from a business profile
Example
curl -X GET https://api.banking.netevia.dev/netevia/profile/1042/subProfiles \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json"