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 "No Match" --> a verification was not achieved from a source, although individual elements may be returned as 'true' there was insufficient postive matches to verify the identity |
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. "Successful" --> all requested data sources were successfully processed "Not Successful" --> all requested data sources were not successfully processed "Partial" --> not all requested data sources were successfully process, some failed |
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. |