メインコンテンツまでスキップ

外部システム連携用インターナルAPI (1.0.0)

Download OpenAPI specification:Download

身元確認申込みコールバック

身元確認結果の審査結果を登録するためのコールバックAPI。

身元確認申込みコールバック(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:
Basic
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

Content type
application/json
{
  • "application_number": "abcdefg012345",
  • "examination_status": "審査中",
  • "comment": "審査開始"
}

Response samples

Content type
application/json
{
  • "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:
Basic
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/json
optional

テンプレートで定義されたスキーマに従うリクエストボディ。 内容は verification-type および verification-process ごとに異なる。

object

Responses

Request samples

Content type
application/json
{
  • "application_number": "abcdefg012345",
  • "examination_status": "承認",
  • "result": {
    }
}

Response samples

Content type
application/json
{
  • "id": "565b030e-04b5-45eb-989e-136e3623dc7d",
  • "application_number": "abcdefg012345"
}

身元確認結果登録

身元確認結果を登録するためのAPI