Core Resources
Payment Methods
Products
Checkout
Payment Links
Billing
Capital
Connect
Reserves
Fraud
Issuing
Terminal
Treasury
Payment Records
Entitlements
Sigma
Reporting
Financial Connections
Tax
Identity
Crypto
Climate
Forwarding
Webhooks

Create an account link v2

Creates an AccountLink object that includes a single-use URL that an account can use to access a Stripe-hosted flow for collecting or updating required information.

Learn more about calling API v2 endpoints.

Parameters

  • accountstringRequired

    The ID of the Account to create link for.

  • use_caseobjectRequired

    The use case of the AccountLink.

Returns

Response attributes

  • objectstring, value is "v2.core.account_link"

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

  • accountstring

    The ID of the connected account this Account Link applies to.

  • createdtimestamp

    The timestamp at which this Account Link was created.

  • expires_attimestamp

    The timestamp at which this Account Link will expire.

  • livemodeboolean

    Has the value true if the object exists in live mode or the value false if the object exists in test mode.

  • urlstring

    The URL at which the account can access the Stripe-hosted flow.

  • use_caseobject

    Hash containing usage options.

Error Codes
400accounts_v2_access_blocked

Accounts v2 is not enabled for your platform.

400configs_must_match_to_use_account_links

Account cannot be onboard via v2/core/account_links without specifying the right configurations.

404not_found

The resource wasn’t found.

429account_rate_limit_exceeded

Account cannot exceed a configured concurrency rate limit on updates.

POST /v2/core/account_links
curl -X POST https://api.stripe.com/v2/core/account_links \
  -H "Authorization: Bearer sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2" \
  -H "Stripe-Version: 2025-12-15.preview" \
  --json '{
    "account": "acct_1Nv0FGQ9RKHgCVdK",
    "use_case": {
        "type": "account_onboarding",
        "account_onboarding": {
            "configurations": [
                "recipient"
            ],
            "return_url": "https://example.com/return",
            "refresh_url": "https://example.com/reauth"
        }
    }
  }'
Response
{
  "object": "v2.core.account_link",
  "account": "acct_1Nv0FGQ9RKHgCVdK",
  "created": "2025-03-27T17:15:18.000Z",
  "expires_at": "2025-03-27T17:25:18.000Z",
  "livemode": true,
  "url": "https://accounts.stripe.com/r/acct_1Nv0FGQ9RKHgCVdK#alu_test_61SGhyomRuz7xsw5216SGhyj0ASQdCLwMKdRUF3mi3H6",
  "use_case": {
    "account_onboarding": {
      "configurations": [
        "recipient"
      ],
      "refresh_url": "https://example.com/reauth",
      "return_url": "https://example.com/return"
    },
    "type": "account_onboarding"
  }
}