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.

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:{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.

Did this page help you?