Verifiable Reports API
The Reports API from Verifiable — 4 operation(s) for reports.
OpenAPI Specification
openapi: 3.0.1
info:
title: Verifiable API Documentation Alerts Reports API
description: "# Introduction\n\nThis document contains the official documentation for the latest version of the Verifiable API. Our solution has been built API-first. That means we first design our API's and build our own user interfaces on top of these API's afterwards. This results in a reusable API that can be used by 3rd parties to offer the exact same functionality as we can provide ourselves. Both the product and API are still subject to significant and potentially breaking changes, so please refer back to this documentation frequently. Any breaking change will be communicated ahead of time to our partners integrating with our API's.\n\n# Release Notes\n\nVerifiable customers can find [release notes](https://help.verifiable.com/hc/en-us/sections/49501536514067-Verifiable-APIs) in the Verifiable Help Center. To access the notes for the first time, go to the [Help Center](https://help.verifiable.com/hc/en-us) and click Sign up next to New to Verifiable.\n\n# Getting Started\n\nThis is a RESTful API that can be accessed using convential HTTP methods. It doesn't matter what programming language you use, there is already tooling available that can jumpstart you to access our API's. This documentation is based on OpenAPI 3.0 specifications and as such it is possible to dynamically generate a client in a language of your choice by simply loading our [specification document](https://api.discovery.verifiable.com/.well-known/openapi/vCurrent.json) in a tool such as [Swagger Codegen](https://swagger.io/tools/swagger-codegen/). It is not necessary to generate such a client and it is also possible to simply use any HTTP client to access our API. You can refer to the reference below to find the correct HTTP method, endpoint and model to use.\n\n### Environments\n\nWhen developing an integration with our API we typicially request you to use our `staging` environment for development and only start using `production` when your integration is stable and tested thoroughly. Please contact [Verifiable support](https://verifiable.com/contact) to be granted access to our environments.\n\n**Staging Base URL**\n```\nhttps://discovery-staging.verifiable.com/api\n```\n\n**Production Base URL**\n```\nhttps://discovery.verifiable.com/api\n```\n\n## Authentication\n\nMost endpoints require authentication to be used. You can authenticate to the API by passing an access token in the `Authentication` header using the `Bearer` scheme. An access token can be requested by authenticating against one of the [Authentication endpoints](/references/api/authentication).\n\n### Example using password authentication endpoint\n\n**Request:**\n\n```http\nPOST /auth/token/password HTTP/1.1\nContent-Type: application/json\nHost: https://<SERVER>\n{\n \"email\": \"john.doe@mail.com\",\n \"password\": \"secret\"\n}\n```\n\n**Response:**\n\n```http\nHTTP/1.1 200 OK\nDate: Fri, 25 Sep 2020 12:59:56 GMT\nContent-Type: application/json; charset=utf-8\n{\n \"tokenId\": \"2e5db76c-4c48-4cce-b11f-23a57ac5824c\",\n \"token\": \"MtetyFcIW...xgXXX-Z4yy\"\n}\n```\n\n### Example using access token\n\n**Request**\n\n```http\nGET /log/events HTTP/1.1\nAuthorization: Bearer <ACCESS_TOKEN>\nHost: https://<SERVER>\n```\n\nAn access token is bound to a single user in an organization. The access token should remain secret and be treated as if it were a password. We recommend you to create access tokens with a short time to live and frequently rotate them. Note that time to live requested might be lowered to a shorter duration based on your organization settings. These can be configured to enforce a suitable maximum time to live for your use-cases that facilitate users and service integrations.\n\n## Create a new provider\n\nA provider must be created and associated with license numbers, NPI numbers or other identifiers that can be used to perform lookups to fetch associated data for this provider.\n\n### Example creating a new provider\n\nTo create a new provider that can be used for license lookups:\n\n**Request:**\n\n```http\nPOST /providers HTTP/1.1\nContent-Type: application/json\nAuthorization: Bearer <ACCESS_TOKEN>\nHost: https://<SERVER>\n{\n \"firstName\": \"John\",\n \"lastName\": \"Doe\"\n}\n```\n\n**Response:**\n\n```http\nHTTP/1.1 201 Created\nDate: Fri, 25 Sep 2020 15:25:12 GMT\nContent-Type: application/json; charset=utf-8\nLocation: https://<SERVER>/providers/9706f2ea-9c1d-49f3-9a57-871159878c9c\n{\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"id\": \"9706f2ea-9c1d-49f3-9a57-871159878c9c\",\n \"licenses\": []\n}\n```\n\n**Note:**\nThe `id` in the response is the `Provider id`. It can be used as a `Path Parameter` to attach licenses to this provider, using [Attach License](/references/api/licenses/attachlicense) API.\nYou will need to pass in a `licenseTypeId`, which can be obtained from the [List Simplified License Types](/references/api/licenses/listsimplifiedlicensetypes) API. For more details on providers see [Provider endpoints](/references/api/providers)\n\n## Get license types\n\nThe list of license types which are supported for license verification.\n\n### Example get license types\n\nReturns a list of all license types that are currently supported and used for license verifications.\n\n**Request**\n\n```http\nGET /licensetypes HTTP/1.1\nAuthorization: Bearer <ACCESS_TOKEN>\nHost: https://<SERVER>\n```\n\n**Response:**\n\n```http\nHTTP/1.1 200 OK\nDate: Fri, 25 Sep 2020 15:32:47 GMT\nContent-Type: application/json; charset=utf-8\n{\n \"nextOffset\": \"100\",\n \"nextCursor\": \"100\",\n \"pageSize\": 100,\n \"items\": [\n {\n \"id\": \"0059f76a-280a-377a-73e2-ddfe86f4113c\",\n \"name\": \"Medical Physician & Surgeon\",\n \"source\": {\n \"id\": \"72dcec62-a0d3-4af8-955d-07ecac8f1e4d\",\n \"name\": \"Missouri Division of ProfessionalRegistration\",\n \"state\": \"MO\",\n \"availability\": \"Available\",\n \"isDegraded\": false,\n \"url\": \"https://pr.mo.gov/licensee-search.asp\"\n }\n },\n ],\n \"sortedBy\": \"Id\",\n \"sortDirection\": \"Asc\"\n}\n```\n\n**Note:**\n`id` in response refers to `licenseTypeId`. It will be unique for each license type. Please see [List Simplified License Types](/references/api/licenses/listsimplifiedlicensetypes) for more details.\n\n## Attach a license to a provider\n\nTo perform a license verification you must attach a license to a provider. The first time you do this will automatically trigger a license verification on that provider. Once attached you can re-verify the same license without reattaching it. A provider can have more than one license attached.\n\n### Example attach license to a provider\n\n**Request:**\n\n```http\nPOST /providers/{providerId}/licenses HTTP/1.1\nContent-Type: application/json\nAuthorization: Bearer <ACCESS_TOKEN>\nHost: https://<SERVER>\n{\n \"licenseNumber\": \"123456\",\n \"licenseTypeId\": \"0059f76a-280a-377a-73e2-ddfe86f4113c\"\n}\n```\n\n**Response:**\n\n```http\nHTTP/1.1 201 Created\nDate: Fri, 25 Sep 2020 15:35:00 GMT\nContent-Type: application/json; charset=utf-8\nLocation: https://<SERVER>/providers/9706f2ea-9c1d-49f3-9a57-871159878c9c?licenseId=bfb028f0-52ca-47f4-8181-6b4c8262d29c\n{\n \"providerId\": \"9706f2ea-9c1d-49f3-9a57-871159878c9c\",\n \"licenseNumber\": \"123456\",\n \"licenseType\": {\n \"id\": \"0059f76a-280a-377a-73e2-ddfe86f4113c\",\n \"name\": \"Registered Nurse - RN\",\n \"source\": {\n \"id\": \"679b4f9a-cc3c-49e8-b560-0d0a9af47fd3”,\n \"name\": \"Missouri Division of ProfessionalRegistration\",\n \"state\": \"MO\",\n \"availability\": \"Available\",\n \"url\": \"https://pr.mo.gov/licensee-search.asp\"\n }\n }\n \"jobStatus\": \"Pending\",\n \"id\": \"b45cbeb0-873e-495b-8182-1b9a8b6d379d\"\n}\n```\n\n**Note:**\nRegister a Webhook to get notified on HTTP endpoint, this prevents the need to poll the API for completion checks. For more details on Webhooks please see [Webhooks endpoint](/references/api/webhooks) and for details on attaching a license see [Attach License endpoint](/references/api/licenses/attachlicense).\n\n## Fetch created provider\n\nReturns the data for a specific provider.\n\n### Example to fetch created provider\n\n**Request**\n\n```http\nGET /providers/{providerId} HTTP/1.1\nAuthorization: Bearer <ACCESS_TOKEN>\nHost: https://<SERVER>\n```\n\n**Response:**\n\n```http\nHTTP/1.1 200 OK\nDate: Fri, 25 Sep 2020 15:36:30 GMT\nContent-Type: application/json; charset=utf-8\n{\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"id\": \"9706f2ea-9c1d-49f3-9a57-871159878c9c\",\n \"npis\": [],\n \"licenses\": [\n {\n \"providerId\": \"9706f2ea-9c1d-49f3-9a57-871159878c9c\",\n \"licenseNumber\": \"123456\",\n \"licenseType\": {\n \"id\": \"0059f76a-280a-377a-73e2-ddfe86f4113c\",\n \"name\": \"Registered Nurse - RN\",\n \"source\": {\n \"id\": \"679b4f9a-cc3c-49e8-b560-0d0a9af47fd3”,\n \"name\": \"Missouri Division of ProfessionalRegistration\",\n \"state\": \"MO\",\n \"availability\": \"Available\",\n \"url\": \"https://pr.mo.gov/licensee-search.asp\"\n }\n }\n \"jobStatus\": \"Idle\",\n \"currentVerificationStatus\": \"NeedsReview\",\n \"id\": \"b45cbeb0-873e-495b-8182-1b9a8b6d379d\"\n }\n ]\n}\n```\n\n**Note:**\nResponse contains attached licenses, NPI details for the given provider. To get details of these individual items (a particular License or an NPI), use unique identifiers in each of these categories. For more details check [Get specific license endpoint](/references/api/licenses/getlicense). Further details on providers are at [Providers endpoint](/references/api/providers).\n\n# Common Concepts\n\n## Pagination, filtering and sorting\n\nSome endpoints can return a large list of data. To allow you to efficiently iterate through this data these endpoints offer pagination, sorting and filtering. The concept will be similar for each endpoint that supports it:\n\n* Pagination, filtering and sorting parameters are provided through the query string.\n* Pagination, filtering and sorting is only supported for endpoints that return lists of data.\n* Filters is only supported for certain endpoints. You can refer to the documentation of the endpoint to find out if filtering is supported.\n* The `sortedBy` and `sortDirection` parameters can be used to specify the sorting method.\n* The `count` parameter can be used to specify the page size. Please note that the maximum and default page size can differ per endpoint.\n* (Deprecated) The `offset` parameter influences the start of the page. For the first page you can always omit this parameter. For any subsequent page you can supply the value from the `nextOffset` parameter as returned by the server.\n* The `cursor` parameter influences the start of the page. For the first page you can always omit this parameter. For any subsequent page you can supply the value from the `nextCursor` or `previousCursor` parameter as returned by the server.\n\nExample on how to make a paginated request:\n\n```http\nGET /log/events?sortDirection=Asc&sortedBy=Timestamp&count=10 HTTP/1.1\nAuthorization: Bearer <ACCESS_TOKEN>\nHost: https://<SERVER>\n```\n\nIn addition to returning a list of `items`, a paginated response will also return `nextCursor` and/or `previousCursor`. The value of this property can be used to fetch the next or previous page by passing it in the `cursor` parameter.\n\n## Error handling\n\nAll responses that do not indicate a success status code will return an error using the error model as specified by [RFC 7807](https://tools.ietf.org/html/rfc7807). The amount of details exposed by the error model varies and depends on the nature of the error. We attempt to include as much information as is necessary to be able to self-diagnose the problem that led to the error. Should this information not be enough, then we also supply a `correlationId` in the response. We kindly request you to make note of this value when contacting Verifiable support as this will help us to quickly locate more information on this error.\n\nExample error result on a malformed request:\n```json\n{\n \"type\": \"https://tools.ietf.org/html/rfc7231#section-6.5.1\",\n \"title\": \"One or more validation errors occurred.\",\n \"status\": 400,\n \"correlationId\": \"5e94110e-45a8-404c-831d-77eaeaa73ad6\",\n \"errors\": {\n \"$.firstName\": [\n \"The JSON value could not be converted to System.String. Path: $.firstName | LineNumber: 1 | BytePositionInLine: 18.\"\n ]\n }\n}\n```\n\n## Nullable properties\n\nIf an input parameter is required it is marked as such. If an input parameter is not marked as required and you do not wish or need to use it, you should omit the parameter completely in the request.\n\nFor response parameters you should always code defensively and assume that a parameter might be missing from the response. This could happen in case the parameter is not applicable (yet) or simply because the data is missing. By coding defensively and assuming that a parameter might be missing you also future proof your solution for potential future (otherwise) breaking changes.\n\n## Flexible data model\n\nIn some cases we collect data from external sources that are hard to fit in a single predefined schema. For these cases we have come up with a flexible data model that allows us to store structured data in 3 different ways:\n - Form \n - Table \n - Section\n \n### Table\n\nData that can be represented in a table structure. The keys of every element/object in the data array is expected to be the same.\n\n```json\n{\n \"type\": \"Table\",\n \"data\": [\n {\n \"Status Code\": \"CB\",\n \"Effective Date\": \"06/10/2016\",\n \"Description\": \"CANCELLED BY BOARD\"\n },\n {\n \"Status Code\": \"NA\",\n \"Effective Date\": \"06/10/2016\",\n \"Description\": \"NOT ACTIVE\"\n }\n ]\n}\n```\n\n### Section\nSections are used to represent multiple different data representations. For example, additional properties can \nhave three sections with section one being a Form, while the other two could be a table. \nAlso note there could be sections with and without heading.\n\n#### With section heading\n```json\n{\n \"type\": \"Section\",\n \"data\": {\n \"Discipline\": {\n \"type\": \"Form\",\n \"data\": {\n \"Discipline/Final Orders state\": \"ILLINOIS\",\n \"Date action was taken\": \"02/03/2020\",\n \"Against privilege to practice (PTP)\": \"N/A\"\n }\n },\n \"NPDB code\": {\n \"type\": \"Form\",\n \"data\": {\n \"NPDB code\": \"39 - LICENSE REVOCATION, SUSPENSION OR OTHER DISCIPLINARY ACTION TAKEN BY A FEDERAL, STATE OR LOCAL LICENSING AUTHORITY\"\n }\n },\n \"Actions\": {\n \"type\": \"Form\",\n \"data\": {\n \"Initial action date\": \"02/03/2020\",\n \"Effective date(s)\": \"02/03/2020 - INDEFINITE/UNSPECIFIED\",\n \"Is license automatically reinstated after the effective date(s)\": \"NOT SUPPLIED\",\n \"NPDB code\": \"1148 - DENIAL OF LICENSE RENEWAL\"\n }\n }\n }\n}\n```\n\n#### Without section heading\n```json\n{\n \"type\": \"Section\",\n \"data\": [\n {\n \"type\": \"Form\",\n \"data\": {\n \"Discipline/Final Orders state\": \"ILLINOIS\",\n \"Date action was taken\": \"02/03/2020\",\n \"Against privilege to practice (PTP)\": \"N/A\"\n }\n },\n {\n \"type\": \"Form\",\n \"data\": {\n \"NPDB code\": \"39 - LICENSE REVOCATION, SUSPENSION OR OTHER DISCIPLINARY ACTION TAKEN BY A FEDERAL, STATE OR LOCAL LICENSING AUTHORITY\"\n }\n },\n {\n \"type\": \"Form\",\n \"data\": {\n \"Initial action date\": \"02/03/2020\",\n \"Effective date(s)\": \"02/03/2020 - INDEFINITE/UNSPECIFIED\",\n \"Is license automatically reinstated after the effective date(s)\": \"NOT SUPPLIED\",\n \"NPDB code\": \"1148 - DENIAL OF LICENSE RENEWAL\"\n }\n }\n ]\n}\n```\n\n### Form\n\nA form is essentially a simple key/value collection, but it can also have nested flexible data.\n\n#### Simple form\n```json\n{\n \"type\": \"Form\",\n \"data\": {\n \"Date of Birth\": \"1958\",\n \"Registration Date\": \"06/13/2016\",\n \"Disciplinary Status\": \"CANCELLED BY BOARD\"\n }\n}\n```\n\n#### Nested form\n\n```json\n{\n \"type\": \"Form\",\n \"data\": {\n \"Date of Birth\": \"1958\",\n \"Registration Date\": \"06/13/2016\",\n \"Disciplinary Status\": \"CANCELLED BY BOARD\",\n \"Status Change\": {\n \"type\": \"Table\",\n \"data\": [\n {\n \"Status Code\": \"CB\",\n \"Effective Date\": \"06/10/2016\",\n \"Description\": \"CANCELLED BY BOARD\"\n },\n {\n \"Status Code\": \"NA\",\n \"Effective Date\": \"06/10/2016\",\n \"Description\": \"NOT ACTIVE\"\n }\n ]\n }\n }\n}\n```\n\n## API Rate Limiting\n\n### Overview\n\nTo ensure the stability and performance of the Verifiable Platform API for all users, we enforce rate limits on API requests. \nThese limits help maintain fair access and high availability across all clients.\n\n### Rate Limits\n\nAPI requests are rate limited to **10,000 requests per 5 minutes.** \nIf a client exceeds this limit, the API will return an HTTP **429 Too Many Requests** response.\n\nVerifiable may adjust rate limits in the future based on factors such as endpoint-specific traffic patterns or system load. \nChanges may include increasing or decreasing limits or introducing secondary rate limits for specific use cases. \nAny changes will be reflected in this documentation.\n\nExample response:\n\n```http\nHTTP/1.1 429 Too Many Requests\n{\n \"title\": \"You have exceeded the allowed rate limit of 10,000 per 5 mins. Try again later.\",\n \"status\": 429\n}\n```\n\n"
version: 26.12.1.962
servers:
- url: https://discovery.verifiable.com/api
description: Production
- url: https://discovery-staging.verifiable.com/api
description: Staging
tags:
- name: Reports
paths:
/organization/reports/sanctionsandexclusions:
get:
tags:
- Reports
summary: 'List sanctions and exclusions reports for the organization.
'
description: 'Returns a list of all the sanctions and exclusions reports that have been created so far. The reports are sorted in descending order from latest created to oldest.
'
operationId: ListSanctionsAndExclusionsReports
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/SanctionsAndExclusionsReportInfoModel'
'401':
description: Unauthorized
'403':
description: Forbidden
'500':
description: Server Error
security:
- Bearer: []
/organization/reports/enrollments:
get:
tags:
- Reports
summary: 'List enrollments reports for the organization.
'
description: 'Returns a list of all the enrollment reports that have been created so far. The reports are sorted in descending order from latest created to oldest.
'
operationId: ListEnrollmentsReports
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/EnrollmentsReportInfoModel'
'401':
description: Unauthorized
'403':
description: Forbidden
'500':
description: Server Error
security:
- Bearer: []
/organization/reports/expirable-credentials:
get:
tags:
- Reports
summary: 'List expirable credentials reports for the organization.
'
description: 'Returns a list of all the expirable credentials reports that have been created so far. The reports are sorted in descending order from latest created to oldest.
'
operationId: ListExpirableCredentialsReports
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ExpirableCredentialsReportInfoModel'
'401':
description: Unauthorized
'403':
description: Forbidden
'500':
description: Server Error
security:
- Bearer: []
/organization/reports/roster:
get:
tags:
- Reports
summary: 'List roster reports for the organization.
'
description: 'Returns a list of all the roster reports that have been created so far. The reports are sorted in descending order from latest created to oldest.
'
operationId: ListRosterReports
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/RosterReportInfoModel'
'401':
description: Unauthorized
'403':
description: Forbidden
'500':
description: Server Error
security:
- Bearer: []
components:
schemas:
SanctionsAndExclusionsReportInfoModel:
type: object
properties:
date:
type: string
description: The time when the report was created.
format: date-time
path:
type: string
description: Path to the report.
additionalProperties: false
ExpirableCredentialsReportInfoModel:
type: object
properties:
date:
type: string
description: The time when the report was created.
format: date-time
path:
type: string
description: Path to the report.
additionalProperties: false
EnrollmentsReportInfoModel:
type: object
properties:
date:
type: string
description: The time when the report was created.
format: date-time
path:
type: string
description: Path to the report.
additionalProperties: false
RosterReportInfoModel:
type: object
properties:
date:
type: string
description: The time when the report was created.
format: date-time
path:
type: string
description: Path to the report.
additionalProperties: false
securitySchemes:
Bearer:
type: http
description: 'Enter your bearer token in the format: Bearer {your token}'
scheme: bearer
bearerFormat: custom
x-tagGroups:
- name: Authentication
tags:
- Authentication
- name: Definitions
tags:
- Definitions
- name: Providers
tags:
- Providers
- ProvidersInfo
- ProviderProfiles
- Notes
- Files
- name: Facilities
tags:
- Facilities
- FacilitiesInfo
- FacilitiesSpecialties
- name: Verifications
tags:
- Licenses
- Datasets
- DEA
- BoardCertifications
- name: Monitoring
tags:
- Monitoring
- Alerts
- name: Credentialing
tags:
- CredentialingRequests
- name: Integrations
tags:
- Integrations
- Webhooks
- name: Audits
tags:
- Audit
- name: Account
tags:
- Users
- name: Organizations
tags:
- Reports
- name: Models
tags:
- Dataset Records
- Webhook Callbacks