Skip to content

Return Prospects Orders Export

Request

Export the results of a completed prospect order as a downloadable file. Supports xls, xlsx and csv formats. Returns the file as a binary stream. If the export is still being processed, returns 202 Accepted.

Security
bearerToken
Path
idstring, (uuid)required

Unique identifier (GUID) of the prospect order to export

Query
fileFormatstring

Export file format

Enum:"xls""xlsx""csv"
curl -i -X GET \
  'https://connect.sandbox.creditsafe.com/v1/prospects/orders/{id}/export?fileFormat=xls' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

File export ready - returns binary file stream

Body
string
Response
"string"