Counterparties
This is the official reference documentation for the SVB Counterparties API. Please see the authentication documentation for access information.

The Counterparties API follows the same conventions as SVB’s other APIs. Please see the documentation on API conventions for more information.
The Counterparty object represents an entity on the other side of a transaction; this can be a person, business, government, or bank. For example, if you send a wire transfer to a vendor, that vendor is the counterparty for the wire.

Counterparties can be used to simplify an app and make it more secure. The recommended best practice is to store the Counterparty ID and use this ID in API calls instead of storing account credentials.

Table of Contents

  • Counterparty Attributes

    • Background 

    The Counterparty object represents an entity on the other side of a transaction (i.e.  a person, business, government agency, or a bank). For example, if you send an ACH transfer to a vendor, that vendor is the counterparty for the transfer.

    Counterparties can be used to simplify an app and make it more secure. The recommended best practice is to store the Counterparty ID and use this ID in API requests instead of storing account credentials.

    Counterparty Attributes

    NAME TYPE DESCRIPTION 
     id  string  Uniquely identifies each counterparty object.
     account_number  string  The account number.
     account_type  enum(checking, savings)  The type of account.
     address_line1  string  Mailing address street.
     address_line2  string  Mailing address apartment, suite, building, etc.
     city  string  Mailing address city.
     state  string  Mailing address state (if applicable).
     country  string  Mailing address country (ISO 3166-1 alpha-2).
     postal_code  string  Mailing address postal_code.
     description  string  A description of the counterparty.
     email_address  string  The counterparty’s email address.
     metadata  object  Optional metadata to associate with the counterparty.
     name  string  The counterparty’s name.
     routing_number  string  The 9-digit ABA routing number.
     wire_routing_number  string  An alternative routing number if required by the bank.

     

    Example Counterparty object:

    {
  "id": "123",
  "account_number": "123456789",
  "address_line1": "123 Parrot Street",
  "address_line2": "Apt. 311",
  "city": "San Francisco",
  "state": "CA",
  "country": "US",
  "postal_code": "94105",
  "description": "Important vendor",
  "email_address": "counterparty@svb.com",
  "name": "Counterparty Co.",
  "metadata": {"foo": "bar"},
  "routing_number": "121140399",
  "type": "counterparty",
  "wire_routing_Number": "121145145",
  "url": "/v1/counterparties/123"
}