Hevn Inc User API
The User API from Hevn Inc — 21 operation(s) for user.
Hevn Inc User 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 User. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 23 operations across 21 paths, and defines 69 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.
23 operations
21 paths
69 schemas
1 DELETE10 GET1 PATCH8 POST3 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Hevn Inc User 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 23
Across 21 paths, the API surfaces 23 operations — 1 DELETE, 10 GET, 1 PATCH, 8 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.
User 23
PUT
/api/v1/user/kyc
Create or get current user
GET
/api/v1/user
Get current user
POST
/api/v1/user/kyc_link
Submit KYC data
GET
/api/v1/user/kyc/status
Get KYC status
GET
/api/v1/user/geo
Geocode address
POST
/api/v1/user/event
Track user event
GET
/api/v1/user/settings
Get user settings
PUT
/api/v1/user/settings
Update user settings
PUT
/api/v1/user/bank_requested
Update requested bank rails
GET
/api/v1/user/notifications
Get recent notifications
POST
/api/v1/user/avatar
Upload user avatar
POST
/api/v1/user/share_kyb_link
Share KYB link
POST
/api/v1/user/invite
Send invite
POST
/api/v1/user/contact/bank/validate
Prevalidate bank contact details
GET
/api/v1/user/contacts
Get user contacts
GET
/api/v1/user/contact/preview
Preview contact by wallet or email
POST
/api/v1/user/contact
Create contact
PATCH
/api/v1/user/contacts/{contact_id}
Update contact name
DELETE
/api/v1/user/contacts/{contact_id}
Delete contact
GET
/api/v1/user/invite_code
Get invite code for current user
GET
/api/v1/user/invited
Get users invited by current user
GET
/api/v1/user/rewards
Get referral rewards earned by current user
POST
/api/v1/kyb/user/share_kyb_link
Share KYB link
Schemas 69
The contract defines 69 schemas that model the data the API accepts and returns. The most detailed are UserResponse (22 properties), IBANAccountDetails-Output (14 properties), UserCreateRequest (13 properties), USExternalAccountDetails-Output (13 properties). Each schema is shown below with its type and property counts.
SwiftAccountInput
object
SWIFT bank contact input.
13 properties
5 required
InviteVolumeBonus
object
Volume-based bonus tier with a threshold.
3 properties
2 required
UserSettings-Output
object
User settings.
5 properties
app__schemas__base__ContactRelationship
string
Unified contact relationship / transfer purpose. Values match Align AlignTransferPurpose (the more granular set). Mapped to Swipelux AccountHolderRelationship…
UaeAccountInput
object
UAE FTS bank contact input.
11 properties
3 required
InvitedStatus
string
Status of an invited user along the KYB funnel.
InviteBonuses
object
Bonus configuration for the referral program.
2 properties
2 required
BankRequestedSettings-Input
object
User bank-rail interest settings.
1 property
ValidationError
object
3 properties
3 required
BankRequestedRails
object
Rails the user is interested in opening.
4 properties
ContactCreateRequest
object
Request to create a contact.
8 properties
AppearancePreference
string
Appearance theme preference.
BankRequestedRailSettings
object
User interest in a bank rail group.
2 properties
InvitedListResponse
object
List of invited users.
2 properties
2 required
ReferrerInfo
object
Lightweight info about the user who referred this user.
3 properties
2 required
AvatarUploadRequest
object
Request schema for uploading user avatar.
1 property
1 required
HTTPValidationError
object
1 property
UserCreateRequest
object
Request schema for creating a user.
13 properties
ContactCryptoResponse
object
Crypto payment details for contact.
3 properties
1 required
OneClickChain
string
1click chain codes.
NotificationListResponse
object
List of notifications response.
2 properties
2 required
RewardItem
object
A single referral reward earned by the current user.
7 properties
6 required
UserEventRequest
object
Request schema for tracking user events.
2 properties
1 required
USExternalAccountDetails-Input
object
US domestic (ACH) external account.
12 properties
3 required
NotificationChannelPrefs
object
Per-channel toggles for a single notification category.
2 properties
UserSettings-Input
object
User settings.
5 properties
TransactionType
string
Transaction type - payment rail. Includes all FiatPaymentType values (sepa/swift/ach/uaefts) plus extended fiat variants (wire/swift-usd/swift-eur/fedwire/pix)…
InvitedUserResponse
object
A single invited user.
8 properties
4 required
InviteBonus
object
A single referral bonus tier.
2 properties
1 required
IBANAccountDetails-Input
object
IBAN (SEPA) external account.
13 properties
3 required
USExternalAccountDetails-Output
object
US domestic (ACH) external account.
13 properties
4 required
ContactLinkedUserResponse
object
Linked HEVN user preview for contact.
2 properties
RewardsListResponse
object
List of referral rewards earned by the current user.
3 properties
2 required
USAccountDetails
object
US domestic account details (ACH).
2 properties
2 required
InviteFlow
string
Invite flow types.
SwiftDetails
object
SWIFT (international wire) account details.
3 properties
2 required
AlignAccountHolderType
string
Account holder type.
ContactUpdateRequest
object
Request to update a contact.
8 properties
AchAccountInput
object
ACH bank contact input.
11 properties
4 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
InviteRequest
object
Request schema for sending an invite.
2 properties
2 required
SwiftAccountDetails-Input
object
SWIFT (international wire) external account.
12 properties
3 required
ContactListResponse
object
List of contacts response.
2 properties
2 required
app__schemas__routers__user__contact__ContactRelationship
string
Relationship between the current user and the contact.
AvatarUploadResponse
object
Response schema for avatar upload.
1 property
1 required
RewardType
string
Referral reward type.
BankRequestedSettings-Output
object
User bank-rail interest settings.
1 property
NotificationChannel
string
Notification delivery channel.
ContactCryptoInput
object
Crypto contact input.
3 properties
3 required
BankValidationRequest
object
Request to prevalidate bank details before creating a contact.
6 properties
1 required
ShareKybLinkRequest
object
Request schema for sharing a KYB link via email.
1 property
1 required
IBANAccountDetails-Output
object
IBAN (SEPA) external account.
14 properties
4 required
EmailAccountInput
object
Email contact input.
2 properties
1 required
ContactResponse
object
Contact response with full structure for transfer.
10 properties
4 required
KycStatusResponse
object
Response schema for KYC status check.
11 properties
3 required
OnchainAccountInput
object
Onchain wallet contact input.
5 properties
3 required
SepaAccountInput
object
SEPA bank contact input.
11 properties
4 required
NotificationsSettings
object
User notification preferences grouped by category. Categories are UI groupings over NotificationType. Mapping lives in NOTIFICATIONTYPECATEGORY. Defaults to al…
9 properties
CountryCode
string
ISO 3166-1 alpha-2 country codes.
ContactPreviewResponse
object
Lightweight user preview for contact lookup.
4 properties
1 required
FiatRailResponse
object
Response schema for a user's fiat rail registration.
4 properties
1 required
InviteCodeResponse
object
Response for invite code.
3 properties
1 required
NotificationResponse
object
Single notification response.
8 properties
5 required
KycStatus
string
KYC verification status.
NotificationType
string
Notification type — matches the kind of event being notified.
UserResponse
object
Schema for user response.
22 properties
6 required
BankValidationResponse
object
Result of bank detail validation.
4 properties
1 required
FiatProvider
string
Supported fiat payment providers.
SwiftAccountDetails-Output
object
SWIFT (international wire) external account.
13 properties
4 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Hevn Inc 12
Other APIs Hevn Inc publishes across the network.
Hevn Inc 2FA API
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
#User