Package io.moov.sdk

Class Avatars

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      GetAvatarRequestBuilder get()
      Get avatar image for an account using a unique ID.
      GetAvatarResponse get​(java.lang.String uniqueID)
      Get avatar image for an account using a unique ID.
      GetAvatarResponse get​(java.util.Optional<java.lang.String> xMoovVersion, java.lang.String uniqueID)
      Get avatar image for an account using a unique ID.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • get

        public GetAvatarRequestBuilder get()
        Get avatar image for an account using a unique ID.

        To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/profile-enrichment.read` scope.

        Returns:
        The call builder

      • get

        public GetAvatarResponse get​(java.lang.String uniqueID)
                      throws java.lang.Exception
        Get avatar image for an account using a unique ID.

        To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/profile-enrichment.read` scope.

        Parameters:
        uniqueID - Any unique ID associated with an account such as accountID, representativeID, routing number, or userID.
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails

      • get

        public GetAvatarResponse get​(java.util.Optional<java.lang.String> xMoovVersion,
                             java.lang.String uniqueID)
                      throws java.lang.Exception
        Get avatar image for an account using a unique ID.

        To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/profile-enrichment.read` scope.

        Specified by:
        get in interface SDKMethodInterfaces.MethodCallGetAvatar
        Parameters:
        xMoovVersion - Specify an API version. API versioning follows the format `vYYYY.QQ.BB`, where - `YYYY` is the year - `QQ` is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10) - `BB` is the build number, starting at `.01`, for subsequent builds in the same quarter. - For example, `v2024.01.00` is the initial release of the first quarter of 2024. The `latest` version represents the most recent development state. It may include breaking changes and should be treated as a beta release.
        uniqueID - Any unique ID associated with an account such as accountID, representativeID, routing number, or userID.
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails