Remove an authorized user (subProfile) from a business customer account.
Remove Authorized User
This endpoint removes an authorized user (subProfile) from a business customer's banking account. By providing the authorized user's unique ID, you can revoke their access to the account and optionally delete any payment cards associated with them. This is essential for managing and controlling access to sensitive financial information when an authorized user no longer requires account access.
Endpoint
POST /api/subProfiles/remove
Authentication
Bearer token required. Obtain via:
POST https://api.banking.netevia.dev/api/auth/v2Include in header: Authorization: Bearer {token}
Token lifetime: 10 minutes. Refresh via POST /api/auth/refresh.
When to use
Use this endpoint when a business customer needs to revoke access for an authorized user, such as when an employee leaves the organization or when their permissions need to be fully terminated. This endpoint also provides the option to automatically delete any payment cards issued to the authorized user, preventing further use of those cards after removal.
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer (int32) | Yes | The unique numeric ID of the authorized user (subProfile) to remove |
| deleteCards | boolean | No | Whether to delete all payment cards associated with the authorized user. Defaults to true |
| paymentCardIds | array of strings | No | Specific payment card IDs to delete. If provided alongside deleteCards: true, these cards will be removed |
Response
200 OK
Confirms successful removal of the authorized user. No response body fields are returned beyond the success status.
{
"status": "Success"
}Error Codes
| Code | When it happens |
|---|---|
| 400 | Missing required fields or validation error (e.g., id not provided or invalid) |
| 401 | Token missing, expired, or invalid |
| 403 | Insufficient permissions — caller does not have rights to remove authorized users |
| 404 | Authorized user with the specified id not found |
| 500 | Internal server error |
Common Mistakes
- Omitting the
idquery parameter, which is required to identify the authorized user to remove - Setting
deleteCardstofalsewithout revoking or canceling the associated payment cards through a separate process, leaving orphaned active cards - Providing
paymentCardIdswithout verifying those cards belong to the specified authorized user
Related Endpoints
POST /api/subProfiles/create— Create a new authorized user for a business customerGET /api/subProfiles— Retrieve the list of authorized users for a business customerPOST /api/subProfiles/update— Update access level or details for an existing authorized user
Example
curl -X POST "https://api.banking.netevia.dev/api/subProfiles/remove?id=4521&deleteCards=true" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json"Success