Skip to content
CertifyOS API
/
/
Get list of provider spec...

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

Create Bulk Provider Professional IDs

Request

Create multiple professional IDs for a provider

Security
BearerAuth
Path
providerIdstringrequired
Headers
organization-idstring
Bodyapplication/jsonrequired
professional_idsArray of objects(CreateProfessionalIdV2Dto)required

Array of professional IDs to create

typestringrequired

Type of professional ID

Enum"Medicare Number""Medicaid Number""ECFMG Number""Foreign National Identification Number""Unique Physician Identification Number""CLIA""DEA"
numberstringrequired

Professional ID number

issue_datestring(date-time)

Issue date of the professional ID

expiration_datestring(date-time)

Expiration date of the professional ID

notesstring

Notes about the professional ID

statestring

State associated with the professional ID

Enum"AK""AL""AR""AS""AZ""CA""CO""CT""DC""DE"
sourcestring

Source of the professional ID

curl -i -X POST \
  'https://docs.certifyos.com/_mock/reference/application/api/v2/provider/{providerId}/professional-ids' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'organization-id: string' \
  -d '{
    "professional_ids": [
      {
        "type": "Medicare Number",
        "number": "string",
        "issue_date": "2019-08-24T14:15:22Z",
        "expiration_date": "2019-08-24T14:15:22Z",
        "notes": "string",
        "state": "AK",
        "source": "string"
      }
    ]
  }'

Responses

Professional IDs created successfully.

Bodyapplication/jsonArray [
idstringrequired

Unique identifier for the professional ID

typestringrequired

Type of professional ID

Enum"Medicare Number""Medicaid Number""ECFMG Number""Foreign National Identification Number""Unique Physician Identification Number""CLIA""DEA"
numberstringrequired

Professional ID number

issue_datestring

Issue date of the professional ID

expiration_datestring

Expiration date of the professional ID

notesstring

Notes about the professional ID

statestring

State associated with the professional ID

sourcestring

Source of the professional ID

]
Response
application/json
[
  {
    "id": "string",
    "type": "Medicare Number",
    "number": "string",
    "issue_date": "string",
    "expiration_date": "string",
    "notes": "string",
    "state": "string",
    "source": "string"
  }
]

Get list of provider specialties

Request

Retrieves a list of specialties for the specified provider.

Security
BearerAuth
Path
providerIdstringrequired
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/provider/{providerId}/specialties?offset=0&limit=10' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'organization-id: string'

Responses

List of specialties

Bodyapplication/json
any
Response
application/json
[
  {
    "id": "string",
    "specialty_nucc_taxonomy_code": "string",
    "name": "string",
    "is_primary": true,
    "sub_specialties": [ … ]
  }
]

Create provider specialties

Request

Create a specialty with optional sub-specialties

Security
BearerAuth
Path
providerIdstringrequired
Headers
organization-idstring
Bodyapplication/jsonrequired
specialty_nucc_taxonomy_codestringrequired

Nucc taxonomy code tied to this specialty

namestringrequired

Name of specialty tied to this taxonomy code

is_primarybooleanrequired

Whether this specialty is the provider’s primary speciality; they can only have 1 primary specialty

sub_specialtiesArray of objects(SubSpecialtiesV2Dto)required

Provider’s subspecialties that are tied to this specialty [array] (if there are no subspecialties, include the field, but just put empty [])

Default []
specialty_nucc_taxonomy_codestringrequired

Nucc taxonomy code tied to this subspecialty

namestringrequired

Name of subspecialty tied to this taxonomy code

curl -i -X POST \
  'https://docs.certifyos.com/_mock/reference/application/api/v2/provider/{providerId}/specialties' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'organization-id: string' \
  -d '{
    "specialty_nucc_taxonomy_code": "string",
    "name": "string",
    "is_primary": true,
    "sub_specialties": []
  }'

Responses

Specialty created successfully.

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