Skip to main content
GET
/
v2
/
companies
/
{companyId}
Get Company
curl --request GET \
  --url https://client-api.dev.finhost.io/v2/companies/{companyId} \
  --header 'Authorization: Bearer <token>'
{
  "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "adm": "adm:active",
  "kyb": "kyb:initiated",
  "name": "<string>",
  "companyType": "<string>",
  "position": "<string>",
  "email": "<string>",
  "emailVerified": true,
  "phone": "<string>",
  "contactName": "<string>",
  "registrationNumber": "<string>",
  "tradingAddress": {
    "country": "<string>",
    "postCode": "<string>",
    "state": "<string>",
    "street": "<string>",
    "streetLine2": "<string>",
    "town": "<string>"
  },
  "address": {
    "country": "<string>",
    "postCode": "<string>",
    "state": "<string>",
    "street": "<string>",
    "streetLine2": "<string>",
    "town": "<string>"
  },
  "contractId": "<string>",
  "onboardingFee": {
    "status": "paid"
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

companyId
string<uuid>
required

Company ID

Response

OK

userId
string<uuid>
required
companyId
string<uuid>
required
adm
enum<string>
required

Administrative Status

Available options:
adm:active,
adm:blocked,
adm:processed,
adm:suspended
kyb
enum<string>
required

KYB Status

Available options:
kyb:initiated,
kyb:unconfirmed,
kyb:confirmed,
kyb:pending,
kyb:rejected,
kyb:resubmission
name
string
required
companyType
string
required
position
string
required
email
string
required
emailVerified
boolean
required
phone
string
required
contactName
string
required
registrationNumber
string
required
tradingAddress
object
required

Any Address Info (all properties can be optional, nullable or empty string)

address
object

Any Address Info (all properties can be optional, nullable or empty string)

contractId
string

Contract ID

Required string length: 1 - 256
Example:

"regularContract"

onboardingFee
object