latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

CredentialingWorkflow

Check which NPDB-required practitioner fields are present

Validates that all practitioner fields required by the tenant's NPDB pipeline configuration are present and non-empty on the workflow identified by workflowId. Requires JWT permission CREDENTIALING_WORKFLOW_PIPELINE_TRIGGER. Returns the validation result without triggering the pipeline — use this endpoint before calling POST /pipeline-runs to confirm the workflow is ready. The set of required fields is tenant-configured. Returns 200 with a NpdbRequiredFieldsCheckResponse indicating which fields pass and which are missing. Returns 400 if the workflow is missing a linked practitioner.

get/credentialing-workflows/{workflowId}/pipeline-runs/npdb-required-fields-check

Path parameters

workflowIdstring required

ID of the credentialing workflow

Headers

tenant-idstring required

Tenant ID

Response

Validation result with missing fields

validboolean

True when no required fields are missing.

allRequiredFieldsstring[]

Effective list of configured required-field registry keys, in config order.

missingFieldsstring[]

Subset of allRequiredFields that are missing on the practitioner OV data.