Skip to main content
A party (pty_*) is a business (ORG) or a person (PERSON) on Natural. It owns your wallets and agents, and must be verified before it can send payments. To learn more, see Compliance and Claim a handle.

Example

GET /parties/me
The object is everything inside data. The field names below are relative to it: attributes.partyType is data.attributes.partyType in the response.

Fields

string
required
Party ID (pty_*).
string
required
Resource type. Always party.
object
required
The party’s details.

Statuses

Events

Other objects

These endpoints in the group don’t return this object:
  • Get party compliance (GET /parties/{partyId}/compliance) returns a complianceCase object.

Errors

See the error codes these endpoints return.

Sandbox simulations

None.