Earnipay Users API

User profile management

Operations 4

GET /v1/users/me Get current user profile #
PATCH /v1/users/me Update user profile #
POST /v1/users/change-password Change user password #
GET /v1/users/me/completion Get profile completion status #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/earnipay-users-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

earnipay-users-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Earnipay Invoicing App Users API
  description: FIRS-compliant e-invoicing platform API
  version: '1.0'
  contact: {}
servers: []
tags:
- name: Users
  description: User profile management
paths:
  /v1/users/me:
    get:
      description: Retrieve the authenticated user's profile information including completion status
      operationId: UserController_getCurrentUser_v1
      parameters: []
      responses:
        '200':
          description: User profile retrieved successfully
        '401':
          description: Unauthorized - Invalid or missing JWT token
        '404':
          description: User not found
      security:
      - JWT-auth: []
      summary: Get current user profile
      tags:
      - Users
    patch:
      description: Update the authenticated user's profile information (first name, last name, phone)
      operationId: UserController_updateProfile_v1
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateUserDto'
      responses:
        '200':
          description: Profile updated successfully
        '400':
          description: Bad Request - Invalid input data
        '401':
          description: Unauthorized - Invalid or missing JWT token
        '404':
          description: User not found
      security:
      - JWT-auth: []
      summary: Update user profile
      tags:
      - Users
  /v1/users/change-password:
    post:
      description: Change the authenticated user's password. Requires current password for verification. Not available for OAuth users.
      operationId: UserController_changePassword_v1
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangePasswordDto'
      responses:
        '200':
          description: Password changed successfully
        '400':
          description: Bad Request - Invalid input or OAuth account
        '401':
          description: Unauthorized - Invalid current password or missing JWT token
        '404':
          description: User not found
      security:
      - JWT-auth: []
      summary: Change user password
      tags:
      - Users
  /v1/users/me/completion:
    get:
      description: Check the completion status of user profile with percentage and missing fields
      operationId: UserController_getProfileCompletion_v1
      parameters: []
      responses:
        '200':
          description: Profile completion status retrieved
        '401':
          description: Unauthorized - Invalid or missing JWT token
        '404':
          description: User not found
      security:
      - JWT-auth: []
      summary: Get profile completion status
      tags:
      - Users
components:
  schemas:
    UpdateUserDto:
      type: object
      properties:
        firstName:
          type: string
          description: User first name
          example: John
          minLength: 2
          maxLength: 50
        lastName:
          type: string
          description: User last name
          example: Doe
          minLength: 2
          maxLength: 50
        phone:
          type: string
          description: User phone number (Nigerian format)
          example: '+2348012345678'
    ChangePasswordDto:
      type: object
      properties:
        currentPassword:
          type: string
          description: Current password
          example: CurrentPass123!
        newPassword:
          type: string
          description: New password (min 8 chars, uppercase, lowercase, number/special char)
          example: NewSecurePass123!
          minLength: 8
      required:
      - currentPassword
      - newPassword
  securitySchemes:
    JWT-auth:
      scheme: bearer
      bearerFormat: JWT
      type: http
      name: JWT
      description: Enter JWT token
      in: header
    API-Key:
      type: apiKey
      in: header
      name: X-API-Key
      description: API Key for third-party integrations