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

Hevn Inc 2FA API

The 2FA API from Hevn Inc — 10 operation(s) for 2fa.

Hevn Inc 2FA API is one of 31 APIs that Hevn Inc publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 10 operations across 10 paths, and defines 7 schemas. It is described by OpenAPI 3.1.0, at version 0.1.2.

Requests are made against a single base URL, https://api.hevn.finance.

10 operations 10 paths 7 schemas 2 DELETE2 GET6 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.1.2
Base URL
https://api.hevn.finance/api/v1
Authentication
HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 2

Hevn Inc 2FA API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (HTTPBearer). An API key is passed in the header as x-api-key (ApiKeyAuth).

  • ApiKeyAuth — Alternative HEVN API key header. The CLI defaults to Authorization Bearer unless configured with HEVNAPIKEYHEADER=X-Api-Key.

Paths & Operations 10

Across 10 paths, the API surfaces 10 operations — 2 DELETE, 2 GET, 6 POST. Each is listed below with its method, path, parameters, and response codes.

2FA 10
GET
/api/v1/user/2fa/status
Get Totp Status
get_totp_status_api_v1_user_2fa_status_get → 200
POST
/api/v1/user/2fa/setup
Setup Totp
setup_totp_api_v1_user_2fa_setup_post → 200
POST
/api/v1/user/2fa/activate
Activate Totp
activate_totp_api_v1_user_2fa_activate_post body → 200422
DELETE
/api/v1/user/2fa
Disable Totp
disable_totp_api_v1_user_2fa_delete body → 200422
POST
/api/v1/user/2fa/recovery-codes
Regenerate Recovery Codes
regenerate_recovery_codes_api_v1_user_2fa_recovery_codes_post body → 200422
GET
/api/v1/auth/user/2fa/status
Get Totp Status Package Alias
get_totp_status_package_alias_api_v1_auth_user_2fa_status_get → 200
POST
/api/v1/auth/user/2fa/setup
Setup Totp Package Alias
setup_totp_package_alias_api_v1_auth_user_2fa_setup_post → 200
POST
/api/v1/auth/user/2fa/activate
Activate Totp Package Alias
activate_totp_package_alias_api_v1_auth_user_2fa_activate_post body → 200422
DELETE
/api/v1/auth/user/2fa
Disable Totp Package Alias
disable_totp_package_alias_api_v1_auth_user_2fa_delete body → 200422
POST
/api/v1/auth/user/2fa/recovery-codes
Regenerate Recovery Codes Package Alias
regenerate_recovery_codes_package_alias_api_v1_auth_user_2fa_recovery_codes_post body → 200422

Schemas 7

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

TotpStatusResponse
object
Response for 2FA status check.
2 properties 1 required
ValidationError
object
3 properties 3 required
TotpActivateResponse
object
Response after successfully activating 2FA.
2 properties 1 required
TotpSetupResponse
object
Response when initiating 2FA setup.
2 properties 2 required
HTTPValidationError
object
1 property
TotpDisableRequest
object
Request to disable 2FA.
1 property 1 required
TotpVerifyRequest
object
Request to verify a TOTP code.
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hevn-inc-2fa-api-openapi.yml Raw ↑

Other APIs Hevn Inc publishes across the network.

Hevn Inc Activity API
Hevn Inc apps API
Hevn Inc apps-transfer API
Hevn Inc auth API
Hevn Inc B2B API
Hevn Inc Balance API
Hevn Inc Banks API
Hevn Inc Cards API
Hevn Inc Chat API
Hevn Inc contracts API
Hevn Inc Devices API
Hevn Inc documents API