Attach a license to a provider

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.

Request
path Parameters
providerId
required
string <uuid>

The identifier describing the provider to attach the license to.

Request Body schema: application/json
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.

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"
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"
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>
Responses
201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Error

post/providers/{providerId}/licenses
Request samples
application/json
{
  • "licenseNumber": "123456",
  • "state": "AL",
  • "licenseTypeId": "25cb4aee-c0c2-419b-b7c0-fd37169e9efb"
}
Response samples
application/json
{
  • "providerId": "4834bcdc-4a64-444d-966b-1a6fe381da24",
  • "licenseNumber": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "state": "AL",
  • "jobStatus": "Idle",
  • "nonVerifiedInfo": {
    },
  • "currentVerificationStatus": "Found",
  • "currentVerification": {
    },
  • "restrictionStatus": "None",
  • "approvedStatus": "Pending",
  • "isPrimary": true,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "isCurrentlyPracticing": true,
  • "prescriptiveAuthority": "RequiredMet",
  • "collaboratingProviderId": "79ac5e55-1b65-4bd8-a907-2b31ef7aa4a6",
  • "licenseType": {
    }
}