Package com.idanalyzer

Class ProfileApi

java.lang.Object
com.idanalyzer.ProfileApi
public class ProfileApi extends Object
Server-side KYC profile management (/profile, /export/profile).

  • Method Details

    • listProfile

      public com.fasterxml.jackson.databind.JsonNode listProfile(int order, int limit, int offset)
      List KYC profiles (GET /profile).
      Parameters:
      order - sort order for the results.
      limit - maximum number of profiles to return.
      offset - number of profiles to skip (for pagination).
      Returns:
      the API response as a JsonNode.
      Throws:
      ApiException - if the API returns an error or a transport error occurs.

    • getProfile

      public com.fasterxml.jackson.databind.JsonNode getProfile(String profileId)
      Retrieve a KYC profile (GET /profile/{id}).
      Parameters:
      profileId - the profile id to retrieve.
      Returns:
      the API response as a JsonNode.
      Throws:
      InvalidArgumentException - if profileId is null or empty.
      ApiException - if the API returns an error or a transport error occurs.

    • createProfile

      public com.fasterxml.jackson.databind.JsonNode createProfile(String name, Profile profile)
      Create a KYC profile (POST /profile).
      Parameters:
      name - the profile name.
      profile - the profile whose override settings define the new profile; may be null.
      Returns:
      the API response as a JsonNode.
      Throws:
      InvalidArgumentException - if name is null or empty.
      ApiException - if the API returns an error or a transport error occurs.

    • updateProfile

      public com.fasterxml.jackson.databind.JsonNode updateProfile(String profileId, String name, Profile profile)
      Update a KYC profile (PUT /profile/{id}).
      Parameters:
      profileId - the profile id to update.
      name - the new profile name; sent when non-empty.
      profile - the profile whose override settings replace the stored settings; may be null.
      Returns:
      the API response as a JsonNode.
      Throws:
      InvalidArgumentException - if profileId is null or empty.
      ApiException - if the API returns an error or a transport error occurs.

    • deleteProfile

      public com.fasterxml.jackson.databind.JsonNode deleteProfile(String profileId)
      Delete a KYC profile (DELETE /profile/{id}).
      Parameters:
      profileId - the profile id to delete.
      Returns:
      the API response as a JsonNode.
      Throws:
      InvalidArgumentException - if profileId is null or empty.
      ApiException - if the API returns an error or a transport error occurs.

    • exportProfile

      public com.fasterxml.jackson.databind.JsonNode exportProfile(String profileId)
      Export a KYC profile (GET /export/profile/{id}).
      Parameters:
      profileId - the profile id to export.
      Returns:
      the API response as a JsonNode.
      Throws:
      InvalidArgumentException - if profileId is null or empty.
      ApiException - if the API returns an error or a transport error occurs.