外部システム連携用インターナルAPI (1.0.0)
Download OpenAPI specification:Download
身元確認申込みコールバック(body:id)
指定された verification-type(テンプレート種別)および verification-process(申込み処理タイプ)に従い、 身元確認申込みのコールバック結果を処理します。
verification-typeはテンプレートのtypeに対応verification-processはテンプレート内のprocessesのキーに対応(例: apply, request-ekyc など)
リクエストボディはテンプレートで定義された request.schema に基づいてバリデーションされ、
必須項目の漏れや形式の不正がある場合はエラーになります。
正常に処理された場合は、response.body_mapping_rules に従いレスポンスを返却します。
さらに、審査が承認された場合はテンプレートの result.verified_claims result.source_detailsに従い身元確認結果が登録されます。
Authorizations:
path Parameters
| tenant-id required | string |
| verification-type required | string Example: my_number |
| verification-process required | string Example: capture |
Request Body schema: application/json
テンプレートで定義されたスキーマに従うリクエストボディ。
内容は verification-type および verification-process ごとに異なる。
※テンプレートのcommonへの設定および、申込み詳細(application_details)から申込みを特定できるパラメータを含める必要があります。
例:application_number
{ "id": "UUID", "type": "investment-account-opening" "common": { "external_service": "mocky", "callback_application_id_param": "application_number" }, "processes": {}, "result: {} }
| property name* additional property | any テンプレートで定義されたスキーマに従う |
Responses
Request samples
- Payload
{- "application_number": "abcdefg012345",
- "examination_status": "審査中",
- "comment": "審査開始"
}Response samples
- 200
- 400
- 401
- 403
{- "id": "565b030e-04b5-45eb-989e-136e3623dc7d",
- "application_number": "abcdefg012345"
}身元確認申込みコールバック(path:id)
指定された verification-type(テンプレート種別)および verification-process(申込み処理タイプ)に従い、 身元確認申込みのコールバック結果を処理します。
verification-typeはテンプレートのtypeに対応verification-processはテンプレート内のprocessesのキーに対応(例: apply, request-ekyc など)
リクエストボディはテンプレートで定義された request.schema に基づいてバリデーションされ、
必須項目の漏れや形式の不正がある場合はエラーになります。
正常に処理された場合は、response.body_mapping_rules に従いレスポンスを返却します。
さらに、審査が承認された場合はテンプレートの result.verified_claims result.source_detailsに従い身元確認結果が登録されます。
Authorizations:
path Parameters
| tenant-id required | string |
| verification-type required | string Example: my_number |
| verification-process required | string Example: capture |
| id required | string <uuid> |
Request Body schema: application/jsonoptional
テンプレートで定義されたスキーマに従うリクエストボディ。
内容は verification-type および verification-process ごとに異なる。
Responses
Request samples
- Payload
{- "application_number": "abcdefg012345",
- "examination_status": "承認",
- "result": {
- "identity_verification_doc": "運転免許証",
- "ekyc_provider": "trust_service",
- "last_name": "伊藤",
- "first_name": "一朗",
- "birthdate": "1990-01-01",
- "email_address": "ichiro@example.com"
}
}Response samples
- 200
- 400
- 401
- 403
{- "id": "565b030e-04b5-45eb-989e-136e3623dc7d",
- "application_number": "abcdefg012345"
}