Skip to main content
POST
companies.registry.officers.search

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
query
string
required

Officer name to search for.

jurisdiction
string

Register jurisdiction, such as gb or us_ca.

Required string length: 1 - 16
Pattern: ^[a-z]{2}(_[a-z0-9]{2,3})?$
role
string

Registered role to match.

Required string length: 1 - 128
inactive
boolean

Filter by inactive office status.

address
string

Public address terms to match.

Required string length: 1 - 2048
birthDate
string<date>

Calendar date, YYYY-MM-DD.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
birthDateRange
object

Inclusive birth-date range.

limit
number

Rows per page, 1 to 100; default 20.

Required range: x >= 1
cursor
string

Opaque nextCursor from the previous page, with the same filters and limit.

Required string length: 1 - 4096

Response

The result

results
object[]
required

The matching items.

nextCursor
string

Pass as cursor to get the next page; absent on the last page.