South Africa National ID

Overview and Purpose

Overview

The South Africa NID is a specialized digital tool designed specifically for individuals operating within South Africa. This API provides crucial support in confirming the authenticity of personal information against official South African records, enhancing trust, accuracy, and compliance across various sectors.

Key Features and Functionalities

Identity Verification: The API checks personal details such as full name, date of birth, and national ID number against South Africa's national identity databases. This is essential for confirming the identity of individuals in processes like account creation, financial transactions, and access to services.

Identity Protection: By verifying identities against official records, this API plays a vital role in preventing identity theft and fraud. It ensures that only authenticated individuals gain access to sensitive services and information.

Business Trust: For sectors such as banking, finance, and telecommunications, where customer identification is critical, this API builds a foundation of trust by ensuring that all verified information is accurate and reliable.

Compliance Support: The API helps businesses meet stringent regulatory requirements by providing reliable verification services that comply with South African laws and guidelines. This is particularly crucial in industries like finance and healthcare, where precise identity verification is mandatory.

The South Africa National ID Verification API secures and streamlines customer onboarding and transactions within South Africa.

API Details

Sample cURL

curl --location 'https://api-preproduction.signzy.app/api/v3/global-kyc-verify/za/nid' \
--header 'Authorization: ' \
--header 'Content-Type: application/json' \
--data '{
    "fullName": "umar",
    "dateOfBirth": "1980-01-01",
    "gender": "Male ",
    "identityInformation": {
        "nationalIdNumber": "9809065830080",
        "issueDate": ""
    },
    "consent": true
}
'

API Input

{
    "fullName": "<Full Name>",
    "dateOfBirth": "<Date of Birth>",
    "gender": "gender ",
    "identityInformation": {
        "nationalIdNumber": "9809065830080",
        "issueDate": ""
    },
    "consent": true
}

Request Body Parameters

Parameter	Type	Description	Required/Optional
fullName	String	The full name of the person	Required
dateOfBirth	String	Date of birth of the person in yyyy-mm-dd format	Required
gender	String	gender of the person Male/Female	Optional
nationalIdNumber	String	13 Digit national Id number	Required
issueDate	String	Issue date of ID Number	Optional
consent	Boolean	Consent of the end user for verification of his/her data	Required

Response

{
    "result": {
        "verificationResult": {
            "fullName": true,
            "dateOfBirth": false,
            "gender": true,
            "nationalIdNumber": true,
            "issueDate": true
        }
    }
}

Response Body Parameters

Parameter	Description	Data Type
fullName	The API returns a Boolean value ("True" for a match found and "False" for no match found) based on the verification of the provided input data against authorized sources.	boolean
gender	The API returns a Boolean value ("True" for a match found and "False" for no match found) based on the verification of the provided input data against authorized sources.	boolean
dateOfBirth	The API returns a Boolean value ("True" for a match found and "False" for no match found) based on the verification of the provided input data against authorized sources.	boolean
nationaIdNumber	The API returns a Boolean value ("True" for a match found and "False" for no match found) based on the verification of the provided input data against authorized sources.	boolean
issueDate	The API returns a Boolean value ("True" for a match found and "False" for no match found) based on the verification of the provided input data against authorized sources.	boolean

Error Code and Response Mapping

{
  "error": {
     "name": "error",
     "message": "Bad Input and description ",
     "status": 400,
     "reason": "VALIDATION_ERROR",
     "type": "Bad Request",
     "statusCode": 400
  }
}

Field	Type	Description
name	string	Text displayed on the screen explaining error type.
reason	string	Reason for the error.
status	number	HTTP status code.
message	string	Error message indicating an upstream error.
type	string	Error type.
statusCode	number	Status code representing the error scenario.

Getting help

Please feel free to contact us if you have any questions, require clarification, or have ideas for how to make the documents or any of our services better.

You can reach out to us at [email protected]. We strive to provide prompt and reliable assistance, ensuring your queries are addressed effectively.

We value your feedback and are committed to making your experience smooth and enjoyable. Our team is dedicated to assisting you with any needs you may have. Thank you for choosing our services. We look forward to helping you!