Skip to main content
GET
/
document
/
secure
/
type
/
list
Get secure document type list
curl --request GET \
  --url https://api-stage.karmacheck.io/document/secure/type/list \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "06813017-94ef-4250-9083-375935ce9dc8",
    "secureDocumentType": "tin-check-result",
    "displayName": "TIN Check Results"
  }
]

Authorizations

​
Authorization
string
header
required

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

Response

Secure document types are listed in alphanumeric order by ID.

​
id
enum<string>
required

The unique identifier for the secure document type. See Secure document type [blocked] for details about each possible document type.

Available options:
06813017-94ef-4250-9083-375935ce9dc8,
4ad585b6-b087-11ec-9bf1-df77b62cb712,
7d25e1de-0b46-4a6c-bd06-d0b55526af08,
857d42f3-73b6-4588-8855-0ab49e376a84,
candidate-disclosures-and-authorizations,
cbsv-authorization,
da070d09-b52f-4423-9c94-eff458ea3aa0,
education-document,
employment-document,
ohs-breath-alcohol,
ohs-chain-of-custody,
ohs-occupational-health,
ohs-participant-passport,
ohs-result-certificate,
search-result
​
secureDocumentType
enum<string>
required

The name of the secure document type.

Available options:
tin-check-result,
oig-verification-proof,
provider-html-report,
identification,
candidate-disclosures-and-authorizations,
cbsv-authorization,
international-report,
education-document,
employment-document,
ohs-breath-alcohol,
ohs-chain-of-custody,
ohs-occupational-health,
ohs-participant-passport,
ohs-result-certificate,
search-result
​
displayName
string
required

The name of the secure document type that's displayed to dashboard users.