ドキュメント/SDK /

SDK

iOS、Android、Web プラットフォーム用の公式クライアントライブラリと SDK。包括的なサンプルとのネイティブ統合。

JavaScript / TypeScript

v2.1.0

Full-featured SDK for Node.js and browser environments. Supports all FreshCredit APIs with type definitions.

インストール

npm install @freshcredit/sdk

例

import { FreshCredit } from '@freshcredit/sdk';

const client = new FreshCredit({
  apiKey: process.env.FRESHCREDIT_API_KEY,
  apiSecret: process.env.FRESHCREDIT_API_SECRET,
});

// Verify identity
const verification = await client.blockid.verify({
  userId: 'user_123',
  type: 'kyc_basic',
});

// Generate credit score
const score = await client.blockscore.score({
  userId: 'user_123',
  modelId: 'model_custom_456',
});

iOS (Swift)

v2.0.1

GitHub →

Native Swift SDK for iOS apps. Full support for BlockID™ identity verification and wallet management.

インストール

pod 'FreshCredit'

例

import FreshCredit

let client = FreshCredit(
    apiKey: "fc_live_xxxxxxxxxxxxxxxx",
    apiSecret: "fc_secret_xxxxxxxxxxxxxxxx"
)

// Verify identity
let verification = try await client.blockID.verify(
    userId: "user_123",
    type: .kycBasic
)

// Get credit score
let score = try await client.blockScore.score(
    userId: "user_123",
    modelId: "model_custom_456"
)

Android (Kotlin)

v2.1.0

GitHub →

Native Kotlin SDK for Android. Comprehensive API coverage with coroutine support.

インストール

implementation 'com.freshcredit:sdk:2.1.0'

例

import com.freshcredit.sdk.FreshCredit

val client = FreshCredit(
    apiKey = "fc_live_xxxxxxxxxxxxxxxx",
    apiSecret = "fc_secret_xxxxxxxxxxxxxxxx"
)

// Verify identity
val verification = client.blockID.verify(
    userId = "user_123",
    type = VerificationType.KYC_BASIC
).await()

// Get credit score
val score = client.blockScore.score(
    userId = "user_123",
    modelId = "model_custom_456"
).await()

Python

v2.0.3

GitHub →

Python SDK for backend integrations and data science workflows. Async support with aiohttp.

インストール

pip install freshcredit

例

from freshcredit import FreshCredit

client = FreshCredit(
    api_key="fc_live_xxxxxxxxxxxxxxxx",
    api_secret="fc_secret_xxxxxxxxxxxxxxxx"
)

# Verify identity
verification = client.blockid.verify(
    user_id="user_123",
    type="kyc_basic"
)

# Generate credit score
score = client.blockscore.score(
    user_id="user_123",
    model_id="model_custom_456"
)

Go

v2.0.0

GitHub →

Go SDK for high-performance backend services. Full context support for cancellation and timeouts.

インストール

go get github.com/freshcredit/go-sdk

例

package main

import (
    "context"
    "github.com/freshcredit/go-sdk"
)

func main() {
    client := freshcredit.New(
        "fc_live_xxxxxxxxxxxxxxxx",
        "fc_secret_xxxxxxxxxxxxxxxx",
    )
    
    // Verify identity
    verification, _ := client.BlockID.Verify(context.Background(),
        &freshcredit.VerifyRequest{
            UserID: "user_123",
            Type:   "kyc_basic",
        },
    )
}

Rust

v2.0.0

GitHub →

Rust SDK for systems programming and WebAssembly. Memory-safe implementation matching our core infrastructure.

インストール

cargo add freshcredit

例

use freshcredit::Client;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new(
        "fc_live_xxxxxxxxxxxxxxxx",
        "fc_secret_xxxxxxxxxxxxxxxx",
    )?;
    
    // Verify identity
    let verification = client
        .blockid()
        .verify("user_123", "kyc_basic")
        .await?;
    
    Ok(())
}

SDK機能 /

自動 HMAC 署名

すべての SDK は、HMAC-SHA256 を使用してリクエストに自動的に署名します。手動で署名を計算する必要はありません。

再試行ロジックと指数バックオフ

回復力を高めるための構成可能な指数バックオフを備えた組み込みの再試行メカニズム。

タイプセーフティ

TypeScript、Swift、Kotlin、Rust における完全な型定義とコンパイル時の安全性。

Webhook ヘルパー

Webhook 署名検証とペイロード解析のためのユーティリティ関数。

次のステップ

はじめる BlockID™を見る

import { FreshCredit } from '@freshcredit/sdk'; const client = new FreshCredit({ apiKey: process.env.FRESHCREDIT_API_KEY, apiSecret: process.env.FRESHCREDIT_API_SECRET, }); // Verify identity const verification = await client.blockid.verify({ userId: 'user_123', type: 'kyc_basic', }); // Generate credit score const score = await client.blockscore.score({ userId: 'user_123', modelId: 'model_custom_456', });

import FreshCredit let client = FreshCredit( apiKey: "fc_live_xxxxxxxxxxxxxxxx", apiSecret: "fc_secret_xxxxxxxxxxxxxxxx" ) // Verify identity let verification = try await client.blockID.verify( userId: "user_123", type: .kycBasic ) // Get credit score let score = try await client.blockScore.score( userId: "user_123", modelId: "model_custom_456" )

import com.freshcredit.sdk.FreshCredit val client = FreshCredit( apiKey = "fc_live_xxxxxxxxxxxxxxxx", apiSecret = "fc_secret_xxxxxxxxxxxxxxxx" ) // Verify identity val verification = client.blockID.verify( userId = "user_123", type = VerificationType.KYC_BASIC ).await() // Get credit score val score = client.blockScore.score( userId = "user_123", modelId = "model_custom_456" ).await()

from freshcredit import FreshCredit client = FreshCredit( api_key="fc_live_xxxxxxxxxxxxxxxx", api_secret="fc_secret_xxxxxxxxxxxxxxxx" ) # Verify identity verification = client.blockid.verify( user_id="user_123", type="kyc_basic" ) # Generate credit score score = client.blockscore.score( user_id="user_123", model_id="model_custom_456" )

package main import ( "context" "github.com/freshcredit/go-sdk" ) func main() { client := freshcredit.New( "fc_live_xxxxxxxxxxxxxxxx", "fc_secret_xxxxxxxxxxxxxxxx", ) // Verify identity verification, _ := client.BlockID.Verify(context.Background(), &freshcredit.VerifyRequest{ UserID: "user_123", Type: "kyc_basic", }, ) }

use freshcredit::Client; #[tokio::main] async fn main() -> Result<(), Box<dyn std::error::Error>> { let client = Client::new( "fc_live_xxxxxxxxxxxxxxxx", "fc_secret_xxxxxxxxxxxxxxxx", )?; // Verify identity let verification = client .blockid() .verify("user_123", "kyc_basic") .await?; Ok(()) }