Update Authorized User
This endpoint allows you to update the profile details of an authorized user (subProfile) associated with a business customer account. You can modify fields such as the authorized user's name, email address, and department assignment. Submitting updated values ensures that authorized user records remain current and accurate within the platform.
Endpoint
POST /api/subProfiles/update
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 customer needs to correct or update the details of an authorized user on their account — for example, after a name change, an email address update, or a department reassignment. Only business customers can have authorized users (subProfiles); this endpoint is not applicable for personal customer accounts. Ensure that only authenticated and authorized business customers initiate updates to their authorized users' profiles.
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
| subProfileId | integer (int32) | No | Unique identifier of the authorized user (subProfile) to update |
| givenName | string | Yes | First name of the authorized user. Max 255 characters |
| familyName | string | Yes | Last name of the authorized user. Max 255 characters |
| string (email) | Yes | Email address of the authorized user. Max 128 characters | |
| departmentId | integer (int32) | No | ID of the department to assign the authorized user to |
| department | string | No | Department name. Deprecated — use departmentId instead. Max 128 characters |
{
"subProfileId": 4821,
"givenName": "Maria",
"familyName": "Gonzalez",
"email": "[email protected]",
"departmentId": 12
}Response
200 OK
A 200 response confirms that the authorized user's profile has been successfully updated. The response body confirms the operation outcome.
| Field | Type | Description |
|---|---|---|
| success | boolean | Indicates whether the update was completed successfully |
| message | string | Human-readable confirmation or error message |
{
"success": true,
"message": "Authorized user profile updated successfully."
}Error Codes
| Code | When it happens |
|---|---|
| 400 | Missing required fields (givenName, familyName, or email), validation failure (e.g., invalid email format, value exceeds max length), or extra/unrecognized fields in the request body |
| 401 | Token missing, expired, or invalid |
| 403 | Authenticated customer does not have permission to update this authorized user |
| 404 | The specified subProfileId does not exist or does not belong to the authenticated business customer |
| 500 | Internal server error |
Common Mistakes
- Omitting
subProfileId— without it, the platform cannot identify which authorized user to update; always include the correct subProfile identifier - Sending an invalid email format for the
emailfield — the value must conform to standard email format (e.g.,[email protected]) - Using the deprecated
departmentstring field instead ofdepartmentId— migrate todepartmentIdto ensure forward compatibility - Exceeding field length limits —
givenNameandfamilyNamemax 255 characters,emailanddepartmentmax 128 characters - Attempting to update a subProfile that belongs to a different business customer — each authorized user is scoped to the business account that created it
Related Endpoints
POST /api/subProfiles/create— Create a new authorized user for a business customer accountGET /api/subProfiles— Retrieve a list of authorized users associated with the authenticated business customerPOST /api/subProfiles/delete— Remove an authorized user from a business customer accountPOST /api/auth/v2— Obtain a Bearer token for authentication
Example
curl -X POST https://api.banking.netevia.dev/api/subProfiles/update \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"subProfileId": 4821,
"givenName": "Maria",
"familyName": "Gonzalez",
"email": "[email protected]",
"departmentId": 12
}' 200Success
