顧客 - Swipelux

入金、支払い、または発行済み銀行口座を構築する前に顧客を作成します。ケイパビリティ、口座、送金はその顧客にスコープされます。externalId を、システム内の対応するレコードへの安定したマッピングとして使用してください。

Environment variables

export API_BASE='https://platform.swipelux.com'
export SWIPELUX_API_KEY='replace-with-your-api-key'

個人顧客

個人顧客は type のみが必須です。既知のプロファイル項目を含め、現在のケイパビリティやタスクが必要とする場合にのみ、他の項目を追加してください。 POST /v3/customers で顧客を作成します。

Create individual customer

curl --request POST \
  "${API_BASE}/v3/customers" \
  --header "X-API-Key: ${SWIPELUX_API_KEY}" \
  --header "Idempotency-Key: customer-user-123" \
  --header "Content-Type: application/json" \
  --data @- <<'JSON'
{
  "type": "individual",
  "externalId": "user_123",
  "individual": {
    "firstName": "Amina",
    "lastName": "Diallo",
    "residenceCountry": "FR"
  }
}
JSON

返された data.id を CUSTOMER_ID として保存します。ポリシー文脈については個人オンボーディングをご覧ください。

ビジネス顧客

ビジネスには business.legalName が必須です。同じ操作でビジネスを作成します。

Create business customer

curl --request POST \
  "${API_BASE}/v3/customers" \
  --header "X-API-Key: ${SWIPELUX_API_KEY}" \
  --header "Idempotency-Key: customer-company-456" \
  --header "Content-Type: application/json" \
  --data @- <<'JSON'
{
  "type": "business",
  "externalId": "company_456",
  "business": {
    "legalName": "Acme Payments SAS"
  }
}
JSON

返された data.id を CUSTOMER_ID として保存します。ポリシーおよびドキュメントの文脈についてはビジネスオンボーディングをご覧ください。取締役、所有者、その他のビジネス参加者が判明したり要求された時点で追加してください。この例では、POST /v3/customers/{customerId}/related-parties で取締役を作成します。

Add related party

curl --request POST \
  "${API_BASE}/v3/customers/${CUSTOMER_ID}/related-parties" \
  --header "X-API-Key: ${SWIPELUX_API_KEY}" \
  --header "Idempotency-Key: related-party-director-001" \
  --header "Content-Type: application/json" \
  --data @- <<'JSON'
{
  "partyType": "person",
  "roles": ["director"],
  "title": "Chief executive officer",
  "person": {
    "firstName": "Amina",
    "lastName": "Diallo",
    "residenceCountry": "FR"
  }
}
JSON

返された data.id を RELATED_PARTY_ID として保存します。顧客をエクスポートする必要がある場合は、POST /v3/customers/{customerId}/export を使用し、リクエストスキーマに従ってください。json_basic_data 形式は、現在の公開 v3 顧客リソースを JSON 添付ファイルとして返します。各呼び出しは現在のデータを再計算し、ドキュメントおよびドキュメントのメタデータは含まれません。ポータビリティトークン形式の場合は、Swipelux の customerId ではなく、受け取り側の KYC プロジェクトのクライアント ID を forClientId として送信してください。返された data.token は data.expiresAt より前に使用してください。同じ Idempotency-Key とボディを再利用すると、そのトークンの結果が再生されます。別のトークンを発行するには新しいキーを使用してください。

ケイパビリティから ready 状態を読み取る

顧客自体には、API における検証や ready 状態はありません。現在のプロファイルデータを取得するには GET /v3/customers/{customerId} で顧客を読み取り、ケイパビリティとその openTaskIds を使って、顧客が次に何をできるかを判断してください。

Get customer

curl --request GET \
  "${API_BASE}/v3/customers/${CUSTOMER_ID}" \
  --header "X-API-Key: ${SWIPELUX_API_KEY}"

未提出の書類がある顧客を見つける

ページ内のどの顧客に必須書類がまだ残っているかを確認するには、GET /v3/customers に include=documentRequirements を渡します。include=capabilities,documentRequirements のように、ケイパビリティのサマリーと組み合わせることもできます。documentRequirements 展開には、API キーに accounts:read が必要です。各顧客サマリーには、documentRequirements オブジェクトが含まれます。

Document requirement summary

{
  "documentRequirements": {
    "required": true,
    "count": 2
  }
}

count は、同じく action_required であるタスク上の、action_required 状態の必須書類要件の数です。口座全体のタスクを含むすべてのタスクスコープを対象とし、ケイパビリティの ready 状態には依存しません。
count が 0 より大きい場合、required は true になります。
代替手段のセットは 1 回だけカウントされ、すべての代替手段が書類を必要とする場合にのみカウントされます。

このサマリーは保守的です。任意の書類、条件付きで必須となる書類、および書類による手段と書類以外の手段が混在する代替手段は除外されます。顧客がホスト型検証で完了できる要件も除外されます。そのため、required: false は書類タスクが適用されないことの証明にはなりません。顧客の優先順位付けに使用し、収集すべき内容の正式なリストについては顧客のタスクを読み取ってください。展開を指定しない場合、レスポンスには documentRequirements が含まれません。次に、必要な製品成果を発見して有効化するためにケイパビリティとタスクに進んでください。

はじめに

顧客のオンボーディング

資金フローの構築

ローンチ

顧客

個人顧客

ビジネス顧客

ケイパビリティから ready 状態を読み取る

未提出の書類がある顧客を見つける

​個人顧客

​ビジネス顧客

​ビジネスの関連当事者を追加する

​ケイパビリティから ready 状態を読み取る

​未提出の書類がある顧客を見つける

個人顧客

ビジネス顧客

ビジネスの関連当事者を追加する

ケイパビリティから ready 状態を読み取る

未提出の書類がある顧客を見つける