post
https://api.zeal.com/reports/kyc-summary
Create a report containing KYC flagged workers by company.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
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 messagecode: Error code as described in Error codes |