Skip to main content
POST
/
case
/
id
/
{caseId}
/
report
/
pdf
/
download
/
url
Get custom report download URL
curl --request POST \
  --url https://api-stage.karmacheck.io/case/id/{caseId}/report/pdf/download/url \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "caseDataIds": [
    "7fcb0b74-147b-48e2-84c9-7aefa3d0e0fa"
  ],
  "excludeCaseDataAttachments": false
}
'
"https://s3.amazonaws.com/stage.private.storage-bin.karmacheck.io/98704f90-2770-4999-ba01-453ef6d0deea-report.pdf?AWSAccessKeyId=ASIATUZWO5YBK7C3DIUH&Expires=1699391676&Signature=sL5Am9sMbvWSd8%2B%2F5CoejqsmeO4%3D&X-Amzn-Trace-Id=Root%3D1-654aa880-4e319ca04da8fe7c3faa6d1e%3BParent%3D3b8e51107e55b256%3BSampled%3D0%3BLineage%3D1dda0c46%3A0&x-amz-security-token=FwoGZXIvYXdzEIb%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDML%2B7WMBiIwah8j4aiK7AVB2sHfQ5tkVkU4Okov%2BRz%2BB%2FMSg6XpdmcOmEb5hJAdg%2BEAxL%2Bt33yt3We5CJUf4auHXMr9huYmkLK%2FQtg3QJQS8CAcZKXPSCaAQ7Wn66D8%2Bpl3x5ppxmgzAONgfejqSfKrYgxl0Srr%2BuAHOz53R5ujbAUA9wwgvfXFoWlJZ4YHah%2BgjFFLzbva%2F4a63g5Mw0Nyngb3EoccWRRn4tEWlzavuGjXYffFcZo2jHT7GXr9eeLoK1sZ96c2jn9oo6cqqqgYyLT8yXkspVciOKVnnBS32UCjIS5rlwu7bL2bMJAW2ocIW0ymnVbak0qb1fMnp6w%3D%3D"

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
caseId
string
required

The ID of the case to get a report for.

Body

application/json
​
caseDataIds
string[]
required

The list of case screenings to include in the report. Each element of this array is the caseDataId associated with an ordered service. It is not the serviceId itself. This granularity allows you to generate a report with only some instances of an ordered service. For example, you can generate a report with just the most recent attempt at a Drug 10 Panel instead of a previous one that was lost in transit.

​
excludeCaseDataAttachments
boolean
default:false

Some services might have attachments that are permitted to appear in the PDF report, like search results or supporting documents. By default, these will appear in the report. You can explicitly specify whether to include these attachments, if there are any associated with the caseDataIds you've chosen, by providing this flag. If there are no applicable attachments, this flag is ignored. Note that some attachments visible in the dashboard, like eScreen ePassports, have feature flags that control whether or not they will show in the reports, even if you set this flag to false. Contact Customer Success if you do not see attachments that you are expecting to see.

Response

The URL returned in this response is a self-signed S3 URL with a time to live (TTL) of 60 seconds. You have 60 seconds to begin the download, but once the download begins, it can take as long as needed. As many download attempts as needed can be made during the 60-second period.

The response is of type string<uri>.

Example:

"https://s3.amazonaws.com/stage.private.storage-bin.karmacheck.io/98704f90-2770-4999-ba01-453ef6d0deea-report.pdf?AWSAccessKeyId=ASIATUZWO5YBK7C3DIUH&Expires=1699391676&Signature=sL5Am9sMbvWSd8%2B%2F5CoejqsmeO4%3D&X-Amzn-Trace-Id=Root%3D1-654aa880-4e319ca04da8fe7c3faa6d1e%3BParent%3D3b8e51107e55b256%3BSampled%3D0%3BLineage%3D1dda0c46%3A0&x-amz-security-token=FwoGZXIvYXdzEIb%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDML%2B7WMBiIwah8j4aiK7AVB2sHfQ5tkVkU4Okov%2BRz%2BB%2FMSg6XpdmcOmEb5hJAdg%2BEAxL%2Bt33yt3We5CJUf4auHXMr9huYmkLK%2FQtg3QJQS8CAcZKXPSCaAQ7Wn66D8%2Bpl3x5ppxmgzAONgfejqSfKrYgxl0Srr%2BuAHOz53R5ujbAUA9wwgvfXFoWlJZ4YHah%2BgjFFLzbva%2F4a63g5Mw0Nyngb3EoccWRRn4tEWlzavuGjXYffFcZo2jHT7GXr9eeLoK1sZ96c2jn9oo6cqqqgYyLT8yXkspVciOKVnnBS32UCjIS5rlwu7bL2bMJAW2ocIW0ymnVbak0qb1fMnp6w%3D%3D"