Skip to content
/providers

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

Export Provider Directory

Request

Triggers an export workflow for the provider directory. The export will include provider details based on the provided filters. The result is typically a CSV or similar file, and the export is processed asynchronously.

Security
BearerAuth
Query
providerIdsArray of strings

Provider ids to be filtered in comma separated strings within the array.

includeInactiveProvidersboolean

Whether to include Inactive Providers

limitnumber

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

offsetnumber

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

Headers
organization-idstring
curl -i -X GET \
  'https://docs.certifyos.com/_mock/reference/application/api/providers/export/provider-directory?providerIds=string&includeInactiveProviders=true&limit=0&offset=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'organization-id: string'

Responses

Workflow Executed. The export process has been triggered successfully.

Bodyapplication/json
any
Response
application/json
{
  "message": "Workflow Executed"
}

Export HSD Report

Request

Triggers an export workflow for the HSD (Health Service Delivery) report. The export will include provider details based on the provided filters. The result is typically a CSV or similar file, and the export is processed asynchronously.

Security
BearerAuth
Query
providerIdsArray of strings

Provider ids to be filtered in comma separated strings within the array.

includeInactiveProvidersboolean

Whether to include Inactive Providers

limitnumber

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

offsetnumber

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

Headers
organization-idstring
curl -i -X GET \
  'https://docs.certifyos.com/_mock/reference/application/api/providers/export/hsd-report?providerIds=string&includeInactiveProviders=true&limit=0&offset=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'organization-id: string'

Responses

Workflow Executed. The export process has been triggered successfully.

Bodyapplication/json
any
Response
application/json
{
  "message": "Workflow Executed"
}

Upload Supporting Document

Request

Uploads a supporting document for a provider by ID. This endpoint accepts a multipart/form-data request with a file and metadata.

  • The uploaded document is associated with the provider and saved in the system.
  • Only valid files and supported document metadata will be processed.
  • Returns a confirmation once the document is uploaded successfully.

Authorization:

  • Requires an Bearer access token.

Possible Errors:

  • 400 Bad Request: If the file or metadata is invalid.
  • 404 Not Found: If the provider with the given ID does not exist.
Security
BearerAuth
Path
idstringrequired
Headers
organization-idstring
Bodymultipart/form-datarequired

Supporting Document upload request

filestring(binary)
fileTypestringrequired
statestring
Enum"AK""AL""AR""AS""AZ""CA""CO""CT""DC""DE"
curl -i -X POST \
  'https://docs.certifyos.com/_mock/reference/application/api/providers/{id}/supporting-documents' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: multipart/form-data' \
  -H 'organization-id: string' \
  -F file=string \
  -F fileType=string \
  -F state=AK

Responses

The supporting document was successfully uploaded.

Get all credentialing workflow timelines for a provider

Request

Returns a list of credentialing workflow timeline records for the specified provider within the organization. Each record contains credentialing status, cycle, dates, and related metadata.

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

Responses

Credentialing workflow timelines retrieved successfully.

Bodyapplication/jsonArray [
idstringrequired
decisionEnteredByIdstring
decisionEnteredByNamestring
medicalDirectorIdstring
medicalDirectorNamestring
receivedForCredentialingDatestring(date-time)
attestationDatestring(date-time)
lastCredentialedDatestring(date-time)required
lastCredentialedDateChangeReasonstring
psvCompleteDatestring(date-time)
credentialingDecisionDatestring(date-time)
nextCredentialingDatestring(date-time)
verificationDatestring(date-time)
verifierIdstring
initialCredentialingDatestring(date-time)required
initialCredentialingDateChangeReasonstring
providerIdstringrequired
organizationIdstringrequired
orgEntityobjectrequired
credentialingWorkflowIdstring or null
credentialingStatusstringrequired
credentialingCyclestring
Enum"Initial""Recredentialing"
credentialingStatusUpdatedAtstring(date-time)
createdAtstring(date-time)
createdBystring
createdByNamestring
updatedAtstring(date-time)
updatedBystring
updatedByNamestring
]
Response
application/json
[
  {
    "id": "string",
    "decisionEnteredById": "string",
    "decisionEnteredByName": "string",
    "medicalDirectorId": "string",
    "medicalDirectorName": "string",
    "receivedForCredentialingDate": "2019-08-24T14:15:22Z",
    "attestationDate": "2019-08-24T14:15:22Z",
    "lastCredentialedDate": "2019-08-24T14:15:22Z",
    "lastCredentialedDateChangeReason": "string",
    "psvCompleteDate": "2019-08-24T14:15:22Z",
    "credentialingDecisionDate": "2019-08-24T14:15:22Z",
    "nextCredentialingDate": "2019-08-24T14:15:22Z",
    "verificationDate": "2019-08-24T14:15:22Z",
    "verifierId": "string",
    "initialCredentialingDate": "2019-08-24T14:15:22Z",
    "initialCredentialingDateChangeReason": "string",
    "providerId": "string",
    "organizationId": "string",
    "orgEntity": {},
    "credentialingWorkflowId": "string",
    "credentialingStatus": "string",
    "credentialingCycle": "Initial",
    "credentialingStatusUpdatedAt": "2019-08-24T14:15:22Z",
    "createdAt": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "createdByName": "string",
    "updatedAt": "2019-08-24T14:15:22Z",
    "updatedBy": "string",
    "updatedByName": "string"
  }
]

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