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

Datavant Prematch API

The Prematch API from Datavant — 4 operation(s) for prematch.

Datavant Prematch API is one of 8 APIs that Datavant publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 4 operations across 4 paths, and defines 42 schemas. It is described by OpenAPI 3.2.0, at version 2023-04-01.

Requests are made against a single base URL, https://api.datavant.io/v2.

4 operations 4 paths 42 schemas 1 DELETE2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2023-04-01
Base URL
https://api.datavant.io/v2
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Datavant Prematch API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the clientCredentials flow. By default, every request must be authenticated.

Paths & Operations 4

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

Prematch 4
POST
/orders/prematch
Create a prematch order
create_prematch_order_orders_prematch_post 1 param body → 201400422
GET
/orders/prematch/all
List Prematch Orders
list_prematch_orders_orders_prematch_all_get 1 param → 200400422
DELETE
/orders/prematch/{order_uuid}
Delete prematch order
delete_prematch_orders_prematch__order_uuid__delete 2 params → 204400422
GET
/orders/prematch/{order_id}/counts
Get prematch result counts
get_prematch_result_counts_orders_prematch__order_id__counts_get 2 params → 200400422

Schemas 42

The contract defines 42 schemas that model the data the API accepts and returns. The most detailed are OrderResponse (55 properties), PrematchOrderResponse (13 properties), LegalEntity (12 properties), StructuredDataExtractionReportConfiguration (8 properties). Each schema is shown below with its type and property counts.

ChartFinderConfiguration
object
A custom BaseModel with the eventual goal of populating inheriting models with the value property of enums rather than the raw enum. For now this is set to Fal…
7 properties
EachDocumentDeliveryOptions
object
A custom BaseModel with the eventual goal of populating inheriting models with the value property of enums rather than the raw enum. For now this is set to Fal…
2 properties 2 required
RetrievalSources
string
An enumeration.
DailyDeliveryOptions
object
A custom BaseModel with the eventual goal of populating inheriting models with the value property of enums rather than the raw enum. For now this is set to Fal…
2 properties 2 required
StructuredDataExtractionReportConfiguration
object
A custom BaseModel with the eventual goal of populating inheriting models with the value property of enums rather than the raw enum. For now this is set to Fal…
8 properties 1 required
MonthlyDeliveryOptions
object
A custom BaseModel with the eventual goal of populating inheriting models with the value property of enums rather than the raw enum. For now this is set to Fal…
2 properties 2 required
Contacts
object
A custom BaseModel with the eventual goal of populating inheriting models with the value property of enums rather than the raw enum. For now this is set to Fal…
2 properties
OrderResponse
object
Represents an Order object returned through the API.
55 properties 5 required
AllDeliveryConfig
object
Model for the delivery configuration.
5 properties
DueDateDeliveryOptions
object
A custom BaseModel with the eventual goal of populating inheriting models with the value property of enums rather than the raw enum. For now this is set to Fal…
2 properties 2 required
SecondaryReason
string
An enumeration.
DeliveryFormat
string
An enumeration.
Body_create_prematch_order_orders_prematch_post
object
5 properties 3 required
AllowBlockGroup
object
A custom BaseModel with the eventual goal of populating inheriting models with the value property of enums rather than the raw enum. For now this is set to Fal…
1 property
OrderStatus
string
OrderStatus is an enumeration representing the different stages in an order's lifecycle. Definitions: draft: An initial state for orders that are created but n…
S3FileTransferConfig
object
A custom BaseModel with the eventual goal of populating inheriting models with the value property of enums rather than the raw enum. For now this is set to Fal…
2 properties 2 required
LegalEntity
object
A custom BaseModel with the eventual goal of populating inheriting models with the value property of enums rather than the raw enum. For now this is set to Fal…
12 properties 1 required
PrimaryReason
string
An enumeration.
RequesterType
string
An enumeration.
BaseDeliveryConfig
object
A custom BaseModel with the eventual goal of populating inheriting models with the value property of enums rather than the raw enum. For now this is set to Fal…
5 properties 1 required
Error
object
3 properties 2 required
PdfDeliveryConfig
object
A custom BaseModel with the eventual goal of populating inheriting models with the value property of enums rather than the raw enum. For now this is set to Fal…
8 properties 1 required
SubmissionSource
string
An enumeration.
DeliveryTiming
string
An enumeration.
WeeklyDeliveryOptions
object
A custom BaseModel with the eventual goal of populating inheriting models with the value property of enums rather than the raw enum. For now this is set to Fal…
2 properties 2 required
ChartDetailExtractConfiguration
object
A custom BaseModel with the eventual goal of populating inheriting models with the value property of enums rather than the raw enum. For now this is set to Fal…
4 properties 1 required
ImportReviewStatus
object
A custom BaseModel with the eventual goal of populating inheriting models with the value property of enums rather than the raw enum. For now this is set to Fal…
1 property
DeliveryFrequencyDay
integer
An enumeration.
PrematchOrderResponse
object
Represents a Prematch Order object returned through the API.
13 properties 6 required
StructuredExtractionDeliveryConfig
object
A custom BaseModel with the eventual goal of populating inheriting models with the value property of enums rather than the raw enum. For now this is set to Fal…
7 properties 2 required
ManifestDeliveryConfig
object
A custom BaseModel with the eventual goal of populating inheriting models with the value property of enums rather than the raw enum. For now this is set to Fal…
5 properties 1 required
ErrorHTTPResponse
object
A custom BaseModel with the eventual goal of populating inheriting models with the value property of enums rather than the raw enum. For now this is set to Fal…
1 property 1 required
BiweeklyDeliveryOptions
object
A custom BaseModel with the eventual goal of populating inheriting models with the value property of enums rather than the raw enum. For now this is set to Fal…
2 properties 2 required
DeliveryType
string
An enumeration.
DeliveryLocation
string
Additional delivery locations for documents (besides API)
ZipDeliveryConfig
object
A custom BaseModel with the eventual goal of populating inheriting models with the value property of enums rather than the raw enum. For now this is set to Fal…
3 properties
ExtractionDeliveryConfig
object
A custom BaseModel with the eventual goal of populating inheriting models with the value property of enums rather than the raw enum. For now this is set to Fal…
4 properties 2 required
DeliveryFrequency
string
An enumeration.
Address
object
A custom BaseModel with the eventual goal of populating inheriting models with the value property of enums rather than the raw enum. For now this is set to Fal…
7 properties
RetrievalAllowBlockConfiguration
object
A custom BaseModel with the eventual goal of populating inheriting models with the value property of enums rather than the raw enum. For now this is set to Fal…
2 properties
ChartDetailExtractDeliveryConfig
object
A custom BaseModel with the eventual goal of populating inheriting models with the value property of enums rather than the raw enum. For now this is set to Fal…
6 properties 1 required
OrderValidationResponse
object
Order validation results.
6 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

datavant-prematch-api-openapi.yml Raw ↑

Other APIs Datavant publishes across the network.

Datavant Configuration API
Datavant Documents API
Datavant Oauth2 API
Datavant Order Queries API
Datavant Orders API
Datavant Projects API
Datavant Visits API
Where this information came from

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