After a license verification is executed we sometimes are uncertain about the results we get from the source. For example when the source returns more than 1 match or the name of the license does not match the name that was used for the provider. In such cases we mark the license status as NeedsReview. It is expected that this status is resolved by the end user. The resolution can be patched by using this endpoint.
Success
Bad Request
Unauthorized
Forbidden
Not Found
Conflict
Server Error
{- "status": "Found",
- "correctResultIndex": 0
}{- "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": "string",
- "property2": "string"
}
}
}
], - "disciplinaryActions": {
- "type": "Form",
- "data": null
}, - "additionalProperties": {
- "type": "Form",
- "data": null
}, - "problems": [
- "NameMismatch"
], - "matchScore": {
- "score": 0,
- "recommendation": "Mismatch"
}
}
], - "additionalVerificationParameters": [
- {
- "accreditationNumber": "string",
- "accreditationProgram": "string",
- "type": "Name"
}
], - "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"
}
}