Skip to content

Latest commit

 

History

History
67 lines (46 loc) · 9.69 KB

README.md

File metadata and controls

67 lines (46 loc) · 9.69 KB

Avatars

(avatars())

Overview

Available Operations

  • get - Get avatar image for an account using a unique ID.

To access this endpoint using an access token you'll need to specify the /profile-enrichment.read scope.

get

Get avatar image for an account using a unique ID.

To access this endpoint using an access token you'll need to specify the /profile-enrichment.read scope.

Example Usage

package hello.world;

import io.moov.sdk.Moov;
import io.moov.sdk.models.components.Security;
import io.moov.sdk.models.operations.GetAvatarResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        Moov sdk = Moov.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        GetAvatarResponse res = sdk.avatars().get()
                .uniqueID("<id>")
                .call();

        if (res.responseStream().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter Type Required Description
xMoovVersion Optional<String> ➖ 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 String ✔️ Any unique ID associated with an account such as accountID, representativeID, routing number, or userID.

Response

GetAvatarResponse

Errors

Error Type Status Code Content Type
models/errors/APIException 4XX, 5XX */*