@quicktrust/quicktrust-sdk

Quick Trust API および Webhook の型安全なスキーマを提供する SDK です。

インストール

npm install @quicktrust/quicktrust-sdk
# または
pnpm add @quicktrust/quicktrust-sdk

使用方法

Webhook ペイロードの検証

import {
  type WebhookPayload,
  WebhookPayloadSchema,
} from '@quicktrust/quicktrust-sdk';

// Webhook リクエストボディを検証
const result = WebhookPayloadSchema.safeParse(req.body);
if (result.success) {
  const payload: WebhookPayload = result.data;

  if (payload.event === 'verification.approved') {
    // 承認時の処理
  } else if (payload.event === 'verification.rejected') {
    // 拒否時の処理
  } else if (payload.event === 'verification.manually_reviewed') {
    // 手動レビュー完了時の処理
  }
}

API クライアントの型付け

import {
  type VerificationSessionCreateInput,
  type VerificationSessionCreateResponse,
  verificationSessionContract,
} from '@quicktrust/quicktrust-sdk';
// ts-rest クライアントで使用
import { initClient } from '@ts-rest/core';

const client = initClient(verificationSessionContract, {
  baseUrl: 'https://api.quicktrust.example.com',
  baseHeaders: {
    'X-API-Key': 'your-api-key',
  },
});

// 型安全な API 呼び出し
const response = await client.create({
  body: {
    callbackUrl: 'https://your-app.com/callback',
  },
});

エクスポート一覧

Webhook スキーマ

• WebhookPayloadSchema - Webhook ペイロード
• WebhookReviewSchema - 手動レビュー情報（手動レビュー時のみ存在）
• WebhookVerificationResultSchema - 検証結果サマリ（手動レビュー時のみ存在）

Verification Session

• verificationSessionContract - セッション API Contract
• VerificationSessionCreateSchema - セッション作成リクエスト
• VerificationSessionDetailSchema - セッション詳細レスポンス

Identification

• identificationContract - 本人確認 API Contract
• IdentificationSchema - 本人確認結果
• DecisionResultSchema - 判定結果

共通

• ErrorSchema - API エラーレスポンス
• VerificationDocumentTypeSchema - ドキュメント種別

ライセンス

MIT