API 문서

CLIP Credit SDK 및 REST API 사용 가이드

SDK 설치

npm install @clip/credit

SDK 사용법

import { Clip } from '@clip/credit';

const clip = Clip({
  apiKey: 'sk-...',
  baseUrl: 'https://clip-credit.floaterlab.com/api/v1',
});

// 1. 자동 분류 + 추출
const result = await clip.extract(file);
// result.documentType → 'credit_rating_report'
// result.data → CreditRatingReport

// 2. 특정 문서 타입 지정
const report = await clip.creditRatingReport(file);
console.log(report.data.creditRating);   // 'AA+'
console.log(report.data.companyName);    // '주식회사 ...'

const fs = await clip.financialStatement(file);
console.log(fs.data.balanceSheet.totalAssets);
console.log(fs.data.incomeStatement.revenue);

const audit = await clip.auditReport(file);
console.log(audit.data.auditOpinion);    // '적정'

const biz = await clip.businessRegistration(file);
console.log(biz.data.businessNumber);    // '123-45-67890'

const corp = await clip.corporateRegistry(file);
console.log(corp.data.directors);        // [{ name, position }]

cURL 예시

curl -X POST https://clip-credit.floaterlab.com/api/v1/ocr_json \
  -H "x-api-key: sk-..." \
  -F "file=@credit_report.pdf" \
  -F "ClassifyDocument=true" \
  -F "ExtractKeyInformation=true"

REST API 엔드포인트

POST/api/v1/ocr_json

문서 OCR + 자동 분류 + 핵심정보 추출

파라미터타입필수설명
fileFile분석할 문서 파일 (PDF, PNG, JPG)
ClassifyDocumentboolean문서 유형 자동 분류
ExtractKeyInformationboolean핵심 정보 추출
POST/api/v1/pipelines/{slug}

커스텀 파이프라인 실행

파라미터타입필수설명
fileFile분석할 문서 파일
GET/api/v1/sdk/config

SDK 설정 조회 (기능, 한도, 문서 타입 목록)

지원 문서 타입

SDK 메서드documentType설명
creditRatingReport()credit_rating_report신용평가보고서
financialStatement()financial_statement재무제표
auditReport()audit_report감사보고서
businessRegistration()business_registration사업자등록증
corporateRegistry()corporate_registry법인등기부등본

인증

모든 API 요청에 x-api-key 헤더를 포함해야 합니다. API 키는 대시보드에서 발급받을 수 있습니다.