Download Batch Upload Error File

Request

Returns a link to download the error file of a batch upload. The file is a CSV of the rows that failed, with an errors column that gives the reason for each row.

The error file only exists once the upload has been checked. Until then, this endpoint returns 404 Batch Upload Error File Not Found.

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

Responses

Created

Bodyapplication/json

downloadUrlstring

Url of the file to download

fileNamestring

Name of the file

expiresAtstring, (date-time)

Date and time when the url will expire

correlationIdstring

A unique ID assigned to this request.

Response

{
  "downloadUrl": "string",
  "fileName": "string",
  "expiresAt": "2019-08-24T14:15:22Z",
  "correlationId": "string"
}