Update Subscriber

PUT/subscribers/{id}Open in the API playground →

Request

Authorizationstringheaderrequired

Bearer olive_live_xxx or Bearer eyJ... (JWT)

Path Parameters

idstringpathrequired

Subscriber UUID (e.g., sub_abc123)

Body Parameters

All fields are optional. Only include fields you want to update.

emailstringbody

Updated email address

addressstringbody

Updated physical address

kyc_levelintegerbody

New KYC level (1-3). Requires supporting documents.

id_numberstringbody

National ID number

id_typestringbody

ID type: NATIONAL_ID, PASSPORT, DRIVERS_LICENSE

id_document_urlstringbody

URL to ID document image

selfie_urlstringbody

URL to selfie image

vult_wallet_idstringbody

Link VULT wallet ID

categorystringbody

Account category: standard, vip, corporate

max_child_cardsintegerbody

Maximum child cards allowed

relationship_manager_idintegerbody

Assigned relationship manager ID

---

Response

successboolean

Whether update succeeded

messagestring

Result message

subscriberobject

Updated subscriber object

---

Examples

Request

cURL - Update Email

curl -X PUT "https://demo.api.vultlocal.com/api/v1/subscribers/sub_abc123" \
  -H "Authorization: Bearer olive_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "newemail@example.com"
  }'

cURL - Upgrade KYC

curl -X PUT "https://demo.api.vultlocal.com/api/v1/subscribers/sub_abc123" \
  -H "Authorization: Bearer olive_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "kyc_level": 2,
    "id_number": "SL12345678",
    "id_type": "NATIONAL_ID",
    "id_document_url": "https://storage.smartpay.example.com/docs/id_front.jpg"
  }'

Response

200 OK

{
  "success": true,
  "message": "Subscriber updated successfully",
  "subscriber": {
    "id": "sub_abc123",
    "phone_number": "+23279123456",
    "first_name": "John",
    "last_name": "Doe",
    "email": "newemail@example.com",
    "kyc_level": 2,
    "status": "ACTIVE",
    "updated_at": "2025-01-20T14:45:00Z"
  }
}

404 Not Found

{
  "error": "Subscriber not found",
  "code": "NOT_FOUND"
}

---

KYC Upgrade Requirements

Level 1 → 2

• Valid ID document
• ID number

Level 2 → 3

• Proof of address
• Selfie verification

Special Categories

• VIP review
• Corporate documents

---

Errors

Status	Code	Description
400	INVALID_REQUEST	Invalid field values
401	UNAUTHORIZED	Invalid or missing API key
403	FORBIDDEN	Cannot update this subscriber
404	NOT_FOUND	Subscriber not found
500	INTERNAL_ERROR	Server error