Register a new subscriber
curl --request POST \
--url https://olive-gateway-a6ba.onrender.com/api/v1/subscribers \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"first_name": "John",
"last_name": "Doe",
"phone_number": "0771234567",
"pin": "1234"
}
'const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({first_name: 'John', last_name: 'Doe', phone_number: '0771234567', pin: '1234'})
};
fetch('https://olive-gateway-a6ba.onrender.com/api/v1/subscribers', 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/subscribers"
payload = {
"first_name": "John",
"last_name": "Doe",
"phone_number": "0771234567",
"pin": "1234"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){}{}{}Subscribers
Register a new subscriber
Register a new subscriber with KYC details
POST
/
subscribers
Register a new subscriber
curl --request POST \
--url https://olive-gateway-a6ba.onrender.com/api/v1/subscribers \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"first_name": "John",
"last_name": "Doe",
"phone_number": "0771234567",
"pin": "1234"
}
'const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({first_name: 'John', last_name: 'Doe', phone_number: '0771234567', pin: '1234'})
};
fetch('https://olive-gateway-a6ba.onrender.com/api/v1/subscribers', 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/subscribers"
payload = {
"first_name": "John",
"last_name": "Doe",
"phone_number": "0771234567",
"pin": "1234"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){}{}{}Authorizations
ApiKeyAuthBearerAuth
API Key for third-party integrations (WhatsApp, Smart PAY, VULT). Format: 'Bearer olive_live_xxxxxxxxxxxxx'
Body
application/json
Subscriber registration details
Example:
"John"
Example:
"Doe"
Example:
"0771234567"
Example:
"1234"
Example:
"123 Main St"
Example:
"retail"
Example:
"https://example.com/cert.pdf"
Example:
"Western Urban"
Example:
"john@example.com"
Example:
"https://example.com/id_back.jpg"
Example:
"https://example.com/id_front.jpg"
Example:
1
Example:
4
Example:
"NID123456"
Example:
"ABC Company Ltd"
Example:
"Limited Company"
Example:
"Michael"
Example:
"REF123"
Example:
"RC123456"
Example:
1
Example:
"0771234567"
Response
Subscriber created successfully
The response is of type object.
⌘I