Skip to main content
POST
/
pep
/
request-access
Request OTP for PEP account access
curl --request POST \
  --url https://olive-gateway-a6ba.onrender.com/api/v1/pep/request-access \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "subscriber_id": "<string>"
}
'
{}

​
Request PEP Access

Generate and send OTP to access a Politically Exposed Person (PEP) account. Staff must have PEP authorization role.

​
Endpoint

POST /api/v1/pep/request-access

​
Authentication

​
Authorization
string
required
Bearer token (Admin JWT with pep_access_authorized: true)

​
Request Body

​
subscriber_id
string
required
PEP subscriber UUID

​
Response

{
  "success": true,
  "message": "OTP sent successfully",
  "expiry_time": "2025-01-15T10:35:00Z"
}

​
What Happens

  1. System verifies subscriber is marked as PEP
  2. System verifies staff has PEP access authorization
  3. 6-digit OTP is generated and sent to staff’s phone
  4. OTP expires in 5 minutes
  5. Access attempt is logged with IP and user agent

​
Errors

CodeDescription
400Invalid request
401User not authenticated
403Not authorized for PEP access
404Subscriber not found
500Internal server error

Authorizations

​
Authorization
string
header
required

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

Body

application/json

PEP access request

​
subscriber_id
string
required

Response

OTP sent successfully

The response is of type object.