What do different parameters in API response mean?

“countryCode”

Country code, example:

“Australia”

Directs the request to search data sources of the input country code. This is provided by the client in the API request.

“clientReference”

Example: “33138643”

Reference number supplied by client in the request. Best practice is for clients to provide the same client reference if making multiple requests related to the same individual or applicant, such as an application or customer reference number to improve reporting.

“reportingReference”

Example: DZ-745a7f0b-c47f-47f1-8115-99e39cff2c27

Reference ID generated by Data Zoo per API request made. Number is unique per API request, is used for billing and support enquiries. 

“matchStatus”

“Full Match 1+1 Verification”

Full Match 1+1 determined when identity verified = true in 1 source/service 

“Full Match 2+2 Verification”

Full Match 2+2 determined when identity verified = true in =>2 sources/services

“No Match”

No Match when neither of the above two rules are determined.

“searchErrorMessage”

 "searchErrorMessage": "The following data source requests failed validation: Australia Residential"

Used to flag if a service has failed a pre-validation check

“safeHarbour”

True

The Safe Harbour Matching Score (i.e.. "safeHarbourScore") is determined by the following logic:

• M1 = Match on full name, address and DOB

• M2 = Match on full name and DOB

• N1 = Match on full name and address

• None = No match

False

Safe Harbour Flag is set to False (i.e.. "safeHarbour" = False) if a True Match is not returned

“searchStatus”

Successful 

“Successful” - Data Zoo has submitted the request to at least one data source

“Not Successful” - a pre-validation error has ocurred (ie incorrect syntax used)

or Data Zoo is not operational at this time and has not submitted the request for verification on behalf of the client.

“serviceResponses”

For example: “Australian Residential”

The service name of the data sources used for verification. The child parameters of this attribute will contain the safe harbour score and element matching.

“status”

0,1,2,3

0 when All input elements matched and identityVerified = ‘true’

1 when Some input elements matched and identityVerified = ‘true’

2 when identityVerified = ‘false’

3 when an error has occurred and the identity can neither be verified or not verified

“sourceStatus”

“successful”

“unsuccessful”

Indicates if the API query successfully reached the data source

“errorMessage”

too many to list

Returns an error message indicating what the error was - usually in conjunction with “status”: 3, however can sometimes occur with “status”: 2 as per DVS enhanced messaging:

"errorMessage": "Some or all of the supplied details do not match the Issuer record. GivenName: Given name does not match. "

“identityVerified”

true

Flag will confirm identity verification, refer to additional field responses, i.e. “nameMatchScore”

false

Refer above

“safeHarbourScore”

Refer to safe harbour table

Score represents which combination of elements have been verified. Name and address match score threshold must be met for a safe harbour score to be returned.

“nameMatchScore”

A score between 0-1

Indicates the exactness of the match against the data source with score of 1 representing exact match. Acceptable match thresholds can be set in for client account preferences to accept fuzzy matching for example setting an acceptable threshold of 0.8 or greater. 

“addressMatchScore”

A score between 0-1

Indicates the exactness of the match against the data source with score of 1 representing exact match. Acceptable match thresholds can be set in for client account preferences to accept fuzzy matching for example setting an acceptable threshold of 0.8 or greater

“verifications”

See “verifications child parameters” below

Contains element level verification on details supplied for the source. Only elements provided in the request from the client will be present in the response. For example if no DOB provided in the request then there will be no DOB attribute in the response.

“returnedData”

An array of dynamic data fields that will differ between services.

Contains data that is additional to the verification status of the individual (ie Canada FINTRAC) or to the source used for the verification (ie category and source number).

Examples:

      "returnedData": {
        "addressAsReported": "97,STANLEY,OTTAWA,ON,K1M1N8",
        "category": "credit – single source",
        "cid": "0053559639",
        "creditFile3Years": true,
        "creditFileCreated": "2018-09-25",
        "dateOfBirthAsReported": "1970-12-12",
        "moreThanOneDistinctSource": true,
        "nameAsReported": "TESTPOTKIDIS,DOMEMIC,,",
        "numberOfTrades": "011",
        "originOfCreditFile": "Canada",
        "source": "dz5"
      }

            "returnedData": {
                "category": "consumer",
                "source": "dz14"
            }