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.
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.
Hide attributes
string
required
Party type. One of: PERSON, ORG.
string | null
required
Legal business name for ORG parties.
string | null
required
Legal first name for PERSON parties.
string | null
required
Legal last name for PERSON parties.
string
required
Party status. One of: PROVISIONAL, ACTIVE, SUSPENDED, INACTIVE. See Statuses.
string
required
RFC 3339 timestamp when the party was created.
string
required
RFC 3339 timestamp when the party was last updated.
string | null
required
Display name for the party.
string | null
required
Party handle, such as @acme, or null when none is set.
string | null
required
Public avatar URL, or null when none is set.
string | null
required
Party’s primary contact email.
string | null
required
Party’s primary phone number.
string | null
required
Street address line 1.
string | null
required
City.
string | null
required
State or province.
string | null
required
Postal or ZIP code.
string | null
required
Country code (e.g., US).
string | null
required
User who created this party (usr_*).
Statuses
Status
Meaning
Can become
PROVISIONAL
Created for someone who isn’t on Natural yet, such as a person sent money by email or phone, or a party whose account type was switched. Finishing onboarding makes it ACTIVE.
ACTIVE, INACTIVE
ACTIVE
The party can use Natural. A party created at sign-up starts here.
PROVISIONAL, SUSPENDED, INACTIVE
SUSPENDED
Natural put the party on hold. Only Natural can suspend a party or lift the hold.