Hevn Inc User API is one of 31 APIs that Hevn 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.2.0, at version 0.1.2.
Requests are made against a single base URL, https://api.hevn.finance.
The identity and technical contract details declared by the specification.
USAccountDetails
object
US domestic account details (ACH).
2 properties
2 required
FiatRailResponse
object
Response schema for a user's fiat rail registration.
4 properties
1 required
ContactCryptoResponse
object
Crypto payment details for contact.
3 properties
1 required
EmailAccountInput
object
Email contact input.
2 properties
1 required
ContactResponse
object
Contact response with full structure for transfer.
10 properties
4 required
InviteFlow
string
Invite flow types.
InvitedListResponse
object
List of invited users.
2 properties
2 required
AvatarUploadResponse
object
Response schema for avatar upload.
1 property
1 required
InviteBonuses
object
Bonus configuration for the referral program.
2 properties
2 required
BankRequestedSettings-Output
object
User bank-rail interest settings.
1 property
NotificationsSettings
object
User notification preferences grouped by category. Categories are UI groupings over NotificationType. Mapping lives in NOTIFICATIONTYPECATEGORY. Defaults to al…
9 properties
IBANAccountDetails-Output
object
IBAN (SEPA) external account.
14 properties
4 required
OnchainAccountInput
object
Onchain wallet contact input.
5 properties
3 required
KycStatus
string
KYC verification status.
RewardsListResponse
object
List of referral rewards earned by the current user.
3 properties
2 required
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)…
IBANAccountDetails-Input
object
IBAN (SEPA) external account.
13 properties
3 required
USExternalAccountDetails-Output
object
US domestic (ACH) external account.
13 properties
4 required
AchAccountInput
object
ACH bank contact input.
11 properties
4 required
app__schemas__base__ContactRelationship
string
Unified contact relationship / transfer purpose. Values match Align AlignTransferPurpose (the more granular set). Mapped to Swipelux AccountHolderRelationship…
UserSettings-Input
object
User settings.
5 properties
NotificationChannelPrefs
object
Per-channel toggles for a single notification category.
2 properties
RewardItem
object
A single referral reward earned by the current user.
7 properties
6 required
InvitedStatus
string
Status of an invited user along the KYB funnel.
KycStatusResponse
object
Response schema for KYC status check.
11 properties
3 required
ContactLinkedUserResponse
object
Linked HEVN user preview for contact.
2 properties
app__schemas__routers__user__contact__ContactRelationship
string
Relationship between the current user and the contact.
SwiftDetails
object
SWIFT (international wire) account details.
3 properties
2 required
AvatarUploadRequest
object
Request schema for uploading user avatar.
1 property
1 required
UserCreateRequest
object
Request schema for creating a user.
13 properties
FiatProvider
string
Supported fiat payment providers.
BankValidationRequest
object
Request to prevalidate bank details before creating a contact.
6 properties
1 required
USExternalAccountDetails-Input
object
US domestic (ACH) external account.
12 properties
3 required
ShareKybLinkRequest
object
Request schema for sharing a KYB link via email.
1 property
1 required
BankRequestedSettings-Input
object
User bank-rail interest settings.
1 property
BankValidationResponse
object
Result of bank detail validation.
4 properties
1 required
AppearancePreference
string
Appearance theme preference.
UaeAccountInput
object
UAE FTS bank contact input.
11 properties
3 required
SwiftAccountDetails-Output
object
SWIFT (international wire) external account.
13 properties
4 required
ContactListResponse
object
List of contacts response.
2 properties
2 required
NotificationListResponse
object
List of notifications response.
2 properties
2 required
ValidationError
object
3 properties
3 required
CountryCode
string
ISO 3166-1 alpha-2 country codes.
UserSettings-Output
object
User settings.
5 properties
UserEventRequest
object
Request schema for tracking user events.
2 properties
1 required
ContactCreateRequest
object
Request to create a contact.
8 properties
NotificationType
string
Notification type — matches the kind of event being notified.
InviteVolumeBonus
object
Volume-based bonus tier with a threshold.
3 properties
2 required
ContactPreviewResponse
object
Lightweight user preview for contact lookup.
4 properties
1 required
AlignAccountHolderType
string
Account holder type.
BankRequestedRailSettings
object
User interest in a bank rail group.
2 properties
OneClickChain
string
1click chain codes.
NotificationChannel
string
Notification delivery channel.
SwiftAccountDetails-Input
object
SWIFT (international wire) external account.
12 properties
3 required
RewardType
string
Referral reward type.
ContactUpdateRequest
object
Request to update a contact.
8 properties
InviteBonus
object
A single referral bonus tier.
2 properties
1 required
BankRequestedRails
object
Rails the user is interested in opening.
4 properties
SwiftAccountInput
object
SWIFT bank contact input.
13 properties
5 required
UserResponse
object
Schema for user response.
22 properties
6 required
ContactCryptoInput
object
Crypto contact input.
3 properties
3 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
InvitedUserResponse
object
A single invited user.
8 properties
4 required
ReferrerInfo
object
Lightweight info about the user who referred this user.
3 properties
2 required
InviteCodeResponse
object
Response for invite code.
3 properties
1 required
NotificationResponse
object
Single notification response.
8 properties
5 required
HTTPValidationError
object
1 property
SepaAccountInput
object
SEPA bank contact input.
11 properties
4 required
InviteRequest
object
Request schema for sending an invite.
2 properties
2 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Hevn publishes across the network.
