CLIP Credit SDK 및 REST API 사용 가이드
npm install @clip/creditimport { 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 -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"/api/v1/ocr_json문서 OCR + 자동 분류 + 핵심정보 추출
| 파라미터 | 타입 | 필수 | 설명 |
|---|---|---|---|
| file | File | ✓ | 분석할 문서 파일 (PDF, PNG, JPG) |
| ClassifyDocument | boolean | 문서 유형 자동 분류 | |
| ExtractKeyInformation | boolean | 핵심 정보 추출 |
/api/v1/pipelines/{slug}커스텀 파이프라인 실행
| 파라미터 | 타입 | 필수 | 설명 |
|---|---|---|---|
| file | File | ✓ | 분석할 문서 파일 |
/api/v1/sdk/configSDK 설정 조회 (기능, 한도, 문서 타입 목록)
| SDK 메서드 | documentType | 설명 |
|---|---|---|
| creditRatingReport() | credit_rating_report | 신용평가보고서 |
| financialStatement() | financial_statement | 재무제표 |
| auditReport() | audit_report | 감사보고서 |
| businessRegistration() | business_registration | 사업자등록증 |
| corporateRegistry() | corporate_registry | 법인등기부등본 |
모든 API 요청에 x-api-key 헤더를 포함해야 합니다. API 키는 대시보드에서 발급받을 수 있습니다.