Retrieve a KYC acceptance summary report

Retrieves a Know Your Customer (KYC) acceptance summary report.

SecuritySecretApiKey or JWT
Request
query Parameters
periodStart
required
string <date-time>

Date and time when the report starts.

periodEnd
required
string <date-time>

Date and time when the report ends.

Responses
200

Report retrieved.

Response Schema: application/json
Array of objects

KYC acceptance data.

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 amount of documents.

accuracyRate
number

Percentage of automatically accepted and rejected documents that remain in the same status after review. Calculated based on the following: (non-archived total - accepted auto rejected - rejected auto accepted)/non-archived total.

acceptanceRate
number

Percentage of accepted documents from the total number of KYC documents. Calculated based on the following: accepted total / total of non-archived documents.

manualReviewTime
number

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

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

get/experimental/reports/kyc-acceptance-summary
Request samples
$service = new Rebilly\Sdk\ReportsService($client);

$report = $service->reports()->getKycAcceptanceSummary(
    new DateTimeImmutable('2022-01-01'),
    new DateTimeImmutable('now'),
);
Response samples
application/json
{
  • "data": [
    ]
}