ReCORE.co-api

本人確認

本人確認検索

概要

• 本人確認の検索を行う

基本情報

• リクエストパス: GET /identifications
• JWTスコープ: identification:index
• 必須個別JWTパラメータ: なし
• レートリミット: 5 rps

query

key	説明	制約など
ids	ケースID	整数のみ、カンマ区切りで複数指定可能
statuses	ステータス	カンマ区切りで複数指定可能
created_at_from	作成日から	2024-04-12 12:08:38 形式
created_at_to	作成日まで	同上
updated_at_from	更新日から	同上
updated_at_to	更新日まで	同上
referable_ids	関連先ID	整数のみ、カンマ区切りで複数指定可能
referable_type	関連先タイプ	-
methods	本人確認方法	カンマ区切りで複数指定可能
page	ページ	整数のみ、デフォルト:1
limit	1ページあたりの件数	整数のみ、デフォルト:50、最大: 250
cursor	ページカーソル	-

例

• Request

GET /identifications?statuses=CONFIRMED

• Response

[
  {
    "id": 124,
    "method": "EKYC",
    "status": "CONFIRMED",
    "document_type": null,
    "document_number": null,
    "expires_on": null,
    "note": null,
    "referable_id": 245,
    "referable_type": "rt_bas",
    "created_at": 1727678325,
    "updated_at": 1727678325,
    "attachments": [],
    "form_url": "https://..."
  }
]

key	type	説明
*	array<object>	本人確認
*.id	int	本人確認ID
*.method	string	本人確認方法
*.status	string	ステータス
*.document_type	string | null	書類種別
*.document_number	string | null	書類番号
*.expires_on	string | null	有効期限
*.note	string | null	メモ
*.referable_id	int | null	関連先ID
*.referable_type	string | null	関連先タイプ
*.created_at	int | null	作成日時
*.updated_at	int | null	更新日時
*.attachments	array<object>	ファイル
*.attachments.*.id	int	ファイルID
*.attachments.*.file_key	string	ファイルキー
*.attachments.*.tag	string	タグ
*.attachments.*.file_name	string | null	ファイル名
*.attachments.*.url	string	一時URL (*1)
*.attachments.*.mime_type	string	MIMEタイプ
*.form_url	string | null	お客様操作用URL

• *1) 一時的なURLなので保存等はしない
• 本人確認方法
  • IN_PERSON 対面
  • BY_POST 非対面
  • EKYC eKYC
• ステータス
  • IN_PROGRESS 入力中
  • SUBMITTED 入力中 (顧客済)
  • CONFIRMING 確認待ち
  • CONFIRMED 確認済み
• 書類種別
  • DRIVERS_LICENSE 運転免許証
  • PASSPORT パスポート
  • HEALTH_INSURANCE 健康保険証
  • RESIDENCE_CARD 在留カード
  • OTHER その他
• 関連先タイプ
  • rt_bas 店頭買取
  • rt_bad 宅配買取
  • rt_member 会員

本人確認取得

概要

• 本人確認を1件取得する

基本情報

• リクエストパス: GET /identifications/{identification_id}
• JWTスコープ: identification:show
• 必須個別JWTパラメータ: なし
• レートリミット: 5 rps

例

• Request

GET /identifications/44

• Response

本人確認検索のresponse[0]と同様

本人確認作成

概要

• 本人確認を作成する

基本情報

• リクエストパス: POST /identifications
• JWTスコープ: identification:store
• 必須個別JWTパラメータ: なし
• レートリミット: 2 rps

body

key	type	説明	制約など
method	string	本人確認方法	-
document_type	?string | null	身分証種類	DRIVERS_LICENSE PASSPORT HEALTH_INSURANCE RESIDENCE_CARD OTHER のいずれか
document_number	?string | null	身分証番号	30文字まで
expires_on	?string | null	有効期限	YYYY-MM-DD形式
note	?string | null	メモ	-
referable_id	?int | null	関連先ID	-
referable_type	?string | null	関連先タイプ	-

例

• Request

POST /identifications

{
  "method": "EKYC",
  "referable_id": 2,
  "referable_type": "rt_member"
}

• Response

本人確認取得と同様

本人確認更新

概要

• 本人確認を更新する

基本情報

• リクエストパス: PUT /identifications/{identification_id}
• JWTスコープ: identification:update
• 必須個別JWTパラメータ: なし
• レートリミット: 2 rps

body

本人確認作成との差分のみ記載

key	type	説明	制約など
method	-	(更新不可)	-

例

• Request

PUT /identifications/44

{
  "note": "メモ"
}

• Response

本人確認取得と同様

本人確認削除

概要

• 本人確認を削除する

基本情報

• リクエストパス: DELETE /identifications/{identification_id}
• JWTスコープ: identification:destroy
• 必須個別JWTパラメータ: なし
• レートリミット: 2 rps

例

• Request

DELETE /identifications/44

• Response

なし

本人確認ステータス更新

概要

• 本人確認のステータスを更新する

基本情報

• リクエストパス: PUT /identifications/{identification_id}/status
• JWTスコープ: identification:status:update
• 必須個別JWTパラメータ: なし
• レートリミット: 2 rps

body

key	type	説明	制約など
status	string	変更後ステータス	(*1)

• *1) ステータス遷移の制約 (本人確認方法により異なる):
  • 対面 (IN_PERSON):
    • IN_PROGRESS → CONFIRMED
    • CONFIRMED: 他のステータスへ変更不可
  • 非対面 (BY_POST):
    • IN_PROGRESS → SUBMITTED
    • SUBMITTED → CONFIRMING
    • CONFIRMING → SUBMITTED CONFIRMED
    • CONFIRMED: 他のステータスへ変更不可
  • eKYC:
    • IN_PROGRESS → SUBMITTED
    • CONFIRMING → CONFIRMED
    • CONFIRMED: 他のステータスへ変更不可

例

• Request

PUT /identifications/44/status

{
  "status": "CONFIRMED"
}

• Response

なし

本人確認コピー

概要

• 本人確認を特定の関連先へコピーする

基本情報

• リクエストパス: POST /identifications/replicate
• JWTスコープ: identification:replicate:store
• 必須個別JWTパラメータ: なし
• レートリミット: 2 rps

body

key	type	説明	制約など
src_referable_id	int	コピー元の関連先ID	-
src_referable_type	string	コピー元の関連先タイプ	-
dist_referable_id	int	コピー先の関連先ID	-
dist_referable_type	string	コピー先の関連先タイプ	-
methods	?array<string>	コピーする本人確認方法	-

• コピー先に同じデータがある場合は無視されます
• コピー元のステータスがCONFIRMEDの場合、コピー先の既存の同じ本人確認方法をもつデータは削除されます（完全置換）
• コピー元のステータスがCONFIRMEDの以外の場合、コピー先に同じ本人確認方法をもつデータがない場合に限りコピーされます

例

• Request

PUT /identifications/44/replicate

{
  "src_referable_id": 11,
  "src_referable_type": "rt_member",
  "dist_referable_id": 44,
  "dist_referable_type": "rt_bad",
  "methods": ["EKYC"]
}

• Response

なし

本人確認ファイル登録

概要

• 本人確認のファイルを登録する

基本情報

• リクエストパス: POST /identifications/{identification_id}/attachments
• JWTスコープ: identification:attachment:store
• 必須個別JWTパラメータ: なし
• レートリミット: 2 rps

body

key	type	説明	制約など
file_key	string	ファイルキー (*1)	-
tag	string	タグ	(*2)
file_name	?string | null	ファイル名	100文字まで

• *1) ファイルアップロード(機密ファイル)で取得したファイルキーを使用
• *2) 使用できるタグ
  • IDENTIFICATION 本人確認

例

• Request

POST /identifications/44/attachments

{
  "file_key": "PdoJcUm1wtopvpX5goCSB36GR45FGuRJCrQAsvky.jpg",
  "tag": "IDENTIFICATION"
}

• Response

本人確認取得のattachments[0]と同様

本人確認ファイル削除

概要

• 本人確認のファイルを削除する

基本情報

• リクエストパス: DELETE /identifications/{identification_id}/attachments/{attachment_id}
• JWTスコープ: identification:attachment:destroy
• 必須個別JWTパラメータ: なし
• レートリミット: 2 rps

例

• Request

DELETE /identifications/44/attachments/123

• Response

なし