Update Entity and Verify Details

v1.0.0

Take the details and documents provided in the entity, and set about verifying them all. So for example, you might extract:

The name from the entity.name object
The address from the entity.address object
The DoB..

All documents that are presently attached to the entity will also be verified (if requested)

You can also specify the level of detail returned using the resultLevel parameter. You can choose "summary" or "full". For the "profile" check type you can also select "simple" to only get the entity profile result.

SPECIAL NOTE: A "Full" response includes details of all checks and how they map against each element, along with all the details of pep/sanctions/etc checks too.

Your account also needs to be configured to support a full response too (talk to your account manager for more information). If you're not configured for full responses, we'll only return summary level data regardless.

Input

{
  "type": "object",
  "properties": {
    "X-Frankie-Background": {
      "type": "string"
    },
    "X-Frankie-CustomerChildID": {
      "type": "string"
    },
    "X-Frankie-CustomerID": {
      "type": "string"
    },
    "checkType": {
      "type": "string"
    },
    "entityId": {
      "type": "string"
    },
    "force": {
      "type": "string"
    },
    "noInvalidate": {
      "type": "string"
    },
    "resultLevel": {
      "type": "string"
    }
  },
  "required": [
    "X-Frankie-CustomerID",
    "checkType",
    "entityId",
    "resultLevel"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "additionalProperties": true
}