Sign in

v1

latestOpenAPI 3.0.02026-08-0679302767.4 KB
v2/provider

Retrieve all available information for a provider.

Fetches comprehensive details about a provider, including optional related data such as credentialing workflows, all sections data (state-licenses, board certifications, dea, etc.), signed URLs for supporting documents/ attachments, verifier info, group info, and sanction items based on the provided query parameters.

get/v2/provider

Query parameters

npistring
external_idstring
provider_idstring
includeCredentialingWorkflowsboolean required

Include credentialing workflows with PSV url.

includeFullDataboolean required

Include full data from every section.

signUrlsboolean required

Sign Document URLs for immediate access.

includeVerifiedboolean required

Included VerifiedBy User info.

includeGroupInfoboolean required

Include group info.

includeSanctionItemsboolean required

Include sanction items.

Headers

organization-idstring

Response

Provider Details.

successboolean required

Example response

{
  "data": {
    "provider_sanctions": [
      {
        "date_of_report": "YYYY-MM-DD",
        "verified_date": "YYYY-MM-DD"
      }
    ],
    "malpractice_insurance": [
      {
        "expiry_date": "YYYY-MM-DD",
        "verified_date": "YYYY-MM-DD",
        "policyEffectiveDate": "YYYY-MM-DD",
        "policyExpirationDate": "YYYY-MM-DD",
        "policyCurrentEffectiveDate": "YYYY-MM-DD"
      }
    ],
    "npdb_data": [
      {
        "report_date": "YYYY-MM-DD",
        "process_date": "YYYY-MM-DD",
        "verified_date": "YYYY-MM-DD",
        "created_date": "YYYY-MM-DD",
        "payment_date": "YYYY-MM-DD",
        "specific_allegation_date": "YYYY-MM-DD",
        "birth_date": "1980-05-21"
      }
    ],
    "application_verification": [
      {
        "verified_date": "YYYY-MM-DD"
      }
    ],
    "board_certifications_data": [
      {
        "expire_date": "YYYY-MM-DD",
        "issue_date": "YYYY-MM-DD",
        "verified_date": "YYYY-MM-DD"
      }
    ],
    "credentialing_timeline": [
      {
        "attestation_date": "YYYY-MM-DD",
        "initial_credentialing_date": "YYYY-MM-DD",
        "last_credentialed_date": "YYYY-MM-DD",
        "psv_complete_date": "YYYY-MM-DD",
        "credentialing_decision_date": "YYYY-MM-DD",
        "next_credentialing_date": "YYYY-MM-DD",
        "received_for_credentialing_date": "YYYY-MM-DD"
      }
    ],
    "education_training": [
      {
        "verified_date": "YYYY-MM-DD"
      }
    ],
    "licenses": [
      {
        "expiration": "YYYY-MM-DD",
        "issue_date": "YYYY-MM-DD",
        "report_date": "YYYY-MM-DD",
        "verified_date": "YYYY-MM-DD"
      }
    ],
    "deas": [
      {
        "expire_date": "YYYY-MM-DD",
        "verified_date": "YYYY-MM-DD"
      }
    ],
    "hospital_affiliations": [
      {
        "start_date": "YYYY-MM-DD",
        "verified_date": "YYYY-MM-DD"
      }
    ],
    "last_monitoring_date": "YYYY-MM-DD",
    "provider_created_date": "YYYY-MM-DD",
    "verified_date": "YYYY-MM-DD",
    "file_completion_date": "YYYY-MM-DD",
    "practice_location": [
      {
        "start_date": "YYYY-MM-DD",
        "clia_expiration_date": "YYYY-MM-DD",
        "verified_date": "YYYY-MM-DD"
      }
    ],
    "sanction_items": [
      {
        "data_acquire_date": "YYYY-MM-DD",
        "source_update_date": "YYYY-MM-DD",
        "data_fetch_method": "YYYY-MM-DD",
        "data_issuing_source": "YYYY-MM-DD",
        "data_source_url": "YYYY-MM-DD",
        "data_fetch_source": "YYYY-MM-DD",
        "date_processed": "YYYY-MM-DD",
        "start_date": "YYYY-MM-DD",
        "end_date": "YYYY-MM-DD",
        "created_at": "YYYY-MM-DD",
        "updated_at": "YYYY-MM-DD",
        "verified_at": "YYYY-MM-DD"
      }
    ]
  }
}