Skip to content

Resolve company UUID

GET
/internal/companies/resolve

Requires Finance DB (FINANCE_DATABASE_URL) and X-Internal-API-Key.

raw
required
string

Raw company identifier to resolve

Resolved UUID

object
success
required
boolean
data
required
data
object
companyId
required
string format: uuid

Validation error

object
success
required
boolean
error
required
object
code
required
string
Example
validation_error
message
required
string

Authenticated but not allowed (e.g. wrong role or invalid internal key)

object
success
required
boolean
error
required
object
code
required
string
Example
validation_error
message
required
string

Finance DB not configured

object
success
required
boolean
error
required
object
code
required
string
Example
validation_error
message
required
string