Using an Entity Profile / Recipe

As detailed here, entity profiles describe a recipe that is applied to an entity when performing checks.

It greatly simplifies managing the original checkTypes and result sets to make is easier to request/update a check and easier to manage the results.

To apply a profile to an entity

There are 2 ways to do this:

  • Automatically - simply set the entity.entityProfile to auto and the service will automatically assign the correct profile, based on your configured rules.
  • Explicitly - set the entity.entityProfile field to the name of the profile you wish to use. For the standard bundle you can choose the profile you would like to use via this method.

You can also remove a profile and return to the current method of specifying checkTypes each time by setting the entityProfile field to “none”.

NOTE: Doing this will not invalidate any past check results - they will still apply for as long as your data ageing rules are configured for. Contact Frankie developer support if you’re unsure about this.

NOTE: You can apply a new entityProfile to an existing entity, or change it using the update entity API calls. The profile will be applied immediately to the entity’s state using existing check data based on the profile’s data ageing rules.

Running a check using the entity profile

To apply the profile to an entity you need to run a verification check, just as you would with the current checkTypes. The API call remains the same:

https://api.kycaml.frankiefinancial.com/compliance/v1.2/entity/{new|id}/verify/{checkType}/full

However, instead of supplying the individual checkTypes (e.g. two_plus,visa,id,pep_media) you simply specify “profile”. This will then apply the recipe defined in the profile. If you’ve set entityProfile to “auto” then the profile is first determined using your preconfigured rules and the checks needed are then run.

As mentioned previously, data ageing rules are applied (if configured) so only the checks that remain in an incomplete state will be (re)run.

However instead of supplying the individual checkTypes (e.g. two_plus,visa,id,pep_media) you simply specify “profile”. e.g.

https://api.kycaml.frankiefinancial.com/compliance/v1.2/entity/{new|id}/verify/profile/full

This will then apply the recipe defined in the profile. If you’ve set entityProfile to “auto” then the profile is first determined using your preconfigured rules and the checks needed are then run.

As mentioned previously, data ageing rules are applied (if configured) so only the checks that remain in an incomplete state will be (re)run.

This is the list of the Standard profiles available for you to use in Demo and if you are on the Standard bundle you will also have these profiles available in production. You can request a specific profile out of this list to be your "auto" one.

Profile Name

Check Types being run

Comments

gov_id

blacklist,id_only,pep,idvalidate

Blocklist, Gov ID only, PEP, Sanction and optional Biometrics

gov_id_media

blacklist,id_only,pep_media,idvalidate

Blocklist, Gov ID only, PEP, Sanction, ADVERSE MEDIA and optional Biometrics

safe_harbour

blacklist,two_plus,pep,idvalidate

Blocklist, KYC (2xName, 2x DOB or Address), PEP and Sanction and optional Biometrics

safe_harbour_media

blacklist,two_plus,pep_media,idvalidate

Blocklist, KYC (2xName, 2x DOB or Address), PEP, Sanction, ADVERSE MEDIA and optional Biometrics

safe_harbour_id

blacklist,two_plus,id,pep,idvalidate

Blocklist, KYC (2xName, 2x DOB or Address), Gov ID, PEP and Sanction and optional Biometrics

safe_harbour_id_media

blacklist,two_plus,id,pep_media,idvalidate

Blocklist, KYC (2xName, 2x DOB or Address), Gov ID, PEP, Sanction, ADVERSE MEDIA and optional Biometrics

safe_harbour_plus

blacklist,two_plus_both,id,pep,idvalidate

Blocklist, KYC (2xName, 1xDOB, 1xAddress), Gov ID, PEP and Sanction and optional Biometrics

safe_harbour_plus_media

blacklist,two_plus_both,id,pep_media,idvalidate

Blocklist, KYC (2xName, 1xDOB, 1xAddress), Gov ID, PEP, Sanction ADVERSE MEDIA and optional Biometrics

international

blacklist,one_plus,id,pep,idvalidate

Blocklist, KYC (1xName, 1x DOB or Address), PEP and Sanction and optional Biometrics

international_media

blacklist,one_plus,id,pep_media,idvalidate

Blocklist, KYC (1xName, 1x DOB or Address), PEP, Sanction, ADVERSE MEDIA and optional Biometrics

Demo Profiles
To assist in testing the use of profiles in the demo environment, common profiles/recipes have been defined and can be used with your Demo / Sandbox keys.

Sample Post Request
Endpoint:

POST: ......./entity/new/verify/profile/full

Payload

{
    "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"
            }
        ]
    }
}

Did this page help you?