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

Vim Patient Identification API

Identify the patient based on personal information

Vim Patient Identification API is one of 10 APIs that Vim publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Patient Identification. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, and rate-limit docs.

This API exposes 1 operation across 1 path, and defines 3 schemas. It is described by OpenAPI 3.2.0.

Requests are made against a single base URL, https://{environment}-{customerName}.com.

1 operations 1 paths 3 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
Base URL
https://api.getvim.com/v1
Authentication
OAuth 2.0, HTTP Bearer
Resource Areas
1

Authentication & Security 2

Vim Patient Identification API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (service) using the implicit flow. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Bearer authentication token obtained from the /oauth/token endpoint

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Patient Identification 1

Identify the patient based on personal information

POST
/patient/identify
Identify an Eligible Patient
post-patient-identify 2 params body → 200400401403404500

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are PatientDetails (8 properties), IdentifyPatientResponse (2 properties), ErrorResponse (2 properties). Each schema is shown below with its type and property counts.

PatientDetails
object
Patient identification details
8 properties 3 required
ErrorResponse
object
2 properties 2 required
IdentifyPatientResponse
object
Response from patient identification
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vim-patient-identification-api-openapi.yml Raw ↑

Other APIs Vim publishes across the network.

Vim Canvas SDK (VimOS.js)
Vim Access Token Retrieval API
Vim Applications API
Vim Appointments API
Vim Authentication API
Vim Chart Retrieval API
Vim Get Patient Care Insights API
Vim Invitations API
Vim Patient Care Insights Feedback API
Where this information came from

This is an independent, third-party profile of Vim Patient Identification 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.