Skip to main content
POST
Check call

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.

Body

application/json
session
string
required

The session (number) that would place the call.

Value constraints

Required string length: 1 - 128
to
string
required

User ID or phone number in E.164 format.

Value constraints

Required string length: 1 - 64

Response

Check result.

success
enum<boolean>
required

Whether the request succeeded.

Allowed values

Available options:
true
data
object
required

Structured data carried by this object.