Get company

GET 
/companies/:id

get a Company.

Request

Path Parameters

id uuidrequired

Responses

200

Successful response

application/json

Schema

Schema

id uuidrequired
customerId uuidrequired
externalId stringrequired
onboardingLevel stringnullablerequired

Possible values: [Onboarding, KYB, Onboarded]

createdAt date-timerequired
updatedAt date-timerequired
createdBy stringrequired
updatedBy stringrequired

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "customerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "externalId": "string",
  "onboardingLevel": "Onboarding",
  "createdAt": "2024-07-29T15:51:28.071Z",
  "updatedAt": "2024-07-29T15:51:28.071Z",
  "createdBy": "string",
  "updatedBy": "string"
}

default

Error response

application/json

Schema

Schema

message stringrequired
code stringrequired
issues object[]
Array [
message stringrequired
]

Example (from schema)

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

Loading...