Change phone number associated with Primary Authorized Person and/or Beneficial Owners.

Change Associated Phone

The /changeAssociatedPhone endpoint allows partners to update the phone number associated with a business customer's account. It can be used to change the contact phone number of the Primary Authorized Person or any Beneficial Owner registered under the business account. This endpoint is exclusively available for business customers.

Endpoint

POST /changeAssociatedPhone

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 contact information for their Primary Authorized Person or a Beneficial Owner — for example, following a change in ownership, replacement of outdated contact details, or for security compliance purposes. Keeping phone numbers current ensures that verification messages and critical communications reach the right individuals. This endpoint requires you to know the associatedPersonId of the person whose phone number is being changed.

Request Body

FieldTypeRequiredDescription
associatedPersonIdstringYesThe ID of the Primary Authorized Person or Beneficial Owner whose phone number is being updated.
phonestringYesThe new phone number to associate with the specified person.
{
  "associatedPersonId": "ap_8f3d2c1b9e4a7f05",
  "phone": "5551234567"
}

Response

200 OK

A 200 OK response indicates the phone number was successfully updated. No response body fields are returned.

{}

Error Codes

CodeWhen it happens
400Missing required fields (associatedPersonId or phone) or validation error (e.g., empty string)
401Token missing, expired, or invalid
403Insufficient permissions to update this account's associated person
404The specified associatedPersonId was not found
500Internal server error

Common Mistakes

  • Omitting associatedPersonId — this field is required; without it the request will fail with a 400 error.
  • Providing an empty string for phone — the schema enforces minLength: 1, so an empty value will be rejected.
  • Using this endpoint for personal (non-business) customers — it is designed exclusively for business account contacts.
  • Using an associatedPersonId that belongs to a different business account than the one tied to the Bearer token.

Related Endpoints

  • POST /changeAssociatedPhone — Update the phone number for a Primary Authorized Person or Beneficial Owner (this endpoint)
  • POST /api/auth/v2 — Obtain a Bearer token for authentication
  • POST /api/auth/refresh — Refresh an expiring Bearer token

Example

curl -X POST https://api.banking.netevia.dev/changeAssociatedPhone \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "associatedPersonId": "ap_8f3d2c1b9e4a7f05",
    "phone": "5551234567"
  }'
Body Params
string
required
length ≥ 1

Primary Authorized Person and/or Beneficial Owner Id.

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!