Get Authorized users by user's ID

Get Authorized Users by User's ID

The GET /api/subProfiles/me endpoint retrieves detailed information about all authorized users linked to the currently authenticated business account. Each authorized user record includes identity details, contact information, address data, and the financial account or payment card they are associated with. This endpoint is useful for reviewing and managing the full list of subProfiles attached to a business customer account.

Endpoint

GET /api/subProfiles/me

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 a business account owner or an authorized user with sufficient access needs to view all subProfiles tied to the account. It is typically called to populate an authorized-user management screen, audit account access, or verify which users are associated with specific financial accounts or payment cards.

Response

200 OK

FieldTypeDescription
idinteger (int32)Internal numeric identifier for the authorized user record
givenNamestringFirst name of the authorized user
familyNamestringLast name of the authorized user
emailstringEmail address of the authorized user
paymentCardIdstringID of the payment card assigned to this authorized user, if any
departmentstringDepartment or team the authorized user belongs to within the business
streetAddressstringStreet address line 1 for the authorized user
postalCodestringZIP or postal code for the authorized user's address
stateinteger (int32)Numeric code representing the US state (1–53)
citystringCity for the authorized user's address
countryCodeAlpha3stringISO 3166-1 alpha-3 country code (e.g., "USA")
phoneNumberstringPhone number of the authorized user (digits only, without country code)
phoneNumberCountryCodestringCountry dialing code for the phone number (e.g., "1" for US)
financialAccountIdstringID of the financial account this authorized user is linked to
financialAccountNamestringDisplay name of the linked financial account
extendedAddressstringSecondary address line (read-only); populated from stored address data
{
  "id": 1042,
  "givenName": "Maria",
  "familyName": "Santos",
  "email": "[email protected]",
  "paymentCardId": "pc_8f3a2d1e9b4c7f0a",
  "department": "Finance",
  "streetAddress": "4200 Commerce Blvd",
  "postalCode": "30301",
  "state": 11,
  "city": "Atlanta",
  "countryCodeAlpha3": "USA",
  "phoneNumber": "4045550192",
  "phoneNumberCountryCode": "1",
  "financialAccountId": "fa_7c91b3e0d2f845aa",
  "financialAccountName": "Operations Checking",
  "extendedAddress": "Suite 300"
}

Error Codes

CodeWhen it happens
401Token missing, expired, or invalid
403Authenticated user does not have permission to view subProfiles
500Internal server error

Common Mistakes

  • Calling this endpoint with a personal customer token — subProfiles are available to business customers only; personal accounts will not have authorized users.
  • Expecting an array in the response — the schema returns a single authorizedusermodel object. If multiple authorized users exist, iterate by calling the endpoint per user or use a list endpoint.
  • Ignoring the state field's numeric encoding — the value is an integer (1–53) mapped to US states and territories, not a two-letter abbreviation.
  • Using an expired token — tokens expire after 10 minutes; refresh with POST /api/auth/refresh before making the call.

Related Endpoints

  • POST /api/subProfiles — Create a new authorized user for a business account
  • PUT /api/subProfiles/{subProfileId} — Update an existing authorized user's details
  • DELETE /api/subProfiles/{subProfileId} — Remove an authorized user from the business account
  • GET /api/subProfiles/{subProfileId} — Retrieve a single authorized user by their ID

Example

curl -X GET https://api.banking.netevia.dev/api/subProfiles/me \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
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