Introduction
Overview
본 문서는 SELVAS AI의 사업자등록증 인식 솔루션인 Selvy OCR for Business Registration Server의 API 가이드입니다.
Selvy OCR for Business Registration는 사업자등록증을 스캔, 복사한 이미지에서 각 필드 정보를 인식합니다.
HTTP를 이용하여 통신하며, Request/Response 시에 전달되는 정보는 json을 사용합니다.
사진 지원 규격
| 항목 | 지원 규격 |
|---|---|
파일 형식 |
jpg, png |
인식 최소 해상도 |
8MP 이상 |
인식 가능 대상 |
사업자 등록증 |
인식 필드 정보
사업자등록증 인식 API는 다음과같은 필드의 인식을 지원 함
| 문서 종류 | 인식 필드 |
|---|---|
사업자등록증 |
과세유형, 등록번호, 법인명(단체명), 대표자, 개업연월일, 법인등록번호, 사업장소재지, 본점소재지, 사업의종류, 종목, 발급사유, 사업자단위과세적용사업자여부, 발급일, 발급권자 |
인식 요청 API 구조
-
신분증을 촬영한 이미지로 인식을 요청한다. 인식 성공 시 신분증 종류와 각 필드 별 인식 결과를 응답으로 받는다
| 항목 | 값 | 설명 |
|---|---|---|
command |
/api/document/br/recognize |
사업자등록증 이미지로 인식을 요청한다 |
header |
'x-api-key' = [API-KEY] |
라이선스 인증을 위한 API-KEY로 올바르지 않은 API-KEY 전달 시 에러 코드 1을 리턴한다 |
JSON body |
“image” |
Base64로 encode 된 사업자등록증 이미지 |
<요청 예>
POST /api/document/br/recognize
Host: xxx.xxx.xxx.xxx
Content-Type: application/json
Content-Length: [length]
x-api-key: ES0c0dLoJUJZ5hg/5huHQt0eiLCUUJZgoxueL+Vpuyw=
{
"data":“/9j/4AAAQSk ……… Xg0wp//Z"
}인식 요청 응답 구조
-
인식이 요청되었을 경우, HTTP 응답은 200 코드와 응답 정보를 리턴 함
-
응답의 body는 인식에 대한 결과 코드와 인식 결과 데이터를 포함함
-
JSON body의 [“code”] 값을 통하여 응답에 대한 정보를 제공함
| 항목 | 키 | 값 | 설명 |
|---|---|---|---|
JSON body |
“code” |
0 |
인식 성공 |
1 |
올바른 API-KEY가 아님 |
||
2 |
올바른 라이선스가 아님 |
||
3 |
Request Body의 형식에 오류가 있음 |
||
4 |
올바른 이미지 데이터가 아님 |
||
5 |
인식 실패 |
||
“data” |
"fields" |
인식 결과 필드 배열 |
|
"imageSize" |
이미지 크기 |
||
"roiImage" |
인식 영역 위치 |
||
"processingTime" |
인식에 소요된 시간 |
-
인식 결과 "fields" 는 다음의 요소로 구성된 리스트
키 |
설명 |
|---|---|
"key" |
항목 타이틀 |
"probability" |
신뢰도 |
"roi" |
이미지내에서 해당 항목 위치 [LT, RT, RB, LB] |
"type" |
항목 종류 |
"value" |
인식 값 |
<응답 예>
HTTP/1.1 200 OK
Content-Type: application/json
{
"code": 0,
"data": "{"fields":[{"key":"셀바스에이아이","probability":0.8650994300842285,"roi":[[442,1430],[895,1427],[895,1481],[443,1485]],"type":99,"value":"(인)"},{"key":"사업자단위과세적용사업자여부","probability":0.9670384526252747,"roi":[[114,1302],[825,1302],[825,1338],[114,1338]],"type":12,"value":"여(v) 부( )"},{"key":"사업의종류","probability":0.9655197262763977,"roi":[[113,773],[503,773],[503,956],[113,956]],"type":8,"value":"도소매|제조|도소매|소매|서비스|서비스|서비스"},{"key":"본점소재지","probability":0.9893342852592468,"roi":[[119,705],[1019,705],[1019,737],[119,737]],"type":7,"value":"서울특별시 금천구 가산동 대륭테크노타운 18차"}, ... "imageSize":[1241,1755],"roiImage":[[78,184],[1133,184],[1133,1708],[78,1708]]}"
}