Get Company Details From A Portfolio

Request

This endpoint allows you to get various company details from a portfolio. Requires a portfolioID and companyID in the PATH of the request.

Security

bearerToken

Path

portfolioIdnumberrequired

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

companyIdstringrequired

A company Safe Number or Connect ID.

curl -i -X GET \
  'https://connect.sandbox.creditsafe.com/v1/monitoring/portfolios/{portfolioId}/companies/{companyId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json

correlationIdstring

A unique ID assigned to this request.

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

connectIdstring

The connectId of the company. A connectId is the primary Company identifier that is used to uniquely identify all companies across Creditsafe's Universe and Partner Network.

Example:"US-X-US22384484"

portfolioIdnumber

The portfolio Id of the portfolio that contains the company.

Example:589960

personalReferencestring or null

Field that can be used to add a personal reference against the company in a portfolio.

Example:"Follow up Jan 2021"

freeTextstring or null

Field that can be used to add a free text note to when adding a company to a portfolio.

Example:null

personalLimitstring or null

Field that can be used to add a personal limit number against the company in a portfolio.

Example:"10000"

safeNumberstring

The Safe Number (Creditsafe's identifier on all Companies owned in the Creditsafe Universe) of the company.

Example:"US22384484"

namestring

The name of the company .

Example:"GOOGLE LLC"

countryCodestring

ISO/Alpha 2 format country code of the company.

Example:"US"

addressstring

The address of the company.

Example:"VIA PABLO NERUDA, 4, TREZZANO SUL NAVIGLIO, 20090"

companyStatusstring or null

In the Company status indicator. Regional models differ, so 2 may represent Pending or Inactive.

Possible values: 1 (Active) 2 (Pending/Inactive) 3 (Inactive) null (Unknown)

For full details, see Company Status Property.

Example:"1"

creditLimitnumber or null

The credit limit of the company.

Example:10000

ratingCommonstring or null

The rating score band that the company is in.

Example:"A"

ratingLocalstring or null

Country specific rating score.

Example:"Not rated - insufficient information to rate"

dateLastEventstring or null

The date of the most recent event the company has had. Returned in ISO 8601 format without a time zone offset, for example 2022-01-20T12:45:43.

Example:"2018-06-14T00:59:06"

dateAddedstring or null

The date the company was added to the portfolio. Returned in ISO 8601 format without a time zone offset, for example 2022-01-20T12:45:43.

Example:"2020-07-01T00:59:06"

dateModifiedstring or null

The date the company was last modified in the portfolio. Returned in ISO 8601 format without a time zone offset, for example 2022-01-20T12:45:43.

Example:"2020-07-01T00:59:06"

Response

{
  "correlationId": "23921650-c073-11ea-860f-06bc8182190e",
  "connectId": "US-X-US22384484",
  "portfolioId": 589960,
  "personalReference": "Follow up Jan 2021",
  "freeText": null,
  "personalLimit": "10000",
  "safeNumber": "US22384484",
  "name": "GOOGLE LLC",
  "countryCode": "US",
  "address": "VIA PABLO NERUDA, 4, TREZZANO SUL NAVIGLIO, 20090",
  "companyStatus": "1",
  "creditLimit": 10000,
  "ratingCommon": "A",
  "ratingLocal": "Not rated - insufficient information to rate",
  "dateLastEvent": "2018-06-14T00:59:06",
  "dateAdded": "2020-07-01T00:59:06",
  "dateModified": "2020-07-01T00:59:06"
}