Change Associated Email
The /changeAssociatedEmail endpoint allows partners to update the email address linked to a business customer's Primary Authorized Person or Beneficial Owners. This is a business-customer-only endpoint designed to keep contact information accurate and up to date. Use it when ownership changes, contact details are outdated, or a security-driven email rotation is required.
Endpoint
POST /changeAssociatedEmail
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 update the email on file for a Primary Authorized Person or a Beneficial Owner. Common scenarios include a change in business ownership, replacing outdated contact details, or rotating email addresses for security compliance. Keeping these emails current ensures that all account communications and verification messages reach the correct recipients.
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
| associatedPersonId | string | Yes | The ID of the Primary Authorized Person or Beneficial Owner whose email is being updated. |
| string (email) | Yes | The new email address to associate with the specified person. |
{
"associatedPersonId": "ap_7f3e2c1a4b8d9e0f",
"email": "[email protected]"
}Response
200 OK
A 200 status indicates the email was successfully updated. The response body confirms success with no additional payload fields.
{}Error Codes
| Code | When it happens |
|---|---|
| 400 | Missing required fields (associatedPersonId or email) or the email format is invalid |
| 401 | Token missing, expired, or invalid |
| 403 | Insufficient permissions to modify this business account |
| 404 | The specified associatedPersonId was not found |
| 500 | Internal server error |
Common Mistakes
- Omitting
associatedPersonId— this field is required and must reference a valid Primary Authorized Person or Beneficial Owner ID associated with the business account. - Providing a malformed email address — the
emailfield must conform to standard email format (e.g.,[email protected]). - Using this endpoint for personal customers —
/changeAssociatedEmailis restricted to business customer accounts only. - Sending a request with an
associatedPersonIdbelonging to a different business account — IDs are scoped to the authenticated partner's customers.
Related Endpoints
POST /changeAssociatedEmail— Update email for a Primary Authorized Person or Beneficial Owner (this endpoint)POST /api/auth/v2— Obtain a Bearer token for authenticationPOST /api/auth/refresh— Refresh an expiring Bearer token
Example
curl -X POST https://api.banking.netevia.dev/changeAssociatedEmail \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"associatedPersonId": "ap_7f3e2c1a4b8d9e0f",
"email": "[email protected]"
}' 200Success
