Package com.yoti.api.client

Class YotiClient

java.lang.Object
com.yoti.api.client.YotiClient
public class YotiClient extends Object

Entry point to interact with the Yoti Connect API.

It can be safely cached and shared even by multiple threads.

  • Method Details

    • builder

      public static YotiClient.Builder builder()
      Creates a new YotiClient.Builder to assist with the creation of the YotiClient
      Returns:
      the new builder

    • getActivityDetails

      public ActivityDetails getActivityDetails(String encryptedYotiToken) throws ProfileException
      Get the activity details for a token. Amongst others contains the user profile with the user's attributes you have selected in your application configuration on Yoti Portal. Note: encrypted tokens should only be used once. You should not invoke this method multiple times with the same token.
      Parameters:
      encryptedYotiToken - encrypted Yoti token (can be only decrypted with your application's private key). Note that this token must only be used once.
      Returns:
      an ActivityDetails instance holding the user's attributes
      Throws:
      ProfileException - aggregate exception signalling issues during the call

    • performAmlCheck

      public AmlResult performAmlCheck(AmlProfile amlProfile) throws AmlException
      Request an AML check for the given profile.
      Parameters:
      amlProfile - Details of the profile to search for when performing the AML check
      Returns:
      an AmlProfile with the results of the check
      Throws:
      AmlException - aggregate exception signalling issues during the call

    • createShareUrl

      public ShareUrlResult createShareUrl(DynamicScenario dynamicScenario) throws DynamicShareException
      Initiate a sharing process based on a dynamic scenario and policy
      Parameters:
      dynamicScenario - Details of the device's callback endpoint, dynamic policy and extensions for the application
      Returns:
      an ShareUrlResult sharing url and reference id
      Throws:
      DynamicShareException - aggregate exception signalling issues during the call