Documentation

Import Using Multiple KVPs

Suggest Edits

The KVP keys are check.<index>.<attribute> where starts at zero and increases monotonically for each additional check result to be imported. When check results are provided in this way FrankieOne will convert them to the single KVP format (see below) and add that to the CHECK_RESULTS document but leave the original multiple KVPs.

Example with two addresses and the second (index 1) having a check result, plus one name check result.

{
    "addresses": [
        {
            "country": "AUS",
            "addressType": "RESIDENTIAL1"
        },
        {
            "country": "AUS",
            "addressType": "RESIDENTIAL2"
        }
    ],
    "identityDocs": [
        {
            "extraData": [
                {
                    "kvpKey": "check.0.type",
                    "kvpValue": "name"
                },
                {
                    "kvpKey": "check.0.source",
                    "kvpValue": "foo"
                },
                {
                    "kvpKey": "check.1.type",
                    "kvpValue": "address"
                },
                {
                    "kvpKey": "check.1.source",
                    "kvpValue": "bar"
                },
                {
                    "kvpKey": "check.1.index",
                    "kvpValue": "1"
                }
            ],
            "idType": "CHECK_RESULTS",
            "country": "AUS"
        }
    ],
    "dateOfBirth": {
        "dateOfBirth": "1920-01-02",
        "yearOfBirth": "1920"
    },
    "name": {
        "displayName": "John Smith"
    }
}

Updated 6 months ago

What’s Next