Skip to content
CertifyOS API
/
/
Lists all providers in an...

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

Create Providers

Request

Create providers (Bulk)

Security
BearerAuth
Headers
organization-idstring
Bodyapplication/jsonrequiredArray [
first_namestringrequired

First name of the Provider

middle_namestring

Middle name of the Provider

Default ""
last_namestringrequired

Last name of the Provider

degreestringrequired

Type of provider

Enum"AA""ABA""ACU""ADC""APN""AT""ATR""AUD""BCaBA""BCBA"
npistring

NPI of the Provider

Default ""
statesstringrequired

States in which Provider will provide care to patients/enrollees

caqh_provider_idstring

CAQH ID of the Provider

Default ""
last_credentialed_datestring(date-time)

Date Provider was last credentialed

next_credentialing_datestring(date-time)

Date by which Provider needs to be recredentialed

initial_credentialing_datestring(date-time)

Date by which Provider was initially credentialed.

external_idstring

Client’s ID for the provider

primary_emailstring

Provider’s email address

Example: "string@string.com"
genderstring

Provider Gender

Enum"M""F""U"
dobstring(date-time)

Provider’s date of birth

group_namestring

Name of the group

group_npistring= 10 characters

Group National Provider Identifier (NPI)

Example: "2345678901"
group_tinstring= 9 characters

Group Tax Identification Number (TIN)

Example: "123456789"
location_namestring

Name of group location

external_group_idstring

Client’s ID for the group

is_pcpboolean

Indicates whether the provider is a Primary Care Provider (PCP).

is_specialistboolean

Indicates whether the provider is a specialist.

accepts_new_patientsboolean

Indicates whether the provider is currently accepting new patients.

accepts_new_medicare_patientsboolean

Indicates whether the provider accepts new Medicare patients.

]
curl -i -X POST \
  https://docs.certifyos.com/_mock/reference/application/api/v2/providers \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'organization-id: string' \
  -d '[
    {
      "first_name": "string",
      "middle_name": "",
      "last_name": "string",
      "degree": "AA",
      "npi": "",
      "states": "string",
      "caqh_provider_id": "",
      "last_credentialed_date": "2019-08-24T14:15:22Z",
      "next_credentialing_date": "2019-08-24T14:15:22Z",
      "initial_credentialing_date": "2019-08-24T14:15:22Z",
      "external_id": "string",
      "primary_email": "string@string.com",
      "gender": "M",
      "dob": "2019-08-24T14:15:22Z",
      "group_name": "string",
      "group_npi": "2345678901",
      "group_tin": "123456789",
      "location_name": "string",
      "external_group_id": "string",
      "is_pcp": true,
      "is_specialist": true,
      "accepts_new_patients": true,
      "accepts_new_medicare_patients": true
    }
  ]'

Responses

The records has been successfully created.

Bodyapplication/jsonArray [
provider_idstring
errorobject(CreateProviderError)required
messagestringrequired
namestring
statusnumber
]
Response
application/json
[
  {
    "provider_id": "string",
    "error": { … }
  }
]

Lists all providers in an organization

Request

Fetches all the providers in the given organization, this endpoint is used to query for all providers in the organization. The endpoint returns a list of providers with the providerId and basic details. This endpoint supports filters for pagination (offset and limit), file type, flagged status, and created or updated date ranges. The practice location data response can be enabled on request, it is not returned by default.

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
file_typestring

File Type of the providers to filter by to be terminated.

Enum"Clean""Non_Clean""Pending"
flaggedboolean

Flagged providers will be terminated.

start_updated_atstring(date-time)

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

end_updated_atstring(date-time)

Filter providers that are created or updated < specified date.

Headers
organization-idstring
curl -i -X GET \
  'https://docs.certifyos.com/_mock/reference/application/api/v2/providers?offset=0&limit=10&file_type=Clean&flagged=true&start_updated_at=2019-08-24T14%3A15%3A22Z&end_updated_at=2019-08-24T14%3A15%3A22Z' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'organization-id: string'

Responses

List of providers.

Bodyapplication/jsonArray [
first_namestringrequired
middle_namestringrequired
last_namestringrequired
npistringrequired
degreestringrequired
provider_idstringrequired
created_atstring(date-time)required
updated_atstring(date-time)required
statusstringrequired

Current status of the provider

Enum"Terminated""Active""Denied""New""In Progress"
credentialing_statusstringrequired

Credentialing status of the provider

Enum"Not sent to credentialing""Not Started""In Progress""Recredentialing in progress""Data missing""Outreach in progress""PSV Complete""PSV ready""Hold for Cred Comm""Tabled"
credentialing_status_update_datestringrequired
Example: "YYYY-MM-DD"
external_idstringrequired
genderstringrequired
primary_emailstringrequired
caqh_primary_emailstringrequired
dobstringrequired
Example: "YYYY-MM-DD"
isHospitalBasedbooleanrequired
practice_locationArray of objects(PracticeLocationDto)required

Practice locations associated with the provider (enabled on request).

idstringrequired
provider_idstringrequired
organization_idstringrequired
namestringrequired
tinstring
start_datestring
Example: "YYYY-MM-DD"
drawing_bloodboolean
laboratory_servicesboolean
clia_numberstring
clia_expiration_datestring
Example: "YYYY-MM-DD"
address1string
citystring
statestring
zipstring
countrystring
npistring
phoneCoverage24x7boolean
totalLocationHoursnumber
locationHoursArray of objects(LocationHourDto)
verified_bystring
verified_datestring
Example: "YYYY-MM-DD"
]
Response
application/json
[
  {
    "first_name": "string",
    "middle_name": "string",
    "last_name": "string",
    "npi": "string",
    "degree": "string",
    "provider_id": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "status": "Terminated",
    "credentialing_status": "Not sent to credentialing",
    "credentialing_status_update_date": "YYYY-MM-DD",
    "external_id": "string",
    "gender": "string",
    "primary_email": "string",
    "caqh_primary_email": "string",
    "dob": "YYYY-MM-DD",
    "isHospitalBased": true,
    "practice_location": [ … ]
  }
]

Terminate providers

Request

Terminate providers.

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

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

reasonstringrequired

Reason for the termination.

filtersobjectrequired

Filters for Provider Termination

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 providers to filter by to be terminated.

Enum"Clean""Non_Clean""Pending"
flaggedboolean

Flagged providers will be terminated.

start_updated_atstring(date-time)

Filter providers 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/providers/terminate-providers \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'organization-id: string' \
  -d '{
    "provider_ids": [
      "string"
    ],
    "reason": "string",
    "filters": {
      "offset": 0,
      "limit": 10,
      "file_type": "Clean",
      "flagged": true,
      "start_updated_at": "2019-08-24T14:15:22Z",
      "end_updated_at": "2019-08-24T14:15:22Z"
    }
  }'

Responses

Providers successfully terminated.

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

Unterminate providers

Request

Unterminate providers

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

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

reasonstringrequired

Reason for the untermination.

filtersobjectrequired

Filters for Provider Un-Termination

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 providers to filter by to be terminated.

Enum"Clean""Non_Clean""Pending"
flaggedboolean

Flagged providers will be terminated.

start_updated_atstring(date-time)

Filter providers 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/providers/unterminate-providers \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'organization-id: string' \
  -d '{
    "provider_ids": [
      "string"
    ],
    "reason": "string",
    "filters": {
      "offset": 0,
      "limit": 10,
      "file_type": "Clean",
      "flagged": true,
      "start_updated_at": "2019-08-24T14:15:22Z",
      "end_updated_at": "2019-08-24T14:15:22Z"
    }
  }'

Responses

Providers successfully unterminated.

Response
No content

Updates provider data

Request

Updates the information of a specific provider.

Security
BearerAuth
Path
idstringrequired
Headers
organization-idstring
Bodyapplication/jsonrequired
initial_credentialing_datestring(date-time)

Date by which Provider was initially credentialed.

external_idstring

Client’s ID for the provider

primary_emailstring

Provider’s email address

Example: "string@string.com"
genderstring

Provider Gender

Enum"M""F""U"
dobstring(date-time)

Provider’s date of birth

is_pcpboolean

Indicates whether the provider is a Primary Care Provider (PCP).

is_specialistboolean

Indicates whether the provider is a specialist.

accepts_new_patientsboolean

Indicates whether the provider is currently accepting new patients.

accepts_new_medicare_patientsboolean

Indicates whether the provider accepts new Medicare patients.

assigned_statesstring

Provider's assigned states

Enum"AK""AL""AR""AS""AZ""CA""CO""CT""DC""DE"
curl -i -X PATCH \
  'https://docs.certifyos.com/_mock/reference/application/api/v2/providers/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'organization-id: string' \
  -d '{
    "initial_credentialing_date": "2019-08-24T14:15:22Z",
    "external_id": "string",
    "primary_email": "string@string.com",
    "gender": "M",
    "dob": "2019-08-24T14:15:22Z",
    "is_pcp": true,
    "is_specialist": true,
    "accepts_new_patients": true,
    "accepts_new_medicare_patients": true,
    "assigned_states": "AK"
  }'

Responses

Provider data successfully updated.

Share multiple providers to Credentialing Committee.

Request

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

Array of provider IDs to share to cred committee

reasonstringrequired

Reason for sharing to cred committee

curl -i -X POST \
  https://docs.certifyos.com/_mock/reference/application/api/v2/providers/bulk-share-to-cred-committee \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'organization-id: string' \
  -d '{
    "provider_ids": [
      "string"
    ],
    "reason": "string"
  }'

Responses

All providers shared to the cred committee successfully.

Response
No content

Share provider to Credentialing Committee.

Request

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

Responses

Shared to the cred committee successfully.

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

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