Create secure document records

curl --request POST \
  --url https://api-stage.karmacheck.io/document/secure/create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "list": [
    {
      "originalFileName": "example_document.jpg",
      "documentTypeId": "candidate-disclosures-and-authorizations",
      "fileKey": "1daa3c43-ea4e-4d66-9330-0cbd197feee6"
    }
  ],
  "accessGrants": {
    "caseId": "22e88848-17d1-4946-bbac-18d44f381ca7"
  }
}
'

{
  "list": [
    {
      "secureDocumentId": "f6723gd8-ee70-4db3-b238-6bb27abf66c0"
    }
  ]
}

Secure Documents

Create secure document records

Creates secure document records in the KarmaCheck system and associates uploaded documents with an existing case.

This is step 3 of 3 when adding documents to KarmaCheck. At this stage, you should have successfully uploaded your documents via the URLs obtained from the Generate secure document upload URLs API call. The uploaded documents are unavailable for use in KarmaCheck until they are associated with a case in this third step.

Document associations are identified by sending access grants. If your token does not have access to associate a document with a specific entity, a 403 Forbidden response will be returned.

In addition to associating a document with an existing case, you can call this API to create candidate disclosure and authorization document records before a case is created. When creating a case, you can send the newly created document IDs to associate these documents with the case and the candidate. Note that this association is allowed only when the document type is a candidate disclosure or authorization.

POST

document

secure

create

Create secure document records

curl --request POST \
  --url https://api-stage.karmacheck.io/document/secure/create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "list": [
    {
      "originalFileName": "example_document.jpg",
      "documentTypeId": "candidate-disclosures-and-authorizations",
      "fileKey": "1daa3c43-ea4e-4d66-9330-0cbd197feee6"
    }
  ],
  "accessGrants": {
    "caseId": "22e88848-17d1-4946-bbac-18d44f381ca7"
  }
}
'

{
  "list": [
    {
      "secureDocumentId": "f6723gd8-ee70-4db3-b238-6bb27abf66c0"
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Body

application/json

list

object[]

required

Show child attributes

accessGrants

object

Show child attributes

Response

list

object[]

required

Show child attributes

⌘I