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" "\<service>", "countrycode" "\<country code>", "firstname" "\<first name>", "middlename" "\<middle name>", "lastname" "\<last name>", "fullname" "\<full name>", "dateofbirth" "\<yyyy mm dd>", "addressline1" "\<address line>", "addressline2" "\<address line>", "addressline3" "\<address line>", "addressline4" "\<address line>", "addressline5" "\<address line>", "identityinformation" { "nationalidnumber" "\<national id number>", "nationalidtype" "\<national id type>", "phonenumber" "\<phone number>", "landlineno" "\<landline number>", "emailaddress" "\<email address>", }, "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" "\<service>", "countrycode" "\<country code>", "firstname" "\<first name>", "middlename" "\<middle name>", "lastname" "\<last name>", "fullname" "\<full name>", "dateofbirth" "\<yyyy mm dd>", "addressline1" "\<address line>", "addressline2" "\<address line>", "addressline3" "\<address line>", "addressline4" "\<address line>", "addressline5" "\<address line>", "identityinformation" { "nationalidnumber" "\<national id number>", "nationalidtype" "\<national id type>", "phonenumber" "\<phone number>", "landlineno" "\<landline number>", "emailaddress" "\<email address>", }, "consent" true }' api input the api expects the following input in the request payload { "result" { "countrycode" "\<country code>", "service" "\<service>", "namematchscore" "\<namematchscore", "addressmatchscore" "\<addressmatchscore>", "verificationresult" { "firstname" "\<true"/"false>", "lastname" "\<true"/"false>", "middlename" "\<true"/"false>", "fullname" "\<true"/"false>", "dateofbirth" "\<true"/"false>"", "addressline1" "\<true"/"false>", "addressline2" "\<true"/"false>", "addressline3" "\<true"/"false>", "addressline4" "\<true"/"false>", "addressline5" "\<true"/"false>", "address" "\<true"/"false>", "nationalidnumber" "\<true"/"false>", "phonenumber" "\<true"/"false>", "landlineno" "\<true"/"false>", "emailaddress" "\<true"/"false>" } }, "reason" "request successful", "code" "s001" } 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 this is the street address required addressline2 string this is the locality or town where the address is located addressline3 string this represents the district or city optional addressline4 string this is the county or region name optional addressline5 string this is the postcode or zip code, which helps to pinpoint the exact area or location optional identityfields object this object will include fields like national id, phone number and email address optional nationalidnumber string national id number of end user e g ssn for usa optional nationalidtype string national id type of end user e g sss, gsis, tin for phillipines optional phonenumber string phone number of end user optional landlineno string landline number of end user 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" "\<service>", "namematchscore" "\<namematchscore", "addressmatchscore" "\<addressmatchscore>", "verificationresult" { "firstname" "\<true"/"false>", "lastname" "\<true"/"false>", "middlename" "\<true"/"false>", "fullname" "\<true"/"false>", "dateofbirth" "\<true"/"false>"", "addressline1" "\<true"/"false>", "addressline2" "\<true"/"false>", "addressline3" "\<true"/"false>", "addressline4" "\<true"/"false>", "addressline5" "\<true"/"false>", "address" "\<true"/"false>", "nationalidnumber" "\<true"/"false>", "phonenumber" "\<true"/"false>", "landlineno" "\<true"/"false>", "emailaddress" "\<true"/"false>" } }, "reason" "request successful", "code" "s001" } response parameters parameter description data type countrycode the country code associated with the verification result string service the service that was used for verification string namematchscore a score representing how closely the provided name matches the verified name (numeric score) integer addressmatchscore a score representing how closely the provided address matches the verified address (numeric score) integer verificationresult an object that contains the verification results for various fields object verificationresult firstname the verification result for the first name (true = verified, false = not verified) boolean verificationresult lastname the verification result for the last name (true = verified, false = not verified) boolean verificationresult middlename the verification result for the middle name (true = verified, false = not verified) boolean verificationresult fullname the verification result for the full name (true = verified, false = not verified) boolean verificationresult dateofbirth the verification result for the date of birth (true = verified, false = not verified) boolean verificationresult addressline1 the verification result for the first address line (true = verified, false = not verified) boolean verificationresult addressline2 the verification result for the second address line (true = verified, false = not verified) boolean verificationresult addressline3 the verification result for the third address line (true = verified, false = not verified) boolean verificationresult addressline4 the verification result for the fourth address line (true = verified, false = not verified) boolean verificationresult addressline5 the verification result for the fifth address line (true = verified, false = not verified) boolean verificationresult address the verification result for the full address (true = verified, false = not verified) boolean verificationresult nationalidnumber the verification result for the national id number (true = verified, false = not verified) boolean verificationresult phonenumber the verification result for the phone number (true = verified, false = not verified) boolean verificationresult landlineno the verification result for the landline number (true = verified, false = not verified) boolean verificationresult emailaddress the verification result for the email address (true = verified, false = not verified) boolean reason a message or explanation about the result (e g , "request successful") string code a code representing the status or result of the request (e g , "s001" for success) st success codes http status code success code description 200 s001 request successful 200 s002 data in process 200 s003 data not found on source 200 s008 data matching the minimum score wasn’t found, though it exists at the source error code and mapping sample error malformatted requestid e001 { "result" {}, "reason" "bad request bad request \<request> is invalid ", "status" "failure", "code" "e001" } requestid not found e401 { "result" {}, "reason" "upstream error", "status" "failure", "code" "e401" } error response parameters parameter description result empty result object reason reason for error status s tatus of the api c ode error code from signzy error codes http status code error code description 400 e001 bad request 401 e1001 unauthorized access 403 e201 forbidden 404 e301 data not found 409 e401 upstream error 429 e501 rate limit exceeded 500 e601 internal server error 503 e701 service unavailable 504 e801 timeout 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!