Data - API Overview

Modified on Mon, 14 Aug 2023 at 01:39 PM

Herewith are the details of the various Datanamix API services available to qualifying customers:

Access to the pbVerify API services is subject to a strict due diligence process, and only qualifying companies will gain access. Some API services are only available to South African companies and can be accessed via the two options below. If you are an international company with no SA company registration, please discuss further with your account manager.

NOTE: When accessing certain credit bureaux data, your company will need to provide proof of the required written consent, prescribed reason, and relevant compliance/due diligence processes that are completed before access to these services are granted. Please review all pbVerify legal information here.

API Product Integration options:

SOAP/RESTful APPLICATION PROGRAMMING INTERFACE (API):

NB: Our Credit Report API services cannot be sold on to third parties and must be used for the NCR-prescribed purpose for vetting your clients, who have given the required written consent.

This interface allows businesses and integrators to integrate and retrieve individuals' identities – and other related data - using RESTful JSON services (company credit bureau API's only available in SOAP XML). We have a full Developers Portal + Sandbox environment, where all testing can be accessed with an easy-to-use Swagger tool. A full overview of our API services can be accessed via the Solutions Portal. Please note, our sandbox/UAT portal only has limited services available for testing. To find out what services are available, please contact your account manager for further information.

Please note you will need to have a registered and approved PBSA account to use this tool.

Service Overview: South African Identity Data

Function: ProfileID/Real–Time/Family Lineage/ ID Photo- Government Source Verified Identity Number Data

Validity of ID number: Validity is verified against the database, not only by checksum values.
First names: First names string will be returned.
Last name: Last name will be returned.
Date of Birth: The official date of birth will be returned.
Age: Age at date of verification will be returned.
Gender: Gender at birth will be returned.
Citizenship: South African or Foreign Citizenship status at the date of birth will be returned.
Country of Birth: Country of birth and if foreign, the exact country, UK, US, ZIM, AUS, IND etc.
ID Block Status: Is the ID nummber blocked by DHA? Yes/No.
Alive/Deceased: Deceased status on file at DHA.
Deceased Data: Deceased date, reason, and place on file from DHA.
Date of Issue: Date of issue on the document if on file.
Marital Status: Married Status – Single, Married, Divorced
ID Card/ID Book: ID Card or ID book including date of issue.
ID Photo: ID Photo on file will be returned if available (Separate API service).
Family Lineage
- This API service returns the family details linked to a "Master ID"
- Master, spouse and parent's data (including photos) will be returned if available at DHA
- Master, spouse and parents contact details are also returned if available.
- Up to 21 children linked to parents returned. (excludes minor contact details)
- Access to these services requires explicit consent and the applicable legal purpose of use in line with POPIA before access can be granted.
- Access to minor ID data requires explicit consent from an authorised guardian before access is granted.

Function: 3D Facial Liveness and Biometric Authentication

The intuitive Facetec - ZoOm interface makes Certified Liveness Detection and 3D Face Matching fast, easy and incredibly secure for everyone, regardless of their device.
During onboarding, ZoOm's 2-second video selfie verifies Liveness, matches your 3D FaceMap to your Photo ID, and sets up your new account.
Each time you return, ZoOm's ongoing authentication again proves Liveness and compares your new 3D FaceMap to the one enrolled. If they match, you get instant access, no password required.
Login from any smartphone, tablet, PC or Laptop, and unlock everything from your car door to your bank account. Real users gain access easily, but bad actors, bots and hackers are rebuffed by Level 1&2 Anti-Spoofing Certified by NIST/iBeta. ZoOm is the Face Authentication market leader and provides more security, portability, and convenience than any other biometric. https://www.facetec.com/

i. https://pbverify.co.za/facetec-3d-proof-of-life/

ii. https://facetec.com/FaceTec-Fiat_Identity_Issuers_The_New_Verifiers_Deck.pdf

iii. https://www.facetec.com/

iv. https://www.liveness.com/

iv. www.spoofbounty.com - $600,000 for anyone who can spoof their production service.

vi. Get the Acuity Research Report: Face Verification & Liveness Synonymous with Remote Onboarding

Videos

i. Introduction - https://www.youtube.com/watch?v=MEPgs7ovb-g&t=37s

ii. Spooging tests - https://www.youtube.com/watch?v=uBrky5_g0-w

iii. Document authentication - https://www.youtube.com/watch?v=wmt3LnyFNaU

Function: ConsumeKYC (Identity, Address, Contact data with Source for FICA)

This API service provides an efficient and fast way to retrieve the last known contact data against a South African ID number.
This function includes the SOURCE of the data to comply with KYC/FICA requirements.
TIP – It is recommended that this call function is used with the RealtimeIDV call function.
Three categories of data will be returned, i.e. last known address and last known mobile phone number and last known employee information.
Address – Up to 6 Addresses returned with the source name.
Address – Date added and, last update from Source.
Telephone number – Date added and, last update from source name.
Telephone number – Up to 6 contact numbers returned with source name.
Employer details - Up to 6 Employees returned with the source name.
Employer detials – Date added and, last update from source name.
The validity of ID number – Validity is checked against a checksum.
Forenames (first names) – First names are returned.
Surname – The last known surname is returned.
Date of Birth (DOB) - Checksum DOB is returned.
Age - Age at date of verification will be returned.
Gender – Gender at birth will be returned.
Deceased Flag Alive/Deceased status.
Deceased Date – If on record, will return the Deceased date, against offline data (not Live from DHA)

Function: AddressSACRRA (Realtime IDV + Address with Source only)
- This API service provides an efficient and fast way to retrieve the last known Credit Bureau contact data against a South African ID number
- Two categories of data will be returned, i.e. last known address and last known mobile phone number.
- The validity of ID number – Validity is checked against a checksum.
- Address – Up to 6 Addresses returned with the source name.
- Address – Date added and, last update from Source.
- Telephone number – Date added and, last update from source name.
- Telephone number – Up to 6 contact numbers returned with source name.
- This API service provides an efficient and fast way to retrieve Credit Bureau data against a South African ID number.
- The validity of ID number – Validity is checked against a checksum.
- Forenames (first names) – First names are returned.
- Surname – The last known surname is returned.
- Date of Birth (DOB) - Checksum DOB is returned.
- Age - Age at date of verification will be returned.
- Gender – Gender at birth will be returned.
- Address – Date of the last update on Credit Bureau record.

Function: MatchcipcCO and CipcCO

This API service provides an efficient and fast way to retrieve commercial company information from CIPC (Companies and Intellectual Properties Commission).
There are two optional (either or both) functions to trigger the search
- By Company registration number
- By partial company name
Once the correct return result is submitted to the cipcCO function, the company's desired result will be returned.
- The returned file will comprise the following:

Function: MatchcipcDI and CipcDI

This 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).
A valid ID number of a Director will trigger the MatchcipcID function, which will return one or multiple results found on the CIPC db.
Once the correct return result is submitted to the cipcDI function, the desired result will be returned for that person.
The returned file will compromise the following:
List and details of each commercial entity where this person holds Directorships (See call function specification later in this document with return field).

Function: Contact ID

This API service provides a fast and efficient way to retrieve ID numbers linked to a mobile number.
The input ID number will return up to the five last known numbers linked to that ID number, starting with the most recent.

Function: Digital KYC (Consumer only)

This API gives businesses that are required to FICA their customers the ability to digitally draw and compare identity data against the Department of Home Affairs' verified data and the address that the consumer declared to you, against data obtained by creditors that are SACRRA (South African Credit Reporting Association) members, including banks, telecommunication companies, large retailers, furniture stores, etc. The KYC API uses an intelligent algorithm to filter minor spelling and differences in the construct of the address and compare the input data against that found on the SACRRA member database.
If no matches are found, the verification will fail using an exception rule.
If matches are found, the creditors through which the matches are found will be listed. For example, matches found at "Edgars, FNB, MTN and Standard Bank". This is then considered a verified address match to satisfy the requirements of FICA.
Consumer Details a. ID Number – South African ID Number.
Surname – Consumer's surname.
Enquiry reason – FICA|Tracing.
Your Reference – Unique transaction reference (your own).
Match Criteria - Use to match your inputted info a. Address - One-line sentence of the address starting with
- Street Number
- Street name
- Suburb
- Province
- City
- Postal Code

Date Range –You can specify your acceptance criteria for the age of the records to compare against, for example:

i. If you do not want your input data to be compared to creditors data older than six months, the date range will be 6.

ii. This can be number 1 to 36 months.

Minimum Match – You can specify your criteria for a successful verification in relation to the number of times the address must be found, for example:

i. If you require the address to be matched to at least three other creditors, the minimum match will be 3.

ii. This can be the number 1 to 10.

Function: Bank Account Verification

This API service provides an efficient and fast way to retrieve bank account verification information from all major banks in SA (see below).
This service will verify the bank details of a consumer or business in SA.
Verification details, Identity information or Company registration, Bank name, Account type, Bank account number, Active, Open, Open for longer than three months.
Ability to verify email address and mobile number linked to bank account.
Positive or negative reply per criteria.
Batch service is available for some backs on request.
The system allows you to verify an account against the following banks:
List of Available Banks - https://pbverify.co.za/bank-account-verification/

Function: Express Credit Score (Consumer only)

This API service provides the consumer's credit score only.
The service returns a score indicating the status of the consumer's score – i.e. Good, Fair or Bad.
The service does not return a reason for the adverse information and will require a full report to view this data.

Function: Company Credit Report

The API service provides an efficient and fast way to retrieve any adverse credit information against a South African registered business
The service retrieves adverse (Judgments, Listings, Adverse etc.) from credit bureau data on commercial companies and the Directors of the Business
A unique summary of all Directors in the business provides a quick overview of the credit status of all the Directors in the company, as well as the company itself

Function: Affordability Assessment Service

The Affordability Assessment Service uses the consumer's income (Gross and Net), calculates their Necessary Expenses (at a minimum, the minimum living expenses as required in terms of Regulations); it evaluates the consumer's total monthly debt repayment obligations and returns the consumer's available income (Discretionary Income) which will indicate the consumer's ability to fund the proposed credit instalment in terms of a new credit agreement.

How does it work?

Automatic determination of a consumer's Gross Income where the value is unknown
Automatic determination of a consumer's Net Income through the application of the relevant tax tables
Automatic inclusion of known Bureau Expenses
Assists with decision-making during the customer acquisition phase
Compliance with the NCA

Function: AML Sanctions Screening – Sanctions PEP/Crime data (AVAILABLE early 2022)

The AMl Sanction services will be available in early 2022
Our Sanctions Lists Check is based on data from the most relevant organizations such as
- OFAC
- UN
- European Union
- HM Treasury (UK)
- US Department of Commerce
- US Department of State
- Canadian Sanctions
- Swiss Sanctions
- The database contains more than 2.5 million detailed profiles, helping clients detect individuals, organizations and vessels linked to more than 50 risk categories, including Sanctions, Foreign Officials, and State-Owned Enterprises.
- Our Politically Exposed Persons (PEP) Check is based on a manually sourced agenda of worldwide elections on national and regional levels.
- We are constantly adding new data sources. We just included Interpol's Red Notices and will be adding the FBI's most-wanted list soon.
- Our simple RESTful API with various endpoints is easy to integrate into your solution
- Our API, including all backend systems, are Enterprise Ready with 95.99% uptime.
- The most cost-effective API for Sanctions and PEP screenings on the market.
- Extensive API documentation was available on Swagger and our Knowledge Base. We also provide a full-featured Sandbox environment for your testing.

Function: OFAC – Office of Foreign Asset Controls

The Office of Foreign Assets Control (OFAC) of the US Department of the Treasury administers and enforces economic and trade sanctions based on US foreign policy and national security goals against targeted foreign countries and regimes, terrorists, international narcotics traffickers, those engaged in activities related to the proliferation of weapons of mass destruction, and other threats to the national security, foreign policy or economy of the United States. OFAC acts under Presidential federal emergency powers and authority granted by specific legislation to impose controls on transactions and freeze assets under US jurisdiction. Many of the sanctions are based on United Nations and other international mandates, are multilateral in scope and involve close cooperation with allied governments.
OFAC publishes lists of individuals and companies owned or controlled by or acting for or on behalf of targeted countries. It also lists individuals, groups, and entities, such as terrorists and narcotics traffickers designated under not country-specific programs.
OFAC administers several different sanctions programs. The sanctions can be either comprehensive or selective, using the blocking of assets and trade restrictions to accomplish foreign policy and national security goals
This API provides a fast and efficient way to compare client information against this database for screening purposes.

Function: Mobile Phone ID Verification + Score + Contact Match

Phone number identification (PhoneID) + Contact Match service

Match Consumers name information to name data linked at the carrier
Businesses submit a mobile phone number and get data back that helps them answer critical questions about consumers.
The API offers data intelligence about a consumer's device, contact information, and more.
Phone number data intelligence can help strengthen the user verification process, reduce fake accounts, inform risk models, improve conversions, and even determine the optimal channel for message delivery.

Mobile phone number/ID score (Score)

By registering fake accounts, criminals can attack legitimate users, thereby damaging your brand's reputation and revenue.
By identifying and blocking fraudsters at account registration, businesses effectively streamline the process for genuine users.
The "Score" part of pbVerify's PhoneID & Score API allows companies to carry out reputation-based scoring on a consumer's mobile phone number, helping them to identify bad actors out to use their account for phishing attacks, promo abuse, and other fraud.

PhoneID & Score

Global data coverage: PhoneID will answer critical questions about users with data available in over 230 countries and territories.
Stronger authentication & reduction of fraud: PhoneID gives instant API access to ongoing and accurate key phone numbers and user identity data attributes, allowing businesses to make better decisions about new registrations, user activity and fraud risks.
Easy integration: PhoneID enables the business to be done with absolute confidence. Real-time data on phone numbers and users enables improved conversions, as well as heightened compliance.
Grow user base responsibly: Phone Score allows businesses to streamline the account registration process and securely grow their user base of verified and valuable users.
Identify fake & suspicious users: Phone Score allows businesses to reduce fraudulent activity and validate that end-users are who they say they are.
Protect brand reputation & value: Phone Score allows businesses to reduce the negative impacts of fraud while creating a more authentic and valuable user base.

Function: SARS Advanced VAT verification

This function allows customers to verify a SA company VAT number against SARS.
You can search via VAT or Company reg number or company name.
Service is also available in batches.