Return A List Of Requested Uploads

Request

Returns a list of uploads that have been requested.

Security

bearerToken

Query

pageinteger

Starting page number.

Default:1

Example:page=1

pageSizeinteger

Specifies the number of items to be displayed per page. Allowed values are between 1 and 100.

Example:pageSize=10

statusesArray of strings

The statuses list to filter by. It can be the collection of submitted, validating, rejected, validated, insufficientCredits, queued, inProgress, processed, completed, partiallyCompleted, failed.

uploadedByIdinteger, (int32)

The id of the uploaded user to filter by.

X-Team-Idstring, (uuid)

Optional. The team to work in, using a team id from List Teams. If left out, the default team is used. Records created in a team can only be seen by sending that team's id. A team id that doesn't exist, or a team being deleted, is rejected with 404 Team Not Found.

Example:6b78aed4-9ba6-441b-80b9-df9bea3b7c97

curl -i -X GET \
  'https://connect.sandbox.creditsafe.com/v1/compliance/kyc-protect/batchUploads?page=1&pageSize=10&statuses=string&uploadedById=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'X-Team-Id: 6b78aed4-9ba6-441b-80b9-df9bea3b7c97'

Responses

Success

Bodyapplication/json

correlationIdstring

A unique ID assigned to this request.

itemsArray of objects(GetKycProtectBatchUploadsByUploadIdItemResponse)

The batch uploads on this page.

totalSizeinteger

Total number of batch uploads available.

Response

{
  "items": [],
  "totalSize": 0,
  "correlationId": "8408fb3a-a41c-4f79-be98-34b7eb7da302"
}