Skip to main content
POST
/
case
/
id
/
{caseId}
/
canadadisclosure
/
{language}
Acknowledge Canada Disclosure
curl --request POST \
  --url https://api-stage.karmacheck.io/case/id/{caseId}/canadadisclosure/{language} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "sendReport": false,
  "signature": "<string>"
}
'

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.

Body

application/json
​
sendReport
boolean
default:false

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

​
signature
string

The name entered into the signature input field on the legal step during candidate onboarding. This value might not be exactly the same as the name that the case was ordered under.

Response

OK