Skip to main content
POST
/
entity
/
{entityId}
/
evaluate
Update Entity and evaluate current results and risk without running any new checks
curl --request POST \
  --url https://api.uat.frankie.one/compliance/v1.2/entity/{entityId}/evaluate \
  --header 'Content-Type: application/json' \
  --header 'X-Frankie-CustomerID: <x-frankie-customerid>' \
  --header 'api_key: <api-key>' \
  --data '
{
  "entity": {
    "addresses": [
      {
        "country": "AUS",
        "addressId": "86932629-bdb4-158f-e670-741e89ff78ba",
        "addressType": "REGISTERED_OFFICE",
        "buildingName": "Highland Tower",
        "careOf": "<string>",
        "endDate": "0001-01-01",
        "extraData": [
          {
            "kvpKey": "ACN",
            "kvpType": "id.external",
            "kvpValue": "406655338"
          }
        ],
        "longForm": "42a Test Eagle Road, Testville, TST 123-TST, Testalia",
        "postalCode": "3000",
        "region": "MELBOURNE",
        "startDate": "2023-03-10",
        "state": "VIC",
        "streetName": "9 ROYCE AVENUE",
        "streetNumber": "FLAT 27",
        "streetType": "Road",
        "suburb": "Testburb",
        "town": "MELBOURNE",
        "unitNumber": "FLAT 27",
        "unstructuredLongForm": "<string>"
      }
    ],
    "dateOfBirth": {
      "country": "AUS",
      "dateOfBirth": "1978-11-12",
      "locality": "Brisbane",
      "unstructuredDateOfBirth": "<string>",
      "yearOfBirth": "1978"
    },
    "entityId": "84a9a860-68ae-4d7d-9a53-54a1116d5051",
    "entityProfile": "<string>",
    "entityType": "ORGANISATION",
    "extraData": [
      {
        "kvpKey": "ACN",
        "kvpType": "id.external",
        "kvpValue": "406655338"
      }
    ],
    "flags": [
      {
        "flag": "<string>",
        "value": 123
      }
    ],
    "gender": "F",
    "identityDocs": [
      {
        "country": "AUS",
        "idType": "DRIVERS_LICENCE",
        "docScan": [
          {
            "ScanDelete": true,
            "scanCreated": "2020-06-02",
            "scanData": "VGhpcyBpcyBzb21lIGV4YW1wbGUgZGF0YS4gV29vLCBJIGJldCB5b3UgcmVncmV0IHRoZSB0aW1lIHlvdSB3YXN0ZWQgZGVjb2RpbmcgdGhpcywgaHVoPw==",
            "scanDataRetrievalState": "NORMAL",
            "scanDocId": "84a9a860-68ae-4d7d-9a53-54a1116d5051",
            "scanFilename": "Important Document - ID1234567.pdf",
            "scanMIME": "image/png",
            "scanPageNum": 1,
            "scanSide": "F",
            "scanType": "PDF"
          }
        ],
        "documentId": "84a9a860-68ae-4d7d-9a53-54a1116d5051",
        "documentStatus": "DOC_SCANNED",
        "extraData": [
          {
            "kvpKey": "ACN",
            "kvpType": "id.external",
            "kvpValue": "406655338"
          }
        ],
        "idExpiry": "2020-02-01",
        "idIssued": "1972-11-04",
        "idNumber": "123456789",
        "idSubType": "<string>",
        "region": "VIC"
      }
    ],
    "name": {
      "familyName": "Smith",
      "displayName": "Jane Cecily Smith",
      "givenName": "Jane",
      "honourific": "Duchess",
      "middleName": "Cecily"
    },
    "organisationData": {
      "adverseCreditDataPresent": true,
      "aliases": [
        "<string>"
      ],
      "class": {
        "code": "<string>",
        "description": "<string>"
      },
      "contactDetails": {
        "email": "<string>",
        "faxNumber": "<string>",
        "telephoneNumber": "<string>",
        "websiteURL": "<string>"
      },
      "disclosingEntityIndicator": true,
      "extractedDate": "2023-12-25",
      "includesNonBeneficiallyHeld": true,
      "industryCodes": [
        {
          "code": "<string>",
          "description": "<string>"
        }
      ],
      "industryDeclarations": [
        {
          "description": "<string>",
          "language": "<string>"
        }
      ],
      "kycCustomerType": "<string>",
      "lastCheckDate": "2023-12-25",
      "legalFormDetails": {
        "basis": "<string>",
        "capital": "<string>",
        "comments": "<string>",
        "control": "<string>",
        "incorp": "<string>",
        "partner": "<string>",
        "responsibility": "<string>",
        "stocks": "<string>"
      },
      "normalisedLegalStatus": "<string>",
      "ownershipResolved": true,
      "registeredName": "<string>",
      "registration": {
        "countryIso": "<string>",
        "date": "2023-12-25",
        "number": "<string>",
        "previousNumber": "<string>",
        "registryCode": "<string>",
        "registryDescription": "<string>",
        "state": "<string>",
        "unstructuredDate": "<string>",
        "unstructuredFoundationDate": "<string>"
      },
      "registries": {
        "abr": {
          "abn": "<string>",
          "acn": "<string>",
          "addresses": [
            {
              "effectiveFrom": "2023-11-07T05:31:56Z",
              "effectiveTo": "2023-11-07T05:31:56Z",
              "postcode": "<string>",
              "stateCode": "<string>"
            }
          ],
          "businessNames": [
            {
              "effectiveFrom": "2023-11-07T05:31:56Z",
              "effectiveTo": "2023-11-07T05:31:56Z",
              "name": "<string>",
              "type": "<string>"
            }
          ],
          "charityEndorsements": [
            {
              "effectiveFrom": "2023-11-07T05:31:56Z",
              "effectiveTo": "2023-11-07T05:31:56Z",
              "type": "<string>"
            }
          ],
          "charityTypes": [
            {
              "description": "<string>",
              "effectiveFrom": "2023-11-07T05:31:56Z",
              "effectiveTo": "2023-11-07T05:31:56Z"
            }
          ],
          "description": "<string>",
          "dgrEndorsements": [
            {
              "endorsedFrom": "2023-11-07T05:31:56Z",
              "endorsedTo": "2023-11-07T05:31:56Z"
            }
          ],
          "gst": [
            {
              "effectiveFrom": "2023-11-07T05:31:56Z",
              "effectiveTo": "2023-11-07T05:31:56Z"
            }
          ],
          "historicalChanges": [
            {
              "businessName": [
                "<string>"
              ],
              "date": "2023-11-07T05:31:56Z",
              "entityStatus": [
                "<string>"
              ],
              "goodsAndServicesTax": [
                "<string>"
              ],
              "mainBusinessPhysicalAddress": [
                "<string>"
              ],
              "mainName": [
                "<string>"
              ],
              "mainTradingName": [
                "<string>"
              ]
            }
          ],
          "lastUpdated": "2023-11-07T05:31:56Z",
          "name": "<string>",
          "registeredDate": "2023-11-07T05:31:56Z",
          "status": "<string>",
          "statusEffectiveFrom": "<string>",
          "type": "<string>",
          "typeCode": "<string>",
          "updatedDate": "2023-11-07T05:31:56Z"
        }
      },
      "reviewDate": "2023-12-25",
      "shareStructure": [
        {
          "amountDue": 123,
          "amountPaid": 123,
          "classCode": "<string>",
          "classTitle": "<string>",
          "docNumber": "<string>",
          "docNumberQualifier": "<string>",
          "sharesIssued": 123,
          "status": "<string>"
        }
      ],
      "startDate": "2023-12-25",
      "status": {
        "code": "<string>",
        "description": "<string>"
      },
      "subType": {
        "code": "<string>",
        "description": "<string>"
      },
      "subclass": {
        "code": "<string>",
        "description": "<string>"
      },
      "type": {
        "code": "<string>",
        "description": "<string>"
      }
    }
  },
  "deviceCheckDetails": {
    "activityType": "<string>",
    "additionalData": [
      {
        "kvpKey": "ACN",
        "kvpType": "id.external",
        "kvpValue": "406655338"
      }
    ],
    "checkSessionKey": "<string>"
  }
}
'
{
  "blacklistCheckResults": [
    {
      "checkDate": "2023-11-07T05:31:56Z",
      "checkId": "54a1116d-68ae-4d7d-9a53-505184a9a860",
      "checkPerformedBy": "dvs",
      "checkSource": "DVS",
      "checkType": "<string>",
      "confidenceLevel": 70,
      "providerCheckID": "<string>",
      "resultNotes": [
        {
          "kvpKey": "ACN",
          "kvpType": "id.external",
          "kvpValue": "406655338"
        }
      ],
      "resultState": "CHECKED_PARTIAL_SUCCESS",
      "riskLevel": 75
    }
  ],
  "checkResultsListSummaries": [
    {
      "checkDate": "2023-11-07T05:31:56Z",
      "checkId": "54a1116d-68ae-4d7d-9a53-505184a9a860",
      "checkPerformedBy": "dvs",
      "checkSource": "DVS",
      "checkType": "<string>",
      "confidenceLevel": 70,
      "providerCheckID": "<string>",
      "resultNotes": [
        {
          "kvpKey": "ACN",
          "kvpType": "id.external",
          "kvpValue": "406655338"
        }
      ],
      "resultState": "CHECKED_PARTIAL_SUCCESS",
      "riskLevel": 75
    }
  ],
  "checkRisk": {
    "checkDate": "2023-11-07T05:31:56Z",
    "checkId": "54a1116d-68ae-4d7d-9a53-505184a9a860",
    "checkPerformedBy": "dvs",
    "checkSource": "DVS",
    "checkType": "<string>",
    "confidenceLevel": 70,
    "providerCheckID": "<string>",
    "resultNotes": [
      {
        "kvpKey": "ACN",
        "kvpType": "id.external",
        "kvpValue": "406655338"
      }
    ],
    "resultState": "CHECKED_PARTIAL_SUCCESS",
    "riskLevel": 75
  },
  "checkSummary": {
    "checkDate": "2023-11-07T05:31:56Z",
    "checkId": "54a1116d-68ae-4d7d-9a53-505184a9a860",
    "checkPerformedBy": "dvs",
    "checkSource": "DVS",
    "checkType": "<string>",
    "confidenceLevel": 70,
    "providerCheckID": "<string>",
    "resultNotes": [
      {
        "kvpKey": "ACN",
        "kvpType": "id.external",
        "kvpValue": "406655338"
      }
    ],
    "resultState": "CHECKED_PARTIAL_SUCCESS",
    "riskLevel": 75
  },
  "duplicateCheckResults": [
    {
      "checkDate": "2023-11-07T05:31:56Z",
      "checkId": "54a1116d-68ae-4d7d-9a53-505184a9a860",
      "checkPerformedBy": "dvs",
      "checkSource": "DVS",
      "checkType": "<string>",
      "confidenceLevel": 70,
      "providerCheckID": "<string>",
      "resultNotes": [
        {
          "kvpKey": "ACN",
          "kvpType": "id.external",
          "kvpValue": "406655338"
        }
      ],
      "resultState": "CHECKED_PARTIAL_SUCCESS",
      "riskLevel": 75
    }
  ],
  "entity": {
    "addresses": [
      {
        "country": "AUS",
        "addressId": "86932629-bdb4-158f-e670-741e89ff78ba",
        "addressType": "REGISTERED_OFFICE",
        "buildingName": "Highland Tower",
        "careOf": "<string>",
        "endDate": "0001-01-01",
        "extraData": [
          {
            "kvpKey": "ACN",
            "kvpType": "id.external",
            "kvpValue": "406655338"
          }
        ],
        "longForm": "42a Test Eagle Road, Testville, TST 123-TST, Testalia",
        "postalCode": "3000",
        "region": "MELBOURNE",
        "startDate": "2023-03-10",
        "state": "VIC",
        "streetName": "9 ROYCE AVENUE",
        "streetNumber": "FLAT 27",
        "streetType": "Road",
        "suburb": "Testburb",
        "town": "MELBOURNE",
        "unitNumber": "FLAT 27",
        "unstructuredLongForm": "<string>"
      }
    ],
    "dateOfBirth": {
      "country": "AUS",
      "dateOfBirth": "1978-11-12",
      "locality": "Brisbane",
      "unstructuredDateOfBirth": "<string>",
      "yearOfBirth": "1978"
    },
    "entityId": "84a9a860-68ae-4d7d-9a53-54a1116d5051",
    "entityProfile": "<string>",
    "entityType": "ORGANISATION",
    "extraData": [
      {
        "kvpKey": "ACN",
        "kvpType": "id.external",
        "kvpValue": "406655338"
      }
    ],
    "flags": [
      {
        "flag": "<string>",
        "value": 123
      }
    ],
    "gender": "F",
    "identityDocs": [
      {
        "country": "AUS",
        "idType": "DRIVERS_LICENCE",
        "createdFromScan": true,
        "docScan": [
          {
            "ScanDelete": true,
            "scanCreated": "2020-06-02",
            "scanData": "VGhpcyBpcyBzb21lIGV4YW1wbGUgZGF0YS4gV29vLCBJIGJldCB5b3UgcmVncmV0IHRoZSB0aW1lIHlvdSB3YXN0ZWQgZGVjb2RpbmcgdGhpcywgaHVoPw==",
            "scanDataRetrievalState": "NORMAL",
            "scanDocId": "84a9a860-68ae-4d7d-9a53-54a1116d5051",
            "scanFilename": "Important Document - ID1234567.pdf",
            "scanMIME": "image/png",
            "scanPageNum": 1,
            "scanSide": "F",
            "scanType": "PDF"
          }
        ],
        "documentId": "84a9a860-68ae-4d7d-9a53-54a1116d5051",
        "documentStatus": "DOC_SCANNED",
        "extraData": [
          {
            "kvpKey": "ACN",
            "kvpType": "id.external",
            "kvpValue": "406655338"
          }
        ],
        "idExpiry": "2020-02-01",
        "idIssued": "1972-11-04",
        "idNumber": "123456789",
        "idSubType": "<string>",
        "manuallyModified": "false",
        "region": "VIC"
      }
    ],
    "name": {
      "familyName": "Smith",
      "displayName": "Jane Cecily Smith",
      "givenName": "Jane",
      "honourific": "Duchess",
      "middleName": "Cecily"
    },
    "organisationData": {
      "adverseCreditDataPresent": true,
      "aliases": [
        "<string>"
      ],
      "class": {
        "code": "<string>",
        "description": "<string>"
      },
      "contactDetails": {
        "email": "<string>",
        "faxNumber": "<string>",
        "telephoneNumber": "<string>",
        "websiteURL": "<string>"
      },
      "disclosingEntityIndicator": true,
      "extractedDate": "2023-12-25",
      "includesNonBeneficiallyHeld": true,
      "industryCodes": [
        {
          "code": "<string>",
          "description": "<string>"
        }
      ],
      "industryDeclarations": [
        {
          "description": "<string>",
          "language": "<string>"
        }
      ],
      "kycCustomerType": "<string>",
      "lastCheckDate": "2023-12-25",
      "legalFormDetails": {
        "basis": "<string>",
        "capital": "<string>",
        "comments": "<string>",
        "control": "<string>",
        "incorp": "<string>",
        "partner": "<string>",
        "responsibility": "<string>",
        "stocks": "<string>"
      },
      "normalisedLegalStatus": "<string>",
      "ownershipResolved": true,
      "registeredName": "<string>",
      "registration": {
        "countryIso": "<string>",
        "date": "2023-12-25",
        "number": "<string>",
        "previousNumber": "<string>",
        "registryCode": "<string>",
        "registryDescription": "<string>",
        "state": "<string>",
        "unstructuredDate": "<string>",
        "unstructuredFoundationDate": "<string>"
      },
      "registries": {
        "abr": {
          "abn": "<string>",
          "acn": "<string>",
          "addresses": [
            {
              "effectiveFrom": "2023-11-07T05:31:56Z",
              "effectiveTo": "2023-11-07T05:31:56Z",
              "postcode": "<string>",
              "stateCode": "<string>"
            }
          ],
          "businessNames": [
            {
              "effectiveFrom": "2023-11-07T05:31:56Z",
              "effectiveTo": "2023-11-07T05:31:56Z",
              "name": "<string>",
              "type": "<string>"
            }
          ],
          "charityEndorsements": [
            {
              "effectiveFrom": "2023-11-07T05:31:56Z",
              "effectiveTo": "2023-11-07T05:31:56Z",
              "type": "<string>"
            }
          ],
          "charityTypes": [
            {
              "description": "<string>",
              "effectiveFrom": "2023-11-07T05:31:56Z",
              "effectiveTo": "2023-11-07T05:31:56Z"
            }
          ],
          "description": "<string>",
          "dgrEndorsements": [
            {
              "endorsedFrom": "2023-11-07T05:31:56Z",
              "endorsedTo": "2023-11-07T05:31:56Z"
            }
          ],
          "gst": [
            {
              "effectiveFrom": "2023-11-07T05:31:56Z",
              "effectiveTo": "2023-11-07T05:31:56Z"
            }
          ],
          "historicalChanges": [
            {
              "businessName": [
                "<string>"
              ],
              "date": "2023-11-07T05:31:56Z",
              "entityStatus": [
                "<string>"
              ],
              "goodsAndServicesTax": [
                "<string>"
              ],
              "mainBusinessPhysicalAddress": [
                "<string>"
              ],
              "mainName": [
                "<string>"
              ],
              "mainTradingName": [
                "<string>"
              ]
            }
          ],
          "lastUpdated": "2023-11-07T05:31:56Z",
          "name": "<string>",
          "registeredDate": "2023-11-07T05:31:56Z",
          "status": "<string>",
          "statusEffectiveFrom": "<string>",
          "type": "<string>",
          "typeCode": "<string>",
          "updatedDate": "2023-11-07T05:31:56Z"
        }
      },
      "reviewDate": "2023-12-25",
      "shareStructure": [
        {
          "amountDue": 123,
          "amountPaid": 123,
          "classCode": "<string>",
          "classTitle": "<string>",
          "docNumber": "<string>",
          "docNumberQualifier": "<string>",
          "sharesIssued": 123,
          "status": "<string>"
        }
      ],
      "startDate": "2023-12-25",
      "status": {
        "code": "<string>",
        "description": "<string>"
      },
      "subType": {
        "code": "<string>",
        "description": "<string>"
      },
      "subclass": {
        "code": "<string>",
        "description": "<string>"
      },
      "type": {
        "code": "<string>",
        "description": "<string>"
      }
    }
  },
  "entityProfileResult": {
    "actionRecommended": "<string>",
    "addressResults": {},
    "alternativeKycResults": [
      {
        "description": "<string>",
        "kycResults": [
          {
            "matchCount": 2,
            "matchCountRequired": 1,
            "matchTypes": {},
            "verified": false
          }
        ],
        "name": "<string>",
        "order": 123,
        "result": "<string>"
      }
    ],
    "checkId": "54a1116d-68ae-4d7d-9a53-505184a9a860",
    "checkResults": [
      {
        "checkClass": "kyc",
        "checkType": "one_plus",
        "code": "<string>",
        "message": "Partial match",
        "name": "1+1",
        "result": "<string>"
      }
    ],
    "checkType": "two_plus,id,pep_media",
    "creditHeaderFailures": [
      "<string>"
    ],
    "documentResults": {},
    "entityId": "84a9a860-68ae-4d7d-9a53-54a1116d5051",
    "issueList": [
      "<string>"
    ],
    "kycResults": [
      {
        "matchCount": 2,
        "matchCountRequired": 1,
        "matchTypes": {},
        "verified": false
      }
    ],
    "latestCheckDate": "2018-11-12T13:14:15Z+10:00",
    "manualIntervention": true,
    "policyName": "SDD U18",
    "profileName": "Credit",
    "resolverRecommended": "<string>",
    "riskLevel": "LOW",
    "riskPolicy": "SDD"
  },
  "entityResult": {
    "addressesCheck": [
      {
        "address": {
          "country": "AUS",
          "addressId": "86932629-bdb4-158f-e670-741e89ff78ba",
          "addressType": "REGISTERED_OFFICE",
          "buildingName": "Highland Tower",
          "careOf": "<string>",
          "endDate": "0001-01-01",
          "extraData": [
            {
              "kvpKey": "ACN",
              "kvpType": "id.external",
              "kvpValue": "406655338"
            }
          ],
          "longForm": "42a Test Eagle Road, Testville, TST 123-TST, Testalia",
          "postalCode": "3000",
          "region": "MELBOURNE",
          "startDate": "2023-03-10",
          "state": "VIC",
          "streetName": "9 ROYCE AVENUE",
          "streetNumber": "FLAT 27",
          "streetType": "Road",
          "suburb": "Testburb",
          "town": "MELBOURNE",
          "unitNumber": "FLAT 27",
          "unstructuredLongForm": "<string>"
        },
        "checkResult": [
          {
            "checkProcessResults": {
              "checkDate": "2023-11-07T05:31:56Z",
              "checkId": "54a1116d-68ae-4d7d-9a53-505184a9a860",
              "checkPerformedBy": "dvs",
              "checkSource": "DVS",
              "checkType": "<string>",
              "confidenceLevel": 70,
              "providerCheckID": "<string>",
              "resultNotes": [
                {
                  "kvpKey": "ACN",
                  "kvpType": "id.external",
                  "kvpValue": "406655338"
                }
              ],
              "resultState": "CHECKED_PARTIAL_SUCCESS",
              "riskLevel": 75
            },
            "checkRequestedBy": "Bank"
          }
        ]
      }
    ],
    "adverseMediaCheck": [
      {
        "backgroundCheckType": "PEP",
        "checkDetails": [
          {
            "kvpKey": "ACN",
            "kvpType": "id.external",
            "kvpValue": "406655338"
          }
        ],
        "checkFrequency": "DAILY",
        "checkId": "54a1116d-68ae-4d7d-9a53-505184a9a860",
        "checkPerformedBy": "dvs",
        "checkSource": "DVS",
        "confidenceLevel": 70,
        "currentState": "CLEAR",
        "firstCheckDate": "2017-11-12T13:14:15Z+10:00",
        "latestCheckDate": "2018-11-12T13:14:15Z+10:00"
      }
    ],
    "amlResultSets": [
      {
        "checkResultsListMedia": [
          {
            "bcro": {
              "backgroundCheckType": "PEP",
              "checkDetails": [
                {
                  "kvpKey": "ACN",
                  "kvpType": "id.external",
                  "kvpValue": "406655338"
                }
              ],
              "checkFrequency": "DAILY",
              "checkId": "54a1116d-68ae-4d7d-9a53-505184a9a860",
              "checkPerformedBy": "dvs",
              "checkSource": "DVS",
              "confidenceLevel": 70,
              "currentState": "CLEAR",
              "firstCheckDate": "2017-11-12T13:14:15Z+10:00",
              "latestCheckDate": "2018-11-12T13:14:15Z+10:00"
            },
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        ],
        "checkResultsListPEP": [
          {
            "bcro": {
              "backgroundCheckType": "PEP",
              "checkDetails": [
                {
                  "kvpKey": "ACN",
                  "kvpType": "id.external",
                  "kvpValue": "406655338"
                }
              ],
              "checkFrequency": "DAILY",
              "checkId": "54a1116d-68ae-4d7d-9a53-505184a9a860",
              "checkPerformedBy": "dvs",
              "checkSource": "DVS",
              "confidenceLevel": 70,
              "currentState": "CLEAR",
              "firstCheckDate": "2017-11-12T13:14:15Z+10:00",
              "latestCheckDate": "2018-11-12T13:14:15Z+10:00"
            },
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        ],
        "checkResultsListSanctions": [
          {
            "bcro": {
              "backgroundCheckType": "PEP",
              "checkDetails": [
                {
                  "kvpKey": "ACN",
                  "kvpType": "id.external",
                  "kvpValue": "406655338"
                }
              ],
              "checkFrequency": "DAILY",
              "checkId": "54a1116d-68ae-4d7d-9a53-505184a9a860",
              "checkPerformedBy": "dvs",
              "checkSource": "DVS",
              "confidenceLevel": 70,
              "currentState": "CLEAR",
              "firstCheckDate": "2017-11-12T13:14:15Z+10:00",
              "latestCheckDate": "2018-11-12T13:14:15Z+10:00"
            },
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        ],
        "checkResultsListWatchlists": [
          {
            "bcro": {
              "backgroundCheckType": "PEP",
              "checkDetails": [
                {
                  "kvpKey": "ACN",
                  "kvpType": "id.external",
                  "kvpValue": "406655338"
                }
              ],
              "checkFrequency": "DAILY",
              "checkId": "54a1116d-68ae-4d7d-9a53-505184a9a860",
              "checkPerformedBy": "dvs",
              "checkSource": "DVS",
              "confidenceLevel": 70,
              "currentState": "CLEAR",
              "firstCheckDate": "2017-11-12T13:14:15Z+10:00",
              "latestCheckDate": "2018-11-12T13:14:15Z+10:00"
            },
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        ],
        "groupDetails": {
          "bcro": {
            "backgroundCheckType": "PEP",
            "checkDetails": [
              {
                "kvpKey": "ACN",
                "kvpType": "id.external",
                "kvpValue": "406655338"
              }
            ],
            "checkFrequency": "DAILY",
            "checkId": "54a1116d-68ae-4d7d-9a53-505184a9a860",
            "checkPerformedBy": "dvs",
            "checkSource": "DVS",
            "confidenceLevel": 70,
            "currentState": "CLEAR",
            "firstCheckDate": "2017-11-12T13:14:15Z+10:00",
            "latestCheckDate": "2018-11-12T13:14:15Z+10:00"
          },
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      }
    ],
    "dateOfBirthCheck": {
      "checkResult": [
        {
          "checkProcessResults": {
            "checkDate": "2023-11-07T05:31:56Z",
            "checkId": "54a1116d-68ae-4d7d-9a53-505184a9a860",
            "checkPerformedBy": "dvs",
            "checkSource": "DVS",
            "checkType": "<string>",
            "confidenceLevel": 70,
            "providerCheckID": "<string>",
            "resultNotes": [
              {
                "kvpKey": "ACN",
                "kvpType": "id.external",
                "kvpValue": "406655338"
              }
            ],
            "resultState": "CHECKED_PARTIAL_SUCCESS",
            "riskLevel": 75
          },
          "checkRequestedBy": "Bank"
        }
      ],
      "dob": {
        "country": "AUS",
        "dateOfBirth": "1978-11-12",
        "locality": "Brisbane",
        "unstructuredDateOfBirth": "<string>",
        "yearOfBirth": "1978"
      }
    },
    "entityId": "84a9a860-68ae-4d7d-9a53-54a1116d5051",
    "genderCheck": {
      "checkResult": [
        {
          "checkProcessResults": {
            "checkDate": "2023-11-07T05:31:56Z",
            "checkId": "54a1116d-68ae-4d7d-9a53-505184a9a860",
            "checkPerformedBy": "dvs",
            "checkSource": "DVS",
            "checkType": "<string>",
            "confidenceLevel": 70,
            "providerCheckID": "<string>",
            "resultNotes": [
              {
                "kvpKey": "ACN",
                "kvpType": "id.external",
                "kvpValue": "406655338"
              }
            ],
            "resultState": "CHECKED_PARTIAL_SUCCESS",
            "riskLevel": 75
          },
          "checkRequestedBy": "Bank"
        }
      ],
      "gender": "F"
    },
    "identityDocsCheck": [
      {
        "checkResult": [
          {
            "checkProcessResults": {
              "checkDate": "2023-11-07T05:31:56Z",
              "checkId": "54a1116d-68ae-4d7d-9a53-505184a9a860",
              "checkPerformedBy": "dvs",
              "checkSource": "DVS",
              "checkType": "<string>",
              "confidenceLevel": 70,
              "providerCheckID": "<string>",
              "resultNotes": [
                {
                  "kvpKey": "ACN",
                  "kvpType": "id.external",
                  "kvpValue": "406655338"
                }
              ],
              "resultState": "CHECKED_PARTIAL_SUCCESS",
              "riskLevel": 75
            },
            "checkRequestedBy": "Bank"
          }
        ],
        "idDocument": {
          "country": "AUS",
          "idType": "DRIVERS_LICENCE",
          "createdFromScan": true,
          "docScan": [
            {
              "ScanDelete": true,
              "scanCreated": "2020-06-02",
              "scanData": "VGhpcyBpcyBzb21lIGV4YW1wbGUgZGF0YS4gV29vLCBJIGJldCB5b3UgcmVncmV0IHRoZSB0aW1lIHlvdSB3YXN0ZWQgZGVjb2RpbmcgdGhpcywgaHVoPw==",
              "scanDataRetrievalState": "NORMAL",
              "scanDocId": "84a9a860-68ae-4d7d-9a53-54a1116d5051",
              "scanFilename": "Important Document - ID1234567.pdf",
              "scanMIME": "image/png",
              "scanPageNum": 1,
              "scanSide": "F",
              "scanType": "PDF"
            }
          ],
          "documentId": "84a9a860-68ae-4d7d-9a53-54a1116d5051",
          "documentStatus": "DOC_SCANNED",
          "extraData": [
            {
              "kvpKey": "ACN",
              "kvpType": "id.external",
              "kvpValue": "406655338"
            }
          ],
          "idExpiry": "2020-02-01",
          "idIssued": "1972-11-04",
          "idNumber": "123456789",
          "idSubType": "<string>",
          "manuallyModified": "false",
          "region": "VIC"
        }
      }
    ],
    "nameCheck": {
      "checkResult": [
        {
          "checkProcessResults": {
            "checkDate": "2023-11-07T05:31:56Z",
            "checkId": "54a1116d-68ae-4d7d-9a53-505184a9a860",
            "checkPerformedBy": "dvs",
            "checkSource": "DVS",
            "checkType": "<string>",
            "confidenceLevel": 70,
            "providerCheckID": "<string>",
            "resultNotes": [
              {
                "kvpKey": "ACN",
                "kvpType": "id.external",
                "kvpValue": "406655338"
              }
            ],
            "resultState": "CHECKED_PARTIAL_SUCCESS",
            "riskLevel": 75
          },
          "checkRequestedBy": "Bank"
        }
      ],
      "name": {
        "familyName": "Smith",
        "displayName": "Jane Cecily Smith",
        "givenName": "Jane",
        "honourific": "Duchess",
        "middleName": "Cecily"
      }
    },
    "pepCheck": [
      {
        "backgroundCheckType": "PEP",
        "checkDetails": [
          {
            "kvpKey": "ACN",
            "kvpType": "id.external",
            "kvpValue": "406655338"
          }
        ],
        "checkFrequency": "DAILY",
        "checkId": "54a1116d-68ae-4d7d-9a53-505184a9a860",
        "checkPerformedBy": "dvs",
        "checkSource": "DVS",
        "confidenceLevel": 70,
        "currentState": "CLEAR",
        "firstCheckDate": "2017-11-12T13:14:15Z+10:00",
        "latestCheckDate": "2018-11-12T13:14:15Z+10:00"
      }
    ],
    "sanctionsCheck": [
      {
        "backgroundCheckType": "PEP",
        "checkDetails": [
          {
            "kvpKey": "ACN",
            "kvpType": "id.external",
            "kvpValue": "406655338"
          }
        ],
        "checkFrequency": "DAILY",
        "checkId": "54a1116d-68ae-4d7d-9a53-505184a9a860",
        "checkPerformedBy": "dvs",
        "checkSource": "DVS",
        "confidenceLevel": 70,
        "currentState": "CLEAR",
        "firstCheckDate": "2017-11-12T13:14:15Z+10:00",
        "latestCheckDate": "2018-11-12T13:14:15Z+10:00"
      }
    ],
    "watchlistCheck": [
      {
        "backgroundCheckType": "PEP",
        "checkDetails": [
          {
            "kvpKey": "ACN",
            "kvpType": "id.external",
            "kvpValue": "406655338"
          }
        ],
        "checkFrequency": "DAILY",
        "checkId": "54a1116d-68ae-4d7d-9a53-505184a9a860",
        "checkPerformedBy": "dvs",
        "checkSource": "DVS",
        "confidenceLevel": 70,
        "currentState": "CLEAR",
        "firstCheckDate": "2017-11-12T13:14:15Z+10:00",
        "latestCheckDate": "2018-11-12T13:14:15Z+10:00"
      }
    ]
  },
  "fraudCheckResults": {
    "fraudBackgroundCheckResults": [
      {
        "checkDate": "2023-11-07T05:31:56Z",
        "checkId": "54a1116d-68ae-4d7d-9a53-505184a9a860",
        "checkPerformedBy": "dvs",
        "checkSource": "DVS",
        "checkType": "<string>",
        "confidenceLevel": 70,
        "providerCheckID": "<string>",
        "resultNotes": [
          {
            "kvpKey": "ACN",
            "kvpType": "id.external",
            "kvpValue": "406655338"
          }
        ],
        "resultState": "CHECKED_PARTIAL_SUCCESS",
        "riskLevel": 75
      }
    ],
    "fraudDeviceResults": [
      {
        "checkDate": "2023-11-07T05:31:56Z",
        "checkId": "54a1116d-68ae-4d7d-9a53-505184a9a860",
        "checkPerformedBy": "dvs",
        "checkSource": "DVS",
        "checkType": "<string>",
        "confidenceLevel": 70,
        "providerCheckID": "<string>",
        "resultNotes": [
          {
            "kvpKey": "ACN",
            "kvpType": "id.external",
            "kvpValue": "406655338"
          }
        ],
        "resultState": "CHECKED_PARTIAL_SUCCESS",
        "riskLevel": 75
      }
    ],
    "fraudListResults": [
      {
        "checkDate": "2023-11-07T05:31:56Z",
        "checkId": "54a1116d-68ae-4d7d-9a53-505184a9a860",
        "checkPerformedBy": "dvs",
        "checkSource": "DVS",
        "checkType": "<string>",
        "confidenceLevel": 70,
        "providerCheckID": "<string>",
        "resultNotes": [
          {
            "kvpKey": "ACN",
            "kvpType": "id.external",
            "kvpValue": "406655338"
          }
        ],
        "resultState": "CHECKED_PARTIAL_SUCCESS",
        "riskLevel": 75
      }
    ]
  },
  "manualCheckResults": [
    {
      "checkDate": "2023-11-07T05:31:56Z",
      "checkId": "54a1116d-68ae-4d7d-9a53-505184a9a860",
      "checkPerformedBy": "dvs",
      "checkSource": "DVS",
      "checkType": "<string>",
      "confidenceLevel": 70,
      "providerCheckID": "<string>",
      "resultNotes": [
        {
          "kvpKey": "ACN",
          "kvpType": "id.external",
          "kvpValue": "406655338"
        }
      ],
      "resultState": "CHECKED_PARTIAL_SUCCESS",
      "riskLevel": 75
    }
  ],
  "requestId": "01BFJA617JMJXEW6G7TDDXNSHX",
  "sharedBlocklistCheckResults": [
    {
      "checkDate": "2023-11-07T05:31:56Z",
      "checkId": "54a1116d-68ae-4d7d-9a53-505184a9a860",
      "checkPerformedBy": "dvs",
      "checkSource": "DVS",
      "checkType": "<string>",
      "confidenceLevel": 70,
      "providerCheckID": "<string>",
      "resultNotes": [
        {
          "kvpKey": "ACN",
          "kvpType": "id.external",
          "kvpValue": "406655338"
        }
      ],
      "resultState": "CHECKED_PARTIAL_SUCCESS",
      "riskLevel": 75
    }
  ]
}

Authorizations

​
api_key
string
header
required

API key issued by Frankie Financial. This will rotate regularly.

Headers

​
X-Frankie-CustomerID
string<uuid>
required

Customer ID issued by Frankie Financial. This will never change. Your API key, which is mapped to this identity, will change over time.

​
X-Frankie-CustomerChildID
string<uuid>

If, as a Frankie Customer, you are acting on behalf of your own customers, then you can populate this field with a Frankie-assigned ID.

Note: If using a CustomerChildID, you will also need a separate api_key for each child.

Any documents, checks, entities that are created when this field has been populated will now be tied to this CustomerID + CustomerChildID combination. Just as Customers cannot see data created by other Customers, so too a Customer's Children will not be able to see each other's data.

A Customer can see the documents/entities and checks of all their Children.

​
X-Frankie-Background
integer

If this header parameter is supplied and set to 1, then the request will not wait for the process to finish, and will return a 202 if there are no obvious errors in the input. The request will then run in the background and send a notification back to the customer. See out callback API for details on this.

See more details here: https://docs.frankieone.com/docs/asynchronous-calls-backgrounding-processes

Required range: 0 <= x <= 1
​
X-Frankie-Channel
string

Open string that can be used to define the "channel" the request comes in from. It can potentially be used in routing and risk calculations upon request. Default values that can be used are:

  • api
  • portal
  • smartui

Any alphanumeric string is supported though. Anything over 64 characters will be truncated.

Path Parameters

​
entityId
string<uuid>
required

The entityId returned previously from an earlier call to /check or /entity

Query Parameters

​
noInvalidate
boolean

Disable check result invalidation for this update request.

​
noNotify
boolean

Disable notifications for this request.

Body

application/json

The entity details to be updated before evaluating the results

Contains all the details we'll check regarding an Entity. It is assumed that this will grow over time.

Current supported check parameters:

  • entity: The Entity we're checking. This must be supplied.
​
entity
object
required

Describes all of the data being used to verify an entity.

​
deviceCheckDetails
object

Contains any/all details we want to pass on to the device checking service as part of an activity / transaction. A transaction isn't just a payment, but can represent a number of different interaction types. See below for more.

NOTE: If you're sending this data, then your recipe or requested checkTypes MUST include a "device" checkType. Otherwise this data will be ignored and dropped.

Response

The request was valid and able to be processed in some fashion. Results may or may not be successful, but it was completed as far as practical with no actual errors. Returns the entity object as it stands now. No docScan file data from any attached ID documents will be returned unless the /full variant is requested.

Describes all of the checks that were carried out against an entity as part of our cascading check process. Because there are a number of steps involved in checking an entity, (including the use of past checks done by you or others), there is an overall summary check result that will tell you the final disposition of the the check you requested.

So if you requested a 2+2+governmentID+pep/sanctions/etc (i.e. everything) then there would have been several checks done in order to meet this requirement. Some may have even failed, but eventually we got there. The summary gives the final assessment, based on all available data.

Detailed writeups on how this all works can be found here: https://docs.frankieone.com/docs/understanding-check-results

​
blacklistCheckResults
object[]

Collection of check results for the entity having been previously blacklisted.

An array of matched blacklisted entities sorted by match confidence level (highest first).

​
checkResultsListSummaries
object[]

Contains a list of all checkSummary records (one for each check)

​
checkRisk
object

Stores the generic results of a process (check, scan, compare, verify, etc)

​
checkSummary
object

Stores the generic results of a process (check, scan, compare, verify, etc)

​
duplicateCheckResults
object[]

Collection of check results for the entity having previously been checked.

An array of matched checked entities sorted by match confidence level (highest first).

​
entity
object

Describes all of the data being used to verify an entity.

​
entityProfileResult
object

Contains the results of a check against an entity profile.

The entityProfileResult will be returned instead of a checkSummary to provide the full details of the verification process.

​
entityResult
object

This will hold all of the check results that were performed against the

​
fraudCheckResults
object

Collection of fraud check results for the entity.

Contains fraud list and/or background result arrays. Other fraud check types will appear over time

​
manualCheckResults
object[]

Collection of check results for the manual KYC.

An array of one entry with the manual check result.

​
requestId
string<ulid>

Unique identifier for every request. Can be used for tracking down answers with technical support.

Uses the ULID format (a time-based, sortable UUID)

Note: this will be different for every request.

Example:

"01BFJA617JMJXEW6G7TDDXNSHX"

​
sharedBlocklistCheckResults
object[]

Collection of check results for the entity having been previously blacklisted in shared blocklist.

An array of matched blacklisted entities sorted by match confidence level (highest first).