Skip to main content
POST
Search profiles

Authorizations

Authorization
string
header
required

nia_sk_...

Body

application/json

The value travels in the body. A pseudonym (p_...) or an identifier: phones, e-mails, WhatsApp ids and CPFs are recognized by format; opaque ids need type (and scope when scoped).

query
string
required
Required string length: 1 - 320
limit
integer
default:20
Required range: 1 <= x <= 50
scope
string | null
Required string length: 1 - 256
type
enum<string> | null

The kind of identifier. The value is classified by its format, never by the field it came from.

Available options:
phone_e164,
wa_id,
wa_jid,
wa_lid,
wa_bsuid,
email,
gov_id_hmac,
app_user_id,
system_id,
org_registry_hmac,
email_domain,
anon_id

Response

The profiles found, with handles masked by the role of the reader.

items
ProfileMatch · object[]
required