Sign in

v1

latestOpenAPI 3.1.02026-08-063776831.4 MB
FacilityCredentialingWorkflow

Update facility state licenses

Replace all state licenses for a facility credentialing workflow

put/facility-credentialing-workflows/{workflowId}/licenses

Path parameters

workflowIdstring required

Headers

tenant-idstring required

Request body

typestring

The type of license

expirationDatestring required

Expiration date of the license

issueDatestring

Issue date of the license

licenseNumberstring required

License number

statestring required

State where license was issued

licenseTypestring required

Type of license

licenseStatusstring required

Status of the license

licenseSourcestring required

Source of the license information

reportDatestring required

Report date

licenseNumberVariationsstring

Variations of the license number

flaggedDatestring

Date when license was flagged

dataSourcestring

Data source for the license

urlstring

URL for license verification

createdAtstring

Date when the record was created

createdBystring

User who created the record

updatedAtstring

Date when the record was last updated

updatedBystring

User who last updated the record

verifiedDatestring

Date when license was verified

verifiedBystring

Person who verified the license

Example request

[
  {
    "type": "Medical",
    "expirationDate": "2024-01-01",
    "issueDate": "2024-01-01",
    "licenseNumber": "LIC123456",
    "state": "CA",
    "licenseType": "Facility License",
    "licenseStatus": "Active",
    "licenseSource": "State Health Department",
    "reportDate": "2024-01-01",
    "licenseNumberVariations": "LIC-123456, 123456",
    "flaggedDate": "2024-01-01",
    "dataSource": "State Board API",
    "url": "https://stateboard.gov/verify",
    "createdAt": "2024-01-01",
    "createdBy": "user@example.com",
    "updatedAt": "2024-01-01",
    "updatedBy": "user@example.com",
    "attachments": [
      {
        "createdAt": "2024-01-15T10:30:00Z",
        "fileType": "License",
        "fileUrl": "gs://bucket/facility-credentialing-workflow/attachments/file.pdf",
        "originalFileName": "license.pdf",
        "state": "CA",
        "expirationDate": "2025-12-31",
        "source": "CAQH",
        "createdBy": "user@example.com",
        "updatedAt": "2024-02-15T14:20:00Z",
        "updatedBy": "admin@example.com"
      }
    ],
    "verifiedDate": "2024-01-01",
    "verifiedBy": "verifier@example.com"
  }
]

Response

State licenses updated successfully