Create KYC Summary Report

Time	Status	User Agent
Make a request to see history.

URL Expired

The URL for this request expired after 30 days.

NOTE: This endpoint is subject to frequent changes.

Creates a KYC Summary report, returning KYC flagged workers for a specified company and utilizing optional filters such as employment status or KYC status as outlined in the body parameters of the reference.

This endpoint will return a job_id instead of the raw data itself. As the data returned from this endpoint can be large, we utilize a job queue to process this data instead of an immediate synchronous response. Once the job status is marked as complete, the report can be downloaded using the Download Report endpoint.

Returns

attribute	type	description
success	boolean	Response status
data	object	`job_id` for KYC Summary Report
errors	array	Contains a list of error objects which consists of: `message`: Error message `code`: Error code as described in Error codes

Parameters

companyID

string

required

ID of the Company.

employment_status

string

enum

required

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

Allowed:

live leave terminated

kyc_status

string

enum

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

Allowed:

all failed approved

media_type

string

required

Defaults to csv

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

Response Codes

``200 200

``400 400

curl --request POST \
     --url https://api.zeal.com/reports/kyc-summary \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '\n{\n  "employment_status": "live",\n  "media_type": "csv"\n}\n'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200 - Result400 - Result