Overview

​

External parties

{
  "data": {
    "attributes": {
      "kind": "individual",
      "name": "Jordan Rivera",
      "email": "jordan@example.com",
      "address": {
        "line1": "123 Market St",
        "city": "San Francisco",
        "state": "CA",
        "postalCode": "94105",
        "countryCode": "US"
      }
    }
  }
}

• kind and name are required. An individual’s name must include first and last name. email, phone, and address are optional; phone numbers are normalized to E.164.
• A supplied address must be complete: line1, city, and an ISO two-letter countryCode; US addresses also require state and postalCode.
• Natural screens every external party and reports screeningStatus as clear, under_review, or rejected. A rejected party cannot have accounts stored.
• Fedwire requires a complete beneficiary address. If a wire create returns 400 wire.beneficiary_address_required, read the party’s addressVersion and call PATCH /external-parties/{externalPartyId}/address with the complete address and expectedAddressVersion, then retry with the same IDs.
• Address completeness and bank wire eligibility are separate requirements — an account that supports ACH does not necessarily support wires.

​

External party accounts

{
  "data": {
    "attributes": {
      "externalPartyId": "epty_019cd1798d8d6873421613705e3c1415",
      "accountDetails": {
        "type": "us_bank_account",
        "accountType": "checking",
        "accountNumber": "123456786789",
        "routingNumber": "121000358"
      }
    }
  }
}

• Responses identify the account by its last four digits and a masked form; the full numbers are stored securely and never returned.
• supportedRails lists the rails the account is expected to accept — one or more of ach, realtime, and wire. It is advisory and refreshed periodically from the payment network; the authoritative check runs when you create a payment.