South Africa ID Number Validator API

South African ID Validation, in JSON via REST API.

API ID 1782

The South Africa ID Number Validator API is a tool that performs a basic check on a South African ID number. It validates the format, length, and other aspects of the number to ensure that it is correct and accurate. This API can be useful for businesses and organizations that require ID number validation for various purposes, such as customer registration and verification.

100% uptime 240 ms avg response

API Documentation

Endpoints

Request

Pass the ID number and run a validation with ease. 

Returns valid or not. 

Example is invalid for security reasons. 

Endpoint ID: 1428
POST https://zylalabs.com/api/1782/south+africa+id+number+validator+api/1428/validator
INPUT PARAMETERS

Validator — Endpoint Features

Object Description
Request Body Required Json

Free test requests remaining: 3 of 3.


INPUT PARAMETERS

API EXAMPLE RESPONSE
JSON
{"valid":true}
Validator — CODE SNIPPETS

curl --location --request POST 'https://zylalabs.com/api/1782/south+africa+id+number+validator+api/1428/validator' --header 'Authorization: Bearer YOUR_API_KEY' 

--data-raw '{
    "idno": "7901016186187"
}'

    

API Access Key & Authentication

After signing up, every developer is assigned a personal API access key, a unique combination of letters and digits provided to access to our API endpoint. To authenticate with the South Africa ID Number Validator API simply include your bearer token in the Authorization header.

Headers
Header Description
Authorization Required Should be Bearer access_key. See "Your API Access Key" above when you are subscribed.

No long-term commitment. Upgrade, downgrade, or cancel anytime. Free Trial includes up to 50 requests.

(Save 2 months with annual billing 🎉)

🚀 Enterprise Plan

Starts at
$ 10,000/Year


  • Custom Volume
  • Custom Rate Limit
  • Specialized Customer Support
  • Real-Time API Monitoring

Overview

About the API: 

The South Africa ID Number Validator API is a tool that enables developers to validate South African ID numbers programmatically. The API performs a simple validation on the ID number to check its format, length, and other key aspects, ensuring that it is a valid South African ID number.

South African ID numbers are unique 13-digit numbers assigned to each citizen or permanent resident of the country. These numbers are used for various purposes, such as identification, voting, and tax administration. The ID number comprises the person's date of birth, gender, and unique identification number.

Using the South Africa ID Number Validator API, developers can easily verify whether an ID number is in a valid format or not. This can be useful for businesses that require ID number validation for customer registration and verification, as well as for government agencies that need to verify the identity of individuals for various purposes.

The API is simple to use and can be integrated into any application or website that requires South African ID number validation. It returns a response indicating whether the ID number is valid or not, along with any errors that may have been encountered during validation.

In summary, the South Africa ID Number Validator API provides a convenient way to validate South African ID numbers programmatically, making it easier for businesses and government agencies to verify the identity of individuals in a reliable and efficient manner.

 

 

What this API receives and what your API provides (input/output)?

Pass the ID number to verify, and receive if it's valid or not. 
 

What are the most common uses cases of this API?

  1. Customer registration: When businesses require customers to register for a service, they can use the API to validate that the ID number provided is in a valid format.

  2. KYC compliance: Financial institutions and other regulated entities can use the API to verify the identity of customers during the KYC (Know Your Customer) process, ensuring that they comply with regulatory requirements.

  3. Voter registration: During voter registration drives, the API can be used to validate that the ID numbers provided by potential voters are valid and belong to eligible voters.

  4. Government benefits: Government agencies can use the API to validate the ID numbers of individuals applying for government benefits such as social grants or healthcare services.

  5. Data cleaning: The API can be used to validate large datasets containing ID numbers, helping to clean up any errors or inconsistencies in the data. This can be useful for organizations that rely on accurate ID number data for business operations.

 

Are there any limitations to your plans?

Besides the number of API calls, there is no other limitation

South Africa ID Number Validator API FAQs

The Validator endpoint returns a JSON response indicating whether the provided South African ID number is valid. The primary field in the response is "valid," which is a boolean value.

The key field in the response data is "valid," which indicates the validity of the ID number. A value of true means the ID number is valid, while false indicates it is not.

The response data is structured in JSON format. It contains a single key-value pair, where the key is "valid" and the value is either true or false, representing the validation result.

The Validator endpoint provides information on the validity of South African ID numbers, specifically checking their format, length, and compliance with validation rules.

Data accuracy is maintained through rigorous validation checks against the established format and rules for South African ID numbers, ensuring that only correctly formatted numbers are marked as valid.

Typical use cases include customer registration, KYC compliance, voter registration, government benefits verification, and data cleaning for organizations needing accurate ID number data.

Users can utilize the returned data by checking the "valid" field to determine if an ID number is acceptable for their processes, such as onboarding customers or verifying identities.

Standard data patterns include a 13-digit numeric format for valid ID numbers. Invalid numbers may exhibit incorrect lengths, non-numeric characters, or fail specific validation rules.

General FAQs

To obtain your API key, first sign in to your account and navigate to the API you want to use. From the API's Pricing section, choose a plan and complete the subscription process. Once subscribed, return to the API page and you will see your API Access Key displayed at the top of the documentation page. You can use this key to authenticate your requests.

You can’t switch APIs during the free trial. If you subscribe to a different API, your trial will end and the new subscription will start as a paid plan.

The free trial lasts for 7 days and allows you to make up to 50 API requests.

No, the free trial is available only once, so we recommend using it on the API that interests you the most. Most of our APIs offer a free trial, but some may not include this option.

Yes. If the API offers a free trial, you will see a "Free 7-Day Trial" option in its Pricing section. The trial lasts for 7 days and allows up to 50 API requests, enabling you to evaluate the API before subscribing to a paid plan.

Zyla API Hub is like a big store for APIs, where you can find thousands of them all in one place. We also offer dedicated support and real-time monitoring of all APIs. Once you sign up, you can pick and choose which APIs you want to use. Just remember, each API needs its own subscription. But if you subscribe to multiple ones, you'll use the same key for all of them, making things easier for you.

Prices are listed in USD (United States Dollar), EUR (Euro), CAD (Canadian Dollar), AUD (Australian Dollar), and GBP (British Pound). We accept all major debit and credit cards. Our payment system uses the latest security technology and is powered by Stripe, one of the world's most reliable payment companies. If you have any trouble paying by card, just contact us at [email protected]

Additionally, if you already have an active subscription in any of these currencies (USD, EUR, CAD, AUD, GBP), that currency will remain for subsequent subscriptions. You can change the currency at any time as long as you don't have any active subscriptions.
The local currency shown on the pricing page is based on the country of your IP address and is provided for reference only. The actual prices are in USD (United States Dollar). When you make a payment, the charge will appear on your card statement in USD, even if you see the equivalent amount in your local currency on our website. This means you cannot pay directly with your local currency.
Occasionally, a bank may decline the charge due to its fraud protection settings. We suggest reaching out to your bank initially to check if they are blocking our charges. Also, you can access the Billing Portal and change the card associated to make the payment. If these does not work and you need further assistance, please contact our team at [email protected]
Prices are determined by a recurring monthly or yearly subscription, depending on the chosen plan.
API calls are deducted from your plan based on successful requests. Each plan comes with a specific number of calls that you can make per month. Only successful calls, indicated by a Status 200 response, will be counted against your total. This ensures that failed or incomplete requests do not impact your monthly quota.
Zyla API Hub works on a recurring monthly subscription system. Your billing cycle will start the day you purchase one of the paid plans, and it will renew the same day of the next month. So be aware to cancel your subscription beforehand if you want to avoid future charges.
To upgrade your current subscription plan, simply go to the pricing page of the API and select the plan you want to upgrade to. The upgrade will be instant, allowing you to immediately enjoy the features of the new plan. Please note that any remaining calls from your previous plan will not be carried over to the new plan, so be aware of this when upgrading. You will be charged the full amount of the new plan.
To check how many API calls you have left for the current month, refer to the 'X-Zyla-API-Calls-Monthly-Remaining' field in the response header. For example, if your plan allows 1,000 requests per month and you've used 100, this field in the response header will indicate 900 remaining calls.

You can monitor your API usage through the response headers included with every request:

x-zyla-api-calls-monthly-used: Shows the total number of API requests you have used during the current billing period.
x-zyla-api-calls-monthly-remaining: Shows the number of API requests you have remaining for the current billing period.

The 'X-Zyla-RateLimit-Reset' header shows the number of seconds until your rate limit resets. This tells you when your request count will start fresh. For example, if it displays 3,600, it means 3,600 seconds are left until the limit resets.

Yes, you can cancel your subscription at any time. Simply go to the Pricing section of the API you're subscribed to and click the "Unsubscribe" button.

Please note that upgrades, downgrades, and cancellations take effect immediately. Once your subscription is canceled, access to the service will end immediately, regardless of any remaining API calls in your quota.

After 7 days, you will be charged the full amount for the plan you were subscribed to during the trial. Therefore, it's important to cancel before the trial period ends. Refund requests for forgetting to cancel on time are not accepted.
When you subscribe to an API free trial, you can make up to 50 API calls. If you wish to make additional API calls beyond this limit, the API will prompt you to perform an "Start Your Paid Plan." You can find the "Start Your Paid Plan" button in your profile under Subscription -> Choose the API you are subscribed to -> Pricing tab.
You can contact us through our chat channel to receive immediate assistance. We are always online from 8 am to 5 pm (EST). If you reach us after that time, we will get back to you as soon as possible. Additionally, you can contact us via email at [email protected]

Please have a look at our Refund Policy: https://zylalabs.com/terms#refund