Patch an existing license

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

Request

path Parameters

licenseId

required

string <uuid>

Identifier of the license to patch.

Request Body schema: 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"
	object (NonVerifiedLicenseInfoModel)
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 <uuid>

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Error

patch/licenses/{licenseId}

Request samples

Payload

application/json

{"restrictionStatus": "NotRestricted",
"approvedStatus": "Yes"
}

Response samples

application/json

{"providerId": "4834bcdc-4a64-444d-966b-1a6fe381da24",
"licenseNumber": "string",
"firstName": "string",
"lastName": "string",
"state": "AL",
"jobStatus": "Idle",
"nonVerifiedInfo": {"issueDate": "2019-08-24T14:15:22Z",
"expirationDate": "2019-08-24T14:15:22Z",
"status": "string"
},
"currentVerificationStatus": "Found",
"currentVerification": {"originalStatus": "Found",
"status": "Found",
"trigger": "Manual",
"started": "2019-08-24T14:15:22Z",
"processingTime": 0,
"results": [{"name": "string",
"licenseType": "string",
"licenseStatus": "string",
"licenseNumber": "string",
"address": "string",
"issued": "2019-08-24T14:15:22Z",
"expires": "2019-08-24T14:15:22Z",
"screenshots": ["string"
],
"attachments": [{"file": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"providerId": "4834bcdc-4a64-444d-966b-1a6fe381da24",
"facilityId": "d7244f5b-52c1-4d27-b4f5-43b1113fc304",
"createdAt": "2019-08-24T14:15:22Z",
"createdByUserId": "4d2aef9a-17b0-44e6-902e-616812033620",
"createdByUserEmail": "string",
"path": "string",
"size": 0
},
"type": "DisciplinaryAction",
"source": "string",
"downloadStatus": "Downloaded",
"failureReason": {"messageTemplate": "string",
"messageParams": {"property1": null,
"property2": null
}
}
}
],
"disciplinaryActions": {"type": "Form",
"data": null
},
"additionalProperties": {"type": "Form",
"data": null
},
"problems": ["NameMismatch"
],
"matchScore": {"score": 0,
"recommendation": "Mismatch"
}
}
],
"verificationSource": {"name": "string",
"url": "string",
"hasPassThroughFee": true
},
"failureReason": {"messageTemplate": "string",
"messageParams": {"property1": "string",
"property2": "string"
}
},
"correctResultIndex": 0,
"export": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"monitoringMetadata": {"monitoringInterval": "Monthly",
"lastMonitoringDate": "2019-08-24T14:15:22Z",
"nextMonitoringDate": "2019-08-24T14:15:22Z",
"monitorId": "075fef10-8522-4c43-ac39-f1796133943e"
}
},
"restrictionStatus": "None",
"approvedStatus": "Pending",
"isPrimary": true,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"isCurrentlyPracticing": true,
"prescriptiveAuthority": "RequiredMet",
"collaboratingProviderId": "79ac5e55-1b65-4bd8-a907-2b31ef7aa4a6",
"licenseType": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"taxonomy": "string",
"name": "string",
"aliases": ["string"
],
"abbreviations": ["string"
],
"states": ["AL"
],
"verificationParameters": {"property1": {"requiredParameters": ["LicenseNumber"
],
"optionalParameters": ["LicenseNumber"
]
},
"property2": {"requiredParameters": ["LicenseNumber"
],
"optionalParameters": ["LicenseNumber"
]
}
},
"sources": [{"state": "AL",
"requiredParameters": ["LicenseNumber"
],
"optionalParameters": ["LicenseNumber"
],
"hasPassThroughFee": true
}
]
}
}