Account Owner

Describes an owner of an account.

Endpoints

GET/v1/financial_connections/accounts/:id/owners

The Account Owner object

Attributes

idstring
Unique identifier for the object.

objectstring
String representing the object’s type. Objects of the same type share the same value.

emailnullable string
The email address of the owner.

namestring
The full name of the owner.

ownershipstring
The ownership object that this owner belongs to.

phonenullable string
The raw phone number of the owner.

raw_addressnullable string
The raw physical address of the owner.

refreshed_atnullable timestamp
The timestamp of the refresh that updated this owner.

The Account Owner object

{
  "id": "fcaown_1NtI9uBHO5VeT9SUKLJU5suZ",
  "object": "financial_connections.account_owner",
  "email": "nobody+janesmith@stripe.com",
  "name": "Jane Smith",
  "ownership": "fcaowns_1NtI9uBHO5VeT9SUSRe21lqt",
  "phone": "+1 555-555-5555",
  "raw_address": "123 Main Street, Everytown USA",
  "refreshed_at": null
}

The Account Ownership object

Attributes

idstring
Unique identifier for the object.

objectstring
String representing the object’s type. Objects of the same type share the same value.

createdtimestamp
Time at which the object was created. Measured in seconds since the Unix epoch.

ownersobject
A paginated list of owners for this account.

The Account Ownership object

{
  "id": "fcaowns_1MwVKR2eZvKYlo2CGV7Mmt6s",
  "object": "linked_account_ownership",
  "created": 1681412227,
  "owners": {
    "object": "list",
    "data": [],
    "has_more": false,
    "url": "/v1/linked_accounts/fca_1MwVKR2eZvKYlo2CoMV2L3PV/owners?ownership=fcaowns_1MwVKR2eZvKYlo2CGV7Mmt6s"
  }
}

List Account Owners

Lists all owners for a given Account

Parameters

ownershipstringRequired
The ID of the ownership object to fetch owners from.

More parameters

ending_beforestring

limitinteger

starting_afterstring

Returns

A dictionary with a data property that contains an array of up to limit owners for a given account, starting after owner starting_after. Each entry in the array is a separate owner object. If no more owners are available, the resulting array will be empty.

GET /v1/financial_connections/accounts/:id/owners

Server-side language

curl -G https://api.stripe.com/v1/financial_connections/accounts/fca_1NoEbE2eZvKYlo2CmmnAn2A1/owners \
  -u "sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc:" \
  -d ownership=fcaowns_1NoEbE2eZvKYlo2C4Xj7vilA

Response

{
  "object": "list",
  "url": "/v1/financial_connections/accounts/fca_1NoEbE2eZvKYlo2CmmnAn2A1/owners",
  "has_more": false,
  "data": [
    {
      "object": "list",
      "url": "/v1/financial_connections/accounts/fca_1NoDzC2eZvKYlo2CwXpqO27d/owners",
      "has_more": false,
      "data": [
        {
          "id": "fcaown_1NoDzC2eZvKYlo2C1TlEZ0K2",
          "object": "linked_account_owner",
          "email": "nobody+janesmith@stripe.com",
          "name": "Jane Smith",
          "ownership": "fcaowns_1NoDzC2eZvKYlo2CAm1EDKTk",
          "phone": "+1 555-555-5555",
          "raw_address": "123 Main Street, Everytown USA",
          "refreshed_at": null
        }
      ]
    }
    {...}
    {...}
  ],
}

Session

A Financial Connections Session is the secure way to programmatically launch the client-side Stripe.js modal that lets your users link their accounts.

Endpoints

POST/v1/financial_connections/sessions

GET/v1/financial_connections/sessions/:id

Transactions

A Transaction represents a real transaction that affects a Financial Connections Account balance.

Endpoints

GET/v1/financial_connections/transactions/:id

GET/v1/financial_connections/transactions

Tax Calculations

A Tax Calculation allows you to calculate the tax to collect from your customer.

Endpoints

GET/v1/tax/calculations/:id/line_items

POST/v1/tax/calculations

Tax Registrations

A Tax Registration lets us know that your business is registered to collect tax on payments within a region, enabling you to automatically collect tax.

Stripe doesn’t register on your behalf with the relevant authorities when you create a Tax Registration object. For more information on how to register to collect tax, see our guide.

Related guide: Using the Registrations API

Endpoints

POST/v1/tax/registrations

POST/v1/tax/registrations/:id

GET/v1/tax/registrations/:id

GET/v1/tax/registrations

Tax Transactions

A Tax Transaction records the tax collected from or refunded to your customer.

Endpoints

POST/v1/tax/transactions/create_reversal

POST/v1/tax/transactions/create_from_calculation

GET/v1/tax/transactions/:id/line_items

GET/v1/tax/transactions/:id

Tax Settings

You can use Tax Settings to manage configurations used by Stripe Tax calculations.

Related guide: Using the Settings API

Endpoints

POST/v1/tax/settings

GET/v1/tax/settings

Verification Session

A VerificationSession guides you through the process of collecting and verifying the identities of your users. It contains details about the type of verification, such as what verification check to perform. Only create one VerificationSession for each verification in your system.

A VerificationSession transitions through multiple statuses throughout its lifetime as it progresses through the verification flow. The VerificationSession contains the user’s verified data after verification checks are complete.

Related guide: The Verification Sessions API

Endpoints

POST/v1/identity/verification_sessions

POST/v1/identity/verification_sessions/:id

GET/v1/identity/verification_sessions/:id

GET/v1/identity/verification_sessions

POST/v1/identity/verification_sessions/:id/cancel

POST/v1/identity/verification_sessions/:id/redact

Verification Report

A VerificationReport is the result of an attempt to collect and verify data from a user. The collection of verification checks performed is determined from the type and options parameters used. You can find the result of each verification check performed in the appropriate sub-resource: document, id_number, selfie.

Each VerificationReport contains a copy of any data collected by the user as well as reference IDs which can be used to access collected images through the FileUpload API. To configure and create VerificationReports, use the VerificationSession API.

Related guides: Accessing verification results.

Endpoints

GET/v1/identity/verification_reports/:id

GET/v1/identity/verification_reports

Crypto Onramp Session

A Crypto Onramp Session represents your customer’s session as they purchase cryptocurrency through Stripe. Once payment is successful, Stripe will fulfill the delivery of cryptocurrency to your user’s wallet and contain a reference to the crypto transaction ID.

You can create an onramp session on your server and embed the widget on your frontend. Alternatively, you can redirect your users to the standalone hosted onramp.

Related guide: Integrate the onramp

Endpoints

POST/v1/crypto/onramp_sessions

GET/v1/crypto/onramp_sessions/:id

GET/v1/crypto/onramp_sessions

Crypto Onramp Quotes

Crypto Onramp Quotes are estimated quotes for onramp conversions into all the different cryptocurrencies on different networks. The Quotes API allows you to display quotes in your product UI before directing the user to the onramp widget.

Related guide: Quotes API

Endpoints

GET/v1/crypto/onramp/quotes

Climate Order

Orders represent your intent to purchase a particular Climate product. When you create an order, the payment is deducted from your merchant balance.

Endpoints

POST/v1/climate/orders

POST/v1/climate/orders/:id

GET/v1/climate/orders/:id

GET/v1/climate/orders

POST/v1/climate/orders/:id/cancel

Climate Product

A Climate product represents a type of carbon removal unit available for reservation. You can retrieve it to see the current price and availability.

Endpoints

GET/v1/climate/products/:id

GET/v1/climate/products

Climate Supplier

A supplier of carbon removal.

Endpoints

GET/v1/climate/suppliers/:id

GET/v1/climate/suppliers

Forwarding Request

Instructs Stripe to make a request on your behalf using the destination URL. The destination URL is activated by Stripe at the time of onboarding. Stripe verifies requests with your credentials provided during onboarding, and injects card details from the payment_method into the request.

Stripe redacts all sensitive fields and headers, including authentication credentials and card numbers, before storing the request and response data in the forwarding Request object, which are subject to a 30-day retention period.

You can provide a Stripe idempotency key to make sure that requests with the same key result in only one outbound request. The Stripe idempotency key provided should be unique and different from any idempotency keys provided on the underlying third-party request.

Forwarding Requests are synchronous requests that return a response or time out according to Stripe’s limits.

Endpoints

POST/v1/forwarding/requests

GET/v1/forwarding/requests/:id

GET/v1/forwarding/requests