Performing Actions with the API

The API has a number of actions that can be performed on documents and entities. These can be done on newly created objects or existing one.

The service allows you to combine additions/updates and actions as well.

For example, if you wished to create a new entity, then perform a profile based check on them, you would call this API endpoint:

/entity/new/verify/profile/simple

This would first attempt to create the entity (and any embedded documents) based on the data provided, and if that was successful, it would then attempt to perform the checks associated with that entity profile.

If you wished to update an entity with new/updated information, you could call this API endpoint:

/entity/{id}/verify/profile/full

This would attempt to update the entity as described above, then run the checks requested.


Did this page help you?