Skip to main content
GET
Resolve identity

Authorizations

Authorization
string
header
required

Polymorfa organization key (pmfa_ prefix), project token (pmfa_pt_ prefix) where supported, or short-lived client token (pmfa_ct_ prefix). Organization and project keys may be personal or service-account owned and enforce selected action scopes. Organization keys cover the team and its projects; project tokens stay inside one project. Client tokens stay inside their live project and session and enforce their client rules.

Path Parameters

session
string
required

Identifier of the connected Polymorfa session.

Query Parameters

phoneNumber
string

Phone number in international format.

id
string

Identifier for this resource.

Value constraints

Pattern: ^pmfa_lid_[1-9]\d*$
username
string

WhatsApp username when one is available.

Value constraints

Required string length: 3 - 35
usernameKey
string

Specifies username key for this query parameter.

Value constraints

Pattern: ^\d{4}$

Response

Stable user ID and known aliases

success
enum<boolean>
required

Whether the request succeeded.

Allowed values

Available options:
true
data
object
required

Structured data carried by this object.