API Output Field Reference

this table provides detailed definitions of the key fields returned in the json api response each element is described to help developers interpret api outputs accurately and implement integrations with clarity these definitions cover data types, expected values, and the purpose of each field root level api response field breakdown field name data type description countrycode string indicates the country where the verification was performed (e g "australia") clientreference string a reference string passed by the client in the request to track the query reportingreference string a unique system generated data zoo id to track and report the verification transaction matchstatus string provides overall match result for single or across multiple data services, based on identityverified element results describes the overall verification outcome "full match 1+1 verification" > single source verification "full match 2+2 verification" > verification returned from two or more sources searcherrormessage string pre validation rules and format errors are captured where there are multiple error messages, they will be concatenated into this element empty when search is successful safeharbour boolean indicates if the result qualifies under safe harbour provisions (e g , true or false) based on safeharbourscore elements and predefined safe harbour rules, this function returns an overall safe harbour result if a client has no safeharbour requirements (for example, 1+1 verification), the default safeharbour is 'false' client is expected to ignore this response searchstatus string indicates whether the transaction was successful in reaching the data zoo gateway serviceresponses object contains individual service level response blocks (e g , "australia residential") remarks array return remarks regarding any encountered issues or pre validation errors nested serviceresponses > \<service name > field name data type description status integer identfies the degree of matching between input data and data source, as well as whether there was a system error it is determined by identyverified , element level verification, and sourcestatus returns one of the following ▪️0 identityverified true element verifications all true ▪️1 identityverified true element verifications not all true ▪️2 identityverified false sourcestatus successful ▪️3 – error querying the data source sourcestatus string indicates whether or not the transaction was successful in reaching the data service gateway returns one of the following \ successful \ unsuccessful errormessage string ▪️when sequencing is enabled, validation rules are returned in errormessage ▪️when sequencing is disabled, pre validation rules are returned in the searcherrormessage identityverified boolean this item is returned as true or false considering the safeharbourscore refer to safe harbour score page safeharbourscore string indicates the identity elements (score) that have been matched by data zoo's safeharbour logic namematchscore string the degree of matching between the input data and the data source name element namematchscore is a weighted score (ranging from 0 000 to 1 000) addressmatchscore string the degree of matching between the input data and the data source address element addressmatchscore is a weighted score (ranging from 0 000 to 1 000) nested verifications (boolean map) these fields return true if the individual data elements were successfully verified, else false or not returned note not all elements are given below element data type description firstname boolean first name matched middlename boolean middle name matched lastname boolean last name matched dateofbirth boolean date of birth matched addresselement1 boolean street level address matched addresselement5 boolean post code matched phoneno boolean phone number matched nationalidno boolean national id number matched nested returneddata note not all elements are given below also, elements are returned if applicable field name data type description source string identifier for the data source used in verification (e g , "dz1") for data zoo reference only fullname string full name of the verified person as returned form the data source category string type or source of the service example, government, telco etc