Get all Authorized users with payment cards, financial accounts and accesses

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

ParameterTypeRequiredDescription
idinteger (int32)YesThe 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)

FieldTypeDescription
idinteger (int32)Unique numeric identifier of the authorized user (subprofile).
nickNamestringDisplay name or alias for the authorized user.
emailstringEmail address of the authorized user.
givenNamestringFirst name of the authorized user.
familyNamestringLast name of the authorized user.
departmentstringDepartment the authorized user belongs to within the business.
paymentCardsarray of paymentcardmodelList of payment cards assigned to this authorized user.
financialAccountsarray of boardingfinancialaccountmodelList of financial accounts accessible to this authorized user.
accessesarray of stringList of access permission labels granted to this authorized user (e.g., Full, Limited, View-Only, Custom).
isMfaEnabledbooleanIndicates whether multi-factor authentication is enabled for this authorized user.
isOtpEnabledbooleanIndicates whether one-time password authentication is enabled for this authorized user.
createdstring (date-time)Timestamp when the authorized user was created.
phonestringPhone number of the authorized user.
addressaddressinput objectMailing address of the authorized user.

Payment card object (paymentcardmodel)

FieldTypeDescription
idstringUnique identifier of the payment card.
formFactorstringCard form factor: Physical, Virtual, or Burner.
binstringBank Identification Number (first 6 digits) of the card.
last4stringLast four digits of the card number.
statusstringCurrent status of the card (e.g., ACTIVE, SUSPENDED, TERMINATED).
financialAccountIdstringIdentifier of the financial account linked to this card.
isMainCardbooleanIndicates whether this is the primary card for the authorized user.
networkstringCard network (e.g., Visa, Mastercard).
isEmailNotifybooleanIndicates whether email notifications are enabled for card activity.
isPushNotifybooleanIndicates whether push notifications are enabled for card activity.
financialAccountfinancialaccountinfo objectNested object with details about the linked financial account.
cardNamestringCustom name or label assigned to the card.
expirationDatestringCard expiration date.

Financial account object (boardingfinancialaccountmodel)

FieldTypeDescription
idstringUnique identifier of the financial account.
namestringDisplay name of the financial account.
last4stringLast four digits of the account number.
routingNumberstringABA routing number for the financial account.
statusstringCurrent status of the financial account (e.g., OPEN, CLOSED, SUSPENDED).
createdstring (date-time)Timestamp when the financial account was created.
availableCashinteger (int64)Available cash balance in the account, expressed in the smallest currency unit (e.g., cents).

Address object (addressinput)

FieldTypeDescription
streetAddressstringPrimary street address line.
extendedAddressstringSecondary address line (suite, apartment, floor, etc.).
postalCodestringZIP or postal code.
localitystringCity or town.
regionstringState, province, or region code.
countryCodeAlpha3stringThree-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

CodeWhen it happens
400Missing required fields or validation error
401Token missing, expired, or invalid
403Insufficient permissions — caller does not have access to the specified profile
404Profile not found for the given id
500Internal server error

Common Mistakes

  • Passing a personal customer profile id instead of a business profile id — 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/refresh before making this call.
  • Treating availableCash as a dollar amount — it is expressed in the smallest currency unit (cents), so 500000 equals $5,000.00.
  • Expecting card numbers in full — the response only returns last4 and bin for 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 profile
  • GET /netevia/profile/{id}/subProfile/{subProfileId} — Retrieve a single authorized user by subprofile ID
  • PUT /netevia/profile/{id}/subProfile/{subProfileId} — Update an existing authorized user's details or access level
  • DELETE /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"
Path Params
int32
required
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Response

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json