Retrieve a Single Report by ID

Request

Fetches the details of a single compliance report identified by its unique reportId.

This endpoint allows users to retrieve the full metadata and status of a specific report, including its creation details, criteria, and expiration timeline.

Use this endpoint to inspect or verify the information of an existing report, or to confirm its current status (e.g., inProgress, completed, failed).

Ensure that the reportId provided corresponds to an existing report in the system.

Security

bearerToken

Path

reportIdstring, (uuid)required

The unique identifier of the report to be retrieved. Must be a valid UUID that corresponds to an existing report in the system.

curl -i -X GET \
  'https://connect.sandbox.creditsafe.com/v1/compliance/kyc-protect/reports/{reportId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json

idstring, (uuid)

Unique identifier for the report, generated when the report is created.

fileNamestring

The name of the report file, as specified during creation or generated automatically.

statusstring

Current processing status of the report. Indicates the lifecycle stage, such as:
- submitted: The report request has been submitted.
- queued: The report is waiting to be processed.
- inProgress: The report is currently being generated.
- completed: The report has been successfully created.
- failed: The report generation encountered an error.

Enum:"submitted""queued""inProgress""completed""failed"

typestring

Type of the report, determining the data and format of the results. Supported values:
- amlAlert: Report for Anti-Money Laundering alerts.
- audit: Report for audit-related compliance checks.

Enum:"amlAlert""audit"

createdAtstring, (date-time)

The timestamp when the report was initially created.

createdByIdinteger, (int32)

The unique identifier of the user who initiated the creation of the report.

createdByUserstring

The username or identifier of the user who created the report.

modifiedAtstring, (date-time)

The timestamp of the last modification made to the report, if applicable.

criteriaobject

The criteria used to generate the report, reflecting the filters and parameters applied during its creation.

The structure of the criteria object depends on the report type (amlAlert or audit). Some properties may be nested in arrays or objects.

expiresAtstring or null, (date-time)

The expiration timestamp for the report, after which it may no longer be accessible.

correlationIdstring

Unique identifier for tracking the request, useful for debugging and tracing.

Response

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "fileName": "string",
  "status": "submitted",
  "type": "amlAlert",
  "createdAt": "2019-08-24T14:15:22Z",
  "createdById": 0,
  "createdByUser": "string",
  "modifiedAt": "2019-08-24T14:15:22Z",
  "criteria": {
    "fromDate": "2019-08-24",
    "toDate": "2019-08-24",
    "property1": {},
    "property2": {}
  },
  "expiresAt": "2019-08-24T14:15:22Z",
  "correlationId": "string"
}