Certifyos Credentialing Workflow API is one of 57 APIs that Certifyos publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include CredentialingWorkflow. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
45 operations
across 37 paths,
and defines 82 schemas.
It is described by OpenAPI 3.2.0, at version 1.0.0.
Requests are made against 6 base URLs: http://localhost:9000, https://api-service.staging.certifyos.com, https://api-service.internal.certifyos.com, https://api-service.test.certifyos.com, https://api-service.demo.certifyos.com, https://api-service.certifyos.com.
The identity and technical contract details declared by the specification.
CreateTimelineEventRequest
object
6 properties
1 required
AppVerificationUpdateRequest
object
App verification data for PUT operations that replace the entire app verifications array
14 properties
3 required
ApiError1
object
1 property
AssignmentHistoryResponse
object
Response containing assignment history for a credentialing workflow
4 properties
BulkCreateCredentialingWorkflowRequest
object
Request to create credentialing workflows for multiple practitioners
4 properties
TimelineEventResponse
object
Response containing timeline event information
7 properties
GetPipelineRunsResponse
object
Response containing a paginated list of pipeline runs
3 properties
PageLinks
object
3 properties
SanctionUpdateRequest
object
Sanction data for PUT operations that replace the entire sanctions array
13 properties
5 required
DmfResponse
object
Response from deceased (DMF) check
10 properties
SupportingDocumentUpdateRequest
object
Supporting document data for PUT operations using replace-all pattern
8 properties
3 required
GetCredentialingWorkflowsResponse
object
Response containing a list of credentialing workflows
2 properties
Practitioner.schema
object
179 properties
NextCredentialingDateChangeLogEntry
object
Change log entry tracking changes to the next credentialing date
5 properties
5 required
AssignmentResult
object
Result of an individual assignment operation
3 properties
CredentialingCycle
string
NpdbReportUpdateRequest
object
NPDB report data for PUT operations that replace the entire NPDB reports array
39 properties
5 required
BulkStatusChangeResponse
object
Response containing results of bulk status change operation
5 properties
5 required
GenerateAllSanctionsPdfResponse
object
1 property
StatusOption
object
Status option with required and optional fields
3 properties
DisclosureQuestionItem
object
Individual disclosure question with answer details
4 properties
UpdateLineOfBusinessRequest
object
Request to update line of business in credentialing workflow. Empty array unsets the field.
2 properties
1 required
NpdbRequiredFieldsCheckResponse
object
Result of an NPDB required-fields pre-check.
3 properties
CredentialingWorkflow.schema
object
Represents the credentialing workflow data stored in the data JSON field.
11 properties
1 required
NpdbEnrollmentStatus
object
Enrollment status information for NPDB reports
8 properties
DeceasedCheckDetails
object
DMF check details for Deceased Check app verification pop-up
10 properties
1 required
BoardCertificationUpdateRequest
object
Board certification data for PUT operations that replace the entire certifications array
21 properties
3 required
BulkCreateAssignmentRequest
object
Request to create assignments for multiple credentialing workflows
5 properties
1 required
CdsUpdateRequest
object
CDS data for PUT operations that replace the entire CDS array
15 properties
4 required
UpdateCredentialingWorkflowRequest
object
Request to update existing credentialing workflow
1 property
ReplayWebhooksRequest
object
Request to replay webhooks for credentialing workflows that missed webhook delivery
1 property
1 required
AssignmentEntry
object
5 properties
JsonNode
object
22 properties
UpdateCredentialingCycleRequest
object
Request to update credentialing cycle in credentialing workflow.
2 properties
1 required
BadRequestErrorResponse
object
Standard error response structure for 400 Bad Request validation and client errors
2 properties
StatusOptionsResponse
object
List of available timeline event status options with required fields
1 property
GeneratePsvResponse
object
5 properties
MalpracticeInsuranceUpdateRequest
object
Malpractice insurance data for PUT operations that replace the entire malpractice insurance array
17 properties
3 required
DataPipelineCallbackRequest
object
2 properties
1 required
CredentialingWorkflowResponse
object
10 properties
PerformanceIndicatorUpdateRequest
object
Performance indicator data for PUT operations that replace the entire performance indicators array
14 properties
1 required
DeleteAttachmentRequest
object
Request to delete an attachment
2 properties
2 required
ErrorObject1
object
4 properties
GetCredentialingWorkflowResponse
object
Response containing a single credentialing workflow
9 properties
HospitalAffiliationUpdateRequest
object
Hospital affiliation data for PUT operations that replace the entire hospital affiliations array
11 properties
2 required
CreateAssignmentRequest
object
Request to create a new assignment for a credentialing workflow
2 properties
EmailUpdateRequest
object
Email data for PUT operations that replace the entire emails array
7 properties
2 required
RunPipelineRequest
object
1 property
1 required
SiteVisitUpdateRequest
object
Site visit data for PUT operations that replace the entire site visits array
10 properties
2 required
TimelineEventData
object
Timeline event data containing event details. Field requirements vary by event name (see oneOf conditions in schema).
9 properties
1 required
UpdateStatesToCredentialRequest
object
Request to update states to credential in credentialing workflow. Empty array unsets the field.
2 properties
1 required
PhoneNumberUpdateRequest
object
Phone number data for PUT operations that replace the entire phone numbers array
7 properties
2 required
CredentialingWorkflowAttachment
object
Attachment metadata for credentialing workflow row
6 properties
3 required
ProfessionalIdUpdateRequest
object
Professional ID data for PUT operations that replace the entire professional IDs array
13 properties
3 required
GenerateNpdbPdfResponse
object
1 property
PractitionerFileTypeUpdateRequest
object
Request to update practitioner file type in credentialing workflow
2 properties
1 required
DeaUpdateRequest
object
DEA data for PUT operations that replace the entire DEA array
17 properties
5 required
PractitionerFileType
string
LicensureActionUpdateRequest
object
Licensure action data for PUT operations that replace the entire licensure actions array
10 properties
2 required
DmfRequest
object
Request for deceased (DMF) check
2 properties
2 required
CredentialingWorkflowResponse.schema
Defines the structure for credentialing workflow response data, extending the base schema with system-computed fields. Computed fields are automatically derive…
LicenseUpdateRequest
object
License data for PUT operations that replace the entire licenses array
21 properties
8 required
SpecialtyUpdateRequest
object
Specialty data for PUT operations that replace the entire specialties array
13 properties
3 required
BulkAssignmentResponse
object
Response containing results of bulk assignment operation
5 properties
PracticeLocationUpdateRequest
object
Practice location data for PUT operations that replace the entire practice locations array
22 properties
7 required
StatusChangeResult
object
Result of a single workflow status change
4 properties
EducationTrainingUpdateRequest
object
Education and training data for PUT operations that replace the entire education training array
13 properties
1 required
attachment
object
9 properties
DataPipelineCallbackResponse
object
4 properties
UpdateTimelineEventRequest
object
4 properties
CreateCredentialingWorkflowRequest
object
Request to create a new credentialing workflow
2 properties
1 required
NextCredDateChangeLogEntry
object
3 properties
LocationHours
object
Hours of operation for a specific day of the week
3 properties
BulkStatusChangeRequest
object
Request to change status of multiple credentialing workflows
4 properties
1 required
AddressUpdateRequest
object
Address data for PUT operations that replace the entire addresses array
12 properties
5 required
CredentialingWorkflowDataPipelineRequestResponse
object
10 properties
GetTimelineEventsResponse
object
Response containing a paginated list of timeline events
2 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Certifyos publishes across the network.