Skip to main content
POST
companies.registry.statement.get

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
ref
string
required

The ref returned by companies.registry.statements.list.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$

Response

The result

statementType
string
required

Official statement type or code.

variant
enum<string>
required

Meaning of the statement.

Available options:
control,
registration,
notice,
trademark,
generic
summary
string

Bounded statement summary, without source metadata.

Maximum string length: 2048
subjectName
string

Disclosed subject name.

Maximum string length: 2048
notifiedOn
string

Date notified, ISO 8601.

ceasedOn
string

Date ceased, ISO 8601.

recordedOn
string

Date recorded, ISO 8601.

entities
object[]

Disclosed entities in the relationship.

Maximum array length: 100
mechanisms
string[]

Disclosed control mechanisms.

Maximum array length: 100
percentage
number

Explicit ownership percentage.

Required range: 0 <= x <= 100
registrationDate
string

Registration date, ISO 8601.

expiryDate
string

Expiry date, ISO 8601.

publication
string

Publication title.

Maximum string length: 2048
markText
string

Trademark text.

Maximum string length: 2048