Global KYC

overview & purpose the global kyc api is a powerful tool that acts as a digital identity detective it empowers businesses and organizations to confirm the accuracy of the personal and address information provided by individuals this api plays a crucial role in ensuring trust, accuracy, and compliance in various industries it primarily focuses on two key aspects identity verification and address verification by interacting with multiple databases and data sources, this api checks if the information submitted by individuals matches what's officially recorded it categorizes the results into true/false helping organizations make informed decisions and protect against identity fraud key features and functionalities of this api include identity verification the api verifies personal details such as full name, date of birth, national id, and gender it assesses the accuracy of this information against official records, providing a clear indication of the level of match address verification it confirms the accuracy of address details, including house number, city, state, postal code, and more this is vital for ensuring that deliveries go to the correct locations and for address based verification in various services result categorization the api categorizes the verification results into "full match" for complete accuracy, "partial match" for partial accuracy, and "no match" when the information provided doesn't align with official records identity protection it plays a crucial role in safeguarding individuals from identity theft and fraudulent activities by confirming identity information, it helps prevent unauthorized access to sensitive services business trust for organizations, the api ensures that they can trust their customers it's particularly important in industries like banking, where accurate identity verification is essential for granting financial services compliance in regulated industries like finance and healthcare, the api helps businesses adhere to strict compliance requirements by verifying customer information against authoritative sources the global verification standard api is a versatile tool that enhances trust, accuracy, and compliance for businesses and individuals alike by checking and confirming personal and address information, it contributes to secure, efficient, and compliant operations across various industries countries supported country alpha 2 country code argentina ar brazil br mexico mx indonesia id south africa za nigeria ng kenya ke philippines ph thailand th malaysia my united kingdom gb united states of america us api details api overview the verification api enables the validation of various personal data inputs, including firstname, lastname, dateofbirth, addressline1, city, state, postalcode, and nationalidno each input is cross referenced against authorized sources to determine a match or no match status authorization access to this api is granted via an authorization token, ensuring secure and authenticated access for authorized users sample curl curl location 'https //api preproduction signzy app/api/v3/global kyc/verify' \\ \ header 'content type application/json' \\ \ header 'authorization \<kong auth token>' \\ \ data raw '{ "service" "", "countrycode" "\<country code>", "firstname" "\<first name>", "middlename" "\<middle name>", "lastname" "\<last name>", "fullname" "\<full name>", "dateofbirth" "\<yyyy mm dd>", "gender" "\<m/f>", "addressline1" "\<address line>", "addressline2" "\<address line>", "addressline3" "\<address line>", "addressline4" "\<address line>", "postalcode" "\<postal code>", "identityinformation" { "nationalidnumber" "\<national id number>", "issuedate" "\<issue date of id>", "expirydate" "\<expiry date of id>", }, "consent" true }'curl location 'https //api signzy app/api/v3/global kyc/verify' \\ \ header 'content type application/json' \\ \ header 'authorization \<kong auth token>' \\ \ data raw '{ "service" "", "countrycode" "\<country code>", "firstname" "\<first name>", "middlename" "\<middle name>", "lastname" "\<last name>", "fullname" "\<full name>", "dateofbirth" "\<yyyy mm dd>", "gender" "\<m/f>", "addressline1" "\<address line>", "addressline2" "\<address line>", "addressline3" "\<address line>", "addressline4" "\<address line>", "postalcode" "\<postal code>", "identityinformation" { "nationalidnumber" "\<national id number>", "issuedate" "\<issue date of id>", "expirydate" "\<expiry date of id>", }, "consent" true }' api input the api expects the following input in the request payload { "service" "kyc", "countrycode" "\<country code>", "firstname" "\<first name>", "lastname" "\<last name>", "dateofbirth" "\<yyyy mm dd>", "addressline1" "\<address line>", "city" "\<city>", "state" "\<state code>", "postalcode" "\<postal code>", "identityfields" { "nationalidno" "\<national id number>", "phoneno" "\<phone number>", "emailaddress" "\<email addresss>" }, "consent" true } parameter type description required/optional service string service field will be kyc for all countries required countrycode string user must enter alpha 2 country codes required firstname string first name of end user required lastname string last name of end user required dateofbirth string date of birth of end user, must be in format yyyy mm dd required addressline1 string residential address of end user, should include details such as house number and street name/number required city string city of residence of end user optional state string state of residence of end user optional postalcode string postal code/zip code of end user's permanant address optional identityfields object this object will include fields like national id, phone number and email address optional nationalidno string national id number of end user e g ssn for usa optional phoneno string phone number of end user (no country code needed at prefix) optional emailaddress string email address of end user optional consent boolean consent of end user to query his personal information against authorized data source user must opt in (consent field must be true) in order to run kyc checks required api output success response & mapping 200 { "result" { "countrycode" "\<country code>", "service" "kyc", "searchstatus" "successful", "reliabilitystatus" "<10/20/30>", "verificationresult" { "firstname" \<true/false>, "lastname" \<true/false>, "dateofbirth" \<true/false>, "addressline1" \<true/false>, "city" \<true/false>, "state" \<true/false>, "postalcode" \<true/false>, "nationaidno" \<true/false>, "phoneno" \<true/false>, "emailaddress" \<true/false> } } } parameter description data type countrycode alpha 2 country code, this will show the country for which data has been queried s tring service service which is used to perform the check s tring searchstatus this field will show whether the search is successful or not for a particular individual s tring reliabilitystatus shows the reliability of the search, reliablility status can be 10, 20, 30 with 10 being most reliable and 30 being least reliable s tring verificationresult this object will contain all the input fields against which search has been made object firstname 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 lastname 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 addressline1 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 city 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 state 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 postalcode 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 nationaidno 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 phoneno 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 emailaddress 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 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!