Prembly
GuidesAPI Reference
Fraud LensFraud ReportSubmit a fraud report POST
POST
/api/v1/fraud/reports/submit/

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).

Authorization

ApiKeyAuth
X-API-Key<token>

In: header

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/api/v1/fraud/reports/submit/" \  -F first_name="John" \  -F last_name="Doe" \  -F country="Nigeria" \  -F fraud_category="bank" \  -F fraud_type="Account Takeover" \  -F date_of_fraud="2024-11-20" \  -F description="Suspect gained unauthorized access to victim's account and transferred funds"
{  "data": {    "success": true,    "message": "Fraud report submitted successfully",    "data": {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "report_id": "Fraud-4190",      "status": "pending",      "status_display": "Pending Review",      "created_at": "2019-08-24T14:15:22Z"    }  },  "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

Get a fraud report GET

Retrieve detailed information about a specific fraud report. Only returns reports submitted by the authenticated user's organization. Includes all suspect information, fraud details, evidence files, and review status.

List bulk fraud scans GET

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