Xtrempay Api Documentation

Save & update user avatar

Cloud Mock

https://mock.apidog.com/m1/918700-0-default

POST

/v1/user/avatar

Maintainer:Xtrempay Devs

The /v1/users/avatar endpoint is a POST operation designed to handle the uploading or updating of a user’s image. It accepts a file (e.g., PNG or JPEG) via a multipart/form-data request and requires authentication via a bearer token. The endpoint processes the file, stores it, and returns a success response with the URL of the uploaded avatar or an error response if something goes wrong (e.g., invalid file, unauthorized access, or server issues).

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Header Params

Body Params multipart/form-data

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://mock.apidog.com/m1/918700-0-default/v1/user/avatar' \
--header 'Content-Type: multipart/form-data' \
--form 'file=@"/Users/topzoft/Downloads/ChatGPT Image Jul 17, 2025, 05_51_11 PM.jpg"'

Responses

🟢200Success

application/json

Body

Example

{
    "timestamp": "1751124838908",
    "status": 200,
    "success": true,
    "message": "Avatar updated successfully",
    "data": {
        "avatarUrl": "https://cdn.xtrempay.com/users/avatar/1234.jpg"
    }
}

🟠400Invalid input

Modified at 2025-07-29 21:54:51

Verify phone number OTP

Verify BVN/NIN