Update Authorized user's address

Update Authorized User's Address

This endpoint updates the address of an authorized user (subProfile) within a business customer account. By providing the authorized user's unique ID along with the new address details — including street, city, state, and postal code — you can efficiently keep address information current. Optionally, the update can also propagate to any payment card billing addresses associated with the authorized user.

Endpoint

POST /api/subProfiles/address

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's authorized user has moved or needs their address record corrected. This is relevant for compliance, KYC maintenance, and ensuring billing addresses on payment cards remain accurate. Only authorized integrations with appropriate permissions may modify subProfile addresses.

Request Body

{
  "subProfileId": 4821,
  "updatePaymentCardBillingAddress": true,
  "streetAddress": "742 Evergreen Terrace",
  "extendedAddress": "Suite 100",
  "postalCode": "62701",
  "state": 14,
  "locality": "Springfield",
  "countryCodeAlpha3": "USA"
}

Response

200 OK

A successful response confirms that the address has been updated for the specified authorized user. The response body on success is empty or a generic success acknowledgment.

{}

Error Codes

Common Mistakes

• Omitting updatePaymentCardBillingAddress — this field is required even when you do not intend to update card billing addresses; pass false explicitly if no card update is needed.
• Providing a postalCode that is not exactly 5 numeric digits — values like "6270" (4 digits) or "62701-1234" (ZIP+4 format) will fail validation.
• Supplying a countryCodeAlpha3 that is not exactly 3 characters — the schema enforces minLength: 3 and maxLength: 3; use ISO alpha-3 codes such as "USA".
• Passing an invalid state integer — the enum accepts values 1 through 53 only; values outside this range will be rejected.
• Formatting streetAddress incorrectly — the field requires a leading street number followed by a street name; P.O. Box formats or address-only strings without a leading number will fail the pattern check.

Related Endpoints

• POST /api/subProfiles — Create a new authorized user (subProfile) for a business customer
• GET /api/subProfiles/{subProfileId} — Retrieve details of a specific authorized user
• POST /api/subProfiles/phone — Update the phone number of an authorized user
• POST /api/subProfiles/email — Update the email address of an authorized user

Example

curl -X POST https://api.banking.netevia.dev/api/subProfiles/address \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "subProfileId": 4821,
    "updatePaymentCardBillingAddress": true,
    "streetAddress": "742 Evergreen Terrace",
    "extendedAddress": "Suite 100",
    "postalCode": "62701",
    "state": 14,
    "locality": "Springfield",
    "countryCodeAlpha3": "USA"
  }'