README.md

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

declare(strict_types=1);

require 'vendor/autoload.php';

use Moov\MoovPhp;
use Moov\MoovPhp\Models\Components;

$sdk = MoovPhp\Moov::builder()
    ->setSecurity(
        new Components\Security(
            username: '',
            password: '',
        )
    )
    ->build();



$response = $sdk->avatars->get(
    uniqueID: '<id>',
    xMoovVersion: 'v2024.01.00'

);

if ($response->bytes !== null) {
    // handle response
}

Parameters

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

Response

?Operations\GetAvatarResponse

Errors

Error Type	Status Code	Content Type
Errors\APIException	4XX, 5XX	*/*