Teruza API Documentation

AI Query

Make any textual AI call

Method	POST
Access	Requires Authentication
Endpoint	/api/v1/ai/query
Cost	R 0.25 per call

Parameters

query

text (required)

The query to be sent to the AI.

Sample Response

No sample response available.

Document Analysis

Analyzes a document to determine its type (e.g. ID document, invoice, statement, etc.) and extracts relevant information into a structured JSON format for easy processing and integration.

Method	POST
Access	Requires Authentication
Endpoint	/api/v1/ai/analyze_document
Cost	R 0.45 per call

Parameters

document

file (required)

Base64 encoded string of the file to be analyzed.

Sample Response

NSFW Content Identifier

Analyzes an image or PDF to identify whether it is NSFW content, such as porn, hentai, violent images etc.

Method	POST
Access	Requires Authentication
Endpoint	/api/v1/ai/nsfw_checker
Cost	R 0.45 per call

Parameters

file

file (required)

Base64 encoded string of the file to be analyzed.

Sample Response

(
    [executedAt] => 2025-07-08 08:11:50
    [connect] => OK
    [callTime] => 4.4643
    [cost] => 0.45
    [remainingCredit] => 4833.663
    [success] => 1
    [error] => null
    [result] => 
        (
            [isNSFW] => 1
            [imageType] => protest
            [short_description_of_image] => Redacted Description
            [minimumViewingAge] => 18
            [isWatermarked] => 1
            [imageText] => Redacted
            [isMeme] => 
            [facesDetected] => Array
                (
                    [0] => 15
                )

            [childFriendlyContent] => 0
            [imageQualityScore] => 0.87
            [blurredSensitiveAreas] => 0
            [scores] => 
                (
                    [explicit] => 0
                    [nudity] => 0
                    [suggestive] => 0
                    [violent] => 0.2
                    [gore] => 0
                    [extremist] => 0
                    [racist] => 0
                    [political] => 0.8
                    [drugs] => 0
                    [weapons] => 0
                    [self-harm] => 0
                    [underage] => 0
                )

        )

    [record_id] => 686cb6a6d01bcb957a031a1b
)

Receipt Analyzer

Analyzes a receipt to identify the billable items and other meta data on the receipt.

Method	POST
Access	Requires Authentication
Endpoint	/api/v1/ai/receipt_analyzer
Cost	R 0.45 per call

Parameters

file

file (required)

Base64 encoded string of the file to be analyzed.

Sample Response

Wine Label Analysis

Analyzes an image or PDF to identify the wine type, vintage, and country of origin etc.

Method	POST
Access	Requires Authentication
Endpoint	/api/v1/ai/analyze_wine_label
Cost	R 0.45 per call

Parameters

winelabel

file (required)

Base64 encoded string of the file to be analyzed.

Sample Response

(
    [executedAt] => 2025-07-08 08:08:26
    [connect] => OK
    [callTime] => 8.18917
    [cost] => 0.45
    [remainingCredit] => 4834.113
    [success] => 1
    [error] => null
    [result] => 
        (
            [isWineLabel] => 1
            [nrOfWineLabels] => 1
            [labels] => Array
                (
                    [0] => 
                        (
                            [wine_name] => Redacted Wine Name
                            [wine_type] => null
                            [wine_maker] => null
                            [grape_varietals] => Array
                                (
                                )

                            [vintage] => 2005
                            [country_of_origin] => France
                            [region] => Graves
                            [alcohol_percentage] => null
                            [volume_ml] => null
                            [award_badges] => Array
                                (
                                )

                            [tasting_notes] => null
                            [label_authentic] => 1
                            [label_language] => French
                            [label_text] => Redacted Label Text
                            [label_text_english] => Redacted Label Text
                            [wine_name_english] => Redacted Wine Name
                            [wine_type_english] => null
                            [winery] => 
                                (
                                    [id] => null
                                    [name] => Redacted Winery
                                    [website] => null
                                    [address] => null
                                    [lat] => null
                                    [long] => null
                                )

                        )

                )

        )

    [record_id] => 686cb5dad01bcb957a031a18
)

Create Chatbot Instance

Creates a chatbot instance for a user.

Method	POST
Access	Requires Authentication
Endpoint	/api/v1/chatbot/create
Cost	R 0.001 per call

Parameters

name string (required)	The name of the chatbot.
description string (optional)	A description that only admins will see.
image file (optional)	Base64 encoded image to be used for the chatbot.
prompt textarea (optional)	The prompt for the bot. I.e. The first message it will receive that should also define how it functions.

Sample Response

(
    [executedAt] => 2025-07-07 12:06:46
    [connect] => OK
    [callTime] => 0.02471
    [cost] => 0.001
    [remainingCredit] => 4838.079
    [success] => 1
    [error] => "null"
    [result] => 
        (
            [created_at] => REDACTED_TIMESTAMP
            [bot_id] => REDACTED_BOT_ID
        )

    [record_id] => REDACTED_RECORD_ID
)

Create new Chatbot Session

Create a new chatbot session to which messages can be sent.

Method	POST
Access	Requires Authentication
Endpoint	/api/v1/chatbot/session/create
Cost	R 0.001 per call

Parameters

botid string (required)	The ID of the chatbot to update.
sessionid string (optional)	A unique ID for the session. If not provided, a random one will be generated.
name string (optional)	The name of the speaker.
email email (optional)	The email of the speaker.
contact_number string (optional)	The contact number of the speaker.

Sample Response

(
    [executedAt] => 2025-07-07 12:22:06
    [connect] => OK
    [callTime] => 0.02322
    [cost] => 0.001
    [remainingCredit] => 4838.072999999999
    [success] => 1
    [error] => "null"
    [result] => 
        (
            [created_at] => REDACTED_TIMESTAMP
            [session_id] => REDACTED_SESSION_ID
        )

    [record_id] => REDACTED_RECORD_ID
)

Embed a Chatbot on a Website

Speak to a chatbot session.

Method	POST
Access	Requires Authentication
Endpoint	/api/v1/chatbot/embed
Cost	R 0.00 per call

Parameters

chatbotid

string (required)

The ID of the chatbot you want to embed.

Sample Response

No sample response available.

Get All Chatbot Instances

Returns all chatbot instances for a user.

Method	POST
Access	Requires Authentication
Endpoint	/api/v1/chatbot/getAll
Cost	R 0.001 per call

Parameters

No parameters

Sample Response

(
    [executedAt] => 2025-07-07 12:15:55
    [connect] => OK
    [callTime] => 0.01238
    [cost] => 0.001
    [remainingCredit] => 4838.076
    [success] => 1
    [error] => "null"
    [result] => 
        (
            [0] => 
                (
                    [uid] => REDACTED_UID
                    [bot_name] => REDACTED_BOT_NAME
                    [bot_description] => REDACTED_BOT_DESCRIPTION
                    [bot_image] => "null"
                    [prompt] => "null"
                    [deleted] => 0
                    [updated_at] => REDACTED_TIMESTAMP
                    [created_at] => REDACTED_TIMESTAMP
                    [prompt_setting__personality] => REDACTED_PERSONALITY
                    [id] => REDACTED_BOT_ID
                )

            [1] => 
                (
                    [uid] => REDACTED_UID
                    [bot_name] => REDACTED_BOT_NAME
                    [bot_description] => REDACTED_BOT_DESCRIPTION
                    [bot_image] => "null"
                    [prompt] => "null"
                    [deleted] => 0
                    [updated_at] => REDACTED_TIMESTAMP
                    [created_at] => REDACTED_TIMESTAMP
                    [prompt_setting__personality] => REDACTED_PERSONALITY
                    [id] => REDACTED_BOT_ID
                )

        )

    [record_id] => REDACTED_RECORD_ID
)

Get Bot Conversation Message

Fetches data obtained through conversations with the bot (can be used to generate leads etc)

Method	POST
Access	Requires Authentication
Endpoint	/api/v1/bot/getMessages
Cost	R 0.02 per call

Parameters

chatBotID string (required)	The ID of the Chatbot that you want to fetch data for.
page integer (optional)	The page number you want to get. Default: 1.
limit integer (optional)	Number of items per page you want to receive. Default: 20. Min: 1. Max: 100.
mustHaveData integer (optional)	Only return messages that contain information in the "data" field. Default: 0.

Sample Response

No sample response available.

Get Chatbot Instance

Get full details of a chatbot instance.

Method	POST
Access	Requires Authentication
Endpoint	/api/v1/chatbot/get
Cost	R 0.001 per call

Parameters

botid

string (required)

The ID of the chatbot to update.

Sample Response

(
    [executedAt] => 2025-07-07 12:14:17
    [connect] => OK
    [callTime] => 0.01361
    [cost] => 0.001
    [remainingCredit] => 4838.077
    [success] => 1
    [error] => "null"
    [result] => 
        (
            [uid] => REDACTED_UID
            [bot_name] => REDACTED_BOT_NAME
            [bot_description] => REDACTED_BOT_DESCRIPTION
            [bot_image] => "null"
            [prompt] => "null"
            [deleted] => 0
            [updated_at] => REDACTED_TIMESTAMP
            [created_at] => REDACTED_TIMESTAMP
            [prompt_setting__personality] => REDACTED_PERSONALITY
            [id] => REDACTED_BOT_ID
            [messages] => Array
                (
                )

        )

    [record_id] => REDACTED_RECORD_ID
)

Get Chatbot Leads

Get any lead data generated by the chatbot session.

Method	POST
Access	Requires Authentication
Endpoint	/api/v1/chatbot/leads/get
Cost	R 0.00 per call

Parameters

No parameters

Sample Response

No sample response available.

Get Chatbot Session Instance

Get full details of a chatbot session including the chat history.

Method	POST
Access	Does not Require Authentication
Endpoint	/api/v1/chatbot/session/get
Cost	R 0.00 per call

Parameters

chatbotid string (required)	The ID of the chatbot.
sessionid string (required)	The Session ID.

Sample Response

No sample response available.

Get Chatbot embeddable CSS

Get chatbot embeddable CSS

Method	POST
Access	Does not Require Authentication
Endpoint	/api/v1/chatbot/css/chatbot.css
Cost	R 0.00 per call

Parameters

No parameters

Sample Response

No sample response available.

Get Chatbot embeddable JS

Get chatbot embeddable JS

Method	POST
Access	Does not Require Authentication
Endpoint	/api/v1/chatbot/js/chatbot.js
Cost	R 0.00 per call

Parameters

No parameters

Sample Response

No sample response available.

Speak to Chatbot Session

Speak to a chatbot session.

Method	POST
Access	Does not Require Authentication
Endpoint	/api/v1/chatbot/speak
Cost	R 0.02 per call

Parameters

sessionid string (required)	The ID of the chatbot session to update.
chatbotid string (optional)	The ID of the chatbot linked to the session. Reguired if the session does not exist yet.
message textarea (required)	The message to send to the chatbot.

Sample Response

(
    [executedAt] => 2025-07-08 08:26:15
    [connect] => OK
    [callTime] => 2.40745
    [cost] => 0.02
    [remainingCredit] => 4830.69
    [success] => 1
    [error] => null
    [result] => 
        (
            [client_message_id] => RedactedClientID
            [agent_message_id] => RedactedAgentID
        )

    [record_id] => RedactedRecordID
)

Update Chatbot Instance

Updates the details of a chatbot instance

Method	POST
Access	Requires Authentication
Endpoint	/api/v1/chatbot/update
Cost	R 0.001 per call

Parameters

botid string (required)	The ID of the chatbot to update.
name string (optional)	The name of the chatbot.
description string (optional)	The description of the chatbot.
image file (optional)	Base64 encoded image to be used for the chatbot.
personality textarea (optional)	The personality of the chatbot.
overview textarea (optional)	An overview of the business.
products textarea (optional)	Detailed information on the products offered by the business.
services textarea (optional)	Detailed information on the services offered by the business.
pricing textarea (optional)	Detailed information on the pricing of the business.
support textarea (optional)	Detailed information on the support offered by the business. I.e. How to get support and what type of support is available.
contact textarea (optional)	Detailed contact information for the business. Include URLS, email, phone numbers, address, how to open support tickets etc.
boundaries textarea (optional)	Detailed information on the boundaries of the chatbot. I.e. What is off limits and what is not.
qa textarea (optional)	Sample questions and answers for the chatbot. (Highly recommennded)

Sample Response

(
    [executedAt] => 2025-07-07 12:11:32
    [connect] => OK
    [callTime] => 0.01508
    [cost] => 0.001
    [remainingCredit] => 4838.0779999999995
    [success] => 1
    [error] => "null"
    [result] => 
        (
            [updated_at] => REDACTED_TIMESTAMP
            [bot_id] => REDACTED_BOT_ID
        )

    [record_id] => REDACTED_RECORD_ID
)

Create Invoice

Creates Invoice for a specific User

Method	POST
Access	Requires Authentication of User with Admin access.
Endpoint	/api/v1/invoices/create
Cost	R 0.00 per call

Parameters

uid integer (required)	User ID of the user for who the invoice must be created.
lineItem1Description string (required)	Line item 1 description.
lineItem1Amount string (required)	Line item 1 amount.
lineItem2Description string (optional)	Line item 2 description.
lineItem2Amount string (optional)	Line item 2 amount.
lineItem3Description string (optional)	Line item 3 description.
lineItem3Amount string (optional)	Line item 3 amount.
lineItem4Description string (optional)	Line item 4 description.
lineItem4Amount string (optional)	Line item 4 amount.
lineItem5Description string (optional)	Line item 5 description.
lineItem5Amount string (optional)	Line item 5 amount.
doNotSendInvoiceToClient integer (optional)	If set to 1, the invoice will not be emailed to the client.
doNotSetAsPaid integer (optional)	If set to 1, the invoice will have status = Unpaid.

Sample Response

(
    [executedAt] => 2025-07-07 06:51:24
    [connect] => OK
    [callTime] => 0.59417
    [remainingCredit] => 4997.44
    [success] => 1
    [error] => "null"
    [result] => 
        (
            [result] => REDACTED_RESULT
            [status] => REDACTED_STATUS
            [invoiceID] => REDACTED_INVOICE_ID
        )

    [record_id] => REDACTED_RECORD_ID
)

Create User

Creates a new user

Method	POST
Access	Requires Authentication of User with Admin access.
Endpoint	/api/v1/admin/user/create
Cost	R 0.00 per call

Parameters

email string (required)	Email of the user.
password string (required)	Password to use when creating the user.
doNotSetAsVerified integer (optional)	If set to 1, the user will not be set to verified and will have to verify their email address before logging in.
first_name string (optional)	First name of the user.
last_name string (optional)	Last name of the user.
id_nr string (optional)	ID Number of the user.
phone_number string (optional)	Phone number of the user.
company_name string (optional)	Company name of the user.
company_nr string (optional)	Company Nr of the user.
vat_nr string (optional)	VAT nr of the user.
currency string (optional)	Currency of the user.
country string (optional)	Country Code of the user. e.g. ZA
address1 string (optional)	Address line 1
address2 string (optional)	Address line 2
city string (optional)	City of the user
state string (optional)	State / Province of the user
postal_code string (optional)	Postal code of the user

Sample Response

(
    [executedAt] => 2025-07-07 07:06:42
    [connect] => OK
    [callTime] => 0.06097
    [remainingCredit] => 4997.44
    [success] => 1
    [error] => "null"
    [result] => 
        (
            [status] => REDACTED_STATUS
            [uid] => REDACTED_UID
        )

    [record_id] => REDACTED_RECORD_ID
)

Get User by Email

Fetches user details by email.

Method	POST
Access	Requires Authentication of User with Admin access.
Endpoint	/api/v1/admin/user/getByEmail
Cost	R 0.00 per call

Parameters

email

string (required)

Email of the user.

Sample Response

(
    [executedAt] => 2025-07-07 06:59:09
    [connect] => OK
    [callTime] => 0.0053
    [remainingCredit] => 4997.44
    [success] => 1
    [error] => "null"
    [result] => 
        (
            [id] => REDACTED_ID
            [first_name] => REDACTED_FIRST_NAME
            [last_name] => REDACTED_LAST_NAME
            [id_nr] => "null"
            [phone_number] => "null"
            [company_name] => "null"
            [company_nr] => "null"
            [vat_nr] => "null"
            [currency] => ZAR
            [country] => ZA
            [email] => REDACTED_EMAIL
            [user_status] => REDACTED_STATUS
            [kyc_status] => REDACTED_KYC
            [profile_pic] => "null"
            [email_verified_at] => "null"
            [avatar] => "null"
            [has_set_password] => 1
            [author_display_name] => "null"
            [author_details] => "null"
            [remember_token] => "null"
            [last_accessed_at] => "null"
            [created_at] => REDACTED_TIMESTAMP
            [updated_at] => REDACTED_TIMESTAMP
            [referred_by_uid] => "null"
            [referred_by_uid_tmp] => "null"
            [referral_tier] => "null"
            [referral_code] => "null"
            [hr_employment_status] => "null"
            [hr_first_day] => "null"
            [hr_last_day] => "null"
            [last_cookie_approved_code] => "null"
            [google_id] => "null"
            [google_token] => "null"
            [google_refresh_token] => "null"
            [google_token_expires_at] => "null"
            [facebook_id] => "null"
            [facebook_token] => "null"
        )

    [record_id] => REDACTED_RECORD_ID
)

Get User by ID

Fetches user details by ID.

Method	POST
Access	Requires Authentication of User with Admin access.
Endpoint	/api/v1/admin/user/getByID
Cost	R 0.00 per call

Parameters

id

integer (required)

ID of the user.

Sample Response

(
    [executedAt] => 2025-07-07 06:59:09
    [connect] => OK
    [callTime] => 0.0053
    [remainingCredit] => 4997.44
    [success] => 1
    [error] => "null"
    [result] => 
        (
            [id] => REDACTED_ID
            [first_name] => REDACTED_FIRST_NAME
            [last_name] => REDACTED_LAST_NAME
            [id_nr] => "null"
            [phone_number] => "null"
            [company_name] => "null"
            [company_nr] => "null"
            [vat_nr] => "null"
            [currency] => ZAR
            [country] => ZA
            [email] => REDACTED_EMAIL
            [user_status] => REDACTED_STATUS
            [kyc_status] => REDACTED_KYC
            [profile_pic] => "null"
            [email_verified_at] => "null"
            [avatar] => "null"
            [has_set_password] => 1
            [author_display_name] => "null"
            [author_details] => "null"
            [remember_token] => "null"
            [last_accessed_at] => "null"
            [created_at] => REDACTED_TIMESTAMP
            [updated_at] => REDACTED_TIMESTAMP
            [referred_by_uid] => "null"
            [referred_by_uid_tmp] => "null"
            [referral_tier] => "null"
            [referral_code] => "null"
            [hr_employment_status] => "null"
            [hr_first_day] => "null"
            [hr_last_day] => "null"
            [last_cookie_approved_code] => "null"
            [google_id] => "null"
            [google_token] => "null"
            [google_refresh_token] => "null"
            [google_token_expires_at] => "null"
            [facebook_id] => "null"
            [facebook_token] => "null"
        )

    [record_id] => REDACTED_RECORD_ID
)

Enabled Social Login Providers

Returns a list of enabled social login providers.

Method	GET
Access	Does not Require Authentication
Endpoint	/api/v1/social-login/enabled-providers
Cost	R 0.00 per call

Parameters

No parameters

Sample Response

(
    [providers] => Array
        (
            [0] => google
            [1] => facebook
            [2] => twitter
        )

)

Facebook Social Login

Handles Facebook OAuth login for mobile app

Method	POST
Access	Does not Require Authentication
Endpoint	/api/v1/social-login/facebook/app-callback
Cost	R 0.00 per call

Parameters

accessToken

string (required)

The Facebook access token from the mobile app

Sample Response

Get Content

Grabs published content from the website

Method	POST
Access	Does not Require Authentication
Endpoint	/api/v1/content/get
Cost	R 0.00 per call

Parameters

contenttype string (required)	The type of content to return.
page integer (optional)	The page number you wish to access. (default: 1)
limit integer (optional)	The number of items to return per page. (default: 10, maximum: 20)
sortby string (optional)	The field by which to sort the results. (default: created_at, options: created_at, title, id, etc)
sortorder string (optional)	The order in which to sort the results. (default: desc, options: asc, desc)
search string (optional)	A search string to filter the results by.
filterField1 string (optional)	An additional field to filter the results by.
filterValue1 string (optional)	The value to filter the results by.

Sample Response

No sample response available.

Google Social Login

Handles Google OAuth login for mobile app

Method	POST
Access	Does not Require Authentication
Endpoint	/api/v1/social-login/google/app-callback
Cost	R 0.00 per call

Parameters

accessToken

string (required)

The Google access token from the mobile app

Sample Response

Login

Log in on this website. Returns a token for future user action execution.

Method	POST
Access	Does not Require Authentication
Endpoint	/api/v1/user/login
Cost	R 0.00 per call

Parameters

email string (required)	The e-mail address of the new user.
password string (required)	The password of the new user.
rememberme string (optional)	If set to 1, tokens will only expire after 365 days or whatever number is configured in your Teruza instance settings.

Sample Response

No sample response available.

Logout

Log out the user by invalidating their mobile session token.

Method	POST
Access	Requires Authentication
Endpoint	/api/v1/user/logout
Cost	R 0.00 per call

Parameters

token

string (required)

The session token to invalidate.

Sample Response

(
    [success] => 1
    [message] => Logged out successfully.
)

Register

Register a new user on this site

Method	POST
Access	Does not Require Authentication
Endpoint	/api/v1/user/register
Cost	R 0.00 per call

Parameters

email string (required)	The e-mail address of the new user.
password string (required)	The password of the new user.
password_confirmation string (required)	The password confirmation.
captcha_code string (required)	The captcha code from the widget.
referral_code string (optional)	A referral code.

Sample Response

(
    [result] => 
        (
            [success] => 1
            [message] => Registration successful. Please verify your email.
            [email] => REDACTED_EMAIL
            [user_id] => REDACTED_USERID
        )

)

Resend OTP

Resends a new OTP for email verification during registration, invalidating the previous one

Method	POST
Access	Does not Require Authentication
Endpoint	/api/v1/mobile/resend-otp
Cost	R 0.00 per call

Parameters

email

string (required)

The email address to resend the OTP to.

Sample Response

(
    [success] => 1
    [message] => A new OTP has been sent to your email.
)

User Credit Balance

Gets the user's credit balance.

Method	GET
Access	Requires Authentication
Endpoint	/api/v1/user/credit
Cost	R 0.00 per call

Parameters

No parameters

Sample Response

(
    [executedAt] => 2025-07-07 07:33:24
    [connect] => OK
    [callTime] => 0.00521
    [remainingCredit] => ****
    [success] => 1
    [error] => null
    [result] => null
    [record_id] => ****
)

Verify OTP

Verifies the OTP for email verification during registration

Method	POST
Access	Does not Require Authentication
Endpoint	/api/v1/mobile/verify-otp
Cost	R 0.00 per call

Parameters

email string (required)	The email address to verify.
otp string (required)	The OTP code sent to the email.

Sample Response

(
    [success] => 1
    [message] => Email verified successfully.
)

Bank Account Verification

Allows third parties to perform real-time verifications on consumer and commercial bank accounts with the following banks: ABSA, FNB, Standard Bank, Nedbank, African Bank, Capitec, Investec, Sasfin Bank, and Discovery Bank.

Method	POST
Access	Requires Authentication
Endpoint	/api/v1/banking/bank_account_verification
Cost	R 17.95 per call

Parameters

bank_name string (required)	One of the following: ABSA, ACCESS BANK, AFRICAN BANK, BIDVEST BANK, CAPITEC BANK, DISCOVERY BANK, FINBOND MUTAUL BANK, FNB, GRINROD BANK, INVESTEC BANK, MERCANTILE BANK, NEDBANK, SASFIN BANK, STANDARD BANK, TYME BANK, UBANK.
branch_code string (required)	The bank account branch code of the account holder. Or alternatively the default branch code of the relevant bank: ABSA - 632005, ACCESS BANK - 410506, AFRICAN BANK - 430000, BIDVEST BANK - 462005, CAPITEC BANK - 470010, DISCOVERY BANK - 679000, FINBOND MUTAUL BANK - 591000, FNB - 250655, GRINROD BANK - 223626, INVESTEC BANK - 580105, MERCANTILE BANK - 450905, NEDBANK - 198765, SASFIN BANK - 683000, STANDARD BANK - 051001, TYME BANK - 678910, UBANK - 430000.
account_number string (required)	The bank account number of the account holder.
account_type integer (required)	Bank account type of account holder: 1 - current, 2 - savings, 3 - transmission, 4 - bond, 5 - credit card, 0 - not known.
idnumber string (required)	ID Number of account holder or numeric part of Company registration number.
initials string (required)	Initials of the account holder. If a Company a blank space must be used.
surname string (required)	Surname of account holder or Company name.

Sample Response

No sample response available.

CIPC (South Africa) Company Name Lookup

The API service provides an efficient and fast way to retrieve commercial company principle (Directorship in different companies) information from CIPC (Companies and Intellectual Properties Commission)

Method	POST
Access	Requires Authentication
Endpoint	/api/v1/companies/cipc_company_name_lookup
Cost	R 29.50 per call

Parameters

company_name

string (required)

The name of the South African company you are trying to find.

Sample Response

CIPC (South Africa) Registration Number Lookup

The API service provides an efficient and fast way to retrieve commercial company principle (Directorship in different companies) information from CIPC (Companies and Intellectual Properties Commission)

Method	POST
Access	Requires Authentication
Endpoint	/api/v1/companies/cipc_company_reg_nr_lookup
Cost	R 29.50 per call

Parameters

reg_nr

string (required)

The full registration number of the company you are looking up in the format: YYYY/NNNNNN/NN

Sample Response

South African Company VAT Number Lookup (WIP)

This API service enables a 3rd party to do a VAT Search either via a Company Name, Company Registration number or via a VAT number. Please note you must specify the vatSearchType which can be either of the following. 1-companyName, to search via Company Name. 2-companyRegNo to search via Company Registration number. 3-vatNumber to search with the company VAT number. both the companyNAme and companyRegNo will give multiple results with a primaryKey and a DBKey which must be used in the vat-dbkey-search to get the final results. the vatNumber search will give the result immediately.

Method	POST
Access	Requires Authentication
Endpoint	/api/v1/companies/vat_lookup
Cost	R 34.50 per call

Parameters

vat_search_type string (required)	Type of VAT Search. Can be either 1 for Company Name, 2 for Company Registration Number or 3 for VAT Number.
company_name string (optional)	if vat_search_type Type is companyName, this will be the Company Name
company_reg_no string (optional)	if vat_search_type Type is companyRegNo, this will be the company registration number in the following format xxxx/xxxxxx/xx
vat_number string (optional)	if vat_search_type Type is vatNumber, this will be the companies VAT Number

Sample Response

(
    [executedAt] => 2025-07-07 07:57:00
    [connect] => OK
    [callTime] => 2.80177
    [cost] => REDACTED_COST
    [remainingCredit] => REDACTED_REMAININGCREDIT
    [success] => 1
    [error] => null
    [result] => 
        (
            [matches] => Array
                (
                    [0] => 
                        (
                            [c_id] => REDACTED_C_ID
                            [registration_no] => REDACTED_REGISTRATION_NO
                            [business_name] => REDACTED_BUSINESS_NAME
                            [e_id] => REDACTED_E_ID
                            [er_id] => REDACTED_ER_ID
                        )

                    [1] => 
                        (
                            [c_id] => REDACTED_C_ID
                            [registration_no] => REDACTED_REGISTRATION_NO
                            [business_name] => REDACTED_BUSINESS_NAME
                            [e_id] => REDACTED_E_ID
                            [er_id] => REDACTED_ER_ID
                        )

                    [2] => 
                        (
                            [c_id] => REDACTED_C_ID
                            [registration_no] => REDACTED_REGISTRATION_NO
                            [business_name] => REDACTED_BUSINESS_NAME
                            [e_id] => REDACTED_E_ID
                            [er_id] => REDACTED_ER_ID
                        )

                )

        )

    [record_id] => REDACTED_RECORD_ID
)

All Currencies

Get Crypto and Forex Rates

Method	GET
Access	Requires Authentication
Endpoint	/api/v1/currencies/all
Cost	R 0.002 per call

Parameters

No parameters

Sample Response

No sample response available.

Crypto

Get Crypto Rates

Method	GET
Access	Requires Authentication
Endpoint	/api/v1/currencies/crypto
Cost	R 0.001 per call

Parameters

No parameters

Sample Response

No sample response available.

Forex

Get Forex Rates

Method	GET
Access	Requires Authentication
Endpoint	/api/v1/currencies/forex
Cost	R 0.001 per call

Parameters

No parameters

Sample Response

No sample response available.

Email Test

Returns an email address to which you can send an email and then receive a response on the quality of the email sent.

Method	POST
Access	Requires Authentication
Endpoint	/api/v1/email/test
Cost	R 0.01 per call

Parameters

No parameters

Sample Response

(
    [executedAt] => 2025-07-07 08:25:49
    [connect] => OK
    [callTime] => 0.01618
    [cost] => REDACTED_COST
    [remainingCredit] => REDACTED_REMAININGCREDIT
    [success] => 1
    [error] => null
    [result] => 
        (
            [code] => REDACTED_CODE
            [email_to] => REDACTED_EMAIL
        )

    [record_id] => REDACTED_RECORD_ID
)

Get Email Test Result

Returns the result of an email test

Method	GET
Access	Requires Authentication
Endpoint	/api/v1/email/test/get
Cost	R 0.01 per call

Parameters

code

string (required)

The code for the test you want to retrieve

Sample Response

No sample response available.

WHOIS Lookup

See owner details of a domain name.

Method	POST
Access	Requires Authentication
Endpoint	/api/v1/domains/whois
Cost	R 1.00 per call

Parameters

domainname

string (required)

The domain name to query. E.g. example.com

Sample Response

(
    [executedAt] => 2025-07-07 08:14:13
    [connect] => OK
    [callTime] => 0.35192
    [cost] => REDACTED_COST
    [remainingCredit] => REDACTED_REMAININGCREDIT
    [success] => 1
    [error] => null
    [result] => 
        (
            [isDirectWhoisServerQuery] => 1
            [domain] => REDACTED_DOMAIN
            [domainName] => REDACTED_DOMAINNAME
            [domainExtension] => REDACTED_DOMAINEXTENSION
            [validDomainName] => 1
            [domainExpiryDate] => REDACTED_DOMAINEXPIRYDATE
            [availableForRegistration] => 0
            [alreadyRegistered] => 1
            [isPremiumDomain] => 0
            [premiumPrice] => null
            [premiumCurrency] => null
            [whoisServerID] => REDACTED_WHOISSERVERID
            [errors] => Array
                (
                )

            [rawWhoisResult] => REDACTED_RAWWHOISRESULT
        )

    [record_id] => REDACTED_RECORD_ID
)

Geolocate

Map an IP Address to its physical location in the world as well as provide additional information on an IP (such as threatLevel, isCrawler and isProxy)

Method	POST
Access	Requires Authentication
Endpoint	/api/v1/geolocation/geolocate
Cost	R 0.05 per call

Parameters

ipaddress

string (required)

The IPv4 or IPv6 address that you want to look up.

Sample Response

(
    [ipAddress] => 123.123.123.123
    [continentCode] => AF
    [continentName] => Africa
    [countryCode] => ZA
    [countryName] => South Africa
    [isEuMember] => 
    [currencyCode] => ZAR
    [currencyName] => Rand
    [phonePrefix] => 27
    [languages] => Array
        (
            [0] => zu
            [1] => xh
            [2] => af
            [3] => nso
            [4] => en-ZA
            [5] => tn
            [6] => st
            [7] => ts
            [8] => ss
            [9] => ve
            [10] => nr
        )

    [stateProvCode] => WC
    [stateProv] => Western Cape
    [district] => City of Cape Town
    [city] => Cape Town
    [geonameId] => 1234567
    [zipCode] => 1234
    [gmtOffset] => 2
    [timeZone] => Africa/Johannesburg
    [latitude] => -33.9221
    [longitude] => 18.4231
    [weatherCode] => SFXX0010
    [asNumber] => 123456
    [asName] => Lightstruck-Connect
    [isp] => Lightstruck Connect
    [usageType] => corporate
    [organization] => Lightstruck Connect
    [isCrawler] => 
    [isProxy] => 
    [threatLevel] => low
)

ID Lookup

Verifies a given South African ID number and its corresponding Consumer details.

Method	POST
Access	Requires Authentication
Endpoint	/api/v1/id_verification/said_verification
Cost	R 1.95 per call

Parameters

idnumber

string (required)

13 Digit South African ID Number

Sample Response

(
    [executedAt] => 2025-07-07 08:29:28
    [connect] => OK
    [callTime] => 0.14793
    [cost] => REDACTED_COST
    [remainingCredit] => REDACTED_REMAININGCREDIT
    [success] => 1
    [error] => null
    [result] => 
        (
            [t_id] => REDACTED_T_ID
            [status] => REDACTED_STATUS
            [first_names] => REDACTED_FIRST_NAMES
            [last_name] => REDACTED_LAST_NAME
            [date_of_birth] => REDACTED_DATE_OF_BIRTH
            [age] => REDACTED_AGE
            [gender] => REDACTED_GENDER
            [citizenship] => REDACTED_CITIZENSHIP
            [date_issued] => null
        )

    [record_id] => REDACTED_RECORD_ID
)

Real-time ID Verification with Photo

South Africa ID number verification against the live Home Affairs Databases with Photo ID.

Method	POST
Access	Requires Authentication
Endpoint	/api/v1/id_verification/home_affairs_id_photo
Cost	R 24.95 per call

Parameters

idnumber

string (required)

13 Digit South African ID Number

Sample Response

(
    [executedAt] => 2025-07-08 08:50:39
    [connect] => OK
    [callTime] => 2.08919
    [cost] => 24.95
    [remainingCredit] => 4803.74
    [success] => 1
    [error] => null
    [result] => 
        (
            [status] => Success
            [id_photo] => [REDACTED_IMAGE_DATA]
            [id_number] => *************
            [input_id_no] => *************
            [ha_id_no] => *************
            [id_no_match_status] => Matched
            [ha_id_book_issued_date] => 
            [id_card_ind] => Yes
            [id_card_date] => 2017-03-08
            [id_blocked] => NO
            [first_names] => RedactedFirst
            [surname] => RedactedLast
            [dob] => RedactedDOB
            [age] => 26
            [gender] => RedactedGender
            [citizenship] => South African
            [country_of_birth] => SOUTH AFRICA 
            [deceased_status] => Alive
            [deceased_date] => 
            [marital_status] => SINGLE
            [marriage_date] => 
        )

    [record_id] => RedactedRecordID
)

Face Compare

Compare two faces with each other and see how similar they are.

Method	GET
Access	Requires Authentication
Endpoint	/api/v1/images/compareFaces
Cost	R 0.40 per call

Parameters

image file (required)	Base64 Encoded String of the Image to be Anbalyzed
face_token1 string (optional)	The id of the first face. (Highest precedence)
face_token2 string (optional)	The id of the second face

Sample Response

No sample response available.

Face Detection

Detects faces inside of an image.

Method	GET
Access	Requires Authentication
Endpoint	/api/v1/images/detectFaces
Cost	R 1.00 per call

Parameters

image file (required)	Base64 Encoded String of the first Image to be Analyzed
externalid string (optional)	An optional external ID that can be used to add a second reference to a lookup.

Sample Response

No sample response available.

Image to Text

Converts Images to Text

Method	GET
Access	Requires Authentication
Endpoint	/api/v1/images/imageToText
Cost	R 0.50 per call

Parameters

image

file (required)

Base64 Encoded String of the Image to be Converted to Text

Sample Response

No sample response available.

PDF to Image

Converts PDFs to Images

Method	POST
Access	Requires Authentication
Endpoint	/api/v1/images/pdfToPng
Cost	R 1.00 per call

Parameters

pdf

file (required)

Base64 Encoded String of the PDF to be Converted to Images

Sample Response

No sample response available.

PDF to Text

Converts PDFs to Text

Method	GET
Access	Requires Authentication
Endpoint	/api/v1/images/pdfToText
Cost	R 0.50 per call

Parameters

pdf

file (required)

Base64 Encoded String of the PDF to be Converted to Text

Sample Response

No sample response available.

AML Search

Search sanctions and other watchlists.

Method	GET
Access	Requires Authentication
Endpoint	/api/v1/kyc/aml/search
Cost	R 2.50 per call

Parameters

type string (optional)	Applicant Type (either "Person" or "Company"). Defaults to "Person"
name string (required)	Full name of the applicant.
dob date (required)	Date of Birth in format YYYY-MM-DD

Sample Response

Adverse Media Lookup

Search global news sources for adverse media.

Method	GET
Access	Requires Authentication
Endpoint	/api/v1/kyc/adverseMedia/search
Cost	R 0.02 per call

Parameters

search string (required)	The name of the entity or person you are looking for, or any general keyword to search for.
externalid string (optional)	An optional external ID that can be used to add a second reference to a lookup.

Sample Response

Check Blurriness

Returns a score of how blurry an image is. < 1 = Not Blurry. > 1 = Blurry. > 4 = Very Blurry.

Method	GET
Access	Requires Authentication
Endpoint	/api/v1/kyc/tools/blurriness
Cost	R 0.50 per call

Parameters

image

string (required)

Base64 Encoded String of the image to checked

Sample Response

No sample response available.

Holidays

Get public holidays for a specific country.

Method	POST
Access	Requires Authentication
Endpoint	/api/v1/misc/holidays
Cost	R 0.05 per call

Parameters

countrycode string (required)	ISO 3166-1 alpha-2 country code. E.g. ZA for South Africa.
year string (required)	The year for which you want to get the holidays.

Sample Response

Add SMS Contact

Create an SMS contact and add it to a contact list.

Method	GET
Access	Requires Authentication
Endpoint	/api/v1/sms/contactLists/[contactlistid]/add/[cellnr]
Cost	R 0.00 per call

Parameters

contactlistid string (required)	The id of the contact list you want to add a contact to.
cellnr string (required)	The cell-number you would like to add. E.g: "+2772123456".
contactname string (required)	The label assigned to this contact. E.g: "Mom".

Sample Response

(
    [executedAt] => 2025-07-08 09:14:23
    [connect] => OK
    [callTime] => 0.00989
    [remainingCredit] => 4801.74000000
    [success] => 1
    [error] => null
    [result] => 
        (
            [contact_list_id] => RedactedContactListID
            [new_contact] => 
                (
                    [name] => RedactedName
                    [cell_number] => RedactedNumber
                )

        )

    [record_id] => RedactedRecordID
)

Create SMS Contact List

Create an SMS contact list for sending SMS in bulk.

Method	GET
Access	Requires Authentication
Endpoint	/api/v1/sms/contactLists/create/[contactlistname]
Cost	R 0.00 per call

Parameters

contactlistname

string (required)

The name to use as a label for a grouping of contacts. E.g: "my-contacts".

Sample Response

(
    [executedAt] => 2025-07-08 09:09:16
    [connect] => OK
    [callTime] => 0.0088
    [remainingCredit] => 4801.74000000
    [success] => 1
    [error] => null
    [result] => 
        (
            [contact_list_id] => RedactedContactListID
            [contact_list_name] => RedactedContactListName
        )

    [record_id] => RedactedRecordID
)

Delete SMS Contact List

Delete a contact list.

Method	POST
Access	Requires Authentication
Endpoint	/api/v1/sms/contactLists/delete/[contactlistid]
Cost	R 0.00 per call

Parameters

contactlistid

string (required)

The id of the contact list you want returned.

Sample Response

(
    [executedAt] => 2025-07-08 09:20:07
    [connect] => OK
    [callTime] => 0.00953
    [remainingCredit] => 4801.74000000
    [success] => 1
    [error] => null
    [result] => 
        (
            [contact_list_id] => RedactedContactListID
        )

    [record_id] => RedactedRecordID
)

Get SMS Contact Lists

Return all existing contact lists.

Method	GET
Access	Requires Authentication
Endpoint	/api/v1/sms/contactLists/get
Cost	R 0.00 per call

Parameters

No parameters

Sample Response

(
    [executedAt] => 2025-07-08 09:11:11
    [connect] => OK
    [callTime] => 0.00969
    [remainingCredit] => 4801.74000000
    [success] => 1
    [error] => null
    [result] => 
        (
            [contact_lists] => Array
                (
                    [0] => 
                        (
                            [frontend_id] => RedactedID1
                            [name] => RedactedName1
                        )

                    [1] => 
                        (
                            [frontend_id] => RedactedID2
                            [name] => RedactedName2
                        )

                    [2] => 
                        (
                            [frontend_id] => RedactedID3
                            [name] => RedactedName3
                        )

                )

        )

    [record_id] => RedactedRecordID
)

Get SMS Pricing

Get the cost to send to various countries in the world.

Method	GET
Access	Requires Authentication
Endpoint	/api/v1/sms/pricing
Cost	R 0.00 per call

Parameters

No parameters

Sample Response

(
    [executedAt] => 2025-07-07 11:27:50
    [connect] => OK
    [callTime] => 0.06063
    [remainingCredit] => REDACTED_REMAININGCREDIT
    [success] => 1
    [error] => null
    [result] => 
        (
            [price_currency_code] => REDACTED_PRICE_CURRENCY_CODE
            [price_currency_prefix] => REDACTED_PRICE_CURRENCY_PREFIX
            [price_currency_name] => REDACTED_PRICE_CURRENCY_NAME
            [pricing] => 
                (
                    [AF] => 
                        (
                            [id] => REDACTED_ID
                            [phone_code] => REDACTED_PHONE_CODE
                            [continent] => REDACTED_CONTINENT
                            [country_code] => REDACTED_COUNTRY_CODE
                            [country_name] => REDACTED_COUNTRY_NAME
                            [usd_zar_rate] => REDACTED_USD_ZAR_RATE
                            [price_zar] => REDACTED_PRICE_ZAR
                            [price_usd_estimated] => REDACTED_PRICE_USD
                        )

                    [AL] => 
                        (
                            [id] => REDACTED_ID
                            [phone_code] => REDACTED_PHONE_CODE
                            [continent] => REDACTED_CONTINENT
                            [country_code] => REDACTED_COUNTRY_CODE
                            [country_name] => REDACTED_COUNTRY_NAME
                            [usd_zar_rate] => REDACTED_USD_ZAR_RATE
                            [price_zar] => REDACTED_PRICE_ZAR
                            [price_usd_estimated] => REDACTED_PRICE_USD
                        )

                    [ZA] => 
                        (
                            [id] => REDACTED_ID
                            [phone_code] => REDACTED_PHONE_CODE
                            [continent] => REDACTED_CONTINENT
                            [country_code] => REDACTED_COUNTRY_CODE
                            [country_name] => REDACTED_COUNTRY_NAME
                            [usd_zar_rate] => REDACTED_USD_ZAR_RATE
                            [price_zar] => REDACTED_PRICE_ZAR
                            [price_usd_estimated] => REDACTED_PRICE_USD
                        )

                    [US] => 
                        (
                            [id] => REDACTED_ID
                            [phone_code] => REDACTED_PHONE_CODE
                            [continent] => REDACTED_CONTINENT
                            [country_code] => REDACTED_COUNTRY_CODE
                            [country_name] => REDACTED_COUNTRY_NAME
                            [usd_zar_rate] => REDACTED_USD_ZAR_RATE
                            [price_zar] => REDACTED_PRICE_ZAR
                            [price_usd_estimated] => REDACTED_PRICE_USD
                        )

                    [IN] => 
                        (
                            [id] => REDACTED_ID
                            [phone_code] => REDACTED_PHONE_CODE
                            [continent] => REDACTED_CONTINENT
                            [country_code] => REDACTED_COUNTRY_CODE
                            [country_name] => REDACTED_COUNTRY_NAME
                            [usd_zar_rate] => REDACTED_USD_ZAR_RATE
                            [price_zar] => REDACTED_PRICE_ZAR
                            [price_usd_estimated] => REDACTED_PRICE_USD
                        )

                    [...] => // more entries truncated for brevity
                )

        )

    [record_id] => REDACTED_RECORD_ID
)

Get a SMS Contact List

Return an individual contact list.

Method	GET
Access	Requires Authentication
Endpoint	/api/v1/sms/contactLists/get/[contactlistid]
Cost	R 0.00 per call

Parameters

contactlistid string (required)	The id of the contact list you want returned.
page string (optional)	The page that should be returned. Default: 1.
limit string (optional)	How many results to return per page. Default: 20.

Sample Response

(
    [executedAt] => 2025-07-08 09:17:18
    [connect] => OK
    [callTime] => 0.00829
    [remainingCredit] => 4801.74000000
    [success] => 1
    [error] => null
    [result] => 
        (
            [contact_list_id] => RedactedContactListID
            [contacts] => Array
                (
                    [0] => 
                        (
                            [name] => RedactedName1
                            [cell_number] => RedactedNumber1
                        )

                    [1] => 
                        (
                            [name] => RedactedName2
                            [cell_number] => RedactedNumber2
                        )

                    [2] => 
                        (
                            [name] => RedactedName3
                            [cell_number] => RedactedNumber3
                        )

                )

            [total_contacts] => 3
            [page] => 1
            [total_pages] => 1
            [limit] => 20
        )

    [record_id] => RedactedRecordID
)

Remove SMS Contact

Delete an SMS contact from a contact list.

Method	GET
Access	Requires Authentication
Endpoint	/api/v1/sms/contactLists/[contactlistid]/remove/[cellnr]
Cost	R 0.00 per call

Parameters

contactlistid string (required)	The id of the contact list you want returned.
cellnr string (required)	The number you which wish to delete from a contact list. E.g: "+2772123456".

Sample Response

(
    [executedAt] => 2025-07-08 09:37:30
    [connect] => OK
    [callTime] => 0.00577
    [remainingCredit] => 4801.74000000
    [success] => 1
    [error] => null
    [result] => 
        (
            [contact_list_id] => RedactedContactListID
            [deleted_contact] => RedactedPhoneNumber
        )

    [record_id] => RedactedRecordID
)

Send SMS

Send an SMS to any cellphone number in the world.

Method	POST
Access	Requires Authentication
Endpoint	/api/v1/sms/send
Cost	Varies

Parameters

cell_nr string (required)	The number to which you want to send an sms. E.g: "+2772123456".
message string (required)	The message you want to send.
send_at string (optional)	The time at which you want to send the SMS. E.g: "2030-05-03 15:00:23". If no value specified, it will send the SMS immediately.

Sample Response

(
    [executedAt] => 2025-07-07 11:25:58
    [connect] => OK
    [callTime] => 0.01103
    [cost] => REDACTED_COST
    [remainingCredit] => REDACTED_REMAININGCREDIT
    [success] => 1
    [error] => null
    [result] => REDACTED_RESULT
    [record_id] => REDACTED_RECORD_ID
)

Send bulk SMS to Contact List

Send a bulk SMS to the cell numbers of a contact list.

Method	GET
Access	Requires Authentication
Endpoint	/api/v1/sms/[contactlistid]?message=[message]
Cost	R 0.00 per call

Parameters

contactlistid string (required)	The id of the contact list you want returned.
message textarea (required)	The message you would like to send to the contact list.
sendat string (optional)	The time at which you want to send the SMS. E.g: "2030-05-03 15:00:23". If no value specified, it will send the SMS immediately.

Sample Response

No sample response available.

Screenshot

Take a screenshot of a website

Method	POST
Access	Requires Authentication
Endpoint	/api/v1/screenshot
Cost	R 0.10 per call

Parameters

url string (required)	The URL that must be scraped.
width integer (optional)	The width of the browser in which the site is rendered. Default: 1920.
height integer (optional)	The height of the browser in which the site is rendered. Default: 1080.

Sample Response

No sample response available.

Web Scraper

Scrape a website URL

Method	POST
Access	Requires Authentication
Endpoint	/api/v1/scrape
Cost	R 0.005 per call

Parameters

url string (required)	The URL that must be scraped.
useragent string (optional)	The optional USER AGENT value you want to use when making requests.

Sample Response

(
    [executedAt] => 2025-07-07 11:38:28
    [connect] => OK
    [callTime] => 7.21217
    [cost] => REDACTED_COST
    [remainingCredit] => REDACTED_REMAININGCREDIT
    [success] => 1
    [error] => null
    [result] => 
        (
            [url] => REDACTED_URL
            [redirectURL] => null
            [attempts] => REDACTED_ATTEMPTS
            [httpCode] => REDACTED_HTTPCODE
            [contentType] => REDACTED_CONTENTTYPE
            [content] => <!-- HTML content truncated for documentation -->
        )

    [record_id] => REDACTED_RECORD_ID
)

Ping

Endpoint to submit data returned from your server

Method	GET
Access	Requires Authentication
Endpoint	/api/v1/security/ping
Cost	R 0.00 per call

Parameters

No parameters

Sample Response

No sample response available.

Introduction

Getting Started

API Key

Pricing

Calling the API

AI

AI Query

Parameters

Sample Response

Document Analysis

Parameters

Sample Response

NSFW Content Identifier

Parameters

Sample Response

Receipt Analyzer

Parameters

Sample Response

Wine Label Analysis

Parameters

Sample Response

AI Chat Bot

Create Chatbot Instance

Parameters

Sample Response

Create new Chatbot Session

Parameters

Sample Response

Embed a Chatbot on a Website

Parameters

Sample Response

Get All Chatbot Instances

Parameters

Sample Response

Get Bot Conversation Message

Parameters

Sample Response

Get Chatbot Instance

Parameters

Sample Response

Get Chatbot Leads

Parameters

Sample Response

Get Chatbot Session Instance

Parameters

Sample Response

Get Chatbot embeddable CSS

Parameters

Sample Response

Get Chatbot embeddable JS

Parameters

Sample Response

Speak to Chatbot Session

Parameters

Sample Response

Update Chatbot Instance

Parameters

Sample Response

Backend (Admin Only)

Create Invoice

Parameters

Sample Response

Create User

Parameters

Sample Response

Get User by Email

Parameters

Sample Response

Get User by ID

Parameters

Sample Response

Backend (Public)

Enabled Social Login Providers

Parameters

Sample Response

Facebook Social Login

Parameters

Sample Response

Get Content

Parameters