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

Upload Provider Attested Data Document

Request

Security
BearerAuth
Path
providerIdstringrequired
Headers
organization-idstring
Bodymultipart/form-datarequired
fileTypestringrequired

Type of the file uploading

organizationIdstringrequired

ID assigned to Client Organization

workflowIdstringrequired

ID assigned to Workflow

filestring(binary)

Provider Document

curl -i -X POST \
  'https://docs.certifyos.com/_mock/reference/application/api/v2/provider/{providerId}/attested-data/documents' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: multipart/form-data' \
  -H 'organization-id: string' \
  -F fileType=string \
  -F organizationId=string \
  -F workflowId=string \
  -F file=string

Responses

The record has been successfully created.

Retrieve signed url of a given supporting-document id.

Request

Retrieves a signed URL for the specified supporting document ID associated with the provider. The signed URL provides secure, temporary access to the document and remains valid for 10 minutes.

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

Responses

Signed URL

Bodyapplication/json
string
Response
application/json
"string"

Lists all provider survey responses in an organization

Request

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
versionnumber

Version of the desired survey response

Headers
organization-idstring
curl -i -X GET \
  'https://docs.certifyos.com/_mock/reference/application/api/v2/provider/{providerId}/survey-responses?offset=0&limit=10&version=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'organization-id: string'

Responses

Survey responses

Bodyapplication/json
dataobject
countnumber
Response
application/json
{ "data": {}, "count": 0 }

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