Subscribers
Verify PIN
Verify a subscriber’s 4-digit PIN
POST
Use this endpoint to verify a subscriber’s PIN before processing sensitive operations.
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
4-digit PIN to verify
Response
boolean
Whether PIN is valid
string
Result message
Examples
PIN Security
Attempt Limits
- 3 failed attempts allowed
- Account locked for 30 minutes
- Counter resets on success
Audit Logging
- All attempts logged
- IP address recorded
- Used for fraud detection
Use Cases
Errors
Related
Change PIN
Change subscriber’s PIN to a new value
Authorizations
API Key for third-party integrations (WhatsApp, Smart PAY, VULT). Format: 'Bearer olive_live_xxxxxxxxxxxxx'
Path Parameters
Subscriber ID
Body
application/json
PIN to verify
Example:
"1234"
Response
PIN verification result
The response is of type object.