For each API request, you will receive a Status indicating whether the request has been successful.
There are 4 different status values:

0 - Indicates that a full match on the identity has been returned.

1 - Indicates that the Identity was matched, but some of the input information provided was incorrect.

2 - Indicates the information provided was not found in the database.

3 - Indicates the data source(s) error and an associated error message will be displayed.


A status will be returned for each data source, even if it is unsuccessful.

Please use the following as a guide to understanding how the Status is returned for the different API requests:


XML

When you receive an XML API response, you will see there are two Status fields that are returned.

The first Status (Status #1 below) field indicates whether the call to the server (API) has been successful. If this Status is not "0", please take a note of the contents of the <Message> tags.

The second Status (Status #2 below) field indicates whether the call to the Data Source was successful.

NOTE: It is the Second Status that indicates 




REST (JSON)

When you receive a REST response in JSON format, you will get a status result for each data source you have used in your request.

Using the below as an example, we can see that for "NationalID", a 0 status has been returned - indicating that we have a full match on that individual's identity. For the "Watchlist AML" datasource, we can see a 2 status has been returned - meaning that no match could be found for that individual on the AML Watchlist (and relevant PEPs and Sanctions lists). 


{
    "reportingReference": "DZ-KWU-000000001037753",
    "safeHarbour": true,
    "nationalId": {
        "status": 0,
        "verified": true,
        "safeHarbourScore": "M2",
        "fullName": "王德玉",
        "gender": "Male",
        "dateOfBirth": "1961-10-25",
        "idCardNo": "370203XXXXXXXXXXXX",
        "address": "山东省青岛市市北区",
        "fields": {
            "dateOfBirth": "True",
            "idCardNo": "True"
        }
    },
    "watchlistAML": [
        {
            "status": 2,
            "verified": false,
            "safeHarbourScore": "None"
        }
    ]
}