Retrieve a KYC requests report

Retrieves a Know Your Customer (KYC) request report by type and by rejection reasons.

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 Headers
Pagination-Total
integer

Total number of items.

Example: 332
Pagination-Limit
integer

Maximum number of items per page.

Example: 100
Pagination-Offset
integer

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example: 2
Response Schema: application/json
Array of objects

Request data.

Array
rejectionReason
string (KycDocumentRequestStatuses)

Reason the document is rejected.

Enum: "abandoned" "expired" "failed" "fulfilled" "pending-review"
count
integer <integer> >= 0

Number of related KYC requests.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

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

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