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>"
}
'const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({subscriber_id: '<string>'})
};
fetch('https://olive-gateway-a6ba.onrender.com/api/v1/pep/request-access', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://olive-gateway-a6ba.onrender.com/api/v1/pep/request-access"
payload = { "subscriber_id": "<string>" }
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){}{}{}{}PEP Access
Request PEP Access
Request OTP for accessing a PEP account
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>"
}
'const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({subscriber_id: '<string>'})
};
fetch('https://olive-gateway-a6ba.onrender.com/api/v1/pep/request-access', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://olive-gateway-a6ba.onrender.com/api/v1/pep/request-access"
payload = { "subscriber_id": "<string>" }
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){}{}{}{}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
string
required
Bearer token (Admin JWT with
pep_access_authorized: true)Request Body
string
required
PEP subscriber UUID
Response
{
"success": true,
"message": "OTP sent successfully",
"expiry_time": "2025-01-15T10:35:00Z"
}
What Happens
- System verifies subscriber is marked as PEP
- System verifies staff has PEP access authorization
- 6-digit OTP is generated and sent to staff’s phone
- OTP expires in 5 minutes
- Access attempt is logged with IP and user agent
Errors
| Code | Description |
|---|---|
| 400 | Invalid request |
| 401 | User not authenticated |
| 403 | Not authorized for PEP access |
| 404 | Subscriber not found |
| 500 | Internal server error |
Authorizations
ApiKeyAuthBearerAuth
API Key for third-party integrations (WhatsApp, Smart PAY, VULT). Format: 'Bearer olive_live_xxxxxxxxxxxxx'
Body
application/json
PEP access request
Response
OTP sent successfully
The response is of type object.
⌘I