To perform a license verification you must first attach a license to a provider. The first time you do this will automatically trigger a license verification on that provider. Once attached you can reverify the same license without reattaching it. A provider can have more than one license attached.
licenseNumber | string A license number from one of the licenses of the provider. |
licenseTypeId required | string <uuid> License type id for one of the license type supported. Please refer to LicenseTypes for more information. |
firstName | string Specify a first name that will be used during the license verification. If not specified, first name will be used from the provider basic info. |
lastName | string Specify a last name that will be used during the license verification. If not specified, last name will be used from the provider basic info. |
state required | string State for which license type needs to be attached. |
restrictionStatus | string Restriction status for the license. |
approvedStatus | string Approval status for the license. |
object (NonVerifiedLicenseInfoModel) | |
skipVerification | boolean If the flag is set, verification wouldn't be run right after attaching license to the provider. |
isCurrentlyPracticing | boolean |
isPrimary | boolean If the flag is set, the license will be set as primary for the provider. |
prescriptiveAuthority | string Enum: "RequiredMet" "RequiredNotMet" "NotRequired" |
collaboratingProviderId | string <uuid> |
Created
Bad Request
Unauthorized
Forbidden
Not Found
Server Error
{- "licenseNumber": "123456",
- "state": "AL",
- "licenseTypeId": "25cb4aee-c0c2-419b-b7c0-fd37169e9efb"
}
{- "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
}
]
}
}