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

The user API from Vital — 16 operation(s) for user.

Vital user 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 User. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 7 JSON Schemas.

This API exposes 19 operations across 16 paths, and defines 43 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.

19 operations 16 paths 43 schemas 2 DELETE9 GET2 PATCH6 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 user 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 19

Across 16 paths, the API surfaces 19 operations — 2 DELETE, 9 GET, 2 PATCH, 6 POST. Each is listed below with its method, path, parameters, and response codes.

user 19
GET
/v2/user
Get Teams Users
get_teams_users_v2_user_get 2 params → 200422
POST
/v2/user
Create User
create_user_v2_user_post body → 200400422
GET
/v2/user/metrics
Get Teams Metrics
get_teams_metrics_v2_user_metrics_get → 200
GET
/v2/user/providers/{user_id}
Get Connected Providers
get_connected_providers_v2_user_providers__user_id__get 1 param → 200422
GET
/v2/user/{user_id}/info/latest
Get User Demographcis
get_user_demographcis_v2_user__user_id__info_latest_get 1 param → 200422
POST
/v2/user/{user_id}/insurance
Create Insurance
create_insurance_v2_user__user_id__insurance_post 1 param body → 200422
GET
/v2/user/{user_id}/insurance/latest
Get Latest Insurance
get_latest_insurance_v2_user__user_id__insurance_latest_get 2 params → 200422
PATCH
/v2/user/{user_id}/info
Create User Demographics
create_user_demographics_v2_user__user_id__info_patch 1 param body → 200422
GET
/v2/user/resolve/{client_user_id}
Get User By Client User Id
get_user_by_client_user_id_v2_user_resolve__client_user_id__get 1 param → 200422
DELETE
/v2/user/{user_id}/{provider}
Deregister Provider
deregister_provider_v2_user__user_id___provider__delete 2 params → 200422
PATCH
/v2/user/{user_id}
Patch User
patch_user_v2_user__user_id__patch 1 param body → 204422
DELETE
/v2/user/{user_id}
Delete User
delete_user_v2_user__user_id__delete 1 param → 200422
GET
/v2/user/{user_id}
Get User
get_user_v2_user__user_id__get 1 param → 200422
POST
/v2/user/undo_delete
Undo User Delete
undo_user_delete_v2_user_undo_delete_post 2 params → 200422
POST
/v2/user/refresh/{user_id}
Refresh User Id
refresh_user_id_v2_user_refresh__user_id__post 2 params → 200202400422
GET
/v2/user/{user_id}/device
Get User Devices
get_user_devices_v2_user__user_id__device_get 1 param → 200422
GET
/v2/user/{user_id}/device/{device_id}
Get User Device
get_user_device_v2_user__user_id__device__device_id__get 2 params → 200422
POST
/v2/user/{user_id}/sign_in_token
Get User Sign In Token
get_user_sign_in_token_v2_user__user_id__sign_in_token_post 1 param → 200422
POST
/v2/user/{user_id}/create_portal_url
Create User Portal Url
create_user_portal_url_v2_user__user_id__create_portal_url_post 1 param body → 200422

Schemas 43

The contract defines 43 schemas that model the data the API accepts and returns. The most detailed are UserInfoCreateRequest (12 properties), UserInfo (12 properties), ClientFacingDevice (9 properties), ClientFacingUser (9 properties). Each schema is shown below with its type and property counts.

GuarantorDetails
object
7 properties 4 required
Gender
string
ℹ️ This enum is non-exhaustive.
UserAddress
object
7 properties 5 required
Address
object
7 properties 5 required
ConnectedSourceClientFacing
object
3 properties 3 required
Resource
string
ℹ️ This enum is non-exhaustive.
TimeseriesMetricPoint
object
3 properties 3 required
SexualOrientation
string
ℹ️ This enum is non-exhaustive.
FallbackTimeZone
object
3 properties 3 required
ClientFacingProviderWithStatus
object
8 properties 6 required
Availability
string
ℹ️ This enum is non-exhaustive.
UserRefreshSuccessResponse
object
5 properties 5 required
FallbackBirthDate
object
3 properties 3 required
vital_core__schemas__db_schemas__lab_test__insurance__PersonDetails
object
7 properties 7 required
UserRefreshErrorResponse
object
4 properties 3 required
CompanyDetails
object
2 properties 2 required
UserPatchBody
object
5 properties
UserInfoCreateRequest
object
12 properties 7 required
UserCreateBody
object
5 properties 1 required
CreateUserPortalURLResponse
object
2 properties 2 required
ClientFacingInsurance
object
8 properties 5 required
ClientFacingConnectionErrorDetails
object
3 properties 3 required
Race
string
ℹ️ This enum is non-exhaustive.
Ethnicity
string
ℹ️ This enum is non-exhaustive.
HTTPValidationError
object
1 property
Providers
string
ℹ️ This enum is non-exhaustive.
UserSignInTokenResponse
object
2 properties 2 required
GenderIdentity
string
ℹ️ This enum is non-exhaustive.
CreateInsuranceRequest
object
7 properties 4 required
ScopeRequirementsGrants
object
2 properties 2 required
ResourceAvailability
object
2 properties 1 required
ScopeRequirements_str_
object
2 properties 2 required
MetricsResult
object
6 properties 1 required
UserInfo
object
12 properties 7 required
ClientFacingUser
object
9 properties 6 required
CreateUserPortalURLBody
object
2 properties 1 required
PaginatedUsersResponse
object
4 properties 4 required
UserSuccessResponse
object
1 property 1 required
ClientFacingProvider
object
A vendor, a service, or a platform which Vital can connect with.
3 properties 3 required
ClientFacingDevice
object
9 properties 4 required
ClientUserIDConflict
object
4 properties 4 required
ResponsibleRelationship
string
ℹ️ This enum is non-exhaustive.
ClientUserIDConflictResponse
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vital-io-user-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 link API
Vital order API
Vital order_transaction API
Vital orders API
Where this information came from

This is an independent, third-party profile of Vital user 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.