Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Earnipay Users API

User profile management

Earnipay Users API is one of 13 APIs that Earnipay publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Users. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 4 operations across 3 paths, and defines 2 schemas. It is described by OpenAPI 3.0.0, at version 1.0.

Requests are made against the base URL https://e-invoicing.earnipay.com/v1.

4 operations 3 paths 2 schemas 2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0
Base URL
https://e-invoicing.earnipay.com/v1
Authentication
HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 2

Earnipay Users API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (JWT-auth). An API key is passed in the header as X-API-Key (API-Key).

  • JWT-auth — Enter JWT token
  • API-Key — API Key for third-party integrations

Paths & Operations 4

Across 3 paths, the API surfaces 4 operations — 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Users 4

User profile management

GET
/v1/users/me
Get current user profile
UserController_getCurrentUser_v1 → 200401404
PATCH
/v1/users/me
Update user profile
UserController_updateProfile_v1 body → 200400401404
POST
/v1/users/change-password
Change user password
UserController_changePassword_v1 body → 200400401404
GET
/v1/users/me/completion
Get profile completion status
UserController_getProfileCompletion_v1 → 200401404

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are UpdateUserDto (3 properties), ChangePasswordDto (2 properties). Each schema is shown below with its type and property counts.

UpdateUserDto
object
3 properties
ChangePasswordDto
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

earnipay-users-api-openapi.yml Raw ↑

Other APIs Earnipay publishes across the network.

Earnipay App API
Earnipay APP Provider API
Earnipay Authentication API
Earnipay Bank API
Earnipay Business API
Earnipay Customers API
Earnipay Invoices API
Earnipay IRN Generator API
Earnipay Payment Details API
Earnipay Products API
Earnipay QR Code Generator API
Earnipay Team API