Skip to main content
POST
Changing PIN requires verification of the current PIN first.

Request

string
required
Bearer olive_live_xxx or Bearer eyJ... (JWT)

Path Parameters

string
required
Subscriber UUID (e.g., sub_abc123)

Body Parameters

string
required
Current 4-digit PIN
string
required
New 4-digit PIN

Response

boolean
Whether change succeeded
string
Result message

Examples


PIN Rules

Format

  • Exactly 4 digits
  • Numbers only (0-9)
  • No spaces or special characters

Security

  • Cannot be same as current PIN
  • Sequential patterns discouraged
  • Simple patterns (1111) warned

Validation


Notifications

A WhatsApp notification is sent to the subscriber when their PIN is changed.

Errors


Verify PIN

Verify a PIN without changing it

Authorizations

Authorization
string
header
required

API Key for third-party integrations (WhatsApp, Smart PAY, VULT). Format: 'Bearer olive_live_xxxxxxxxxxxxx'

Path Parameters

id
string
required

Subscriber ID

Body

application/json

PIN change details

new_pin
string
required
old_pin
string
required

Response

PIN changed successfully

The response is of type object.