Return Batch Upload File Details

Request

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

Security

bearerToken

Path

uploadIdinteger, (int32)required

id of the upload.

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

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

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"
}