Retrieve a KYC requests report

Retrieve a KYC request report by type and by rejection reasons.

SecuritySecretApiKey or JWT
Request
query Parameters
periodStart
required
string

Report start date.

periodEnd
required
string

Report end date.

Responses
200

Report successfully retrieved.

Response Headers
Pagination-Total
integer

Total items count.

Example: 332
Pagination-Limit
integer

Items per page limit.

Example: 100
Pagination-Offset
integer

Pagination offset.

Example: 2
Response Schema: application/json
Array of objects
Array
rejectionReason
string (KycDocumentRequestStatuses)
Enum: "abandoned" "expired" "failed" "fulfilled" "pending-review"
count
integer <integer> >= 0

Number of related KYC requests.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

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