# Patch an existing license

Allows you to change a license's restriction or approved status.

Endpoint: PATCH /licenses/{licenseId}
Version: 26.2.0.4309
Security: Bearer

## Path parameters:

  - `licenseId` (string, required)
    Identifier of the license to patch.

## Request fields (application/json):

  - `restrictionStatus` (string)
    If set, the license's restriction status will be updated with this value.
    Enum: "None", "Restricted", "Unrestricted"

  - `approvedStatus` (string)
    If set, the license's approved status will be updated with this value.
    Enum: "Pending", "Yes", "No"

  - `nonVerifiedInfo` (object)

  - `nonVerifiedInfo.issueDate` (string,null)

  - `nonVerifiedInfo.expirationDate` (string,null)

  - `nonVerifiedInfo.status` (string,null)

  - `isCurrentlyPracticing` (boolean)
    If set, the license's isCurrentlyPracticing flag will be updated with this value.

  - `isPrimary` (boolean)
    If set, the license's isPrimary flag will be updated with this value.

  - `prescriptiveAuthority` (string)
    Enum: "RequiredMet", "RequiredNotMet", "NotRequired"

  - `collaboratingProviderId` (string)

## Response 200 fields (application/json):

  - `providerId` (string)
    Identifier of the provider associated with this license.

  - `licenseNumber` (string)
    The license number used when attaching this license to the provider.

  - `firstName` (string)
    Provider first name number used when attaching this license to the provider.

  - `lastName` (string)
    Provider last name used when attaching this license to the provider.

  - `state` (string)
    State associated with the license.
    Enum: "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "AS", "GU", "MP", "PR", "VI"

  - `jobStatus` (string)
    If the jobStatus is Pending or Working it means that we are busy performing the license verification. Once the status is Idle the verification is done.
    Enum: "Idle", "Pending", "Working"

  - `nonVerifiedInfo` (object)

  - `nonVerifiedInfo.issueDate` (string,null)

  - `nonVerifiedInfo.expirationDate` (string,null)

  - `nonVerifiedInfo.status` (string,null)

  - `currentVerificationStatus` (string)
    Status of the last requested verification for this license.
    Enum: "Found", "Failed", "NeedsReview", "NotFound", "Pending", "Working"

  - `currentVerification` (object)

  - `currentVerification.originalStatus` (string)
    The original status as our license verification process determined. Unlike status the originalStatus can never change.
    Enum: "Found", "Failed", "NeedsReview", "NotFound", "Pending", "Working"

  - `currentVerification.status` (string)
    The current status for this license verification. If you patch the license verification status (in case the status is NeedsReview) this property will be updated, but originalStatus will remain the same.
    Enum: "Found", "Failed", "NeedsReview", "NotFound", "Pending", "Working"

  - `currentVerification.trigger` (string)
    Set to Manual if the verification is triggered by a user or Monitor if the verification was triggered by the monitoring system.
    Enum: "Manual", "Monitor"

  - `currentVerification.started` (string)
    Timestamp of when the license verification started processing.

  - `currentVerification.processingTime` (integer)
    The duration in milliseconds it took to process the license verification from start to end.

  - `currentVerification.results` (array)
    Array of verification records returned by the source that match the license number.

  - `currentVerification.results.name` (string)
    Name of the provider as indicated by the source.

  - `currentVerification.results.licenseType` (string)
    Textual description of the license type as indicated by the source.

  - `currentVerification.results.licenseStatus` (string)
    Textual description of the license status as indicated by the source.

  - `currentVerification.results.licenseNumber` (string)
    License number as indicated by the source.

  - `currentVerification.results.address` (string)
    Address of the license holder as indicated by the source.

  - `currentVerification.results.issued` (string)
    Timestamp when the license was issued as indicated by the source.

  - `currentVerification.results.expires` (string)
    Timestamp when the license expires as indicated by the source.

  - `currentVerification.results.screenshots` (array)
    Array of paths to screenshots that were taken as proof of the license verification.

  - `currentVerification.results.attachments` (array)
    Array of attachments related to the verification that were taken from the source.

  - `currentVerification.results.attachments.file` (object)

  - `currentVerification.results.attachments.file.id` (string)
    Unique identifier for this file.

  - `currentVerification.results.attachments.file.providerId` (string)
    If set, the provider to which this file is associated.

  - `currentVerification.results.attachments.file.facilityId` (string)
    If set, the facility to which this file is associated.

  - `currentVerification.results.attachments.file.createdAt` (string)
    The time when the file was created.

  - `currentVerification.results.attachments.file.createdByUserId` (string)
    The identifier of the user who created the file.

  - `currentVerification.results.attachments.file.createdByUserEmail` (string)
    The e-mail of the user who created the file.

  - `currentVerification.results.attachments.file.path` (string)
    Path to the file.

  - `currentVerification.results.attachments.file.size` (integer)
    The size of the file.

  - `currentVerification.results.attachments.type` (string)
    Enum: "DisciplinaryAction", "VerificationLetter", "AdditionalDocument"

  - `currentVerification.results.attachments.source` (string)
    The original url for the file, taken from the verification source.

  - `currentVerification.results.attachments.downloadStatus` (string)
    The status of the download. ´Downloaded´ or ´Failed´
    Enum: "Downloaded", "Failed"

  - `currentVerification.results.attachments.failureReason` (object)
    An object with a reason message template and an array of params. Can be used to construct a meaningful description of the error. Not set when no errors happened.

  - `currentVerification.results.attachments.failureReason.messageTemplate` (string)
    An informative human readable message describing the verification failure.

  - `currentVerification.results.attachments.failureReason.messageParams` (object)
    Collection of key/value pairs containing parameters to be replaced in messageTemplate.

  - `currentVerification.results.disciplinaryActions` (object)

  - `currentVerification.results.disciplinaryActions.type` (string)
    The schema type for data.
    Enum: "Form", "Table", "Section"

  - `currentVerification.results.disciplinaryActions.data` (any)
    The actual data for this property. The schema can change depending on type. See the [Flexible Data Model](/references/api/section/common-concepts/flexible-data-model) for more information.

  - `currentVerification.results.additionalProperties` (object)

  - `currentVerification.results.problems` (array)
    Array of problems that resulted in a NeedsReview status for the license verification.
    Enum: "NameMismatch", "LicenseTypeMismatch"

  - `currentVerification.results.matchScore` (object)

  - `currentVerification.results.matchScore.score` (number)

  - `currentVerification.results.matchScore.recommendation` (string)
    Enum: "Mismatch", "Match"

  - `currentVerification.results.prescriptiveAuthority` (string)
    Indicates whether the provider is legally authorized to prescribe medications, as reported by the licensing authority.

  - `currentVerification.results.compactStatus` (string)
    Indicates whether the provider holds a multistate/interstate practice privilege under an applicable compact, as reported by the licensing authority.

  - `currentVerification.additionalVerificationParameters` (array)
    List of additional parameters required for a select number of sources. Missing data for select sources will result in a failed verification.

  - `currentVerification.verificationSource` (object)

  - `currentVerification.verificationSource.name` (string)
    Name of the licensing organization.

  - `currentVerification.verificationSource.url` (string)
    The URL used to fetch the license data for this source.

  - `currentVerification.verificationSource.hasPassThroughFee` (boolean)
    Indicates whether the source charges a pass-through fee for a verification.

  - `currentVerification.correctResultIndex` (integer)
    In case there is more than 1 result you can patch the verification and specify which of the records is the correct match by setting correctResultIndex to the appropriate index matching the index in the results array.

  - `currentVerification.export` (string)
    Once a license verification is in an 'end state' a PDF export will be generated. Once the PDF is generated this property will contain the path to that export. That path can be used to [download the file](/references/api/files/downloadfile). Please note that the process to generate an export is asynchronous and it can take several seconds after a verification is completed before the export is ready.

  - `currentVerification.id` (string)
    Unique identifier for this license verification.

  - `currentVerification.monitoringMetadata` (object)

  - `currentVerification.monitoringMetadata.monitoringInterval` (string)
    The interval at which the data is being monitored.NOTE: Continuous interval is only supported by the NPDB dataset at this time.
    Enum: "Continuous", "Daily", "Weekly", "Monthly", "Yearly"

  - `currentVerification.monitoringMetadata.lastMonitoringDate` (string)
    The previous date on which this data was monitored, if any.

  - `currentVerification.monitoringMetadata.nextMonitoringDate` (string)
    The next date on which this data is scheduled to be monitored.

  - `currentVerification.monitoringMetadata.monitorId` (string)
    Unique identifier of the monitor.

  - `restrictionStatus` (string)
    Restriction status for the license. None is a default value.
    Enum: "None", "Restricted", "Unrestricted"

  - `approvedStatus` (string)
    Approval status for the license. Pending is a default value.
    Enum: "Pending", "Yes", "No"

  - `isPrimary` (boolean)
    If the flag is set, license will be set as primary for the provider.

  - `id` (string)
    Unique identifier for this specific license.

  - `isCurrentlyPracticing` (boolean)
    Indicates whether the provider is currently practicing in this state.

  - `prescriptiveAuthority` (string)
    The prescriptive authority status identifying whether the license requires a collaborative practice agreement or protocol, and whether the requirement has been met.
    Enum: "RequiredMet", "RequiredNotMet", "NotRequired"

  - `collaboratingProviderId` (string)
    Identifier describing the provider who fulfills the license's collaborative practice agreement or protocol requirement.

  - `licenseType` (object)

  - `licenseType.id` (string)
    Unique identifier associated with this license type.

  - `licenseType.taxonomy` (string)
    Unique taxonomy code associated with this license type.

  - `licenseType.name` (string)
    Descriptive name for this license type.

  - `licenseType.aliases` (array)
    Aliases used by different sources.

  - `licenseType.abbreviations` (array)
    License type name abbreviations.

  - `licenseType.sources` (array)
    A list of parameters and other verification-related information per state.

  - `licenseType.sources.state` (string)
    The state the verification information relates to for the given license type.
    Enum: "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "AS", "GU", "MP", "PR", "VI"

  - `licenseType.sources.requiredParameters` (array)
    List of parameters required to run a license verification. Missing data for a required parameter will result in a failed verification.
    Enum: "LicenseNumber", "Name", "Ssn"

  - `licenseType.sources.optionalParameters` (array)
    List of optional parameters that may be used to improve the verification result quality by applying additional filters.
    Enum: "LicenseNumber", "Name", "Ssn"

  - `licenseType.sources.hasPassThroughFee` (boolean)
    Indicates whether the source for this state + license type combination charges a pass-through fee for a verification.

  - `licenseType.states` (array)
    List of states for which license verification is supported.
    Enum: "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "AS", "GU", "MP", "PR", "VI"

  - `licenseType.verificationParameters` (object)
    Description of parameters required to run verifications.


## Response 400 fields

## Response 401 fields

## Response 403 fields

## Response 404 fields

## Response 500 fields