Change email address

Change Email Address

The /changeEmail endpoint allows personal customers to update their registered email address in the Netevia Banking system. This ensures all account communications, notifications, and security verifications reach the correct address. Three request variants are supported depending on whether a verification code is required or the update targets an associated person.

Endpoint

POST /changeEmail

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 personal customer needs to update their registered email address — for example, after switching email providers, correcting a typo, or consolidating personal accounts. Keeping email addresses current is critical for receiving account alerts, security notifications, and verification codes. For secured operations, include a one-time code to confirm the change.

Request Body

This endpoint accepts one of three request variants. Select the variant that matches your use case.


Variant 1 — Basic email change (changeemailrequest)

FieldTypeRequiredDescription
emailstring (email)YesNew email address to register for the customer
{
  "email": "[email protected]"
}

Variant 2 — Change email for an associated person (changeassociatedpersonemailrequest)

Extends Variant 1. Use when updating the email of a Primary Authorized Person or Beneficial Owner linked to the account.

FieldTypeRequiredDescription
emailstring (email)YesNew email address to register
associatedPersonIdstringYesID of the Primary Authorized Person and/or Beneficial Owner whose email is being updated
{
  "email": "[email protected]",
  "associatedPersonId": "ap_8f3d2e1c4b9a7056"
}

Variant 3 — Secured email change (changeemailsecuredrequest)

Extends Variant 1. Use when the platform requires a one-time verification code to authorize the change.

FieldTypeRequiredDescription
emailstring (email)YesNew email address to register
oneTimeCodestringYesSix-digit numeric verification code (pattern: ^\d{6}$)
secureOperationTypestring (enum)YesVerification method used to generate the code. One of: ShortMessageCode, TimeBasedCode, LegacyTimeBasedCode
{
  "email": "[email protected]",
  "oneTimeCode": "482917",
  "secureOperationType": "ShortMessageCode"
}

Response

200 OK

A 200 response indicates the email address was successfully updated. No response body is returned.

Error Codes

CodeWhen it happens
400Missing required fields, invalid email format, or one-time code does not match the expected pattern
401Token missing, expired, or invalid
403Insufficient permissions to update the specified email
404Customer or associated person not found
500Internal server error

Common Mistakes

  • Sending oneTimeCode without secureOperationType (or vice versa) — both fields are required together in Variant 3.
  • Omitting associatedPersonId when intending to update an associated person's email — without it, the request targets the authenticated customer's own email.
  • Providing a oneTimeCode that is not exactly 6 digits — the pattern ^\d{6}$ enforces this strictly.
  • Using an already-registered or improperly formatted email address in the email field.

Related Endpoints

  • POST /api/auth/v2 — Obtain a Bearer token for authentication
  • POST /api/auth/refresh — Refresh an expiring Bearer token
  • POST /changePhone — Update the registered phone number for a customer account

Example

Basic email change:

curl -X POST https://api.banking.netevia.dev/changeEmail \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "[email protected]"
  }'

Secured email change with SMS verification:

curl -X POST https://api.banking.netevia.dev/changeEmail \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "[email protected]",
    "oneTimeCode": "482917",
    "secureOperationType": "ShortMessageCode"
  }'

Update email for an associated person:

curl -X POST https://api.banking.netevia.dev/changeEmail \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "[email protected]",
    "associatedPersonId": "ap_8f3d2e1c4b9a7056"
  }'
Body Params
string
required
length ≥ 1
Headers
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Response
200

Success

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here!