How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Vital link API

The link API from Vital — 13 operation(s) for link.

Vital link API is one of 18 APIs that Vital publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 7 JSON Schema definitions.

Tagged areas include Link. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 7 JSON Schemas.

This API exposes 13 operations across 13 paths, and defines 30 schemas. It is described by OpenAPI 3.1.0, at version 0.4.497.

Requests are made against 4 base URLs: https://api.us.junction.com, https://api.eu.junction.com, https://api.sandbox.us.junction.com, https://api.sandbox.eu.junction.com.

13 operations 13 paths 30 schemas 3 GET10 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.4.497
Base URL
https://api.us.junction.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Vital link API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-vital-api-key (apiKeyAuth). By default, every request must be authenticated.

  • apiKeyAuth — Vital Team API Key

Paths & Operations 13

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

link 13
GET
/v2/link/bulk_op
List Bulk Ops
list_bulk_ops_v2_link_bulk_op_get 2 params → 200422
POST
/v2/link/bulk_import
Bulk Import Connections
bulk_import_connections_v2_link_bulk_import_post body → 200202422
POST
/v2/link/bulk_trigger_historical_pull
Bulk Trigger Historical Pull
bulk_trigger_historical_pull_v2_link_bulk_trigger_historical_pull_post body → 200202422
POST
/v2/link/bulk_export
Bulk Export Connections
bulk_export_connections_v2_link_bulk_export_post body → 200422
POST
/v2/link/bulk_pause
Bulk Pause Connections
bulk_pause_connections_v2_link_bulk_pause_post body → 200422
POST
/v2/link/token
Generate Vital Link Token
generate_vital_link_token_v2_link_token_post body → 200422
POST
/v2/link/code/create
Create Token
create_token_v2_link_code_create_post 2 params → 200422
GET
/v2/link/provider/oauth/{oauth_provider}
Generate Oauth Link Endpoint
generate_oauth_link 2 params → 200422
POST
/v2/link/provider/password/{provider}
Connect Password Provider
connect_password_provider_v2_link_provider_password__provider__post 2 params body → 200422
POST
/v2/link/provider/password/{provider}/complete_mfa
Complete Password Provider Mfa
complete_password_provider_mfa_v2_link_provider_password__provider__complete_mfa_post 2 params body → 200422
POST
/v2/link/provider/email/{provider}
Connect Email Auth Provider
connect_email_auth_provider_v2_link_provider_email__provider__post 2 params body → 200422
GET
/v2/link/providers
Get Providers
get_providers_v2_link_providers_get 1 param → 200422
POST
/v2/link/connect/demo
Create Demo Connection
create_demo_connection_v2_link_connect_demo_post body → 200422

Schemas 30

The contract defines 30 schemas that model the data the API accepts and returns. The most detailed are Source (11 properties), SourceLink (8 properties), ProviderLinkResponse (8 properties), BulkOp (7 properties). Each schema is shown below with its type and property counts.

SourceType
string
ℹ️ This enum is non-exhaustive.
LinkTokenExchange
object
6 properties 1 required
BulkOp
object
7 properties 7 required
DemoProviders
string
ℹ️ This enum is non-exhaustive.
DemoConnectionCreationPayload
object
2 properties 2 required
ProviderMFARequest
object
2 properties 2 required
VitalTokenCreatedResponse
object
3 properties 3 required
LinkTokenExchangeResponse
object
2 properties 2 required
BulkOpsResponse
object
2 properties 2 required
Source
object
11 properties 5 required
BulkTriggerHistoricalPullBody
object
3 properties 2 required
BulkImportConnectionsResponse
object
2 properties 2 required
IndividualProviderData
object
3 properties 2 required
BulkExportConnectionsResponse
object
2 properties 2 required
SourceLink
object
8 properties 5 required
EmailProviders
string
ℹ️ This enum is non-exhaustive.
ConnectionRecipe
object
6 properties 5 required
BulkExportConnectionsBody
object
3 properties 1 required
OAuthProviders
string
ℹ️ This enum is non-exhaustive.
Providers
string
ℹ️ This enum is non-exhaustive.
HTTPValidationError
object
1 property
SourceAuthType
string
ℹ️ This enum is non-exhaustive.
BulkPauseConnectionsBody
object
2 properties 2 required
EmailProviderAuthLink
object
3 properties 1 required
Region
string
ℹ️ This enum is non-exhaustive.
BulkImportConnectionsBody
object
3 properties 2 required
PasswordProviders
string
ℹ️ This enum is non-exhaustive.
CompletePasswordProviderMFABody
object
1 property 1 required
DemoConnectionStatus
object
2 properties 2 required
ProviderLinkResponse
object
8 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vital-io-link-api-openapi.yml Raw ↑

Other APIs Vital publishes across the network.

Vital Management API
Vital Aggregate API
Vital compendium API
Vital insurance API
Vital introspect API
Vital lab_account API
Vital lab_report API
Vital lab_tests API
Vital order API
Vital order_transaction API
Vital orders API
Vital payor API
Where this information came from

This is an independent, third-party profile of Vital link API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.