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

The checkout API from Vital — 6 operation(s) for checkout.

This API exposes 6 operations across 6 paths, and defines 31 schemas. It is described by OpenAPI 3.2.0, at version 0.4.911.

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.

6 operations 6 paths 31 schemas 2 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

Vital Checkout 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 6

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

Checkout 6
POST
/checkout/v1/session
Create Session
create_session_checkout_v1_session_post 1 param body → 200422
GET
/checkout/v1/session/{checkout_session_id}
Get Session
get_session_checkout_v1_session__checkout_session_id__get 1 param → 200422
POST
/checkout/v1/session/{checkout_session_id}/confirm
Confirm Session
confirm_session_checkout_v1_session__checkout_session_id__confirm_post 1 param → 200422
POST
/checkout/v1/quote
Create Quote
create_quote_checkout_v1_quote_post body → 200422
POST
/checkout/v1/quote/{quote_id}/refine
Refine Quote
refine_quote_checkout_v1_quote__quote_id__refine_post 1 param body → 200422
GET
/checkout/v1/quote/{quote_id}
Get Quote
get_quote_checkout_v1_quote__quote_id__get 1 param → 200422

Schemas 31

The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are PatientDetailsWithValidation (13 properties), CheckoutQuote (10 properties), CheckoutSession (10 properties), PatientAddressWithValidation (9 properties). Each schema is shown below with its type and property counts.

ClientFacingCheckoutQuoteCreated
object
3 properties 3 required
OrderSetParameters
object
1 property
Ethnicity
string
ℹ️ This enum is non-exhaustive.
LabTestCollectionMethod
string
The method used to perform a lab test. ℹ️ This enum is non-exhaustive.
CheckoutSessionPayment
object
4 properties 2 required
PatientDetailsWithValidation
object
Patient details with validation for firstname, lastname, email, and dob.
13 properties 6 required
Gender
string
ℹ️ This enum is non-exhaustive.
GuarantorDetails
object
7 properties 4 required
CheckoutSessionAppointment
object
A PSC slot held with the collection network while the patient pays; it becomes the order's appointment once payment creates the order.
3 properties 2 required
CheckoutQuote
object
10 properties 10 required
CreateCheckoutQuoteBody
object
4 properties 4 required
RefineCheckoutQuoteBody
object
1 property
ClientFacingCheckoutSessionCreated
object
3 properties 3 required
CheckoutSessionPaymentMethod
string
ℹ️ This enum is non-exhaustive.
SexualOrientation
string
ℹ️ This enum is non-exhaustive.
CheckoutSessionStatus
string
ℹ️ This enum is non-exhaustive.
OrderSetFastingRequirement
string
ℹ️ This enum is non-exhaustive.
WalkInCollectionNetworkSlug
string
ℹ️ This enum is non-exhaustive.
Address
object
7 properties 5 required
Race
string
ℹ️ This enum is non-exhaustive.
CreateCheckoutSessionBody
object
6 properties 5 required
PatientAddressWithValidation
object
9 properties 5 required
ClientFacingCheckoutSessionUpdated
object
3 properties 3 required
GenderIdentity
string
ℹ️ This enum is non-exhaustive.
CheckoutAppointmentHoldStatus
string
Public view of the checkout's PSC appointment hold. None on the snapshot means no appointment was requested. held covers both a live vendor hold and the attach…
CheckoutQuoteLineItemCode
string
ℹ️ This enum is non-exhaustive.
AddOnOrder
object
2 properties
CheckoutQuoteLineItem
object
3 properties 3 required
CheckoutSession
object
A checkout session collects payment for a quote; once it is paid, the order is created. The checkout session endpoints return this object, and checkout.session…
10 properties 8 required
HTTPValidationError
object
1 property
OrderSetRequest
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vital-io-checkout-api-openapi.yml Raw ↑
Where this information came from

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