埋め込みアカウント登録

連結アカウントに、現地に適応したデータ検証可能なアカウント登録フォームを提供します。

埋め込みアカウント登録は、テーマを適用できるアカウント登録 UI であり、Stripe のブランディングは限定的にしか表示されません。プラットフォームアプリケーションにアカウント登録コンポーネントを埋め込むと、連結アカウントはアプリケーションから離れずに埋め込みコンポーネントを操作できます。

このコンポーネントはネットワーク経由のアカウント登録に対応しており、複数の Stripe アカウントの所有者がアカウント間で事業情報を共有できます。アカウント登録時にそれらの情報を再提出する代わりに、既存のアカウントの情報を再利用できます。

埋め込みアカウント登録では、Accounts API を使用して要件を読み取り、Stripe がサポートするすべての国に合わせて調整された、データ検証機能を持つアカウント登録フォームを生成します。さらに、埋め込みアカウント登録は、次のすべてを処理します。

ビジネスのタイプ
会社代表者の設定
確認書類のアップロード
本人確認とステータス
海外の銀行口座
エラーの状態

このデモでは、埋め込みアカウント登録コンポーネントのインターフェイスを確認できます。

アカウントを作成し、情報を事前入力する
サーバー側

デフォルトの controller (コントローラー) プロパティを使用して連結アカウントを作成します。コントローラープロパティについて、詳細はシステムの設計をご覧ください。または、アカウントの type (タイプ) を指定して、連結アカウントを作成することもできます。

アカウントの国を指定するか、アカウントのケイパビリティをリクエストした場合、アカウント所有者は国を変更できません。それ以外の場合は、アカウントのダッシュボードへのアクセス権によって異なります。

** Stripe ダッシュボードの全機能:** アカウント登録時に、アカウント所有者は通常の Stripe アカウントへの登録時と同様に、任意の取引国を選択できます。Stripe は、選択された国に基づいて、アカウントのケイパビリティのセットを自動的にリクエストします。
Express ダッシュボード: アカウント登録時に、アカウント所有者は、プラットフォームのダッシュボードのアカウント登録オプションで設定された国のリストから選択できます。また、これらのオプションを設定して、各国のアカウントにリクエストするデフォルトのケイパビリティを指定することもできます。
Stripe ダッシュボードなし:Stripe が要件収集を担当する場合、アカウント登録フローではアカウント所有者が任意の取引国を選択できます。それ以外の場合は、カスタムのアカウント登録フローで国を設定し、ケイパビリティをリクエストする必要があります。

レスポンスには ID が含まれており、システム全体で Account を参照する場合はこれを使用します。

ケイパビリティをリクエストする

アカウントの作成時に、必要なケイパビリティの requested プロパティを true に設定することで、ケイパビリティをリクエストできます。Express ダッシュボードにアクセスできるアカウントの場合は、アカウント登録オプションを設定して、アカウントの作成時に特定のケイパビリティを自動的にリクエストすることもできます。

Stripe のアカウント登録 UI は、リクエストされたケイパビリティの要件を自動的に収集します。アカウント登録の負荷を軽減するため、必要なケイパビリティのみをリクエストしてください。

情報を事前入力する

アカウント所有者に関する情報 (氏名、住所、その他の詳細など) を入手している場合、アカウントの作成時または更新時にそれを提供することで、アカウント登録をシンプルにできます。アカウント登録インターフェイスは、アカウント所有者に対して、Connect 利用規約に同意する前に、事前入力された情報を確認するよう求めます。アカウント所有者は、Accounts API を使用して情報を提供した場合でも、その事前入力された情報を利用規約に同意する前に編集することができます。

アカウント登録を行い、プラットフォームから URL が提供されている場合は、アカウントの business_profile.url を事前入力します。ビジネスに URL がない場合には、代わりに business_profile.product_description を事前入力できます。

実装内容をテストする際は、テストデータを使用して、本人確認、事業情報の確認、入金の失敗などのさまざまな結果をシミュレーションできます。

収集する情報を決定する

プラットフォームは、連結アカウントから必要な情報を事前に (アップフロント) 収集するか、段階的に (インクリメンタル) 収集するかを決定する必要があります。アップフロントアカウント登録ではアカウントの eventually_due 要件を収集しますが、インクリメンタルアカウント登録では currently_due 要件のみを収集します。

アカウント登録のタイプ	メリット
アップフロント	通常、すべての情報に対して 1 回のみのリクエストが必要期限に間に合わなかったために入金や処理に問題が生じる可能性を回避できるアカウントが情報提供を拒否した場合の潜在的なリスクを、早期に可視化できる
インクリメンタル	アカウントは多くの情報を提供する必要がないため、素早くアカウント登録できる

アップフロントとインクリメンタルのどちらのアカウント登録を使用するかを決定するには、連結アカウントの所在地とケイパビリティに関する要件を確認してください。Stripe は連結アカウントへの影響を最小限に抑えるように努めていますが、時間の経過とともに要件が変化する可能性があります。

お客様が必要な情報を収集する責任を負う連結アカウントの場合、collection_options パラメーターを使用して、今後の要件の動作をカスタマイズできます。アカウントの将来の要件を収集するには、collection_options.future_requirements を include に設定します。

ユーザーに表示するポリシーをカスタマイズする

Stripe の利用規約とプライバシーポリシーは、オンラインのアカウント登録で連結アカウントに提示されます。Stripe の利用規約に同意していない連結アカウントは、アカウント登録の最後の画面で規約を受け入れるように求められます。また、オンラインのアカウント登録のフッターにも、Stripe の利用規約とプライバシーポリシーへのリンクが掲載されています。

プラットフォームが要件の収集を行う連結アカウントに対しては、アカウント登録フローをカスタマイズする追加オプションがあります。以下に概要を示します。

自社で利用規約への同意を管理する

プラットフォームとして、貴社が必要な情報を収集する責任を負う連結アカウントを登録している場合、Stripe のオンラインのアカウント登録コンポーネントではなく、自社のプロセスを使用して利用規約への同意を収集できます。自社のプロセスを使用する場合、アカウント登録の最終画面では、連結アカウントには入力した情報の確認のみが求められます。Stripe の利用規約への同意は貴社で確実に取得する必要があります。

ただし、オンラインのアカウント登録には (フッターなどに) 利用規約へのリンクが表示されます。このリンクを、自社の規約およびプライバシーポリシーへのリンクで置き換えることを選択できます。

利用規約およびプライバシーポリシーへのリンク

Stripe の利用規約とプライバシーポリシーはオンライン登録のいたるところで連結アカウントに提示されます。貴社が要件の収集に責任を負う連結アカウントの場合、これらのリンクを自社の規約とポリシーに置き換えることができます。以下の手順に従って Stripe 利用規約を組み込み、Stripe プライバシーポリシーにリンクします。

アカウント登録コンポーネントを実装する
サーバー側
クライアント側

連結アカウントの ID と、有効にするコンポーネントとして account_onboarding を指定し、Account Session (アカウントセッション) を作成します。

アカウントセッションを作成する

アカウントセッションの作成時に、components パラメーターで account_onboarding を指定して、アカウント登録を有効にします。

アカウントセッションを作成して ConnectJS を初期化すると、フロントエンドにアカウント登録コンポーネントを表示できます。

メソッド	タイプ	説明	デフォルト
`setFullTermsOfServiceUrl`	`string`	利用規約全文への同意の絶対 URL。	Stripe の利用規約全文
`setRecipientTermsOfServiceUrl`	`string`	Recipient (受取人) の利用規約への同意の絶対 URL。	Stripe 受取人利用規約
`setPrivacyPolicyUrl`	`string`	プライバシーポリシーへの絶対 URL。	Stripe プライバシーポリシー
`setSkipTermsOfServiceCollection`	`string`	true の場合、オンラインのアカウント登録では利用規約への同意の収集がスキップされ、規約への同意を自社で収集する必要があります。	false
`setCollectionOptions`	`{ fields: 'currently_due' \| 'eventually_due', future_requirements: 'omit' \| 'include' }`	`currently_due` または `eventually_due` の要件の収集をカスタマイズし、future requirements (今後の要件) を含めるかどうかを制御します。`eventually_due` を指定すると、`eventually_due` と `currently_due` の両方の要件が収集されます。	`{fields: 'currently_due', futureRequirements: 'omit'}`
`setOnExit`	`() => void`	連結アカウントがアカウント登録プロセスを終了しました。
`setOnStepChange`	`({step}: StepChange) => void`	連結アカウントがアカウント登録プロセス内のいずれかのステップから別のステップに移動しました。以下で説明するように、`StepChange` を使用して現在のステップを識別します。

このコンポーネントを使用して新しいアカウントを設定するには、以下を実行します。

連結アカウントを作成します。この API コールの Account オブジェクトに情報を事前入力できます。
連結アカウントの ID を使用して、Connect の埋め込みコンポーネントを初期化します。
account-onboarding エレメントを含めて、連結アカウントにアカウント登録フローを表示します。
このコンポーネントから送信される exit イベントをリッスンします。Stripe は、連結アカウントがアカウント登録プロセスを終了したときにこのイベントを送信します。
exit がトリガーされたら、Account の詳細を取得して、以下のステータスを確認します。
- details_submitted
- charges_enabled
- payouts_enabled
- その他のリクエストされたケイパビリティ
必要なケイパビリティがすべて有効な場合、連結アカウントをフローの次のステップに進めることができます。

StepChange オブジェクト

StepChange タイプは connect.js で定義されています。連結アカウントがアカウント登録プロセスでステップ間を移動するたびに、ステップ変更ハンドラーは、以下のプロパティが指定された StepChange オブジェクトを受け取ります。

名前	タイプ	サンプル値
`step`	`string` (有効なステップ名を指定してください)	`business_type`
アカウント登録ステップへの一意の参照。

ステップの制限

StepChange オブジェクトは分析専用です。
ステップは任意の順序で表示でき、繰り返す場合があります。
有効な step 名のリストは、予告なしにいつでも変更される可能性があります。

ステップ名

アカウント登録フローの各ページには、以下のステップ名のいずれかが設定されています。

ステップ名	説明
`stripe_user_authentication`	ユーザー認証には、Stripe が管理するウィンドウへのポップアップが含まれます。ワークフローを続行する前に、連結アカウントは認証を終える必要があります。
`risk_intervention`	リスクに関する要件を解決するための指示を連結アカウントに提示します。
`legal_entity_sharing`	連結アカウントは、必要に応じて、同じ所有者の既存のアカウントの事業情報を再利用できます。
`business_type`	連結アカウントの会社形態を設定します。場合により、連結アカウントに国を設定することもできます。
`business_details`	連結アカウントのビジネスに関する情報を収集します。
`business_verification`	会社の定款など、会社の企業識別番号を確認できる証明書類を収集します。または、誤って入力された会社情報をユーザーが修正できるようにします。
`business_bank_account_ownership_verification`	銀行口座情報 (法的所有者の名前、口座番号など) が、そのユーザーの Stripe アカウントの情報と一致していることを裏付けるのに必要な書類を収集します。
`business_documents`	ビジネスに関する追加書類および確認要件を収集します。
`representative_details`	アカウント代表者に関する情報を収集します。
`representative_document`	アカウント代表者の存在を証明する政府発行の本人確認書類を収集します。
`representative_additional_document`	アカウント代表者の情報を裏付ける追加書類を収集します。
`legal_guardian_details`	未成年者が開設したアカウントに対する法定後見人の同意を収集します。
`owners`	会社の代表者に関する情報を収集します。
`directors`	会社の取締役に関する情報を収集します。
`executives`	会社の幹部に関する情報を収集します。
`proof_of_ownership_document`	会社代表者を確認するための文書を収集します。
`proof_of_authorization`	社内でアカウント代表者が十分な権限のある地位に就いていることを確認するための文書を収集します。
`confirm_owners`	Stripe に提供した会社代表者情報が最新かつ正確であることを、連結アカウントが証明できるようにします。
`risa_compliance_survey`	(日本国内のビジネスにのみ適用されます。)改正割賦販売法に関連する質問に回答します。
`treasury_and_card_issuing_terms_of_service`	これらのケイパビリティをリクエストすると、Treasury と Card Issuing の利用規約が収集されます。
`external_account`	連結アカウントの外部口座を収集します。
`support_details`	顧客が連結アカウントのビジネスを識別するのに役立つ情報を収集します。このサポート情報は、支払い明細書、請求書、領収書に表示できます。
`climate`	連結アカウントが Stripe Climate にオプトインできるようにします。
`tax`	連結アカウントが Stripe Tax にオプトインできるようにします。
`summary`	アカウント登録の最終審査のステップ。連結アカウントは、入力した情報をこのステップで更新できます。利用規約とプライバシーの URL がこの画面に表示されます。
`summary_risk`	連結アカウントは、リスク要件に関する情報をサマリーステップで更新できます。
`summary_business_type`	連結アカウントは、サマリーステップから、ビジネスタイプに関連する情報を更新できます。
`summary_business`	連結アカウントは、ビジネスに関する情報をサマリーステップで更新できます。
`summary_support`	連結アカウントは、サマリーステップから、ビジネスに関連する公開情報を更新できます。
`summary_persons`	連結アカウントは、アカウントに保存されている個人に関する情報をサマリーステップで更新できます。
`summary_external_account`	連結アカウントは、サマリーステップから外部口座に関連する情報を更新できます。
`summary_tax`	連結アカウントは、Stripe Tax システムに関する情報をサマリーステップで更新できます。
`summary_tax_identification_form`	連結アカウントは、W8 / W9 フォームの資格情報をサマリーステップで更新できます。これは、Stripe が W8 / W9 フォームの情報を収集する必要がある場合に表示されます。
`summary_climate`	連結アカウントは、Stripe Climate システムに関する情報をサマリーステップで更新できます。

要件の更新を特定して対処する
サーバー側

アカウント要件に対する変更をリッスンするようにシステムを設定します。テストトリガーカードを使用して、新しい要件への対応 (および支払いと入金を無効にする方法) をテストできます。

連結アカウントに currently_due または eventually_due の要件がある場合、アカウント登録フローに送り返します。アカウント登録インターフェイスで収集が必要な情報が認識されるため、具体的な要件を特定する必要はありません。たとえば、タイプミスによってアカウント所有者の本人確認ができない場合、アカウント登録で本人確認書類のアップロードが求められます。

Stripe は、連結アカウントに影響する今後の要件の更新について通知します。アカウントの今後の要件を確認することで、この情報を事前に収集できます。

controller.requirement_collection が stripe である連結アカウントの場合は、Account Link (アカウントリンク) または Account Session (アカウントセッション) の作成後に本人確認情報の更新の受信を停止します。

アカウントは、本人確認情報を company ハッシュと individual ハッシュに保存します。

確認エラーを処理する

account.updated イベントをリッスンします。current_deadline が着信したときにアカウントに currently_due フィールドが含まれている場合は、対応する機能が無効になり、そのフィールドが past_due に追加されます。

アカウント登録コンポーネントにアカウントを誘導して、確認要件を修正できるようにします。

Stripe ユーザー認証を無効にする

埋め込みアカウント登録を使用する場合、Stripe ユーザー認証がデフォルトで有効になります。disable_stripe_user_authentication を使用して、この動作を削除できます。

ベストプラクティスとして、2 要素認証または同等のセキュリティ対策を導入することをお勧めします。Custom など、この機能をサポートするアカウント設定では、連結アカウントがマイナス残高を返済できない場合、貴社がそのアカウントに対する責任を負うことになります。