An external party (epty_*) is a person or business that isn’t on Natural, which you pay over Direct. To learn more, see Pay over a specific rail.
Example
GET /external-parties/{externalPartyId}
The object is everything inside data. The field names below are relative to it: attributes.kind is data.attributes.kind in the response.
Fields
External party ID (epty_*).
Resource type. Always externalParty.
The external party’s details.
External party type. One of: individual, business.
External party display or legal name.
Normalized email address, if supplied.
Normalized E.164 phone number, if supplied.
External party address.
Street address line 2, or null.
State or province, or null.
Postal or ZIP code, or null.
ISO 3166-1 alpha-2 country code.
Address revision for concurrent correction checks. Null on older cached create responses; get the external party before correction.
Sanctions screening disposition. One of: clear, under_review, rejected.
RFC 3339 timestamp when the external party was archived, or null while active.
RFC 3339 timestamp when the external party was created.
RFC 3339 timestamp when the external party was last updated.
Related resources, each by type and ID.
Customer party.
Related resource identifier.
Resource type. Always party.
Party ID (pty_*).
Events
This resource sends no webhook events.
Errors
See the error codes these endpoints return.
Sandbox simulations
None.