Skip to content
/credentialing-workflows

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

CredentialingWorkflowsController_revertStatus

Request

Security
BearerAuth
Path
idstringrequired
Headers
organization-idstring
Bodyapplication/jsonrequired
reasonstringrequired
curl -i -X PATCH \
  'https://docs.certifyos.com/_mock/reference/application/api/credentialing-workflows/{id}/revert-status' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'organization-id: string' \
  -d '{
    "reason": "string"
  }'

Responses

The status has been successfully reverted.

Create Credentialing Note

Request

Creates a new note associated with the specified credentialing workflow.

Functionality

  • Adds a user-generated note to a credentialing workflow.
  • Useful for internal communication, tracking decisions, or annotating the process.
  • The note will be associated with the given workflow ID.
Security
BearerAuth
Path
idstringrequired
Headers
organization-idstring
Bodyapplication/jsonrequired
messagestringrequired
curl -i -X POST \
  'https://docs.certifyos.com/_mock/reference/application/api/credentialing-workflows/{id}/notes' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'organization-id: string' \
  -d '{
    "message": "string"
  }'

Responses

Note has been successfully created.

Update Credentialing Note

Request

Updates an existing note associated with a credentialing workflow.

Security
BearerAuth
Path
idstringrequired
noteIdstringrequired
Headers
organization-idstring
Bodyapplication/jsonrequired
messagestring
curl -i -X PATCH \
  'https://docs.certifyos.com/_mock/reference/application/api/credentialing-workflows/{id}/notes/{noteId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'organization-id: string' \
  -d '{
    "message": "string"
  }'

Responses

Note has been successfully updated.

Populate template fields for credentialing workflow

Request

Retrieves and populates template fields for the specified credentialing workflow. Useful for generating documents, emails, or other communications that require workflow-specific data to be inserted into templates.

Security
BearerAuth
Path
idstringrequired

The unique identifier of the credentialing workflow for which to populate template fields.

Query
reasonsstringrequired

A comma-separated list of reasons to be included in the template fields (e.g., "reason1,reason2"). These reasons should already be present in the organization settings under "outreach" to be used here.

Headers
organization-idstring
curl -i -X GET \
  'https://docs.certifyos.com/_mock/reference/application/api/credentialing-workflows/{id}/populate-template-fields?reasons=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'organization-id: string'

Responses

Successfully populated template fields

Bodyapplication/json
any
Response
application/json
{
  "workflowId": "abc123",
  "providerName": "Dr. Jane Doe",
  "organizationName": "HealthCare Org",
  "reasons": [
    "Missing License",
    "Incomplete Application"
  ],
  "otherField1": "value1",
  "otherField2": "value2"
}

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