Retrieve a KYC acceptance summary report

Retrieve a KYC acceptance summary report.

SecuritySecretApiKey or JWT
Request
query Parameters
periodStart
required
string

Report start date.

periodEnd
required
string

Report end date.

Responses
200

Report was retrieved successfully.

Response Schema: application/json
Array of objects
Array
documentType
string

Type of KYC document.

Enum: "identity-proof" "address-proof" "funds-proof" "purchase-proof" "credit-file-proof"
object

Statistics for each status.

total
integer

Total documents amount.

accuracyRate
number

Percent of automatically accepted and rejected documents that remain in the same status after review. Calculated by the formula: (nonarchived total - accepted auto rejected - rejected auto accepted)/nonarchived total.

acceptanceRate
number

Percent of accepted documents out of the total number of KYC documents. Calculated by accepted total divided by the total of nonarchived documents.

manualReviewTime
number

Median duration in minutes between review and created time for manually reviewed documents.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

get/reports/kyc-acceptance-summary
Request samples
Response samples
application/json
{
  • "data": [
    ]
}