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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Hevn Inc

Hevn Inc Public API

The Public API from Hevn Inc — 8 operation(s) for public.

Documentation Provider Profile APIs.io OpenAPI GitHub

Hevn Inc Public 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 Public. 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 27 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.

8 operations 8 paths 27 schemas 5 GET3 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 Public 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 8

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

Public 8
GET
/api/v1/public/time
Server Time
server_time_api_v1_public_time_get → 200
POST
/api/v1/public/waitlist
Join Waitlist
join_waitlist_api_v1_public_waitlist_post body → 200422
GET
/api/v1/public/rates/{currency}
Get public FX rates
get_public_rate_api_v1_public_rates__currency__get 1 param → 200422
GET
/api/v1/public/invoices/user_details
Get contractor details by invoice share key
invoice_user_details_api_v1_public_invoices_user_details_get 1 param → 200422
GET
/api/v1/public/invoices/{invoice_id}
Get Public Invoice
get_public_invoice_api_v1_public_invoices__invoice_id__get 1 param → 200422
GET
/api/v1/public/products/{product_id}
Get Public Product
get_public_product_api_v1_public_products__product_id__get 1 param → 200422
POST
/api/v1/public/products/{product_id}/pay
Pay Product
pay_product_api_v1_public_products__product_id__pay_post 1 param body → 200422
POST
/api/v1/public/{payment_id}/submit
Submit Product Deposit
submit_product_deposit_api_v1_public__payment_id__submit_post 2 params body → 200422

Schemas 27

The contract defines 27 schemas that model the data the API accepts and returns. The most detailed are UniversalQuoteResponse (18 properties), PublicInvoiceResponse (16 properties), IBANAccountDetails-Output (14 properties), PublicProductResponse (14 properties). Each schema is shown below with its type and property counts.

ContactWalletResponse
object
Wallet payment method block used by invoice/payment method schemas.
4 properties 1 required
InvoiceDocumentInfo
object
Document attached to an invoice. key is a short-lived signed token. To download call GET /documents/download/{id}?key={key}.
3 properties 3 required
app__schemas__base__ContactRelationship
string
Unified contact relationship / transfer purpose. Values match Align AlignTransferPurpose (the more granular set). Mapped to Swipelux AccountHolderRelationship…
InvoiceUserDetailsResponse
object
Contractor details returned by a share link.
2 properties 2 required
ValidationError
object
3 properties 3 required
HTTPValidationError
object
1 property
WaitlistRequest
object
2 properties 2 required
PayProductRequest
object
8 properties 2 required
InvoiceStatus
string
Invoice status.
RateResponse
object
Combined FX rate response.
3 properties
USExternalAccountDetails-Output
object
US domestic (ACH) external account.
13 properties 4 required
PublicInvoiceResponse
object
16 properties 6 required
USAccountDetails
object
US domestic account details (ACH).
2 properties 2 required
AlignAccountHolderType
string
Account holder type.
SwiftDetails
object
SWIFT (international wire) account details.
3 properties 2 required
UniversalQuoteResponse
object
Universal quote response.
18 properties 6 required
UserAddress
object
Address schema for user. Canonical field names: streetaddress, addressline2, city, state, country, zip. Accepts legacy Align/IBAN field names (streetline1, str…
6 properties
PublicProductResponse
object
Product info for anonymous buyers.
14 properties 5 required
EmailAccountInput
object
Email contact input.
2 properties 1 required
IBANAccountDetails-Output
object
IBAN (SEPA) external account.
14 properties 4 required
PublicInvoiceContractInfo
object
3 properties 1 required
PublicInvoiceItem
object
3 properties
SubmitDepositRequest
object
2 properties 2 required
SwiftAccountDetails-Output
object
SWIFT (international wire) external account.
13 properties 4 required
CountryCode
string
ISO 3166-1 alpha-2 country codes.
InvoiceParticipant
object
Minimal participant info for invoice response.
3 properties 1 required
PaymentTransactionResponse
object
13 properties 6 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hevn-inc-public-api-openapi.yml Raw ↑

Other APIs Hevn Inc publishes across the network.

Hevn Inc 2FA API
AE Profile APIs.io
Hevn Inc Activity API
AE Profile APIs.io
Hevn Inc apps API
AE Profile APIs.io
Hevn Inc apps-transfer API
AE Profile APIs.io
Hevn Inc auth API
AE Profile APIs.io
Hevn Inc B2B API
AE Profile APIs.io
Hevn Inc Balance API
AE Profile APIs.io
Hevn Inc Banks API
AE Profile APIs.io
Hevn Inc Cards API
AE Profile APIs.io
Hevn Inc Chat API
AE Profile APIs.io
Hevn Inc contracts API
AE Profile APIs.io
Hevn Inc Devices API
AE Profile APIs.io
#Public
← Back to H APIs
API Details
ID
hevn-inc:hevn-inc-public-api
Base URL
https://api.hevn.finance/api/v1
Docs
https://hevninc.mintlify.app/
Provider
Hevn Inc
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network