Return Batch Upload File Details

Request

Returns a batch Upload response as specified by the provided id.

Security

bearerToken

Path

uploadIdstring, (uuid)required

id of the upload.

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/{uploadId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'X-Team-Id: 6b78aed4-9ba6-441b-80b9-df9bea3b7c97'

Responses

Success

Bodyapplication/json

idstring, (uuid)

Batch upload request Id

filenamestring

User given file name

statusstring

Batch upload status

Enum:"submitted""validating""rejected""validated""insufficientCredits""queued""inProgress""processed""completed""partiallyCompleted"

rowCountinteger, (int32)

Batch upload file record count

successCountinteger, (int32)

Successful record count in batch upload file

uploadedAtstring, (date-time)

Batch upload requested timestamp

uploadedByIdinteger, (int32)

Batch upload requested by user id

uploadedBystring

Batch file uploaded by user

completedAtstring or null, (date-time)

Batch upload completed timestamp

correlationIdstring

A unique ID assigned to this request.

Response

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "filename": "string",
  "status": "submitted",
  "rowCount": 0,
  "successCount": 0,
  "uploadedAt": "2019-08-24T14:15:22Z",
  "uploadedById": 0,
  "uploadedBy": "string",
  "completedAt": "2019-08-24T14:15:22Z",
  "correlationId": "string"
}