> For the complete documentation index, see [llms.txt](https://peoplescourt.ai/llms.txt). This page is also available as Markdown.

# Admit or resume Stripe account onboarding for a tenant

An active tenant administrator and current account session are required. Return and refresh URLs are fixed by the service. A single-use URL is shown once. Retrying resumes onboarding for the same authorized tenant account.

Reference

Execution

POST

partial

`/api/account/integrations/{partnerId}/stripe-connect`

`createConsoleStripeOnboardingLink`

## Authentication and authority

Use one listed account-session, scoped OAuth, or partner credential alternative. Account tokens retain the approving account’s authority. Cookie-authenticated writes require same-origin authorization. Alternatives are OR; schemes in one alternative are AND.

`CanonicalSession`

The signed-in account’s session. Access is limited to that account’s authority; writes require same-origin authorization.

## Parameters

Name

Location

Requirement

Schema

`partnerId`

path

Required

{"type":"string"}

`Idempotency-Key`

header

Required

{"type":"string","minLength":8,"maxLength":200}

## Request body

Required request body.

application/json

```json
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "accountRecordId": {
      "type": "string"
    }
  }
}
```

## Responses

### 201

Authorized Stripe Connect resource.

application/json

```json
{
  "type": "object",
  "required": [
    "ok",
    "data"
  ],
  "properties": {
    "data": {
      "type": "object",
      "required": [
        "account",
        "onboardingUrl",
        "expiresAt"
      ],
      "properties": {
        "account": {
          "$ref": "#/components/schemas/StripeConnectedAccount",
          "type": "object",
          "required": [
            "id",
            "environment",
            "status",
            "admittedAt"
          ],
          "properties": {
            "id": {
              "type": "string"
            },
            "accountId": {
              "type": "string"
            },
            "accountApiVersion": {
              "type": "string",
              "enum": [
                "v1",
                "v2"
              ],
              "description": "Stripe Accounts API used by this linked account. Historical records may omit this field and use v1."
            },
            "environment": {
              "enum": [
                "test",
                "live"
              ]
            },
            "status": {
              "enum": [
                "pending",
                "requirements_due",
                "ready",
                "restricted"
              ]
            },
            "admittedAt": {
              "type": "string",
              "format": "date-time"
            },
            "chargesEnabled": {
              "type": "boolean"
            },
            "payoutsEnabled": {
              "type": "boolean"
            },
            "requirementsDue": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "checkedAt": {
              "type": "string",
              "format": "date-time"
            }
          },
          "x-mcp-exposure": "none"
        },
        "onboardingUrl": {
          "type": "string",
          "format": "uri"
        },
        "expiresAt": {
          "type": "string",
          "format": "date-time"
        }
      }
    },
    "ok": {
      "type": "boolean"
    }
  }
}
```

### default

Authorization, validation or provider configuration failure.

application/problem+json

```json
{
  "$ref": "#/components/schemas/Problem",
  "type": "object",
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "requestId"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer"
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "requestId": {
      "type": "string"
    },
    "details": {
      "description": "Account-readiness refusals include a value-free checklist and exact account-page link. Other error codes may provide different details.",
      "anyOf": [
        {
          "$ref": "#/components/schemas/AccountReadinessDetails",
          "type": "object",
          "additionalProperties": false,
          "required": [
            "ready",
            "accountSetupUrl",
            "missing"
          ],
          "properties": {
            "ready": {
              "type": "boolean"
            },
            "accountSetupUrl": {
              "type": "string",
              "format": "uri"
            },
            "missing": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/AccountReadinessRequirement",
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "label",
                  "section",
                  "accountUrl"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "label": {
                    "type": "string"
                  },
                  "section": {
                    "type": "string",
                    "enum": [
                      "email",
                      "identity",
                      "legal_documents"
                    ]
                  },
                  "accountUrl": {
                    "type": "string",
                    "format": "uri"
                  }
                }
              }
            }
          }
        },
        {
          "$ref": "#/components/schemas/LegalDocumentsRequiredDetails",
          "type": "object",
          "additionalProperties": false,
          "required": [
            "legalDocumentsUrl"
          ],
          "properties": {
            "legalDocumentsUrl": {
              "type": "string",
              "format": "uri",
              "description": "Absolute account-page URL where the person reviews and accepts the current Terms and Privacy Notice. Uses the configured public application origin. After accepting the documents, retry the original operation."
            },
            "ready": {
              "type": "boolean"
            },
            "accountSetupUrl": {
              "type": "string",
              "format": "uri"
            },
            "missing": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/AccountReadinessRequirement",
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "label",
                  "section",
                  "accountUrl"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "label": {
                    "type": "string"
                  },
                  "section": {
                    "type": "string",
                    "enum": [
                      "email",
                      "identity",
                      "legal_documents"
                    ]
                  },
                  "accountUrl": {
                    "type": "string",
                    "format": "uri"
                  }
                }
              }
            }
          }
        },
        {}
      ]
    }
  }
}
```

## Example response

### Successful response

```json
{
  "data": {
    "account": {
      "id": "id_test",
      "environment": "test",
      "status": "pending",
      "admittedAt": "2026-08-09T12:00:00.000Z"
    },
    "onboardingUrl": "https://partner.test.example/callbacks/peoples-court",
    "expiresAt": "2026-08-09T12:00:00.000Z"
  },
  "ok": false
}
```

## Errors

Read the response status and stable error code. See [errors](https://peoplescourt.ai/docs/api/errors.md) and [rate limits](https://peoplescourt.ai/docs/api/rate-limits.md) for recovery. Refresh the resource before resolving a state or digest conflict.

## Idempotency and retries

- For throttling, honor Retry-After when present. Back off on retryable server failures.
- Send a unique Idempotency-Key. An exact retry returns the stored result; reusing the key with a different request fails.
- The request is accepted only when its credential, authority, case state, and resource preconditions are satisfied.

## Request examples

Use `https://peoplescourt.ai` with the test credential issued for your integration.

```sh
curl --request POST \
  --url 'https://peoplescourt.ai/api/account/integrations/partner_test_123/stripe-connect' \
  --header 'Cookie: arb_session=COPY_ACCOUNT_SESSION' \
  --header 'Origin: https://peoplescourt.ai' \
  --header 'Idempotency-Key: idem_test_12345678' \
  --header 'Content-Type: application/json' \
  --data '{}'
```

```ts
const input = {};

const response = await fetch("https://peoplescourt.ai/api/account/integrations/partner_test_123/stripe-connect", {
  method: "POST",
  headers: {
    "Cookie": "arb_session=COPY_ACCOUNT_SESSION",
    "Origin": "https://peoplescourt.ai",
    "Idempotency-Key": "idem_test_12345678",
    "Content-Type": "application/json"
  },
  body: JSON.stringify(input),
});
if (!response.ok) throw await response.json();
const result = await response.json();
```

```python
import requests

response = requests.post(
    "https://peoplescourt.ai/api/account/integrations/partner_test_123/stripe-connect",
    headers={
      "Cookie": "arb_session=COPY_ACCOUNT_SESSION",
      "Origin": "https://peoplescourt.ai",
      "Idempotency-Key": "idem_test_12345678",
      "Content-Type": "application/json"
    },
    json={},
    timeout=30,
)
response.raise_for_status()
result = response.json()
```