Our API

AI

Our AI endpoint offers AI functions that can cover a wide range of use cases.

API Call	Endpoint
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.	/api/v1/ai/analyze_document
NSFW Content Identifier Analyzes an image or PDF to identify whether it is NSFW content, such as porn, hentai, violent images etc.	/api/v1/ai/nsfw_checker
Receipt Analyzer Analyzes a receipt to identify the billable items and other meta data on the receipt.	/api/v1/ai/receipt_analyzer
Wine Label Analysis Analyzes an image or PDF to identify the wine type, vintage, and country of origin etc.	/api/v1/ai/analyze_wine_label

Pricing Pricing Buy Credit Buy Credit Docs Docs

AI Chat Bot

Integration points required to implement our AI chatbot.

API Call	Endpoint
Create Chatbot Instance Creates a chatbot instance for a user.	/api/v1/chatbot/create
Create Whatsapp Bot Connects an existing Chatbot to a whatsapp number so that a user can converse with the AI via whatsapp.	/api/v1/whatsapp/bot/create
Create new Chatbot Session Create a new chatbot session to which messages can be sent.	/api/v1/chatbot/session/create
Embed a Chatbot on a Website Speak to a chatbot session.	/api/v1/chatbot/embed
Get All Chatbot Instances Returns all chatbot instances for a user.	/api/v1/chatbot/getAll
Get Bot Conversation Message Fetches data obtained through conversations with the bot (can be used to generate leads etc)	/api/v1/bot/getMessages
Get Chatbot Instance Get full details of a chatbot instance.	/api/v1/chatbot/get
Get Chatbot Leads Get any lead data generated by the chatbot session.	/api/v1/chatbot/leads/get
Get Chatbot Session Instance Get full details of a chatbot session including the chat history.	/api/v1/chatbot/session/get
Get Chatbot embeddable CSS Get chatbot embeddable CSS	/api/v1/chatbot/css/chatbot.css
Get Chatbot embeddable JS Get chatbot embeddable JS	/api/v1/chatbot/js/chatbot.js
Speak to Chatbot Session Speak to a chatbot session.	/api/v1/chatbot/speak
Update Chatbot Instance Updates the details of a chatbot instance	/api/v1/chatbot/update
Whatsapp Bot Webhook The entry point for webhooks to receive data back from Meta/Whatsapp.	/api/v1/whatsapp/webhook

Pricing Pricing Buy Credit Buy Credit Docs Docs

Backend (Admin Only)

These are a variety of calls that will allow you to talk to this instance of Teruza directly. The calls in this category require admin access as they execute admin-level features.

API Call	Endpoint
Create Invoice Creates Invoice for a specific User	/api/v1/invoices/create
Create User Creates a new user	/api/v1/admin/user/create
Get User by Email Fetches user details by email.	/api/v1/admin/user/getByEmail
Get User by ID Fetches user details by ID.	/api/v1/admin/user/getByID

Pricing Pricing Buy Credit Buy Credit Docs Docs

Backend (Public)

These are a variety of calls that will allow you to talk to this instance of Teruza directly.

API Call	Endpoint
Enabled Social Login Providers Returns a list of enabled social login providers.	/api/v1/social-login/enabled-providers
Facebook Social Login Handles Facebook OAuth login for mobile app	/api/v1/social-login/facebook/app-callback
Get Content Grabs published content from the website	/api/v1/content/get
Google Social Login Handles Google OAuth login for mobile app	/api/v1/social-login/google/app-callback
Login Log in on this website. Returns a token for future user action execution.	/api/v1/user/login
Logout Log out the user by invalidating their mobile session token.	/api/v1/user/logout
Register Register a new user on this site	/api/v1/user/register
Resend OTP Resends a new OTP for email verification during registration, invalidating the previous one	/api/v1/mobile/resend-otp
User Credit Balance Gets the user's credit balance.	/api/v1/user/credit
Verify OTP Verifies the OTP for email verification during registration	/api/v1/mobile/verify-otp

Pricing Pricing Buy Credit Buy Credit Docs Docs

Banking

Our Banking module provides secure integration with banking services such as bank account verification.

API Call	Endpoint
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.	/api/v1/banking/bank_account_verification

Pricing Pricing Buy Credit Buy Credit Docs Docs

Companies

Our Companies endpoint lets you fetch and analyze business information from official or third-party sources.

API Call	Endpoint
BIPA (Namibia) Company Name Lookup The API service provides an efficient and fast way to retrieve commercial company information from BIPA (Business and Intellectual Property Authority)	/api/v1/companies/bipa_company_name_lookup
BIPA (Namibia) Registration Number Lookup The API service provides an efficient and fast way to retrieve commercial company information from BIPA (Business and Intellectual Property Authority)	/api/v1/companies/bipa_company_reg_nr_lookup
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)	/api/v1/companies/cipc_company_name_lookup
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)	/api/v1/companies/cipc_company_reg_nr_lookup
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.	/api/v1/companies/vat_lookup

Pricing Pricing Buy Credit Buy Credit Docs Docs

Currencies

Get foreign exchange currency rates and crypto asset prices.

API Call	Endpoint
All Currencies Get Crypto and Forex Rates	/api/v1/currencies/all
Crypto Get Crypto Rates	/api/v1/currencies/crypto
Forex Get Forex Rates	/api/v1/currencies/forex

Pricing Pricing Buy Credit Buy Credit Docs Docs

Domain and Email Tools

A variety of domain API calls.

API Call	Endpoint
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.	/api/v1/email/test
Get Email Test Result Returns the result of an email test	/api/v1/email/test/get
WHOIS Lookup See owner details of a domain name.	/api/v1/domains/whois

Pricing Pricing Buy Credit Buy Credit Docs Docs

Geolocation

Our Geolocation tools help pinpoint user locations and enrich data with geographic context.

API Call	Endpoint
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)	/api/v1/geolocation/geolocate

Pricing Pricing Buy Credit Buy Credit Docs Docs

ID Verification

Our ID Verification service validates identity documents and ensures compliance using real-time checks.

API Call	Endpoint
ID Lookup Verifies a given South African ID number and its corresponding Consumer details.	/api/v1/id_verification/said_verification
Real-time ID Verification with Photo South Africa ID number verification against the live Home Affairs Databases with Photo ID.	/api/v1/id_verification/home_affairs_id_photo

Pricing Pricing Buy Credit Buy Credit Docs Docs

Images and PDF

A variety of image and PDF processing tools.

API Call	Endpoint
Face Compare Compare two faces with each other and see how similar they are.	/api/v1/images/compareFaces
Face Detection Detects faces inside of an image.	/api/v1/images/detectFaces
Image to Text Converts Images to Text	/api/v1/images/imageToText
PDF to Image Converts PDFs to Images	/api/v1/images/pdfToPng
PDF to Text Converts PDFs to Text	/api/v1/images/pdfToText

Pricing Pricing Buy Credit Buy Credit Docs Docs

KYC, AML & Other Lookups

Provides a comprehensive set of functions to verify individuals and companies, check against global sanctions and watchlists, and perform various other identification and compliance-related lookups

API Call	Endpoint
AML Search Search sanctions and other watchlists.	/api/v1/kyc/aml/search
Adverse Media Lookup Search global news sources for adverse media.	/api/v1/kyc/adverseMedia/search
Check Blurriness Returns a score of how blurry an image is. < 1 = Not Blurry. > 1 = Blurry. > 4 = Very Blurry.	/api/v1/kyc/tools/blurriness
Create Applicant Create a new applicant entry for a person or company. This will also perform all verification checks.	/api/v1/kyc/applicants/create
Get Applicant Get an applicant after it was created.	/api/v1/kyc/applicants/get
Upload Applicant Document Upload a supporting document for an applicant (ID, Selfie or Proof of Address). IMPORTANT: Uploading a document will fire off verification for this document which coule entail further costs.	/api/v1/kyc/applicants/documents/upload

Pricing Pricing Buy Credit Buy Credit Docs Docs

Miscellaneous

Various other tools that do not fit into other categories.

API Call	Endpoint
Holidays Get public holidays for a specific country.	/api/v1/misc/holidays

Pricing Pricing Buy Credit Buy Credit Docs Docs

SMS

Our SMS gateway allows you to send text messages globally.

API Call	Endpoint
Add SMS Contact Create an SMS contact and add it to a contact list.	/api/v1/sms/contactLists/[contactlistid]/add/[cellnr]
Create SMS Contact List Create an SMS contact list for sending SMS in bulk.	/api/v1/sms/contactLists/create/[contactlistname]
Delete SMS Contact List Delete a contact list.	/api/v1/sms/contactLists/delete/[contactlistid]
Get SMS Contact Lists Return all existing contact lists.	/api/v1/sms/contactLists/get
Get SMS Pricing Get the cost to send to various countries in the world.	/api/v1/sms/pricing
Get a SMS Contact List Return an individual contact list.	/api/v1/sms/contactLists/get/[contactlistid]
Remove SMS Contact Delete an SMS contact from a contact list.	/api/v1/sms/contactLists/[contactlistid]/remove/[cellnr]
Send SMS Send an SMS to any cellphone number in the world.	/api/v1/sms/send
Send bulk SMS to Contact List Send a bulk SMS to the cell numbers of a contact list.	/api/v1/sms/[contactlistid]?message=[message]