Documentation

API 문서

Fidox API를 사용하여 얼굴 인식, 신분증 OCR, 라이브니스 탐지 기능을 연동하세요.

시작하기

Base URL

https://api.fidox.co/v1

개발 환경: https://dev-ekyc-api.i-janus.com/v1

요청 헤더

Content-Type: application/json

이미지 형식

모든 이미지는 Base64로 인코딩되어 전송됩니다. 지원 형식: JPEG, PNG, WebP (최대 10MB)

얼굴 인식 (FR)

EZway, Applemango 멀티 엔진 지원. 자동 폴백 활성화.

POST/v1/fr/register

사용자 얼굴을 FR 엔진에 등록

Request Body

{
  "userCode": "string",     // 사용자 고유 코드
  "image": "string",        // Base64 인코딩 이미지
  "engine": "ezway"         // 선택: ezway | applemango
}

Response

{
  "success": true,
  "message": "등록 완료",
  "trxId": "uuid"
}

POST/v1/fr/verify

등록된 얼굴과 비교하여 본인 인증

Request Body

{
  "userCode": "string",
  "image": "string",
  "context": "login"        // login | monitoring | general
}

Response

{
  "success": true,
  "score": 0.95,
  "isMatch": true,
  "threshold": 0.7,
  "engine": "ezway",
  "trxId": "uuid"
}

POST/v1/fr/compare

두 이미지의 얼굴을 1:1 비교 (신분증 vs 셀카)

Request Body

{
  "image1": "string",       // 기준 이미지 (예: 신분증)
  "image2": "string"        // 비교 대상 (예: 셀카)
}

Response

{
  "success": true,
  "score": 0.92,
  "isMatch": true,
  "trxId": "uuid"
}

POST/v1/fr/count

이미지 내 얼굴 수 카운트

Request Body

{
  "image": "string"
}

Response

{
  "success": true,
  "count": 1,
  "trxId": "uuid"
}

DELETE/v1/fr/register/{userCode}

FR 엔진에서 등록된 얼굴 삭제

Response

{
  "success": true,
  "message": "삭제 완료"
}

신분증 OCR

주민등록증, 운전면허증, 여권, 외국인등록증 지원.

POST/v1/ocr/recognize

신분증 이미지에서 텍스트 정보 추출

Request Body

{
  "image": "string",
  "idType": "DRIVER"        // RESIDENT | DRIVER | PASSPORT | FOREIGN
}

Response

{
  "success": true,
  "data": {
    "idType": "DRIVER",
    "name": "홍길동",
    "idNum": "******-*******",   // 마스킹 처리
    "birthDate": "1990-01-01",
    "details": {
      "licenseNo": "12-34-567890-12",
      "licenseType": "1종보통",
      "address": "서울시 강남구...",
      "issueDate": "2020-01-01",
      "expiryDate": "2030-01-01"
    }
  },
  "confidence": 0.98,
  "trxId": "uuid"
}

라이브니스

딥페이크, 사진 공격, 마스크 착용 탐지.

POST/v1/liveness/detect

위변조 여부 탐지 (딥페이크, 사진 공격 등)

Request Body

{
  "image": "string",
  "checkType": "all"        // deepfake | photo | mask | all
}

Response

{
  "success": true,
  "isReal": true,
  "confidence": 0.99,
  "checks": {
    "deepfake": false,
    "photoAttack": false,
    "mask": false
  },
  "trxId": "uuid"
}

에러 코드

코드	HTTP	설명
`40102`	401	잘못된 Access Key
`40104`	401	잘못된 Secret Key
`40105`	401	Access Token 만료
`40107`	401	Tenant Token 만료
`40402`	404	사용자 없음
`4040A`	404	이미지에서 얼굴 없음
`4040B`	404	이미지에서 신분증 없음
`40901`	409	FR 서버 연결 실패
`40904`	409	OCR 처리 오류
`40910`	409	이미지에서 얼굴 감지 불가
`40915`	409	미등록 사용자
`40923`	409	다중 얼굴 감지
`40924`	409	얼굴 불일치

도움이 필요하신가요?

API 연동 중 문제가 발생하면 기술 지원팀에 문의해주세요. Swagger UI에서 실시간으로 API를 테스트할 수도 있습니다.

기술 지원 문의 Swagger UI