# Datasets

Endpoints related to scanning datasets and reading resulting matches. The supported datasets will grow over time and can be discovered via the [ListDatasets](/reference/operation/ListDatasets) endpoint. A dataset scan is asynchronous, but most scans will result in near immediate completion. A webhook of type [DatasetScanCompleted](/reference/tag/Webhook-Callbacks/#tag/Webhook-Callbacks/section/DatasetScanCompleted) is triggered upon completion, but you can also check the completion status by querying the [GetDatasetScan](#operation/GetDatasetScan) operation.


## Start a dataset scan

 - [POST /datasets/scans](https://test-docs.discovery-staging.verifiable.com/references/development/deprecated/api/datasets/startdatasetscan.md): Starts a new dataset scan.

Will return a failed scan if required parameters are missing.

## List dataset scans

 - [GET /datasets/scans](https://test-docs.discovery-staging.verifiable.com/references/development/deprecated/api/datasets/listdatasetscans.md): Returns a page of dataset scans.

## Get dataset scan

 - [GET /datasets/scans/{scanId}](https://test-docs.discovery-staging.verifiable.com/references/development/deprecated/api/datasets/getdatasetscan.md): Returns the status and results for a previously started dataset scan.

## List dataset matches

 - [GET /datasets/matches](https://test-docs.discovery-staging.verifiable.com/references/development/deprecated/api/datasets/listdatasetmatches.md): Returns a page of dataset matches. By default, only matches that have not been rejected are returned. By default, only the most recent matches are returned.

## Get dataset metadata

 - [GET /datasets/{datasetType}](https://test-docs.discovery-staging.verifiable.com/references/development/deprecated/api/datasets/getdataset.md): Returns metadata for a specific dataset. The metadata includes the date it was last updated in our system in addition to the JSON schema used for the records.

## List datasets metadata

 - [GET /datasets](https://test-docs.discovery-staging.verifiable.com/references/development/deprecated/api/datasets/listdatasets.md): Returns metadata for all available datasets. The metadata includes the date it was last updated in our system in addition to the JSON schema used for the records.

## Get dataset scan parameters for a provider

 - [GET /datasets/{datasetType}/parameters/providers/{providerId}](https://test-docs.discovery-staging.verifiable.com/references/development/deprecated/api/datasets/getproviderdatasetscanparameters.md): Returns the list of dataset scan parameters that will be used during a dataset scan.

## Get dataset scan parameters for a facility

 - [GET /datasets/{datasetType}/parameters/facilities/{facilityId}](https://test-docs.discovery-staging.verifiable.com/references/development/deprecated/api/datasets/getfacilitydatasetscanparameters.md): Returns the list of dataset scan parameters that will be used during a dataset scan.

## Upload a dataset file

 - [POST /datasets/{datasetType}/uploads](https://test-docs.discovery-staging.verifiable.com/references/development/deprecated/api/datasets/uploaddatasetfile.md): Uploads a dataset file. Only CSV files are supported.

## Get dataset matches aggregations

 - [GET /datasets/matches/aggregations](https://test-docs.discovery-staging.verifiable.com/references/development/deprecated/api/datasets/getdatasetmatchesaggregations.md): Returns aggregated counts for dataset matches that require user action and for dataset matches that have been accepted.

## (Deprecated) Get dataset scan parameters for a provider

 - [GET /datasets/{datasetType}/parameters/{providerId}](https://test-docs.discovery-staging.verifiable.com/references/development/deprecated/api/datasets/getdatasetscanparameters.md): Returns the list of dataset scan parameters that will be used during a dataset scan.

## List schools

 - [GET /datasets/nsc/schoolCodes](https://test-docs.discovery-staging.verifiable.com/references/development/deprecated/api/datasets/listnscschools.md): Returns a page of schools that are supported by NSC.

The codes originating from National Student Clearinghouse

## Patch an existing dataset match

 - [PATCH /datasets/matches/{matchId}](https://test-docs.discovery-staging.verifiable.com/references/development/deprecated/api/datasets/patchdatasetmatch.md): Allows you to reject, accept or restore a previous rejected dataset match. Only a match from the most recent scan can be patched.

## Refresh dataset scan

 - [POST /datasets/scans/{scanId}/refresh](https://test-docs.discovery-staging.verifiable.com/references/development/deprecated/api/datasets/refreshdatasetscan.md): Triggers a refresh for an existing running continuous dataset scan. Currently only NPDB dataset supports it. For NPDB it will trigger Status request to fetch the latest available response from the site.