Skip to content

Get company

GET 
/api/apiGateway/getCompanyInfo/{id}

Get the details of a company, identified by its id.

Parameters

id string

The unique identifier of the company that you want to retrieve.

Response

Type: application/json

Schema: CompanyInfoResponseDto

success boolean

Indicates whether the request completed successfully.

error ErrorDto

id string

name string

description string

Company description

logo array [ string(byte) ]

address AddressDto

primaryEmail string

Company contact primary email

primaryPhoneNumber string

Company contact primary phone number

companyDebtService number(double)

companyCashFlowAfterDebtService number(double)

companyDSCR number(double)

companyAssetSubtotal number(double)

companyLiabilitySubtotal number(double)

companyLiquidity number(double)

contactId string

riskRating string

Risk rating of the company contact

ein string

The company EIN

GET ${BASE_URL}/api/apiGateway/getCompanyInfo/0b6696e4-7c45-46c2-bb1f-d36d3ee93df7
Accept: */*
Authorization: Bearer eyJz93a...k4laUWw

curl --request GET \
    --url "${BASE_URL}/api/apiGateway/getCompanyInfo/0b6696e4-7c45-46c2-bb1f-d36d3ee93df7" \
    --header 'Accept: */*' \
    --header 'Authorization: Bearer eyJz93a...k4laUWw'
Response
{
  "success": true,
  "error": {
    "target": "string",
    "code": "Duplicated",
    "message": "string",
    "details": ["string"]
  },
  "id": "string",
  "name": "string",
  "description": "string",
  "logo": ["string"],
  "address": {
    "fullAddress": "string",
    "placeId": "string",
    "geoLocation": {
      "lat": 0,
      "lng": 0
    },
    "zipCode": "string",
    "number": 0,
    "street": "string",
    "city": "string",
    "county": "string",
    "state": "string",
    "country": "string",
    "additionalFreeText": "string"
  },
  "primaryEmail": "string",
  "primaryPhoneNumber": "string",
  "companyDebtService": 0,
  "companyCashFlowAfterDebtService": 0,
  "companyDSCR": 0,
  "companyAssetSubtotal": 0,
  "companyLiabilitySubtotal": 0,
  "companyLiquidity": 0,
  "contactId": "string",
  "riskRating": "string",
  "ein": "string"
}