Export Results
Reporting & Analytics
Export Results
Export Results
Generate and download PDF reports of completed KYC validation results. Reports include all scan results, matches, and metadata from the original screening.
This occurs when:
Endpoint
Authentication
Requireskyc: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
| Field | Type | Description |
|---|---|---|
request_id | string | The job ID that was requested |
bucket | string | S3 bucket name where PDF is stored |
key | string | S3 object key (path) |
presigned_url | string | Pre-signed URL valid for 1 hour (default) |
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
- The
jobIdis incorrect - The record has been deleted
- The job never completed successfully
- The job belongs to a different tenant
500 Internal Server Error
Status Codes
| Code | Description |
|---|---|
| 200 | Success - PDF generated and presigned URL returned |
| 400 | Bad Request - Invalid parameters |
| 401 | Unauthorized - Missing or invalid token |
| 403 | Forbidden - Insufficient permissions |
| 404 | Not Found - Job not found |
| 500 | Internal Server Error |
PDF Report Contents
The generated PDF includes:-
Header Section
- Report generation timestamp
- Job ID
- Entity name checked
-
Summary Section
- Total lists checked
- Match status (Yes/No)
- Overall risk level
-
Entity Information
- Full name
- Document ID (if provided)
- Nationality (if provided)
- Other identifiers
-
Results by List
- List name
- Match status
- Match count
- Confidence scores
- Match details (entity names, programs)
-
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
- Perform KYC check via
POST /kyc - Save the
job_idfrom the response - Request export via
GET /exports/{jobId} - Download PDF from the presigned URL
- Presigned URL is valid for 1 hour