# Get the credentialing data for a provider Returns the credentialing data for a provider. Endpoint: GET /providers/{providerId}/credentialing-data Version: 26.2.0.4309 Security: Bearer ## Path parameters: - `providerId` (string, required) Identifier of the provider to get the data for. ## Query parameters: - `credentialingRequestId` (string) Identifier of the credentialing request associated to the provider. ## Response 200 fields (application/json): - `providerInfo` (object) All the provider information. - `licenseVerifications` (array) All the provider verified licenses. - `licenseVerifications.originalStatus` (string) The original status as our license verification process determined. Unlike status the originalStatus can never change. Enum: "Found", "Failed", "NeedsReview", "NotFound", "Pending", "Working" - `licenseVerifications.status` (string) The current status for this license verification. If you patch the license verification status (in case the status is NeedsReview) this property will be updated, but originalStatus will remain the same. Enum: "Found", "Failed", "NeedsReview", "NotFound", "Pending", "Working" - `licenseVerifications.trigger` (string) Set to Manual if the verification is triggered by a user or Monitor if the verification was triggered by the monitoring system. Enum: "Manual", "Monitor" - `licenseVerifications.started` (string) Timestamp of when the license verification started processing. - `licenseVerifications.processingTime` (integer) The duration in milliseconds it took to process the license verification from start to end. - `licenseVerifications.results` (array) Array of verification records returned by the source that match the license number. - `licenseVerifications.results.name` (string) Name of the provider as indicated by the source. - `licenseVerifications.results.licenseType` (string) Textual description of the license type as indicated by the source. - `licenseVerifications.results.licenseStatus` (string) Textual description of the license status as indicated by the source. - `licenseVerifications.results.licenseNumber` (string) License number as indicated by the source. - `licenseVerifications.results.address` (string) Address of the license holder as indicated by the source. - `licenseVerifications.results.issued` (string) Timestamp when the license was issued as indicated by the source. - `licenseVerifications.results.expires` (string) Timestamp when the license expires as indicated by the source. - `licenseVerifications.results.screenshots` (array) Array of paths to screenshots that were taken as proof of the license verification. - `licenseVerifications.results.attachments` (array) Array of attachments related to the verification that were taken from the source. - `licenseVerifications.results.attachments.file` (object) - `licenseVerifications.results.attachments.file.id` (string) Unique identifier for this file. - `licenseVerifications.results.attachments.file.providerId` (string) If set, the provider to which this file is associated. - `licenseVerifications.results.attachments.file.facilityId` (string) If set, the facility to which this file is associated. - `licenseVerifications.results.attachments.file.createdAt` (string) The time when the file was created. - `licenseVerifications.results.attachments.file.createdByUserId` (string) The identifier of the user who created the file. - `licenseVerifications.results.attachments.file.createdByUserEmail` (string) The e-mail of the user who created the file. - `licenseVerifications.results.attachments.file.path` (string) Path to the file. - `licenseVerifications.results.attachments.file.size` (integer) The size of the file. - `licenseVerifications.results.attachments.type` (string) Enum: "DisciplinaryAction", "VerificationLetter", "AdditionalDocument" - `licenseVerifications.results.attachments.source` (string) The original url for the file, taken from the verification source. - `licenseVerifications.results.attachments.downloadStatus` (string) The status of the download. ´Downloaded´ or ´Failed´ Enum: "Downloaded", "Failed" - `licenseVerifications.results.attachments.failureReason` (object) An object with a reason message template and an array of params. Can be used to construct a meaningful description of the error. Not set when no errors happened. - `licenseVerifications.results.attachments.failureReason.messageTemplate` (string) An informative human readable message describing the verification failure. - `licenseVerifications.results.attachments.failureReason.messageParams` (object) Collection of key/value pairs containing parameters to be replaced in messageTemplate. - `licenseVerifications.results.disciplinaryActions` (object) - `licenseVerifications.results.disciplinaryActions.type` (string) The schema type for data. Enum: "Form", "Table", "Section" - `licenseVerifications.results.disciplinaryActions.data` (any) The actual data for this property. The schema can change depending on type. See the [Flexible Data Model](/references/api/section/common-concepts/flexible-data-model) for more information. - `licenseVerifications.results.additionalProperties` (object) - `licenseVerifications.results.problems` (array) Array of problems that resulted in a NeedsReview status for the license verification. Enum: "NameMismatch", "LicenseTypeMismatch" - `licenseVerifications.results.matchScore` (object) - `licenseVerifications.results.matchScore.score` (number) - `licenseVerifications.results.matchScore.recommendation` (string) Enum: "Mismatch", "Match" - `licenseVerifications.results.prescriptiveAuthority` (string) Indicates whether the provider is legally authorized to prescribe medications, as reported by the licensing authority. - `licenseVerifications.results.compactStatus` (string) Indicates whether the provider holds a multistate/interstate practice privilege under an applicable compact, as reported by the licensing authority. - `licenseVerifications.additionalVerificationParameters` (array) List of additional parameters required for a select number of sources. Missing data for select sources will result in a failed verification. - `licenseVerifications.verificationSource` (object) - `licenseVerifications.verificationSource.name` (string) Name of the licensing organization. - `licenseVerifications.verificationSource.url` (string) The URL used to fetch the license data for this source. - `licenseVerifications.verificationSource.hasPassThroughFee` (boolean) Indicates whether the source charges a pass-through fee for a verification. - `licenseVerifications.correctResultIndex` (integer) In case there is more than 1 result you can patch the verification and specify which of the records is the correct match by setting correctResultIndex to the appropriate index matching the index in the results array. - `licenseVerifications.export` (string) Once a license verification is in an 'end state' a PDF export will be generated. Once the PDF is generated this property will contain the path to that export. That path can be used to [download the file](/references/api/files/downloadfile). Please note that the process to generate an export is asynchronous and it can take several seconds after a verification is completed before the export is ready. - `licenseVerifications.id` (string) Unique identifier for this license verification. - `licenseVerifications.monitoringMetadata` (object) - `licenseVerifications.monitoringMetadata.monitoringInterval` (string) The interval at which the data is being monitored.NOTE: Continuous interval is only supported by the NPDB dataset at this time. Enum: "Continuous", "Daily", "Weekly", "Monthly", "Yearly" - `licenseVerifications.monitoringMetadata.lastMonitoringDate` (string) The previous date on which this data was monitored, if any. - `licenseVerifications.monitoringMetadata.nextMonitoringDate` (string) The next date on which this data is scheduled to be monitored. - `licenseVerifications.monitoringMetadata.monitorId` (string) Unique identifier of the monitor. - `datasetScans` (array) All the provider verified dataset scans. - `datasetScans.type` (string) The type of records that are being scanned. Enum: "Sam", "MedicareOptOut", "OigFugitives", "OfacSdn", "OfacConsolidated", "OigExclusions", "StateSanctionsAndExclusions", "Npdb", "Dmf", "Npi", "Nsc", "Dea", "CmsPreclusion", "Tricare", "AmericanBoardofInternalMedicine", "NationalCommissiononCertificationofPhysicianAssistants", "Abms", "NationalBoardforCertifiedCounselors", "AmericanAcademyofNursePractitioners", "NationalBoardofCertificationandRecertificationforNurseAnesthetists", "AmericanOsteopathicAssociation", "AmericanNursesCredentialingCenter", "NationalBoardforCertificationinOccupationalTherapy", "AmericanSpeechLanguageHearingAssociation", "AmericanBoardofFamilyMedicine", "AmericanBoardofPsychiatryandNeurology", "InternationalBoardofLactationConsultantExaminers", "AmericanMidwiferyCertificationBoard", "AmericanDentalBoardofAnesthesiology", "AmericanBoardofClinicalSocialWork", "BoardOfPharmacySpecialties", "AmericanBoardofAllergyandImmunology", "AmericanBoardofOrthodontics", "AmericanBoardofOralMedicine", "AmericanBoardofPediatricDentistry", "AmericanBoardofOralandMaxillofacialSurgery", "AmericanBoardofOralandMaxillofacialRadiology", "AmericanBoardofProsthodontics", "AmericanBoardofOralandMaxillofacialPathology", "AmericanBoardofEndodontics", "AmericanBoardofPeriodontology", "AmericanBoardofOralImplantology", "AmericanBoardofPodiatricMedicine", "AmericanBoardofDentalPublicHealth", "BehaviorAnalystCertificationBoard", "AmericanBoardofGeneralDentistry", "NationalAssociationofSchoolPsychologists", "AmericanBoardofAddictionMedicine", "AmericanBoardofMultipleSpecialtiesinPodiatry", "CommissionOnDieteticRegistration", "AmericanBoardOfObesityMedicine", "NationalCertificationCorporation", "NationalCommissionForCertificationOfAnesthesiologistAssistants", "AmericanRegistryOfRadiologyTechnologists", "AmericanBoardOfAnesthesiology", "AmericanRegistryForDiagnosticMedicalSonography", "NationalBoardOfPhysiciansAndSurgeons", "CardiovascularCredentialingInternational", "NationalCenterForCompetencyTesting", "NationalAssociationOfPhlebotomyTechnicians", "AmericanAlliedHealth", "NationalRegistryOfAlliedHealthProfessionals", "AmericanMedicalTechnologists", "NationalHealthCareerAssociation", "DentalAssistingNationalBoard", "PediatricNursingCertification", "NationalCertificationCommissionForAcupunctureAndOrientalMedicine", "CertificationBoardForMusicTherapists", "AmericanBoardOfChiropracticInternists", "AmericanBoardofPhysicalTherapySpecialties", "AmericanBoardofPhysicianSpecialties", "AmericanAcademyofOptometry", "AmericanBoardofNeurologicalSurgery", "AmericanBoardofObstetricsandGynecology", "AmericanBoardofOphthalmology", "AmericanBoardofOtolaryngologyHeadandNeckSurgery", "AmericanBoardofPediatrics", "AmericanBoardofOrthopaedicSurgery", "AmericanBoardofPhysicalMedicineandRehabilitation", "AmericanBoardofPlasticSurgery", "AmericanBoardofRadiology", "AmericanBoardofSurgery", "AmericanBoardofUrology", "AmericanBoardofColonandRectalSurgery", "AmericanAssociationofCriticalCareNurses", "AmericanBoardofFootandAnkleSurgery", "PharmacyTechnicianCertificationBoard", "NationalBoardofSurgicalTechnologyandSurgicalAssisting", "AmericanBoardofPainMedicine", "AmericanBoardofOrofacialPain", "NuclearMedicineTechnologyCertificationBoard", "AmericanBoardofEmergencyMedicine", "ArtTherapyCredentialsBoard", "AmericanHeartAssociation", "MedicaidEnrollmentCalifornia", "JointCommission", "FacilityCmsCertification" - `datasetScans.id` (string) Unique identifier for this dataset scan. - `datasetScans.started` (string) Timestamp when this scan was started. - `datasetScans.completed` (string) Timestamp at which the scan was completed or failed. If empty the scan is still running. - `datasetScans.status` (string) The status of this scan. Pending and Working means the scan is still running. Active means the scan has completed its initial execution and will continue to check for any changes going forward. Completed means it completed successfully, while Failed means there was a problem while scanning and the scan should be retried. Enum: "Pending", "Working", "Completed", "Failed", "Active" - `datasetScans.providerId` (string) The identifier of the provider that is associated with this scan, if any. - `datasetScans.facilityId` (string) The identifier of the facility that is associated with this scan, if any. - `datasetScans.trigger` (string) Set to Manual if the scan is triggered by a user or Monitor if the scan was triggered by the monitoring system. Enum: "Manual", "Monitor" - `datasetScans.options` (object) - `datasetScans.options.parameterSetId` (string) Set this to override the default parameters that will be used for a dataset scan. If a parameterSetId isn’t specified, we will use the default/preferred parameter set. - `datasetScans.options.referenceId` (string) Set this to a provider info that will be used during the dataset scan, if a reference id isn’t supplied, we will use the data from the entity itself, such as name. - `datasetScans.statusDescription` (any) - `datasetScans.parameters` (array) The parameters that where used for this scan. The array of parameters is constructed from the provider data available at the time of the scan. - `datasetScans.matches` (array) Array of records that match the input data for this scan. - `datasetScans.matches.id` (string) - `datasetScans.matches.datasetTimestamp` (string) The timestamp when the dataset was last updated in our system at the time of this scan. - `datasetScans.matches.recordTimestamp` (string) The timestamp when this record was last updated in our system at the time of this scan. - `datasetScans.matches.data` (object) - `datasetScans.matches.data.positiveParameters` (array) Array of parameters used in the scan which have an explicit positive hit on this record. - `datasetScans.matches.data.negativeParameters` (array) Array of parameters used in the scan which have an explicit negative hit on this record. - `datasetScans.matches.data.record` (any) The matched data. This model is different for each dataset. Refer to [Dataset Records](/references/api/Dataset-Records) for an overview of models for each dataset. The models are also returned in JSON schema in the [GetDataset](/reference/operation/GetDataset) operation. - `datasetScans.matches.scanId` (string) The identifier of the scan to which this match belongs. Not set if scan is populated. - `datasetScans.matches.scan` (object) - `datasetScans.matches.userActionNeeded` (boolean) Boolean indicating if action is needed for this match. - `datasetScans.matches.isIgnored` (boolean) Set to true if this match was ignored for the associated provider. - `datasetScans.matches.userActionResolution` (string) Enum: "Accept", "Reject" - `datasetScans.matches.userActionResolutionNote` (string) - `datasetScans.matches.matchRelevance` (string) Enum: "Low", "Medium", "High" - `datasetScans.matches.createdTimestamp` (string) Indicates the time that the match was added to the scan. Only populated for matches on or after January 25th 2024. - `datasetScans.matches.obsoleteTimestamp` (string) Indicates the time that the match became obsolete. This only occurs when a scan with a status of Active determines that the match is now obsolete due to changes in primary source data. - `datasetScans.verifiedAt` (string) Indicates the most recent time that the verification was performed successfully. - `datasetScans.datasetMetadata` (object) - `datasetScans.datasetMetadata.importDate` (string) The date of the import file that the dataset scan was compared against. - `datasetScans.datasetMetadata.importFileName` (string) The original file name of the dataset source. - `datasetScans.provider` (any) The provider model that is associated with this scan, if any. - `files` (array) All the provider files. - `profiles` (array) All the provider profile imports. - `profiles.id` (string) Unique identifier associated with this provider profile import. - `profiles.providerId` (string) The provider unique identifier associated with this profile import. - `profiles.source` (string) Source of the import. Enum: "Npi", "CaqhPo", "AmericanMedicalAssociationPhysician", "AmericanMedicalAssociationPhysicianAssistant" - `profiles.started` (string) TimeStamp of this import when started - `profiles.completed` (string) TimeStamp of this import when completed or null if is still in progress. - `profiles.status` (string) Status of the import. If it is Pending or Working it means that we are busy performing the import. Once the status is Completed or Failed the import is done. Enum: "Pending", "Working", "Completed", "Failed" - `profiles.trigger` (string) Type of trigger for this import. Enum: "Manual", "Automated" - `profiles.failureCode` (string) If set it means there was an error during the import or null when no errors happened. Enum: "DatabaseError", "InvalidImportSourceError", "UnknownError", "ParseError", "NpiSourceError", "ImportError", "ImportRequestError", "SourceError", "NoContent", "BadRequest", "Unauthorized", "Forbidden", "NotFound", "NotAcceptable", "RequestTimeout", "TooManyRequests", "InternalServerError", "BadGateway", "ServiceUnavailable", "GatewayTimeout" - `profiles.profile` (any) - `profiles.parameters` (array) ## Response 401 fields ## Response 403 fields ## Response 500 fields