Skip to content
CertifyOS API
/
/
Retrieve all available in...

CertifyOS API

Download OpenAPI description
api.json
api.yaml
Overview
Languages
Servers
Mock server
https://docs.certifyos.com/_mock/reference/application/api/
Production
https://ng-api-production.certifyos.com/
Staging (Test Data)
https://ng-api-stg.certifyos.com/

auth-tokens

Operations

credentialing-workflows

Operations

v2/credentialing-workflows

Operations

providers

Operations

v2/provider

Operations

v2/providers

Operations

v2/flags

Operations

v2/provider-with-groups

Operations

flags

Operations

v2/groups

Operations

Webhooks

Operations

forms

Operations

v2/facility-credentialing-workflows

Operations

v2/facilities

Operations

Retrieve all available information for a Facility. Supporting documents are URLs to the file.

Request

Security
BearerAuth
Path
facilityIdstringrequired
Headers
organization-idstring
curl -i -X GET \
  'https://docs.certifyos.com/_mock/reference/application/api/v2/facilities/{facilityId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'organization-id: string'

Responses

Facility Details.

Bodyapplication/json
namestring<= 128 charactersrequired

Legal name of the facility

dbastringrequired

Doing Business As (DBA) name or trade name of the facility

typestringrequired

Type of facility

Example: "Ambulatory Surgery Centers"
tinstringrequired

Tax Identification Number (TIN) for the facility

medicareNumberstring
medicaidNumberstring
addressstringrequired

Street address of the facility (Line 1)

citystringrequired

City where the facility is located

Example: "Saint George"
zipcodestringrequired

ZIP code of the facility location

Example: "90210"
contactNamestringrequired

Name of the primary contact person for the facility

contactPhonestringrequired

Primary contact phone number for the facility

Example: "8000001234"
contactEmailstringrequired

Primary contact email address for the facility (email format)

contactFaxstringrequired

Contact fax number for the facility (optional)

Example: "8000001234"
statestringrequired

State where the facility is located (2-letter state code)

Enum"AK""AL""AR""AS""AZ""CA""CO""CT""DC""DE"
Example: "CA"
fileTypestring

File processing status for the facility record

Enum"Clean""Non_Clean""Pending"
Example: "Clean"
npistring

National Provider Identifier (NPI) - 10-digit identifier

externalIdstring

External identifier for the facility from external systems

Example: "V2222L00000"
skipOnSiteReviewbooleanrequired
stateLicensesArray of objects(FacilityStateLicenseDto)required
idstring
actionstring
Default "updated"
Enum"updated""created""deleted"
isUpdatedboolean
licenseTypestringrequired

Type of license

Enum"State License""Business Permit""Occupational License""Medical gas permit"
Example: "State License"
sourcestringrequired

Source of license verification (licensing authority)

Example: "Utah Department of Health and Human Services"
licenseNumberstringrequired

License number issued by the licensing authority

Example: "F23-100000"
statusstringrequired

Status of the license (e.g., "Active", "Expired")

Enum"Active""Inactive""Expired""Retired""Revoked""Lapsed""Probation""Surrendered""Suspended"
Example: "Active"
issueDatestring(date)

Date when the state license was issued

expirationDatestring(date)required

Date when the state license expires

facilitySupportingDocumentsArray of objects(FacilitySupportingDocumentDto)required
idstring
actionstring
Default "updated"
Enum"updated""created""deleted"
isUpdatedboolean
namestringrequired
lastModifiedstring(date-time)required
typestringrequired
accreditationsArray of objects(AccreditationDto)required
idstring
actionstring
Default "updated"
Enum"updated""created""deleted"
isUpdatedboolean
accreditationBodystringrequired
Default ""
applicablestringrequired
statusstringrequired

Accreditation status

Enum"Accredited""Not Accredited"
Example: "Accredited"
effectiveDatestring(date-time)required
expirationDatestring(date-time)
siteVisitsArray of objects(OnSiteReviewDto)required
idstring
actionstring
Default "updated"
Enum"updated""created""deleted"
isUpdatedboolean
applicablestringrequired

Whether on-site review is applicable

Enum"Yes""No""N/A"
Example: "Yes"
sourcestringrequired
gradestring
certificationsArray of objects(CertificationsDto)required
idstring
actionstring
Default "updated"
Enum"updated""created""deleted"
isUpdatedboolean
sourcestring
typesstring
certificateTypestring

Type of certification

Default "CLIA"
Enum"State Survey""CLIA""CMS""CDS""DEA""N/A"
Example: "CLIA"
numberstring
issueDatestring(date-time)
expirationDatestring(date-time)
npdbArray of objects(NpdbDto)required
idstring
actionstring
Default "updated"
Enum"updated""created""deleted"
isUpdatedboolean
applicablestringrequired

Whether NPDB check is applicable

Enum"Yes""No""N/A"
Example: "Yes"
sourcestringrequired
typeOfActionstringrequired

Type of NPDB action

Enum"No Action""Medical Malpractice Payment""Health Plan""State Licensure/Certification""Professional Society""Exclusion/Debarment""DEA/Federal Licensure""Government Administrative""Judgement/Conviction""Clinical Privileges"
Example: "No Action"
reportResultsstring

NPDB report results

Default "No Report Found"
Enum"Adverse Action Report""Medical Malpractice Payment Report""No Report Found"
Example: "No Report Found"
reportDatestring(date-time)required
processDatestring(date-time)required
sanctionsArray of objects(SanctionsDto)required
idstring
actionstring
Default "updated"
Enum"updated""created""deleted"
isUpdatedboolean
sanctionTypestringrequired
sourcestringrequired
reportResultsstringrequired
perfIndicatorArray of objects(FacilityPerformanceIndicatorDto)required
idstring
actionstring
Default "updated"
Enum"updated""created""deleted"
isUpdatedboolean
applicablestringrequired

Whether performance indicator is applicable

Enum"Yes""No""N/A"
Example: "Yes"
complaintsstringrequired
clinicalstringrequired
benefitsstringrequired
claimsstringrequired
accessIssuesstringrequired
liabilityInsurancesArray of objects(InsuranceDto)required
idstring
actionstring
Default "updated"
Enum"updated""created""deleted"
isUpdatedboolean
policyNumberstringrequired

Insurance policy number

sourcestringrequired

Insurance carrier/company name

insuranceTypestringrequired

Type of insurance

Enum"General Liability""Professional Liability"
Example: "Professional Liability"
expirationDatestring(date)required

Date when the insurance policy expires

lastCredentialingDatestring(date)required

Date the facility was last credentialed

nextCredentialingDatestring(date)required

Date when the facility is due for re-credentialing

facilitySpecialtiesArray of objects(CreateSpecialtiesDto)
facilityPrimarySpecialtyobject(CreateSpecialtiesDto)
facilityHsdSpecialtyobject(HsdSpecialty)
appVerificationsArray of objects(AppVerificationDto)
medicareStarRatingsArray of objects(MedicareStarRatingDto)required
idstring
actionstring
Default "updated"
Enum"updated""created""deleted"
isUpdatedboolean
starRatingstring
reportDatestring(date-time)
sourcestring
linesOfBusinessArray of arrays
organizationIdstringrequired
contractEntitystringrequired
credentialingStartDatestring(date)required

Date the facility was received for credentialing

attestationDatestring(date)required

Date when facility attestation was completed

psvCompleteDatestring(date-time)required
credentialingDecisionDatestring(date-time)required
medicalDirectorIdstringrequired
medicalDirectorNamestringrequired
idstringrequired
createdAtstring(date-time)required
Example: "YYYY-MM-DD"
createdBystringrequired
createdByNamestringrequired
updatedAtstring(date-time)required
Example: "YYYY-MM-DD"
updatedBystringrequired
updatedByNamestringrequired
surveyResponseArray of objectsrequired
providersArray of objects(FacilityProviderV2Dto)required
idstringrequired
npistringrequired
namestringrequired
typestringrequired

Provider type/credential

Enum"AA""ABA""ACU""ADC""APN""AT""ATR""AUD""BCaBA""BCBA"
Example: "MD"
verified_bystringrequired
verified_datestringrequired
Example: "YYYY-MM-DD"
practiceLicenseArray of objects(PracticeLicenseV2Dto)required
idstringrequired
statestringrequired

US state or territory where practice license is issued

Enum"AK""AL""AR""AS""AZ""CA""CO""CT""DC""DE"
Example: "CA"
expirationDatestring(date-time)required
typestringrequired

Type of practice license

Enum"State License""Business Permit""Occupational License""Medical gas permit"
Example: "State License"
statusstringrequired

Current status of the practice license

Enum"Active""Inactive""Expired""Retired""Revoked""Lapsed""Probation""Surrendered""Suspended"
Example: "Active"
licensestringrequired
sourcestringrequired

Source of practice license verification

verified_bystringrequired

Name of the person who verified this practice license information

verified_datestringrequired

Date when this practice license information was verified

Example: "YYYY-MM-DD"
issueDatestring(date-time)required
businessLicenseArray of objects(BusinessLicenseV2Dto)required
idstringrequired
namestringrequired

Business name as registered

entitystringrequired

Business entity type

citystringrequired
typestringrequired
incorporationDatestring(date)required

Date when the business was incorporated

verified_bystringrequired

Name of the person who verified this business license information

Example: "John Doe"
verified_datestringrequired

Date when this business license information was verified

Example: "YYYY-MM-DD"
onsiteReviewsArray of objects(OnSiteReviewDto)required
idstring
actionstring
Default "updated"
Enum"updated""created""deleted"
isUpdatedboolean
applicablestringrequired

Whether on-site review is applicable

Enum"Yes""No""N/A"
Example: "Yes"
sourcestringrequired
gradestring
licensureActionsArray of objectsrequired
deasArray of objects(DEADto)required
idstring
actionstring
Default "updated"
Enum"updated""created""deleted"
isUpdatedboolean
statestringrequired

State where DEA license is issued

Enum"AK""AL""AR""AS""AZ""CA""CO""CT""DC""DE"
Example: "CA"
deaNumberstringrequired
providerTypestringrequired
statusstringrequired

Status of the DEA license

Enum"Active""Inactive"
Example: "Active"
sourcestringrequired
expirationDatestring(date-time)required
credentialingStatusstringrequired

Current credentialing status of the facility

Enum"Not sent to credentialing""Not Started""In Progress""Data missing""Outreach in progress""PSV complete by CertifyOS""Credentialing restarted""PSV ready""Cred approved""Hold for Cred Comm"
Example: "In Progress"
timelinesArray of objects(TimelineV2Dto)required
idstringrequired
enteredAtstring(date-time)required
titlestringrequired
verified_bystringrequired
verified_datestringrequired
Example: "YYYY-MM-DD"
Response
application/json
{
  "name": "string",
  "dba": "string",
  "type": "Ambulatory Surgery Centers",
  "tin": "string",
  "medicareNumber": "string",
  "medicaidNumber": "string",
  "address": "string",
  "city": "Saint George",
  "zipcode": "90210",
  "contactName": "string",
  "contactPhone": "8000001234",
  "contactEmail": "string",
  "contactFax": "8000001234",
  "state": "CA",
  "fileType": "Clean",
  "npi": "string",
  "externalId": "V2222L00000",
  "skipOnSiteReview": true,
  "stateLicenses": [
    { … }
  ],
  "facilitySupportingDocuments": [
    { … }
  ],
  "accreditations": [
    { … }
  ],
  "siteVisits": [
    { … }
  ],
  "certifications": [
    { … }
  ],
  "npdb": [
    { … }
  ],
  "sanctions": [
    { … }
  ],
  "perfIndicator": [
    { … }
  ],
  "liabilityInsurances": [
    { … }
  ],
  "lastCredentialingDate": "2019-08-24",
  "nextCredentialingDate": "2019-08-24",
  "facilitySpecialties": [
    { … }
  ],
  "facilityPrimarySpecialty": {
    "specialtyNuccTaxonomyCode": "string",
    "code": "string",
    "name": "string",
    "id": "string",
    "isPrimary": true,
    "specialtyBoardName": "string",
    "source": "string",
    "subSpecialties": [ … ]
  },
  "facilityHsdSpecialty": {
    "code": "",
    "name": ""
  },
  "appVerifications": [
    { … }
  ],
  "medicareStarRatings": [
    { … }
  ],
  "linesOfBusiness": [
    []
  ],
  "organizationId": "string",
  "contractEntity": "string",
  "credentialingStartDate": "2019-08-24",
  "attestationDate": "2019-08-24",
  "psvCompleteDate": "2019-08-24T14:15:22Z",
  "credentialingDecisionDate": "2019-08-24T14:15:22Z",
  "medicalDirectorId": "string",
  "medicalDirectorName": "string",
  "id": "string",
  "createdAt": "YYYY-MM-DD",
  "createdBy": "string",
  "createdByName": "string",
  "updatedAt": "YYYY-MM-DD",
  "updatedBy": "string",
  "updatedByName": "string",
  "surveyResponse": [
    {}
  ],
  "providers": [
    { … }
  ],
  "practiceLicense": [
    { … }
  ],
  "businessLicense": [
    { … }
  ],
  "onsiteReviews": [
    { … }
  ],
  "licensureActions": [
    {}
  ],
  "deas": [
    { … }
  ],
  "credentialingStatus": "In Progress",
  "timelines": [
    { … }
  ]
}

Update information for a facility.

Request

Security
BearerAuth
Path
facilityIdstringrequired
Headers
organization-idstring
Bodyapplication/jsonrequired
namestring<= 128 characters

Legal name of the facility

dbastring

Doing Business As (DBA) name or trade name of the facility

typestring

Type of facility

Example: "Ambulatory Surgery Centers"
tinstring

Tax Identification Number (TIN) for the facility

medicareNumberstring
medicaidNumberstring
addressstring

Street address of the facility (Line 1)

citystring

City where the facility is located

Example: "Saint George"
zipcodestring

ZIP code of the facility location

Example: "90210"
contactNamestring

Name of the primary contact person for the facility

contactPhonestring

Primary contact phone number for the facility

Example: "8000001234"
contactEmailstring

Primary contact email address for the facility (email format)

contactFaxstring

Contact fax number for the facility (optional)

Example: "8000001234"
statestring

State where the facility is located (2-letter state code)

Enum"AK""AL""AR""AS""AZ""CA""CO""CT""DC""DE"
Example: "CA"
fileTypestring

File processing status for the facility record

Enum"Clean""Non_Clean""Pending"
Example: "Clean"
npistring

National Provider Identifier (NPI) - 10-digit identifier

externalIdstring

External identifier for the facility from external systems

Example: "V2222L00000"
skipOnSiteReviewboolean
stateLicensesArray of objects(FacilityStateLicenseDto)
facilitySupportingDocumentsArray of objects(FacilitySupportingDocumentDto)
accreditationsArray of objects(AccreditationDto)
siteVisitsArray of objects(OnSiteReviewDto)
certificationsArray of objects(CertificationsDto)
npdbArray of objects(NpdbDto)
sanctionsArray of objects(SanctionsDto)
perfIndicatorArray of objects(FacilityPerformanceIndicatorDto)
liabilityInsurancesArray of objects(InsuranceDto)
lastCredentialingDatestring(date-time)
nextCredentialingDatestring(date-time)
facilitySpecialtiesArray of objects(CreateSpecialtiesDto)
facilityPrimarySpecialtyobject(CreateSpecialtiesDto)
facilityHsdSpecialtyobject(HsdSpecialty)
appVerificationsArray of objects(AppVerificationDto)
medicareStarRatingsArray of objects(MedicareStarRatingDto)
linesOfBusinessArray of strings
credentialingStatusstring
credentialingStartDatestring(date-time)
psvCompleteDatestring(date-time)
credentialingDecisionDatestring(date-time)
attestationDatestring(date-time)
medicalDirectorIdstring
curl -i -X PATCH \
  'https://docs.certifyos.com/_mock/reference/application/api/v2/facilities/{facilityId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'organization-id: string' \
  -d '{
    "name": "string",
    "dba": "string",
    "type": "Ambulatory Surgery Centers",
    "tin": "string",
    "medicareNumber": "string",
    "medicaidNumber": "string",
    "address": "string",
    "city": "Saint George",
    "zipcode": "90210",
    "contactName": "string",
    "contactPhone": "8000001234",
    "contactEmail": "string",
    "contactFax": "8000001234",
    "state": "CA",
    "fileType": "Clean",
    "npi": "string",
    "externalId": "V2222L00000",
    "skipOnSiteReview": true,
    "stateLicenses": [
      {
        "id": "string",
        "action": "updated",
        "isUpdated": true,
        "licenseType": "State License",
        "source": "Utah Department of Health and Human Services",
        "licenseNumber": "F23-100000",
        "status": "Active",
        "issueDate": "2019-08-24",
        "expirationDate": "2019-08-24"
      }
    ],
    "facilitySupportingDocuments": [
      {
        "id": "string",
        "action": "updated",
        "isUpdated": true,
        "name": "string",
        "lastModified": "2019-08-24T14:15:22Z",
        "type": "string"
      }
    ],
    "accreditations": [
      {
        "id": "string",
        "action": "updated",
        "isUpdated": true,
        "accreditationBody": "",
        "applicable": "string",
        "status": "Accredited",
        "effectiveDate": "2019-08-24T14:15:22Z",
        "expirationDate": "2019-08-24T14:15:22Z"
      }
    ],
    "siteVisits": [
      {
        "id": "string",
        "action": "updated",
        "isUpdated": true,
        "applicable": "Yes",
        "source": "string",
        "grade": "string"
      }
    ],
    "certifications": [
      {
        "id": "string",
        "action": "updated",
        "isUpdated": true,
        "source": "string",
        "types": "string",
        "certificateType": "CLIA",
        "number": "string",
        "issueDate": "2019-08-24T14:15:22Z",
        "expirationDate": "2019-08-24T14:15:22Z"
      }
    ],
    "npdb": [
      {
        "id": "string",
        "action": "updated",
        "isUpdated": true,
        "applicable": "Yes",
        "source": "string",
        "typeOfAction": "No Action",
        "reportResults": "No Report Found",
        "reportDate": "2019-08-24T14:15:22Z",
        "processDate": "2019-08-24T14:15:22Z"
      }
    ],
    "sanctions": [
      {
        "id": "string",
        "action": "updated",
        "isUpdated": true,
        "sanctionType": "string",
        "source": "string",
        "reportResults": "string"
      }
    ],
    "perfIndicator": [
      {
        "id": "string",
        "action": "updated",
        "isUpdated": true,
        "applicable": "Yes",
        "complaints": "string",
        "clinical": "string",
        "benefits": "string",
        "claims": "string",
        "accessIssues": "string"
      }
    ],
    "liabilityInsurances": [
      {
        "id": "string",
        "action": "updated",
        "isUpdated": true,
        "policyNumber": "string",
        "source": "string",
        "insuranceType": "Professional Liability",
        "expirationDate": "2019-08-24"
      }
    ],
    "lastCredentialingDate": "2019-08-24T14:15:22Z",
    "nextCredentialingDate": "2019-08-24T14:15:22Z",
    "facilitySpecialties": [
      {
        "specialtyNuccTaxonomyCode": "string",
        "code": "string",
        "name": "string",
        "id": "string",
        "isPrimary": true,
        "specialtyBoardName": "string",
        "source": "string",
        "subSpecialties": [
          {
            "specialtyNuccTaxonomyCode": "string",
            "name": "string"
          }
        ]
      }
    ],
    "facilityPrimarySpecialty": {
      "specialtyNuccTaxonomyCode": "string",
      "code": "string",
      "name": "string",
      "id": "string",
      "isPrimary": true,
      "specialtyBoardName": "string",
      "source": "string",
      "subSpecialties": [
        {
          "specialtyNuccTaxonomyCode": "string",
          "name": "string"
        }
      ]
    },
    "facilityHsdSpecialty": {
      "code": "",
      "name": ""
    },
    "appVerifications": [
      {
        "id": "string",
        "action": "updated",
        "isUpdated": true,
        "explanation": "string",
        "source": "string",
        "verificationType": "string"
      }
    ],
    "medicareStarRatings": [
      {
        "id": "string",
        "action": "updated",
        "isUpdated": true,
        "starRating": "string",
        "reportDate": "2019-08-24T14:15:22Z",
        "source": "string"
      }
    ],
    "linesOfBusiness": [
      "string"
    ],
    "credentialingStatus": "string",
    "credentialingStartDate": "2019-08-24T14:15:22Z",
    "psvCompleteDate": "2019-08-24T14:15:22Z",
    "credentialingDecisionDate": "2019-08-24T14:15:22Z",
    "attestationDate": "2019-08-24T14:15:22Z",
    "medicalDirectorId": "string"
  }'

Responses

Updated.

List all Facilities.

Request

Security
BearerAuth
Query
offsetnumber>= 0

The starting index for pagination, specifying how many records to skip.

Default 0
limitnumber

The maximum number of records to retrieve in a single request.

Default 10
Headers
organization-idstring
curl -i -X GET \
  'https://docs.certifyos.com/_mock/reference/application/api/v2/facilities?offset=0&limit=10' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'organization-id: string'

Responses

Paginated list of facilities.

Bodyapplication/json
dataArray of objects(FacilityResponseV2Dto)required

Array of facility objects

namestring<= 128 charactersrequired

Legal name of the facility

dbastringrequired

Doing Business As (DBA) name or trade name of the facility

typestringrequired

Type of facility

Example: "Ambulatory Surgery Centers"
tinstringrequired

Tax Identification Number (TIN) for the facility

medicareNumberstring
medicaidNumberstring
addressstringrequired

Street address of the facility (Line 1)

citystringrequired

City where the facility is located

Example: "Saint George"
zipcodestringrequired

ZIP code of the facility location

Example: "90210"
contactNamestringrequired

Name of the primary contact person for the facility

contactPhonestringrequired

Primary contact phone number for the facility

Example: "8000001234"
contactEmailstringrequired

Primary contact email address for the facility (email format)

contactFaxstringrequired

Contact fax number for the facility (optional)

Example: "8000001234"
statestringrequired

State where the facility is located (2-letter state code)

Enum"AK""AL""AR""AS""AZ""CA""CO""CT""DC""DE"
Example: "CA"
fileTypestring

File processing status for the facility record

Enum"Clean""Non_Clean""Pending"
Example: "Clean"
npistring

National Provider Identifier (NPI) - 10-digit identifier

externalIdstring

External identifier for the facility from external systems

Example: "V2222L00000"
skipOnSiteReviewbooleanrequired
stateLicensesArray of objects(FacilityStateLicenseDto)required
idstring
actionstring
Default "updated"
Enum"updated""created""deleted"
isUpdatedboolean
licenseTypestringrequired

Type of license

Enum"State License""Business Permit""Occupational License""Medical gas permit"
Example: "State License"
sourcestringrequired

Source of license verification (licensing authority)

Example: "Utah Department of Health and Human Services"
licenseNumberstringrequired

License number issued by the licensing authority

Example: "F23-100000"
statusstringrequired

Status of the license (e.g., "Active", "Expired")

Enum"Active""Inactive""Expired""Retired""Revoked""Lapsed""Probation""Surrendered""Suspended"
Example: "Active"
issueDatestring(date)

Date when the state license was issued

expirationDatestring(date)required

Date when the state license expires

facilitySupportingDocumentsArray of objects(FacilitySupportingDocumentDto)required
idstring
actionstring
Default "updated"
Enum"updated""created""deleted"
isUpdatedboolean
namestringrequired
lastModifiedstring(date-time)required
typestringrequired
accreditationsArray of objects(AccreditationDto)required
idstring
actionstring
Default "updated"
Enum"updated""created""deleted"
isUpdatedboolean
accreditationBodystringrequired
Default ""
applicablestringrequired
statusstringrequired

Accreditation status

Enum"Accredited""Not Accredited"
Example: "Accredited"
effectiveDatestring(date-time)required
expirationDatestring(date-time)
siteVisitsArray of objects(OnSiteReviewDto)required
idstring
actionstring
Default "updated"
Enum"updated""created""deleted"
isUpdatedboolean
applicablestringrequired

Whether on-site review is applicable

Enum"Yes""No""N/A"
Example: "Yes"
sourcestringrequired
gradestring
certificationsArray of objects(CertificationsDto)required
idstring
actionstring
Default "updated"
Enum"updated""created""deleted"
isUpdatedboolean
sourcestring
typesstring
certificateTypestring

Type of certification

Default "CLIA"
Enum"State Survey""CLIA""CMS""CDS""DEA""N/A"
Example: "CLIA"
numberstring
issueDatestring(date-time)
expirationDatestring(date-time)
npdbArray of objects(NpdbDto)required
idstring
actionstring
Default "updated"
Enum"updated""created""deleted"
isUpdatedboolean
applicablestringrequired

Whether NPDB check is applicable

Enum"Yes""No""N/A"
Example: "Yes"
sourcestringrequired
typeOfActionstringrequired

Type of NPDB action

Enum"No Action""Medical Malpractice Payment""Health Plan""State Licensure/Certification""Professional Society""Exclusion/Debarment""DEA/Federal Licensure""Government Administrative""Judgement/Conviction""Clinical Privileges"
Example: "No Action"
reportResultsstring

NPDB report results

Default "No Report Found"
Enum"Adverse Action Report""Medical Malpractice Payment Report""No Report Found"
Example: "No Report Found"
reportDatestring(date-time)required
processDatestring(date-time)required
sanctionsArray of objects(SanctionsDto)required
idstring
actionstring
Default "updated"
Enum"updated""created""deleted"
isUpdatedboolean
sanctionTypestringrequired
sourcestringrequired
reportResultsstringrequired
perfIndicatorArray of objects(FacilityPerformanceIndicatorDto)required
idstring
actionstring
Default "updated"
Enum"updated""created""deleted"
isUpdatedboolean
applicablestringrequired

Whether performance indicator is applicable

Enum"Yes""No""N/A"
Example: "Yes"
complaintsstringrequired
clinicalstringrequired
benefitsstringrequired
claimsstringrequired
accessIssuesstringrequired
liabilityInsurancesArray of objects(InsuranceDto)required
idstring
actionstring
Default "updated"
Enum"updated""created""deleted"
isUpdatedboolean
policyNumberstringrequired

Insurance policy number

sourcestringrequired

Insurance carrier/company name

insuranceTypestringrequired

Type of insurance

Enum"General Liability""Professional Liability"
Example: "Professional Liability"
expirationDatestring(date)required

Date when the insurance policy expires

lastCredentialingDatestring(date)required

Date the facility was last credentialed

nextCredentialingDatestring(date)required

Date when the facility is due for re-credentialing

facilitySpecialtiesArray of objects(CreateSpecialtiesDto)
facilityPrimarySpecialtyobject(CreateSpecialtiesDto)
facilityHsdSpecialtyobject(HsdSpecialty)
appVerificationsArray of objects(AppVerificationDto)
medicareStarRatingsArray of objects(MedicareStarRatingDto)required
idstring
actionstring
Default "updated"
Enum"updated""created""deleted"
isUpdatedboolean
starRatingstring
reportDatestring(date-time)
sourcestring
linesOfBusinessArray of arrays
organizationIdstringrequired
contractEntitystringrequired
credentialingStartDatestring(date)required

Date the facility was received for credentialing

attestationDatestring(date)required

Date when facility attestation was completed

psvCompleteDatestring(date-time)required
credentialingDecisionDatestring(date-time)required
medicalDirectorIdstringrequired
medicalDirectorNamestringrequired
idstringrequired
createdAtstring(date-time)required
Example: "YYYY-MM-DD"
createdBystringrequired
createdByNamestringrequired
updatedAtstring(date-time)required
Example: "YYYY-MM-DD"
updatedBystringrequired
updatedByNamestringrequired
surveyResponseArray of objectsrequired
providersArray of objects(FacilityProviderV2Dto)required
idstringrequired
npistringrequired
namestringrequired
typestringrequired

Provider type/credential

Enum"AA""ABA""ACU""ADC""APN""AT""ATR""AUD""BCaBA""BCBA"
Example: "MD"
verified_bystringrequired
verified_datestringrequired
Example: "YYYY-MM-DD"
practiceLicenseArray of objects(PracticeLicenseV2Dto)required
idstringrequired
statestringrequired

US state or territory where practice license is issued

Enum"AK""AL""AR""AS""AZ""CA""CO""CT""DC""DE"
Example: "CA"
expirationDatestring(date-time)required
typestringrequired

Type of practice license

Enum"State License""Business Permit""Occupational License""Medical gas permit"
Example: "State License"
statusstringrequired

Current status of the practice license

Enum"Active""Inactive""Expired""Retired""Revoked""Lapsed""Probation""Surrendered""Suspended"
Example: "Active"
licensestringrequired
sourcestringrequired

Source of practice license verification

verified_bystringrequired

Name of the person who verified this practice license information

verified_datestringrequired

Date when this practice license information was verified

Example: "YYYY-MM-DD"
issueDatestring(date-time)required
businessLicenseArray of objects(BusinessLicenseV2Dto)required
idstringrequired
namestringrequired

Business name as registered

entitystringrequired

Business entity type

citystringrequired
typestringrequired
incorporationDatestring(date)required

Date when the business was incorporated

verified_bystringrequired

Name of the person who verified this business license information

Example: "John Doe"
verified_datestringrequired

Date when this business license information was verified

Example: "YYYY-MM-DD"
onsiteReviewsArray of objects(OnSiteReviewDto)required
idstring
actionstring
Default "updated"
Enum"updated""created""deleted"
isUpdatedboolean
applicablestringrequired

Whether on-site review is applicable

Enum"Yes""No""N/A"
Example: "Yes"
sourcestringrequired
gradestring
licensureActionsArray of objectsrequired
deasArray of objects(DEADto)required
idstring
actionstring
Default "updated"
Enum"updated""created""deleted"
isUpdatedboolean
statestringrequired

State where DEA license is issued

Enum"AK""AL""AR""AS""AZ""CA""CO""CT""DC""DE"
Example: "CA"
deaNumberstringrequired
providerTypestringrequired
statusstringrequired

Status of the DEA license

Enum"Active""Inactive"
Example: "Active"
sourcestringrequired
expirationDatestring(date-time)required
credentialingStatusstringrequired

Current credentialing status of the facility

Enum"Not sent to credentialing""Not Started""In Progress""Data missing""Outreach in progress""PSV complete by CertifyOS""Credentialing restarted""PSV ready""Cred approved""Hold for Cred Comm"
Example: "In Progress"
timelinesArray of objects(TimelineV2Dto)required
idstringrequired
enteredAtstring(date-time)required
titlestringrequired
verified_bystringrequired
verified_datestringrequired
Example: "YYYY-MM-DD"
countnumberrequired

Total number of facilities

Example: 528
idsArray of arrays or null or null

Array of specific facility IDs (when filtering)

Response
application/json
{
  "data": [
    { … }
  ],
  "count": 528,
  "ids": []
}

Add a facility.

Request

Security
BearerAuth
Headers
organization-idstring
Bodyapplication/jsonrequired
namestring<= 128 charactersrequired

Legal name of the facility

dbastringrequired

Doing Business As (DBA) name or trade name of the facility

typestringrequired

Type of facility

Example: "Ambulatory Surgery Centers"
tinstringrequired

Tax Identification Number (TIN) for the facility

medicareNumberstring
medicaidNumberstring
addressstringrequired

Street address of the facility (Line 1)

citystringrequired

City where the facility is located

Example: "Saint George"
zipcodestringrequired

ZIP code of the facility location

Example: "90210"
contactNamestringrequired

Name of the primary contact person for the facility

contactPhonestringrequired

Primary contact phone number for the facility

Example: "8000001234"
contactEmailstringrequired

Primary contact email address for the facility (email format)

contactFaxstringrequired

Contact fax number for the facility (optional)

Example: "8000001234"
statestringrequired

State where the facility is located (2-letter state code)

Enum"AK""AL""AR""AS""AZ""CA""CO""CT""DC""DE"
Example: "CA"
fileTypestring

File processing status for the facility record

Enum"Clean""Non_Clean""Pending"
Example: "Clean"
npistring

National Provider Identifier (NPI) - 10-digit identifier

externalIdstring

External identifier for the facility from external systems

Example: "V2222L00000"
skipOnSiteReviewbooleanrequired
stateLicensesArray of objects(FacilityStateLicenseDto)required
idstring
actionstring
Default "updated"
Enum"updated""created""deleted"
isUpdatedboolean
licenseTypestringrequired

Type of license

Enum"State License""Business Permit""Occupational License""Medical gas permit"
Example: "State License"
sourcestringrequired

Source of license verification (licensing authority)

Example: "Utah Department of Health and Human Services"
licenseNumberstringrequired

License number issued by the licensing authority

Example: "F23-100000"
statusstringrequired

Status of the license (e.g., "Active", "Expired")

Enum"Active""Inactive""Expired""Retired""Revoked""Lapsed""Probation""Surrendered""Suspended"
Example: "Active"
issueDatestring(date)

Date when the state license was issued

expirationDatestring(date)required

Date when the state license expires

facilitySupportingDocumentsArray of objects(FacilitySupportingDocumentDto)required
idstring
actionstring
Default "updated"
Enum"updated""created""deleted"
isUpdatedboolean
namestringrequired
lastModifiedstring(date-time)required
typestringrequired
accreditationsArray of objects(AccreditationDto)required
idstring
actionstring
Default "updated"
Enum"updated""created""deleted"
isUpdatedboolean
accreditationBodystringrequired
Default ""
applicablestringrequired
statusstringrequired

Accreditation status

Enum"Accredited""Not Accredited"
Example: "Accredited"
effectiveDatestring(date-time)required
expirationDatestring(date-time)
siteVisitsArray of objects(OnSiteReviewDto)required
idstring
actionstring
Default "updated"
Enum"updated""created""deleted"
isUpdatedboolean
applicablestringrequired

Whether on-site review is applicable

Enum"Yes""No""N/A"
Example: "Yes"
sourcestringrequired
gradestring
certificationsArray of objects(CertificationsDto)required
idstring
actionstring
Default "updated"
Enum"updated""created""deleted"
isUpdatedboolean
sourcestring
typesstring
certificateTypestring

Type of certification

Default "CLIA"
Enum"State Survey""CLIA""CMS""CDS""DEA""N/A"
Example: "CLIA"
numberstring
issueDatestring(date-time)
expirationDatestring(date-time)
npdbArray of objects(NpdbDto)required
idstring
actionstring
Default "updated"
Enum"updated""created""deleted"
isUpdatedboolean
applicablestringrequired

Whether NPDB check is applicable

Enum"Yes""No""N/A"
Example: "Yes"
sourcestringrequired
typeOfActionstringrequired

Type of NPDB action

Enum"No Action""Medical Malpractice Payment""Health Plan""State Licensure/Certification""Professional Society""Exclusion/Debarment""DEA/Federal Licensure""Government Administrative""Judgement/Conviction""Clinical Privileges"
Example: "No Action"
reportResultsstring

NPDB report results

Default "No Report Found"
Enum"Adverse Action Report""Medical Malpractice Payment Report""No Report Found"
Example: "No Report Found"
reportDatestring(date-time)required
processDatestring(date-time)required
sanctionsArray of objects(SanctionsDto)required
idstring
actionstring
Default "updated"
Enum"updated""created""deleted"
isUpdatedboolean
sanctionTypestringrequired
sourcestringrequired
reportResultsstringrequired
perfIndicatorArray of objects(FacilityPerformanceIndicatorDto)required
idstring
actionstring
Default "updated"
Enum"updated""created""deleted"
isUpdatedboolean
applicablestringrequired

Whether performance indicator is applicable

Enum"Yes""No""N/A"
Example: "Yes"
complaintsstringrequired
clinicalstringrequired
benefitsstringrequired
claimsstringrequired
accessIssuesstringrequired
liabilityInsurancesArray of objects(InsuranceDto)required
idstring
actionstring
Default "updated"
Enum"updated""created""deleted"
isUpdatedboolean
policyNumberstringrequired

Insurance policy number

sourcestringrequired

Insurance carrier/company name

insuranceTypestringrequired

Type of insurance

Enum"General Liability""Professional Liability"
Example: "Professional Liability"
expirationDatestring(date)required

Date when the insurance policy expires

lastCredentialingDatestring(date-time)
nextCredentialingDatestring(date-time)
facilitySpecialtiesArray of objects(CreateSpecialtiesDto)
facilityPrimarySpecialtyobject(CreateSpecialtiesDto)
facilityHsdSpecialtyobject(HsdSpecialty)
appVerificationsArray of objects(AppVerificationDto)
medicareStarRatingsArray of objects(MedicareStarRatingDto)required
idstring
actionstring
Default "updated"
Enum"updated""created""deleted"
isUpdatedboolean
starRatingstring
reportDatestring(date-time)
sourcestring
linesOfBusinessArray of arrays
curl -i -X POST \
  https://docs.certifyos.com/_mock/reference/application/api/v2/facilities \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'organization-id: string' \
  -d '{
    "name": "string",
    "dba": "string",
    "type": "Ambulatory Surgery Centers",
    "tin": "string",
    "medicareNumber": "string",
    "medicaidNumber": "string",
    "address": "string",
    "city": "Saint George",
    "zipcode": "90210",
    "contactName": "string",
    "contactPhone": "8000001234",
    "contactEmail": "string",
    "contactFax": "8000001234",
    "state": "CA",
    "fileType": "Clean",
    "npi": "string",
    "externalId": "V2222L00000",
    "skipOnSiteReview": true,
    "stateLicenses": [
      {
        "id": "string",
        "action": "updated",
        "isUpdated": true,
        "licenseType": "State License",
        "source": "Utah Department of Health and Human Services",
        "licenseNumber": "F23-100000",
        "status": "Active",
        "issueDate": "2019-08-24",
        "expirationDate": "2019-08-24"
      }
    ],
    "facilitySupportingDocuments": [
      {
        "id": "string",
        "action": "updated",
        "isUpdated": true,
        "name": "string",
        "lastModified": "2019-08-24T14:15:22Z",
        "type": "string"
      }
    ],
    "accreditations": [
      {
        "id": "string",
        "action": "updated",
        "isUpdated": true,
        "accreditationBody": "",
        "applicable": "string",
        "status": "Accredited",
        "effectiveDate": "2019-08-24T14:15:22Z",
        "expirationDate": "2019-08-24T14:15:22Z"
      }
    ],
    "siteVisits": [
      {
        "id": "string",
        "action": "updated",
        "isUpdated": true,
        "applicable": "Yes",
        "source": "string",
        "grade": "string"
      }
    ],
    "certifications": [
      {
        "id": "string",
        "action": "updated",
        "isUpdated": true,
        "source": "string",
        "types": "string",
        "certificateType": "CLIA",
        "number": "string",
        "issueDate": "2019-08-24T14:15:22Z",
        "expirationDate": "2019-08-24T14:15:22Z"
      }
    ],
    "npdb": [
      {
        "id": "string",
        "action": "updated",
        "isUpdated": true,
        "applicable": "Yes",
        "source": "string",
        "typeOfAction": "No Action",
        "reportResults": "No Report Found",
        "reportDate": "2019-08-24T14:15:22Z",
        "processDate": "2019-08-24T14:15:22Z"
      }
    ],
    "sanctions": [
      {
        "id": "string",
        "action": "updated",
        "isUpdated": true,
        "sanctionType": "string",
        "source": "string",
        "reportResults": "string"
      }
    ],
    "perfIndicator": [
      {
        "id": "string",
        "action": "updated",
        "isUpdated": true,
        "applicable": "Yes",
        "complaints": "string",
        "clinical": "string",
        "benefits": "string",
        "claims": "string",
        "accessIssues": "string"
      }
    ],
    "liabilityInsurances": [
      {
        "id": "string",
        "action": "updated",
        "isUpdated": true,
        "policyNumber": "string",
        "source": "string",
        "insuranceType": "Professional Liability",
        "expirationDate": "2019-08-24"
      }
    ],
    "lastCredentialingDate": "2019-08-24T14:15:22Z",
    "nextCredentialingDate": "2019-08-24T14:15:22Z",
    "facilitySpecialties": [
      {
        "specialtyNuccTaxonomyCode": "string",
        "code": "string",
        "name": "string",
        "id": "string",
        "isPrimary": true,
        "specialtyBoardName": "string",
        "source": "string",
        "subSpecialties": [
          {
            "specialtyNuccTaxonomyCode": "string",
            "name": "string"
          }
        ]
      }
    ],
    "facilityPrimarySpecialty": {
      "specialtyNuccTaxonomyCode": "string",
      "code": "string",
      "name": "string",
      "id": "string",
      "isPrimary": true,
      "specialtyBoardName": "string",
      "source": "string",
      "subSpecialties": [
        {
          "specialtyNuccTaxonomyCode": "string",
          "name": "string"
        }
      ]
    },
    "facilityHsdSpecialty": {
      "code": "",
      "name": ""
    },
    "appVerifications": [
      {
        "id": "string",
        "action": "updated",
        "isUpdated": true,
        "explanation": "string",
        "source": "string",
        "verificationType": "string"
      }
    ],
    "medicareStarRatings": [
      {
        "id": "string",
        "action": "updated",
        "isUpdated": true,
        "starRating": "string",
        "reportDate": "2019-08-24T14:15:22Z",
        "source": "string"
      }
    ],
    "linesOfBusiness": [
      []
    ]
  }'

Responses

The record has been successfully created.

Terminate Facilities (Bulk)

Request

Terminates the facility.

Security
BearerAuth
Headers
organization-idstring
Bodyapplication/jsonrequired
facility_idsArray of stringsrequired

Facility ids to be terminated in comma separated strings within the array.

reasonstringrequired

Reason for the termination.

filtersobjectrequired

Add Filters to the facility to be terminated

offsetnumber>= 0

The starting index for pagination, specifying how many records to skip.

Default 0
limitnumber

The maximum number of records to retrieve in a single request.

Default 10
file_typestring

File Type of the facility to filter by to be terminated. (Effective only when no facility_ids are being passed and filters are used for query instead, but we need to pass the value in every case to make the api request)

Enum"Clean""Non_Clean""Pending"
start_updated_atstring(date-time)

Filter facility that are created or updated >= specified date.

end_updated_atstring(date-time)

Filter providers that are created or updated < specified date.

curl -i -X PATCH \
  https://docs.certifyos.com/_mock/reference/application/api/v2/facilities/terminate-facility \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'organization-id: string' \
  -d '{
    "facility_ids": [
      "string"
    ],
    "reason": "string",
    "filters": {
      "offset": 0,
      "limit": 10,
      "file_type": "Clean",
      "start_updated_at": "2019-08-24T14:15:22Z",
      "end_updated_at": "2019-08-24T14:15:22Z"
    }
  }'

Responses

Facility successfully terminated.

Bodyapplication/json
messagestring
Response
application/json
{
  "message": "string"
}

Unterminate Facilities (Bulk)

Request

Unterminates the facility

Security
BearerAuth
Headers
organization-idstring
Bodyapplication/jsonrequired
facility_idsArray of stringsrequired

Facility ids to be unterminated in comma separated strings within the array.

reasonstringrequired

Reason for the untermination.

filtersobjectrequired

Add Filters to the facility to be unterminated

offsetnumber>= 0

The starting index for pagination, specifying how many records to skip.

Default 0
limitnumber

The maximum number of records to retrieve in a single request.

Default 10
file_typestring

File Type of the facility to filter by to be terminated. (Effective only when no facility_ids are being passed and filters are used for query instead, but we need to pass the value in every case to make the api request)

Enum"Clean""Non_Clean""Pending"
start_updated_atstring(date-time)

Filter facility that are created or updated >= specified date.

end_updated_atstring(date-time)

Filter providers that are created or updated < specified date.

curl -i -X PATCH \
  https://docs.certifyos.com/_mock/reference/application/api/v2/facilities/unterminate-facility \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'organization-id: string' \
  -d '{
    "facility_ids": [
      "string"
    ],
    "reason": "string",
    "filters": {
      "offset": 0,
      "limit": 10,
      "file_type": "Clean",
      "start_updated_at": "2019-08-24T14:15:22Z",
      "end_updated_at": "2019-08-24T14:15:22Z"
    }
  }'

Responses

Facility successfully unterminated.

Retrieve signed PSV url of a given facility.

Request

Security
BearerAuth
Path
facilityIdstringrequired
Headers
organization-idstring
curl -i -X GET \
  'https://docs.certifyos.com/_mock/reference/application/api/v2/facilities/{facilityId}/psv/signed-url' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'organization-id: string'

Responses

Bodyapplication/json
string
Response
application/json
"string"

Retrieve groups/org-entities for a facility.

Request

Security
BearerAuth
Path
facilityIdstringrequired
Headers
organization-idstring
curl -i -X GET \
  'https://docs.certifyos.com/_mock/reference/application/api/v2/facilities/{facilityId}/groups' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'organization-id: string'

Responses

Facility Groups.

Bodyapplication/jsonArray [
idstringrequired
group_namestringrequired
group_npistring= 10 charactersrequired

Group National Provider Identifier (NPI)

Example: "2345678901"
group_tinstring= 9 charactersrequired

Group Tax Identification Number (TIN)

Example: "123456789"
external_group_idstring
]
Response
application/json
[
  {
    "id": "string",
    "group_name": "string",
    "group_npi": "2345678901",
    "group_tin": "123456789",
    "external_group_id": "string"
  }
]

Retrieve credentialing workflow timeline for a facility.

Request

Security
BearerAuth
Path
facilityIdstringrequired
Headers
organization-idstring
curl -i -X GET \
  'https://docs.certifyos.com/_mock/reference/application/api/v2/facilities/{facilityId}/credentialing-workflow-timelines' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'organization-id: string'

Responses

Credentialing workflow timeline

Bodyapplication/json
facilityCredentialingWorkflowIdstring
credentialingStatusstring
credentialingCyclestring
facilityIdstringrequired
organizationIdstringrequired
medicalDirectorIdstring
medicalDirectorNamestring
receivedForCredentialingDatestringrequired
attestationDatestring
lastCredentialedDatestringrequired
psvCompleteDatestringrequired
credentialingDecisionDatestringrequired
nextCredentialingDatestringrequired
updatedAtstringrequired
updatedByNamestring
updatedBystring
createdAtstringrequired
createdBystring
createdByNamestring
decisionEnteredByIdstring
decisionEnteredByNamestring
verifierIdstring
Response
application/json
{
  "facilityCredentialingWorkflowId": "string",
  "credentialingStatus": "string",
  "credentialingCycle": "string",
  "facilityId": "string",
  "organizationId": "string",
  "medicalDirectorId": "string",
  "medicalDirectorName": "string",
  "receivedForCredentialingDate": "string",
  "attestationDate": "string",
  "lastCredentialedDate": "string",
  "psvCompleteDate": "string",
  "credentialingDecisionDate": "string",
  "nextCredentialingDate": "string",
  "updatedAt": "string",
  "updatedByName": "string",
  "updatedBy": "string",
  "createdAt": "string",
  "createdBy": "string",
  "createdByName": "string",
  "decisionEnteredById": "string",
  "decisionEnteredByName": "string",
  "verifierId": "string"
}