Import A Portfolio File

Request

Endpoint allows you to import a list of companies to add to the selected portfolio along with some personal information for the company.

Importing a portfolio will add the companies to the specified portfolio, duplicates in the import file will be ignored.
You may also optionally add an email to the body of the request and get an email notification when the import is processed.

IMPORTANT: Detailed information on the structure of the CSV file and file size limits can be found in the help documentation: Import and Sync Companies documentation

Security

bearerToken

Path

portfolioIdnumberrequired

The unique identifier of the portfolio, obtained from /portfolios.

Bodymultipart/form-datarequired

importcsvstring, (binary)

The import file ideally needs to be a .csv file.

emailstring

Option field. Provide an email and get a notification when the import has been completed with the details about the import.

Example:"john.smith@creditsafe.com"

curl -i -X POST \
  'https://connect.sandbox.creditsafe.com/v1/monitoring/portfolios/{portfolioId}/import' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: multipart/form-data' \
  -F importCsv=FILE_PATH \
  -F email=john.smith@creditsafe.com

Responses

Bodyapplication/json

correlationIdstring

A unique ID assigned to this request.

Example:"23921650-c073-11ea-860f-06bc8182190e"

statusstring

A message about the status of this request.

Example:"Accepted for processing. Import Id 339523"

Response

{
  "correlationId": "23921650-c073-11ea-860f-06bc8182190e",
  "status": "Accepted for processing. Import Id 339523"
}