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 Authentication API

User authentication and authorization endpoints

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

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

This API exposes 8 operations across 8 paths, and defines 7 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.

8 operations 8 paths 7 schemas 8 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 Authentication 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 8

Across 8 paths, the API surfaces 8 operations — 8 POST. Each is listed below with its method, path, parameters, and response codes.

Authentication 8

User authentication and authorization endpoints

POST
/v1/auth/signup
Register new user account
AuthController_signup_v1 body → 201409
POST
/v1/auth/verify-email
Verify email with code
AuthController_verifyEmail_v1 body → 200400
POST
/v1/auth/resend-code
Resend verification code
AuthController_resendVerificationCode_v1 body → 200400
POST
/v1/auth/login
Login with email and password
AuthController_login_v1 body → 200401
POST
/v1/auth/refresh
Refresh access token
AuthController_refreshToken_v1 body → 200401
POST
/v1/auth/logout
Logout user (invalidate refresh token)
AuthController_logout_v1 body → 200
POST
/v1/auth/forgot-password
Request password reset link
AuthController_forgotPassword_v1 body → 200
POST
/v1/auth/reset-password
Reset password with token
AuthController_resetPassword_v1 body → 200400

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are SignupDto (4 properties), ResetPasswordDto (2 properties), VerifyEmailDto (2 properties), LoginDto (2 properties). Each schema is shown below with its type and property counts.

LoginDto
object
2 properties 2 required
ForgotPasswordDto
object
1 property 1 required
ResendCodeDto
object
1 property 1 required
RefreshTokenDto
object
1 property 1 required
VerifyEmailDto
object
2 properties 2 required
ResetPasswordDto
object
2 properties 2 required
SignupDto
object
4 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

earnipay-authentication-api-openapi.yml Raw ↑

Other APIs Earnipay publishes across the network.

Earnipay App API
Earnipay APP Provider 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
Earnipay Users API