Update Authorized user's phone

Update Authorized User's Phone

The POST /api/subProfiles/phone endpoint updates the phone number for an authorized user (subProfile) linked to a business customer account. By supplying the authorized user's unique ID along with the new phone number and its country code, partners can ensure contact information remains accurate and current. The endpoint validates both the format and length of the phone number before persisting the change.

Endpoint

POST /api/subProfiles/phone

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 changes their mobile number or when initial onboarding captured an incorrect phone number. Keeping phone numbers up to date supports secure communication such as SMS-based verification and transaction alerts. This endpoint applies exclusively to subProfiles (authorized users) of business customers; it is not used for personal customer profiles.

Request Body

{
  "subProfileId": 4821,
  "phoneNumberCountryCode": "001",
  "phoneNumber": "8005550199"
}

Response

200 OK

A successful response confirms that the authorized user's phone number has been updated. The response body contains the updated subProfile details.

{
  "success": true,
  "message": "Phone number updated successfully."
}

Error Codes

Common Mistakes

• Passing a phone number with formatting characters (dashes, parentheses, spaces) — the phoneNumber field must be exactly 10 numeric digits with no separators.
• Providing a phoneNumberCountryCode that is not exactly 3 characters — both shorter and longer values will be rejected with a 400 error.
• Omitting subProfileId when intending to update a specific authorized user — without it the request may target an unintended profile or fail validation.
• Using this endpoint for personal customer profiles — it is designed exclusively for business customer subProfiles.

Related Endpoints

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

Example

curl -X POST https://api.banking.netevia.dev/api/subProfiles/phone \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "subProfileId": 4821,
    "phoneNumberCountryCode": "001",
    "phoneNumber": "8005550199"
  }'