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 preproduction curl location 'https //api preproduction signzy app/api/v3/global kyc verify/za/nid' \\ \ header 'authorization < auth token >' \\ \ header 'content type application/json' \\ \ data '{ "fullname" "umar", "dateofbirth" "1980 01 01", "gender" "male ", "identityinformation" { "nationalidnumber" "9809065830080", "issuedate" "" }, "consent" true } ' production curl location 'https //api signzy app/api/v3/global kyc verify/za/nid' \\ \ header 'authorization < auth token >' \\ \ 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 400 (bad request) { "error" { "name" "error", "message" "bad input and description ", "status" 400, "reason" "validation error", "type" "bad request", "statuscode" 400 } } 401(unauthorized) { "error" { "name" "error", "message" "invalid authentication credentials", "status" 401, "reason" "authentication error", "type" "bad request", "statuscode" 401 } } 403 (forbidden) { "error" { "name" "error", "message" "forbidden", "reason" "error", "type" "bad request", "statuscode" "403" } } 500 (internal server error) { "error" { "name" "error", "message" "internal server error", "status" 500, "reason" "error", "type" "bad request", "statuscode" 500 } } 409(upstream down { "error" { "name" "error", "message" "upstream down", "status" 409, "reason" "error", "type" "bad request", "statuscode" 409 } } 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 help\@signzy com 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!