Skip to main content
PUT
/
case
/
id
/
{caseId}
/
{disclosureType}
/
{language}
Acknowledge location-specific disclosures
curl --request PUT \
  --url https://api-stage.karmacheck.io/case/id/{caseId}/{disclosureType}/{language} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "sendReport": true,
  "list": [
    {
      "legalType": "general-ca-disclosure",
      "signature": "Alex Smith"
    },
    {
      "legalType": "state-city-all-disclosure"
    },
    {
      "legalType": "custom-ab-ca-disclosure-1",
      "signature": "Alex Smith"
    },
    {
      "legalType": "custom-ab-ca-disclosure-2",
      "signature": "Alex Smith"
    }
  ]
}
'

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
language
enum<string>
required

The desired language for the legal document. Must be an ISO 639-1 code. Currently, the only supported value is en (English). If an unsupported language is requested, the call still succeeds but returns an English version of the document.

Available options:
en
​
caseId
string
required

The ID of a case.

​
disclosureType
enum<string>
required

The type of disclosure.

Available options:
disclosures,
customdynamicdisclosure

Body

application/json

All disclosures that are returned in the Request location-specific disclosures [blocked] API call must be included. If any expected disclosures are not acknowledged in this request, the entire request will be rejected and nothing will be saved for this request.

Note

Inclusion of a legalType in the request list indicates that the candidate acknowledged that legal disclosure via an input. The client should not include the legalType in the post request until that acknowledgement happens.

​
sendReport
boolean
required

If true, a report notification will be emailed to the candidate when the report is finished.

​
list
object[]
required

Response

OK