Verify customers

In FrankieOne your customers are represented by the Entity object. You can perform KYC, AML and fraud checks on a potential customer undergoing onboarding using the Create and Verify Entity API.

A potential customer must pass each of the checks specified, either explicitly or as part of the Entity Profile, as a minimum before their profile can reach a Passed status and they can open an account.

Create and verify a new entity

To create a new entity and immediately perform verification checks:

curl https://api.demo.frankiefinancial.io/compliance/v1.2/entity/new/verify/profile/full \
  -X POST \
  -d '{
    "entity": {
      "entityProfile": "safe_harbour",
      "entityType": "INDIVIDUAL",
      "name": {
        "familyName": "TESTFORTY",
        "middleName":"Z",
        "givenName": "STACY"
      },
      "dateOfBirth": {
        "dateOfBirth": "1989-01-01"
      },
      "addresses": [
        {
          "addressType": "RESIDENTIAL1",
          "country": "AUS",
          "postalCode": "7140",
          "state": "TAS",
          "unitNumber": "",
          "streetNumber": "9",
          "streetName": "THE AVENUE",
          "town": "ELLENDALE"
        }
      ],
      "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": "cust_001",
          "kvpType": "id.external"
        }
      ],
      "identityDocs": [
        {
          "country": "ESP",
          "idType": "PASSPORT",
          "idNumber": "J64407008"
        }
      ]
    }
  }'

Re-verify an existing entity

You can re-verify an existing entity using the same API. Pass the ID of the entity in the path instead of new:

curl -X POST https://api.demo.frankiefinancial.io/compliance/v1.2/entity/YOUR_ENTITY_ID/verify/profile/full

Re-verifying an entity will re-use any previous check results if they are stil valid, rather than performing the checks again.

Specifying what checks to run

The checkType path paramter specifies which checks run when verifying an entity.

Typically you only need to pass profile as the value, which will use the Entity Profile assigned to the entity to determine which checks run. If the entity profile has been set to auto, then the profile is first determined using the preconfigured rules, and the checks needed are then run.

View About Entity Profiles to learn more.

FrankieOne recommends you always use entity profiles. However you can still specify check types individually as a comma separated list, for example two_plus,visa,id,pep_media. View the [reference documentation] to learn more.

See verification results

Through the API

Verification results are returned in the response of the Create and Verify Entity API. You must specify a resultLevel parameter indicating the level of detail you with to receive.

To request simple verification results:

curl -X POST https://api.demo.frankiefinancial.io/compliance/v1.2/entity/new/verify/profile/simple

To request full verification results:

curl -X POST https://api.demo.frankiefinancial.io/compliance/v1.2/entity/new/verify/profile/full

Through the Portal

The result of the checks run against a potential customer is displayed under the Overview tab of a customer’s profile.