Skip to content

CertifyOS API

Download OpenAPI description
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

Creates a credentialing workflow for the provider.

Request

Initiates a new credentialing workflow for the specified provider. The workflow will automatically trigger the pipeline to fetch the required provider information needed for credentialing.

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

Responses

Credentialing workflow ID

Bodyapplication/json
idstring
providerIdstring
Response
application/json
{ "id": "string", "providerId": "string" }

Retrieve signed URL for provider PSV PDF

Request

Returns a signed URL for downloading the PSV (Primary Source Verification) PDF for the specified provider. The signed URL is time-limited and allows secure access to the PSV document.

Security
BearerAuth
Path
providerIdstringrequired

The unique identifier of the provider whose PSV PDF signed URL is to be retrieved.

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

Responses

Signed URL for the provider PSV PDF.

Bodyapplication/json
any
Response
application/json
{ "signedUrl": "https://storage.googleapis.com/bucket/psv.pdf?X-Goog-Signature=..." }

Modify groups associated to a provider

Request

Modifies the groups (org-entities) associated with a provider.

Security
BearerAuth
Path
providerIdstringrequired
Headers
organization-idstring
Bodyapplication/jsonrequiredArray [
group_namestringrequired

Name of the group

group_npistring= 10 charactersrequired

Group National Provider Identifier (NPI)

Example: "2345678901"
group_tinstring= 9 charactersrequired

Group Tax Identification Number (TIN)

Example: "123456789"
location_namestring

Name of group location

external_group_idstring

Client's ID for the group

]
curl -i -X PUT \
  'https://docs.certifyos.com/_mock/reference/application/api/v2/provider/{providerId}/groups' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'organization-id: string' \
  -d '[
    {
      "group_name": "string",
      "group_npi": "2345678901",
      "group_tin": "123456789",
      "location_name": "string",
      "external_group_id": "string"
    }
  ]'

Responses

The record has been successfully updated.

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