v1

latestOpenAPI 3.1.02026-07-2414339465.7 KB

Create KYC Summary Report

Create a report containing KYC flagged workers by company.

post/kyc-summary

Request body

companyIDstring required

ID of the Company.

employment_status'live' | 'leave' | 'terminated' required

Filters the report by workers' employment status. Accepts: "live", "leave", or "terminated" as values.

kyc_status'all' | 'failed' | 'approved'

Filters the report by KYC status. Accepts: "all", "failed", or "approved" as values.

media_typestring required

The Media Type of the report. Currently only accepts CSV.

Response

200

successboolean

Example response

{
  "success": true,
  "data": {
    "job_id": "707ce36e-2267-2088-9fc4-c34d57c69c72",
    "status": "pending",
    "request_body": {
      "companyID": "fe93448eueowej923474124eeze9",
      "employment_status": "live",
      "kyc_status": "all",
      "media_type": "csv"
    },
    "created_at": "2024-02-29T18:21:28.951Z"
  }
}