# Get the credentialing data for a facility

Returns the credentialing data for a facility.

Endpoint: GET /facilities/{facilityId}/credentialing-data
Version: 26.2.0.4309
Security: Bearer

## Path parameters:

  - `facilityId` (string, required)
    Identifier of the facility to get the data for.

## Query parameters:

  - `credentialingRequestId` (string)
    Identifier of the credentialing request associated to the facility.

## Response 200 fields (application/json):

  - `facility` (object)

  - `facility.id` (string)

  - `facility.name` (string)
    The name of this facility.

  - `facility.createdAt` (string)
    Timestamp when this facility was created.

  - `facility.deactivated` (boolean)
    If set, the facility is deactivated.

  - `facility.parentFacilityId` (string)

  - `facility.dba` (string)
    The DBA of this facility.

  - `facility.addressLine1` (string)
    The street address of this facility.

  - `facility.addressLine2` (string)
    The secondary address information of this facility.

  - `facility.city` (string)
    The city in which the facility address is located.

  - `facility.state` (string)
    The state in which the facility address is located.
    Enum: "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "AS", "GU", "MP", "PR", "VI"

  - `facility.zipCode` (string)
    The postal code associated with the facility address.

  - `facility.phoneNumber` (string)
    Phone number associated with the facility.

  - `facility.faxNumber` (string)
    Fax number associated with the facility.

  - `facility.groupTaxId` (string)
    The group tax id associated with the facility.

  - `facility.facilityTaxId` (string)
    The tax id associated with the facility.

  - `facility.contactName` (string)
    The contact name associated with the facility.

  - `facility.contactEmail` (string)
    The contact email associated with the facility.

  - `facility.medicarePartANumber` (string)

  - `facility.medicarePartBNumber` (string)

  - `facility.medicaidNumber` (string)

  - `facilitySpecialties` (array)
    All the facility specialties associated with the specified credentialing request.

  - `facilitySpecialties.id` (string)
    The unique identifier of this specialty.

  - `facilitySpecialties.facilityId` (string)
    The facility unique identifier related to this specialty.

  - `facilitySpecialties.taxonomyId` (string)
    The taxonomy unique identifier related to this specialty.

  - `facilitySpecialties.credentialedDate` (string)

  - `facilitySpecialties.nextCredentialingDate` (string)

  - `facilitySpecialties.recredentialedDates` (array)

  - `facilityInfo` (object)
    Facility information collection associated with the specified credentialing request.

  - `childFacilities` (array)
    Facility children.

  - `datasetScans` (array)

  - `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.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.

  - `datasetScans.failureReason.messageTemplate` (string)
    An informative human readable message describing the verification failure.

  - `datasetScans.failureReason.messageParams` (object)
    Collection of key/value pairs containing parameters to be replaced in messageTemplate.

  - `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.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.matchScore` (object)

  - `datasetScans.matches.matchScore.score` (number)

  - `datasetScans.matches.matchScore.recommendation` (string)
    Enum: "Mismatch", "Match"

  - `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.monitoringMetadata` (object)

  - `datasetScans.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"

  - `datasetScans.monitoringMetadata.lastMonitoringDate` (string)
    The previous date on which this data was monitored, if any.

  - `datasetScans.monitoringMetadata.nextMonitoringDate` (string)
    The next date on which this data is scheduled to be monitored.

  - `datasetScans.monitoringMetadata.monitorId` (string)
    Unique identifier of the monitor.

  - `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)

  - `files.id` (string)
    Unique identifier for this file.

  - `files.providerId` (string)
    If set, the provider to which this file is associated.

  - `files.facilityId` (string)
    If set, the facility to which this file is associated.

  - `files.createdAt` (string)
    The time when the file was created.

  - `files.createdByUserId` (string)
    The identifier of the user who created the file.

  - `files.createdByUserEmail` (string)
    The e-mail of the user who created the file.

  - `files.path` (string)
    Path to the file.

  - `files.size` (integer)
    The size of the file.


## Response 401 fields

## Response 403 fields

## Response 500 fields