Skip to main content
GET
/
service
/
cplc
/
id
/
{cplcId}
Get CPLC full definition
curl --request GET \
  --url https://api-stage.karmacheck.io/service/cplc/id/{cplcId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "name": "<string>",
  "enabled": true,
  "crStamp": "2021-08-06T02:08:35.000Z",
  "modStamp": "2021-08-06T02:08:35.000Z",
  "fields": [
    {
      "id": "<string>",
      "fieldId": "<string>",
      "cplcId": "<string>",
      "label": "<string>",
      "required": true,
      "displayLabel": "<string>",
      "crStamp": "2021-08-06T02:08:35.000Z",
      "modStamp": "2024-05-21T14:14:02.000Z",
      "ordinal": 123,
      "placeholder": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
cplcId
string
required

The unique identifier [blocked] of a professional license or certification.

Response

OK

​
id
string

The unique identifier [blocked] of a professional license or certification.

​
name
string

The name [blocked] of the professional license or certification.

​
category
enum<string>

The category that the professional license or certification falls under.

Available options:
Finance,
General,
Healthcare,
Other
​
enabled
boolean

True if verification of the professional license or certification is enabled in KarmaCheck; false otherwise.

​
crStamp
string<date-time>
Example:

"2021-08-06T02:08:35.000Z"

​
modStamp
string<date-time>
Example:

"2021-08-06T02:08:35.000Z"

​
fields
object[]

Information about each field that's associated with the professional license or certification. Each field represents a specific piece of information, such as the issue date or completion date of the license or certification.