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

Change Associated Address

The /changeAssociatedAddress endpoint allows business customers to update the address on file for a Primary Authorized Person or a Beneficial Owner. This is used to ensure that all legal, regulatory, and transactional correspondence is directed to the correct, current address. Only business accounts are eligible to use this endpoint.

Endpoint

POST /changeAssociatedAddress

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 Primary Authorized Person or a Beneficial Owner on a business account has changed their residential or mailing address. This keeps the business's compliance records current and ensures correspondence reaches the right individual. This endpoint is only applicable to business customers — personal accounts are not supported.

Request Body

FieldTypeRequiredDescription
associatedPersonIdstringYesThe ID of the Primary Authorized Person or Beneficial Owner whose address is being updated.
streetAddressstringYesStreet address in the format 123 Avenue Street. Must begin with a number followed by street name components.
extendedAddressstringNoApartment, suite, unit, or other secondary address information.
postalCodestringYes5-digit US ZIP code (e.g., 90210).
citystringYesCity name.
stateintegerYesUS state as an integer enum value (1–53, corresponding to US states and territories).
{
  "associatedPersonId": "ap_9f3c2e1d4b7a8c0e",
  "streetAddress": "742 Evergreen Terrace",
  "extendedAddress": "Suite 100",
  "postalCode": "62704",
  "city": "Springfield",
  "state": 14
}

Response

200 OK

A 200 status indicates the address was successfully updated. No additional response body fields are returned.

{}

Error Codes

CodeWhen it happens
400Missing required fields, invalid postal code format, invalid street address format, or unrecognized state enum value
401Token missing, expired, or invalid
403Insufficient permissions or caller is not associated with a business account
404The specified associatedPersonId was not found
500Internal server error

Common Mistakes

  • Providing a state value outside the valid integer range (1–53); use the documented enum values, not two-letter state abbreviations.
  • Formatting streetAddress incorrectly — it must begin with a number (e.g., 742 Evergreen Terrace) and match the required pattern; PO Box formats are not accepted.
  • Omitting associatedPersonId — this field is required and must reference an existing Primary Authorized Person or Beneficial Owner on the account.
  • Using this endpoint for personal customer accounts; it is only valid for business accounts.
  • Sending a postalCode that is not exactly 5 digits — extended ZIP+4 formats (e.g., 62704-1234) are not accepted.

Related Endpoints

  • POST /changeAddress — Update the primary address on a customer account
  • POST /api/auth/v2 — Obtain a Bearer authentication token
  • POST /api/auth/refresh — Refresh an existing Bearer token

Example

curl -X POST https://api.banking.netevia.dev/changeAssociatedAddress \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "associatedPersonId": "ap_9f3c2e1d4b7a8c0e",
    "streetAddress": "742 Evergreen Terrace",
    "extendedAddress": "Suite 100",
    "postalCode": "62704",
    "city": "Springfield",
    "state": 14
  }'
Body Params
string
required
length ≥ 1

Primary Authorized Person and/or Beneficial Owner Id.

string
required
length ≥ 1

Please, use next format 123 Avenue Street for Address

string | null
^[a-zA-Z\d',. \-#]+(([',. \-#][a-zA-Z ])?[a-zA-Z.]*)*$
string
required
length ≥ 1
^\d{5}$
string
required
length ≥ 1
int32
enum
required
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!