Skip to main content
Export Results
Generate and download PDF reports of completed KYC validation results. Reports include all scan results, matches, and metadata from the original screening.

Endpoint

Authentication

Requires kyc:export permission. Include your Bearer token in the Authorization header.

Path Parameters

Description

This endpoint generates a PDF report for a completed KYC check and returns a presigned URL for downloading the report. The PDF includes:
  • Entity information checked
  • Lists scanned
  • Match results (if any)
  • Confidence scores
  • Timestamps
  • Processing metadata

Request Example

Response Format

Success Response

Response Fields

Presigned URL Details

  • Validity: 1 hour by default
  • Access: Direct download via HTTPS
  • Format: PDF document
  • Size: Typically 50-500 KB depending on match count

Usage Examples

Download PDF with cURL

Python Example

JavaScript/Fetch Example

Error Responses

400 Bad Request - Missing Job ID

400 Bad Request - Missing Tenant ID

404 Not Found

This occurs when:
  • The jobId is incorrect
  • The record has been deleted
  • The job never completed successfully
  • The job belongs to a different tenant

500 Internal Server Error

Status Codes

PDF Report Contents

The generated PDF includes:
  1. Header Section
    • Report generation timestamp
    • Job ID
    • Entity name checked
  2. Summary Section
    • Total lists checked
    • Match status (Yes/No)
    • Overall risk level
  3. Entity Information
    • Full name
    • Document ID (if provided)
    • Nationality (if provided)
    • Other identifiers
  4. Results by List
    • List name
    • Match status
    • Match count
    • Confidence scores
    • Match details (entity names, programs)
  5. Metadata
    • Processing time
    • Search type used
    • Timestamp

Notes

  • PDFs are generated on-demand when requested
  • Reports are stored in S3 for 90 days (configurable)
  • Presigned URLs expire after 1 hour
  • Each tenant’s reports are stored in separate S3 prefixes for data isolation
  • Large reports (many matches) may take longer to generate

Workflow

  1. Perform KYC check via POST /kyc
  2. Save the job_id from the response
  3. Request export via GET /exports/{jobId}
  4. Download PDF from the presigned URL
  5. Presigned URL is valid for 1 hour