Prembly
GuidesAPI Reference
Fraud LensFraud ScanList bulk fraud scans GET
GET
/api/v1/fraud/bulk-scan/

Retrieve a paginated list of all bulk fraud scans for your organisation.

Features:

  • Standard pagination (page, page_size parameters)
  • Filter by scan_type (face_scan, id_scan)
  • Filter by status (pending, processing, completed, failed)
  • Ordered by most recent first (uploaded_at DESC)

Status Meanings:

  • pending: Queued for processing, not yet started
  • processing: Currently being processed in background
  • completed: Successfully processed, results available
  • failed: Processing failed, see error_message

Response Fields:

  • bulk_id: Unique identifier for the bulk scan
  • scan_type: Type of scan (face_scan or id_scan)
  • status: Current processing status
  • total_records: Total number of records in upload
  • processed_records: Number of records processed so far
  • success_count: Number of successfully processed records
  • error_count: Number of records with errors
  • result_file_url: Download link for results (available when completed)
  • error_file_url: Download link for validation errors (if any)
  • uploaded_by: Email of user who uploaded
  • uploaded_at: Timestamp of upload
  • completed_at: Timestamp of completion (null if not completed)

Pagination:

  • Default page_size: 20
  • Max page_size: 100
  • Returns: count, next, previous, results

Authorization

ApiKeyAuth
X-API-Key<token>

In: header

Query Parameters

page?integer

Page number

page_size?integer

Number of items per page (max 100)

scan_type?string

Filter by scan type

Value in

  • "face_scan"
  • "id_scan"
status?string

Filter by processing status

Value in

  • "completed"
  • "failed"
  • "pending"
  • "processing"

Response Body

application/json

curl -X GET "https://example.com/api/v1/fraud/bulk-scan/"
{  "data": {},  "status": true,  "message": "Request successful.",  "errors": {},  "meta": {    "timestamp": "2019-08-24T14:15:22Z",    "version": "v1",    "request_id": "string"  },  "pagination": {    "page": 0,    "page_size": 0,    "total_pages": 0,    "total_items": 0  }}
Response Codes & Statuses: Prembly API responses include custom response_code values (e.g., 00 Success, 01 Not Found, 02 Unavailable).
View Response Codes Guide
Prembly Slack Community

Join our developer Slack channel for real-time integration support, engineering updates, and direct Q&A with the Prembly team.

Join Slack Channel

Submit a fraud report POST

Submit a new fraud report with suspect information, fraud details, and evidence. Required fields: - first_name, last_name - fraud_category, fraud_type - date_of_fraud - description - country Optional fields: - Evidence files (uploaded as multipart/form-data) - Bank details (required for bank fraud category) - ID information - Amount involved The system automatically generates a unique report ID (e.g., Fraud-4190).

Get a bulk fraud scan GET

Retrieve detailed information about a specific bulk fraud scan. **Use this endpoint to:** - Check processing status of a bulk scan - Get download links for result and error files - Monitor processing progress (processed_records vs total_records) - View success/error counts - Access error messages if processing failed **Response Includes:** - Complete scan details (type, status, counts) - File URLs (results, errors, original upload) - Processing timestamps (uploaded_at, completed_at) - User information (uploaded_by) - Error details if status is 'failed' **Status Check:** - Poll this endpoint to monitor processing progress - When status changes to 'completed', result_file_url is available - If status is 'failed', check error_message for details