Documentation

Forcing Errors in Test Scenarios

Suggest Edits

The easiest way to do this is to choose a record from the test data, then supply incorrect data.

Failed Credit Header

To assist you in testing the credit header failures that may happen. We’ve provided a way to simulate a mismatch by entering the name of the credit bureau as the street name. eg. “77 Experian Street Melbourne, VIC 3000, Australia“.

Please see below the Sample JSON payload that can be used in the Demo or UAT environment.

Set the street name to one of:

  • Equifax
  • Experian
    This will force the service to return a failed credit header source with the chosen bureau.
{
    "entity": {
        "entityProfile": "default",
        "entityType": "INDIVIDUAL",
        "name": {
            "familyName": "KINSELLA",
            "middleName": "JOHN",
            "givenName": "ERIC"
        },
        "dateOfBirth": {
            "dateOfBirth": "1952-02-28"
        },
        "addresses": [
            {
                "addressType": "RESIDENTIAL1",
                "country": "AUS",
                "streetNumber": "17",
                "streetName": "Experian",
                "streetType": "STREET",
                "suburb": "",
                "town": "ELLIOT",
                "region": "",
                "state": "VIC",
                "postalCode": "3104"
            }
        ],
        "extraData": [
            {
                "kvpKey": "consent.general",
                "kvpValue": "true",
                "kvpType": "general.bool"
            },
            {
                "kvpKey": "consent.docs",
                "kvpValue": "true",
                "kvpType": "general.bool"
            },
            {
                "kvpKey": "consent.creditheader",
                "kvpValue": "true",
                "kvpType": "general.bool"
            },
            {
                "kvpKey": "customer_reference",
                "kvpValue": "20210531_2020",
                "kvpType": "id.external"
            }
        ],
        "identityDocs": [
            {
                "country": "AUS",
                "idType": "DRIVERS_LICENCE",
                "idNumber": "028021259",
                "region": "VIC"
                
            }
        ]
    }
}

Fail Non-ID Checks

You may wish to force fail all but ID checks. This can be useful if you're trying to test scenarios where someone will pass just using IDs.

You can do this by setting the middle name to FailNonID. This will force the test service to only evaluate ID details.

{
    "entity": {
        "entityProfile": "default",
        "entityType": "INDIVIDUAL",
        "name": {
            "familyName": "KINSELLA",
            "middleName": "FailNonID",
            "givenName": "ERIC"
        },
        "dateOfBirth": {
            "dateOfBirth": "1952-02-28"
        },
        "addresses": [
            {
                "addressType": "RESIDENTIAL1",
                "country": "AUS",
                "streetNumber": "17",
                "streetName": "Experian",
                "streetType": "STREET",
                "suburb": "",
                "town": "ELLIOT",
                "region": "",
                "state": "VIC",
                "postalCode": "3104"
            }
        ],
        "extraData": [
            {
                "kvpKey": "consent.general",
                "kvpValue": "true",
                "kvpType": "general.bool"
            },
            {
                "kvpKey": "consent.docs",
                "kvpValue": "true",
                "kvpType": "general.bool"
            },
            {
                "kvpKey": "consent.creditheader",
                "kvpValue": "true",
                "kvpType": "general.bool"
            },
            {
                "kvpKey": "customer_reference",
                "kvpValue": "20210531_2020",
                "kvpType": "id.external"
            }
        ],
        "identityDocs": [
            {
                "country": "AUS",
                "idType": "DRIVERS_LICENCE",
                "idNumber": "028021259",
                "region": "VIC"
                
            }
        ]
    }
}

🚧

Don't forget the details...

You will need to ensure that the rest of the details normally verified with the ID (such as name, DoB, and the ID details) are in fact, correct for this to work as anticipated.

Updated about 1 year ago