Skip to content
CertifyOS API
/
/
Retrieve CAQH data for a...

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

Lists all provider email outreaches 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
Headers
organization-idstring
curl -i -X GET \
  'https://docs.certifyos.com/_mock/reference/application/api/v2/provider/{providerId}/outreaches?offset=0&limit=10' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'organization-id: string'

Responses

List of provider email outreaches

Bodyapplication/json
dataArray of objects(ProviderOutreachDto)required
provider_idstringrequired
organization_idstringrequired
workflow_idstringrequired
outreach_correspondence_idstring
dataobject(OutreachDataDto)required
toArray of stringsrequired
Example: ["string@string.com"]
reasonstringrequired
subjectstringrequired
bodystringrequired
entityTypestring
entityIdstring
numberOfAttachmentsnumber
attachmentsArray of objects(Attachment)
created_atstringrequired
created_by_namestringrequired
idstringrequired
latest_eventstring
outreach_correspondencestring
status_codenumber
sg_message_idstring
countnumberrequired
Example: 10
Response
application/json
{
  "data": [
    { … }
  ],
  "count": 10
}

Retrieve CAQH data for a provider

Request

Returns the CAQH (Council for Affordable Quality Healthcare) data for the specified provider. This data includes provider credentialing and demographic information as stored in CAQH.

Security
BearerAuth
Path
providerIdstringrequired

The unique identifier of the provider whose CAQH data is to be retrieved.

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

Responses

CAQH Data for the provider.

Bodyapplication/json
practitionerInformationobject
practitionerProfileDetailobject
healthPlanPractitionerDetailobject
practitionerProfessionalIdArray of objects
practitionerEducationArray of objects
practitionerSpecialExperienceAndTrainingobject
practitionerTrainingArray of objects
practitionerSpecialtyArray of objects
practitionerAffiliationArray of objects
practitionerPracticeLocationArray of objects
practitionerEmploymentInformationArray of objects
practitionerEmploymentGapArray of objects
practitionerCertificationArray of objects
practitionerDocumentArray of objects
practitionerClinicalPracticeobject
practitionerProfessionalLiabilityInsuranceArray of objects
providerIdstring
updatedAtstring(date-time)
updatedBystring
updatedByNamestring
workflowSourcestring
Response
application/json
{
  "practitionerInformation": {
    "caqhProviderId": 0,
    "firstName": "string",
    "middleName": "string",
    "lastName": "string",
    "suffix": "string",
    "gender": "string",
    "birthDate": "2019-08-24T14:15:22Z",
    "ssn": "string",
    "personalEmail": "string",
    "primaryEmail": "string",
    "ethnicity": "string",
    "raceEthnicity": [ … ],
    "languagesSpoken": [ … ],
    "birthCountry": "string",
    "primaryPracticeState": "string",
    "otherPracticeState": [ … ],
    "mailingAddress": { … },
    "homePhoneNumber": "string",
    "practiceSetting": "string",
    "citizenshipCountry": "string",
    "workPermitStatus": "string",
    "usWorkEligibleFlag": true,
    "visaNumber": "string",
    "practitionerType": { … },
    "homeAddress": { … }
  },
  "practitionerProfileDetail": {
    "practitionerStatus": { … },
    "lastAttestationDate": "2019-08-24T14:15:22Z",
    "attestId": "string",
    "practitionerStatusDate": "2019-08-24T14:15:22Z"
  },
  "healthPlanPractitionerDetail": {
    "proViewRosteredOnDate": "2019-08-24T14:15:22Z",
    "practitionerAuthorizationFlag": true,
    "practitionerAuthorizationDate": "2019-08-24T14:15:22Z",
    "practitionerLastRecredentialDate": "2019-08-24T14:15:22Z",
    "practitionerNextRecredentialDate": "2019-08-24T14:15:22Z"
  },
  "practitionerProfessionalId": [
    { … }
  ],
  "practitionerEducation": [
    { … }
  ],
  "practitionerSpecialExperienceAndTraining": {
    "adolescents": true,
    "angerManagement": true,
    "anxiety": true,
    "attentionDeficitHyperactivityDisorder": true,
    "autismSpectrumDisorders": true,
    "bipolarDisorder": true,
    "blindnessOrVisualImpairment": true,
    "children": true,
    "childWelfare": true,
    "chronicIllness": true,
    "cooccurringDisorders": true,
    "createdAt": "2019-08-24T14:15:22Z",
    "deafness": true,
    "depression": true,
    "dialecticalBehavioralTherapy": true,
    "genderIdentityDisorder": true,
    "genderNonConformity": true,
    "geriatricBehavioralHealth": true,
    "groupTherapy": true,
    "hivAIDS": true,
    "homelessness": true,
    "lesbianGayBisexual": true,
    "marriageAndFamilyTherapy": true,
    "medicalIllnessAndTherapy": true,
    "medicationManagementAndTherapy": true,
    "militaryVeterans": true,
    "modifiedAt": "2019-08-24T14:15:22Z",
    "neuropsychologicalTestingAdolescents": true,
    "neuropsychologicalTestingChildren": true,
    "obsessiveCompulsiveDisorder": true,
    "other": "string",
    "peopleWithDisabilities": true,
    "physicalDisabilities": true,
    "playTherapy": true,
    "postpartumDepressionAndOrPsychosis": true,
    "psychologicalTestingAdolescents": true,
    "psychologicalTestingChildren": true,
    "resourceAuthorization": { … },
    "seriousMentalIllness": true,
    "sleepDisorders": true,
    "substanceAbuse": true,
    "transgender": true,
    "trauma": true
  },
  "practitionerTraining": [
    { … }
  ],
  "practitionerSpecialty": [
    { … }
  ],
  "practitionerAffiliation": [
    { … }
  ],
  "practitionerPracticeLocation": [
    { … }
  ],
  "practitionerEmploymentInformation": [
    { … }
  ],
  "practitionerEmploymentGap": [
    { … }
  ],
  "practitionerCertification": [
    { … }
  ],
  "practitionerDocument": [
    { … }
  ],
  "practitionerClinicalPractice": {
    "fullTimeFlag": true
  },
  "practitionerProfessionalLiabilityInsurance": [
    { … }
  ],
  "providerId": "string",
  "updatedAt": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "updatedByName": "string",
  "workflowSource": "string"
}

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"
}

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