Ireland Residential

3 min

Verifies input data against data obtained from the partnered Semi Government sources from Ireland.

For Authorization Get Session Token from Authentication page.

Ireland Residential

* Verification Outcome – Returns KYC verification * Consumer Consent – N/A * Mandatory Input – Name * Verifies – Name, DOB, Gender and Address * Returned Data - N/A

POST

https://idu-test.datazoo.com/api/v2/verify

Header Parameters

Authorizationstringrequired
Description
sessionToken obtained via the Authentication call

Body Parameters

dataobjectrequired
Description
request body sent to the API
- countryCodestringrequired
  Description
  IE
- servicearrayrequired
  Description
  Ireland Residential
- clientReferencestring
  Description
  a client reference field
- firstNamestringrequired
  Description
  the first name of the identity owner
- middleNamestring
  Description
  the middle name(s) of the identity owner
- lastNamestringrequired
  Description
  the last name of the identity owner
- genderstring
  Description
  Male or Female
- dateOfBirthstring
  Description
  in YYYY-MM-DD (preferred) or DD-MM-YYYY format
- addressElement1string
  Description
  the house/unit number and street name of the address
- addressElement3string
  Description
  the Town/City of the address
- addressElement4string
  Description
  the state of the address

Response

countryCodestring
Description
Ireland
clientReferencestring
Description
the client reference (if given as input)
reportingReferencestring
Description
a reference number generated which is unique to each transaction.
validationErrorsstring
Description
Returned with HTTP status code 400 when the request contains invalid or improperly formatted input data.
matchStatusstring
Description
"Full Match 1+1 Verification" "No Match"
searchErrorMessagestring
Description
error message returned querying the data source
safeHarbourboolean
Description
true or false
searchStatusstring
Description
"Successful" "Not Successful"
serviceResponsesobject
Description
Verification Details with "Ireland Residential" returned as the Service Identifier.
- statusinteger
  Description
  0 - identityVerified TRUE - element verifications all TRUE 1 - identityVerified TRUE - element verifications not all TRUE 2 - identityVerified FALSE - sourceStatus SUCCESSFUL 3 - identityVerified FALSE - sourceStatus NOT SUCCESSFUL
- sourceStatusstring
  Description
  "Successful" "Unsuccessful"
- errorMessagestring
  Description
  error message(s) from the data source. Example, "Error querying data source".
- identityVerifiedboolean
  Description
  true or false
- safeHarbourScorestring
  Description
  M1, M2, N1 or "none" * For more information, refer to Safe Harbour Scores page
- nameMatchScorestring
  Description
  A string that acts as a value between 0.000 and 1.000.
- addressMatchScorestring
  Description
  A string that acts as a value between 0.000 and 1.000.
- verificationsobject
  Description
  element level verification returned as true or false [Only applicable elements will be included, and not all elements may be present]
  - addressElement1boolean
  - addressElement3boolean
  - addressElement4boolean
  - dateOfBirthboolean
  - firstNameboolean
  - genderboolean
  - lastNameboolean
  - middleNameboolean
- returnedDataobject
  Description
  Null
remarksarray
Description
will return remarks regarding any encountered issues.

curl

curl --location 'https://idu-test.datazoo.com/api/v2/verify' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJ0ZXN0IiwiaWF0IjoxNzQzNDYyNDQ4LCJpcGEiOiIzNC4xNTEuMTE3LjI0OSIsInVpZCI6MzAzLCJvaWQiOjYyLCJsaWQiOjU2NjQ2MTUsImV4cCI6MTc0MzQ5MTI0OCwiYXVkIjoiaHR0cHM6Ly9pZHUuZGF0YXpvby5jb20ifQ.D_mGA78PBG_p_wYy-JcKCy28Rk8CX_U0IADn8DeEL8aSw3cnusbiDefJIqE_j74QcKu0IXNNpE-9SoQUSL8fAg' \
--data '{
    "countryCode": "IE",
    "service": [
        "Ireland Residential"
    ],
    "clientReference": "Test_0001",
    "firstName": "CLFNAME", 
    "middleName": "CLMNAME", 
    "lastName": "CLLNAME", 
    "gender": "FEMALE", 
    "dateOfBirth": "1985-01-05", 
    "addressElement1": "CLADDRESS 1", 
    "addressElement3": "CLCITY", 
    "addressElement4": "CLSTATE" 
}'

200

{
    "countryCode": "Ireland",
    "clientReference": "Test_0001",
    "reportingReference": "DZ-1fdbbbcf-843f-48ef-a6c9-496064238eda",
    "matchStatus": "Full Match 1+1 Verification",
    "searchErrorMessage": "",
    "safeHarbour": false,
    "searchStatus": "Successful",
    "serviceResponses": {
        "Ireland Residential": {
            "status": 1,
            "sourceStatus": "Successful",
            "errorMessage": "",
            "identityVerified": true,
            "safeHarbourScore": "N1",
            "nameMatchScore": "1.000",
            "addressMatchScore": "1.000",
            "verifications": {
                "addressElement1": true,
                "addressElement3": true,
                "addressElement4": true,
                "dateOfBirth": false,
                "firstName": true,
                "gender": true,
                "lastName": true,
                "middleName": true
            },
            "returnedData": {}
        }
    },
    "remarks": []
}

404

{
  "message": "Ain't no cake like that."
}

Links

About Safe Harbour Scores

Change History

Added

Last updated - 1 April, 2025