Add Company To Portfolio

Request

Endpoint to add a company using a company id, into a portfolio provided in as a path parameter. Additional fields can be used to add a personalReference, freeText, and personalLimit. These fields need to be submitted in the requestBody but can be 'nulled' if not required. See the two examples of the submission with and without these fields.

Security

bearerToken

Path

portfolioIdnumberrequired

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

Bodyapplication/json

idstringrequired

The company Safe Number or Connect ID

personalReferencestring or nullrequired

A personal reference for the company

freeTextstring or nullrequired

A free field to add any additional text to the company in the portfolio

personalLimitstring or nullrequired

A personal limit for the company - separate from the credit limit

curl -i -X POST \
  'https://connect.sandbox.creditsafe.com/v1/monitoring/portfolios/{portfolioId}/companies' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "GB-0-12345678",
    "personalReference": "",
    "freeText": "",
    "personalLimit": ""
  }'

Responses

Bodyapplication/json

correlationIdstring

A unique ID assigned to this request.

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

messagestring

A status message relating to your request.

Example:"Company Added"

Response

{
  "correlationId": "23921650-c073-11ea-860f-06bc8182190e",
  "message": "Company Added"
}