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

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

Hevn Inc kyb 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 kyb. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 10 operations across 8 paths, and defines 26 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 8 paths 26 schemas 2 GET6 POST2 PUT

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 kyb 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 8 paths, the API surfaces 10 operations — 2 GET, 6 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

kyb 10
PUT
/api/v1/b2b/kyb/draft
Save KYB draft
save_kyb_draft_api_v1_b2b_kyb_draft_put 1 param body → 200422
GET
/api/v1/b2b/kyb/draft
Get KYB draft
get_kyb_draft_api_v1_b2b_kyb_draft_get 1 param → 200422
POST
/api/v1/b2b/kyb/draft/documentsdeprecated
Upload draft document (deprecated, use POST /documents/upload)
upload_draft_document_api_v1_b2b_kyb_draft_documents_post 1 param body → 201422
POST
/api/v1/b2b/kyb/submit
Submit KYB
submit_kyb_api_v1_b2b_kyb_submit_post 2 params → 200422
POST
/api/v1/b2b/kyb/request
Request KYB for a provider
request_kyb_api_v1_b2b_kyb_request_post 1 param → 200422
PUT
/api/v1/kyb/b2b/kyb/draft
Save KYB draft
save_kyb_draft_package_alias_api_v1_kyb_b2b_kyb_draft_put 1 param body → 200422
GET
/api/v1/kyb/b2b/kyb/draft
Get KYB draft
get_kyb_draft_package_alias_api_v1_kyb_b2b_kyb_draft_get 1 param → 200422
POST
/api/v1/kyb/b2b/kyb/draft/documentsdeprecated
Upload draft document (deprecated, use POST /documents/upload)
upload_draft_document_package_alias_api_v1_kyb_b2b_kyb_draft_documents_post 1 param body → 201422
POST
/api/v1/kyb/b2b/kyb/submit
Submit KYB
submit_kyb_package_alias_api_v1_kyb_b2b_kyb_submit_post 2 params → 200422
POST
/api/v1/kyb/b2b/kyb/request
Request KYB for a provider
request_kyb_package_alias_api_v1_kyb_b2b_kyb_request_post 1 param → 200422

Schemas 26

The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are BusinessUserCreateRequest-Input (30 properties), BusinessUserCreateRequest-Output (30 properties), ShareholderDraftResponse (17 properties), FiatShareholder (16 properties). Each schema is shown below with its type and property counts.

KybSubmitResponse
object
Submit response.
4 properties 3 required
KybDocumentUpload
object
Document upload for draft.
5 properties 2 required
FiatPurposeOfFunds
string
Purpose of funds.
BusinessUserCreateRequest-Input
object
Request schema for creating/updating a business user (all fields optional for partial updates).
30 properties
KybDraftResponse
object
Full draft response.
13 properties 2 required
ValidationError
object
3 properties 3 required
FiatShareholder
object
Shareholder data stored in businessdata JSONB.
16 properties 1 required
HTTPValidationError
object
1 property
FiatSourceOfFunds
string
Source of funds.
FiatIdentityDocumentType
string
Identity document type.
FiatBusinessAddress
object
Business address.
6 properties
ShareholderDraftResponse
object
Shareholder in response with resolved documents. All fields optional for partial filling.
17 properties 1 required
FiatBusinessType
string
Business industry type.
FiatShareholderAddress
object
Shareholder address.
4 properties
DocumentDraftInfo
object
Document info in response.
7 properties 2 required
KybDraftRequest
object
Draft request. Documents are uploaded separately via POST /kyb/draft/documents.
3 properties
FiatEntityType
string
Business entity type.
FiatIdentityDocument
object
Identity document for shareholder.
3 properties
BusinessUserCreateRequest-Output
object
Request schema for creating/updating a business user (all fields optional for partial updates).
30 properties
CountryCode
string
ISO 3166-1 alpha-2 country codes.
SlxDocumentType
string
Document types for upload.
FiatRailResponse
object
Response schema for a user's fiat rail registration.
4 properties 1 required
FiatVerifierRole
string
KYB verifier role.
KycStatus
string
KYC verification status.
BankRail
string
Bank account route: provider rail + bank id ({rail}-{bank}).
FiatProvider
string
Supported fiat payment providers.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

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