본문 바로가기
개발가이드진위 확인서류 원본 확인 묶음

서류 원본 확인 묶음 API

명세 내보내기
OpenAPI 3.0.3Postman 컬렉션Markdown

registry_doc_verify, tax_cert_verify 을(를) 한 번의 요청으로 함께 조회합니다. 구성원마다 결과가 성공·실패로 나뉘어 돌아옵니다.

POSThttps://apick.app/rest/data_result_doc_verify_bundle
인증
Bearer 키
요청 형식
form-data
응답
JSON
경로
1개

알아둘 점

요청 한 번으로 담긴 조회 2종을 함께 받습니다. 접수·인증 대기 단계가 없고, 응답에 구성원별 성공(results)·실패(failures)가 함께 돌아옵니다.

/rest/data_result_doc_verify_bundle
84P · 한 번의 요청으로 완료

이용 전 확인

이 묶음에는 아래 2종 조회가 들어 있습니다.

  • registry_doc_verify
  • tax_cert_verify

요청이 처리되면 묶음 단가 84P가 한 번 차감됩니다. 접수·인증 대기 단계가 없어 요청 하나가 곧 조회이며, 구성원이 하나도 성공하지 못하면 success 가 false 로 돌아옵니다.

입력은 담긴 조회가 쓰는 항목의 합집합입니다. 각 구성원은 자기가 쓰는 항목만 읽고, 모자란 항목은 그 구성원만 failures 로 실립니다.

인증키는 서버 환경변수에 보관하고 브라우저·앱에 넣지 마세요. 공통 규칙은 연동 전에 확인하세요를 참고하세요.

요청과 응답

API 요청
POST/rest/data_result_doc_verify_bundle
  • Bearer 인증
  • multipart/form-data
  • JSON 응답
요청 파라미터 5개
파라미터
설명
issue_nostring조건부
발급확인번호 12자리입니다. 등기 문서 확인 조회에 씁니다. 문자열로 보내며, 생략하면 서버 기본값이 적용되거나 해당 조건이 해제됩니다.
예시
…
kindstring선택
문서 종류입니다. 기본 <code>realestate</code>입니다.
예시
…
cert_nostring조건부
증명서 발급번호 14자리입니다. 납세증명서 확인 조회에 씁니다. 문자열로 보내며, 생략하면 서버 기본값이 적용되거나 해당 조건이 해제됩니다.
예시
…
txpr_nostring조건부
등록번호입니다(주민 앞 6자리 또는 사업자등록번호 10자리). 납세증명서 확인 조회에 씁니다.
예시
…
txpr_clsfstring선택
납세자 구분(<code>01</code> 개인·<code>02</code> 사업자)입니다. 생략하면 자동 판정합니다.
예시
…
응답 필드 14개
응답 필드
설명
dataobject
요청 처리 결과 묶음입니다. 조회한 값·작업 상태·오류 설명이 이 안에 들어 있으며, 실제 하위 필드 구성은 서비스마다 다릅니다. 값이 없으면 null·빈 배열·필드 생략 중 해당 서비스의 규칙을 따릅니다.
data.successboolean
업무 처리 결과 코드입니다. 1은 정상 결과, 0은 실패 또는 무료 응답입니다. 서비스에 따라 2·3처럼 추가 코드를 쓰므로 같은 응답의 status·msg·error 필드도 함께 확인하세요. true = 업무 처리까지 정상 완료된 경우, false = 대상 없음·조회 실패로 결과를 쓸 수 없는 경우입니다. api.success와 다를 수 있으므로 두 값을 함께 보세요.
data.productstring
조회한 상품 코드입니다. 인증요청 때 보낸 product와 같은 값이며, 응답의 result 구조를 해석할 때 기준이 됩니다.
data.membersarray
이 묶음에 담긴 구성원 코드 목록입니다. 각 항목의 구성은 서비스에 따라 다르며, 값이 없으면 빈 배열입니다. 항목 수와 순서를 함께 확인하세요.
data.resultsobject
조회 결과 항목 목록입니다. 항목이 없으면 빈 배열입니다. 하위 필드에 코드·이름·상태 같은 세부 값이 들어 있으며, 자료가 없으면 빈 객체이거나 생략됩니다.
data.results.registry_doc_verifyobject
'registry_doc_verify' 관련 값을 묶은 객체입니다. 하위 필드에 세부 값이 들어 있으며, 자료가 없으면 빈 객체이거나 생략됩니다.
data.results.tax_cert_verifyobject
'tax_cert_verify' 관련 값을 묶은 객체입니다. 하위 필드에 세부 값이 들어 있으며, 자료가 없으면 빈 객체이거나 생략됩니다.
data.failuresobject
실패한 구성원의 오류. 구성원 코드를 키로, 안내 문구를 값으로 담습니다. 실패가 없으면 빈 객체 {} 입니다.
data.failures.tax_cert_verifystring
'tax_cert_verify' 문자열 값입니다. 값이 없으면 빈 문자열이거나 필드가 생략됩니다.
apiobject
API 호출 메타데이터입니다. 이번 요청의 서버 처리 성공 여부(api.success), 실제 차감 포인트(api.cost), 결제 기록 ID(api.pl_id)를 담습니다. 처리 시간(api.ms)은 응답에 포함된 경우에만 제공됩니다. 업무 결과는 data에서 확인합니다.
api.successboolean
API 서버가 이번 요청을 정상 처리했는지 여부입니다. true여도 업무 결과가 실패일 수 있으므로 data.success·data.status와 함께 판단합니다. 인증 실패·잘못된 입력·서버 오류 응답에서는 false입니다.
api.costinteger
이번 호출에서 실제로 차감된 포인트입니다. 유료 성공 응답에서만 단가만큼 차감되며, 실패·무료 조회·같은 요청의 멱등 재전송은 0입니다. 화면의 표시 단가와 실제 차감액이 다를 수 있으므로 정산은 이 값을 기준으로 합니다.
api.msinteger
서버가 요청을 받아 응답 본문을 만들기까지 걸린 처리 시간(밀리초)입니다. 네트워크 왕복 시간과 클라이언트 대기 시간은 포함되지 않습니다.
api.pl_idinteger
포인트 차감 기록 ID입니다. 차감이 발생한 호출에만 값이 있으며, 과금 내역을 문의할 때 이 번호를 사용합니다. 무과금 응답은 -1·null이거나 필드가 생략됩니다.
입력 조건·전송 규칙

묶음 조회 요청

이 묶음은 polling 이 아닙니다. 요청 한 번이 조회 한 번이며, 응답에 결과가 바로 담깁니다. 구성원 일부가 실패해도 성공한 구성원의 결과는 그대로 돌아옵니다. 실패한 구성원은 failures 에만 적힙니다. 과금은 요청 1건에 한 번만 발생합니다. 실패 여부를 떠나 같은 요청을 반복하지 말고, 결과를 확인한 뒤 입력을 고쳐 다시 요청하세요.

응답 처리

HTTP 성공과 업무 결과를 구분하세요. 경로별 응답 필드와 예시는 위 요청과 응답에 함께 있습니다.

응답 규격

응답 예시

모두 성공

{
    "data": {
        "success": true,
        "product": "doc_verify_bundle",
        "members": ["registry_doc_verify","tax_cert_verify"],
        "results": {

            "registry_doc_verify": { },

            "tax_cert_verify": { }

        },
        "failures": {}
    },
    "api": {
        "success": true,
        "cost": 84,
        "ms": 240,
        "pl_id": 4903
    }
}
            
일부 실패

{
    "data": {
        "success": true,
        "product": "doc_verify_bundle",
        "members": ["registry_doc_verify","tax_cert_verify"],
        "results": {
            "registry_doc_verify": { }
        },
        "failures": {
            "tax_cert_verify": "오류 안내 문구"
        }
    },
    "api": {
        "success": true,
        "cost": 84,
        "ms": 240,
        "pl_id": 4903
    }
}
            
위 값은 응답 구조를 보여주기 위한 예시입니다. 값은 가상이지만 필드 구성과 타입은 실제 응답과 같습니다. results 의 값은 구성원이 돌려주는 응답 본문 그대로입니다. 예시에서는 빈 객체 { } 로 표시했습니다.
원문 응답 필드 표 보기
이름
타입
설명
success
Boolean
성공한 구성원이 하나 이상이면 true 입니다.
product
String
묶음 상품 코드(doc_verify_bundle)
members
Array<String>
이 묶음에 담긴 구성원 코드 목록입니다.
results
Object
성공한 구성원의 응답 본문. 구성원 코드를 키로 담깁니다.
failures
Object
실패한 구성원의 오류. 구성원 코드를 키로, 안내 문구를 값으로 담습니다. 실패가 없으면 빈 객체 {} 입니다.
api
Object
API 호출 공통 데이터
success
Boolean
API 서버 정상 응답 여부
cost
Integer
API 호출 요금
ms
Integer
API 응답 시간
pl_id
Integer
API 결제 로그 ID

오류 코드

응답을 아래 순서로 확인하세요. 결과 유무와 과금 여부는 서로 다릅니다.

  1. HTTP 상태전송·인증·입력 오류
  2. api.successAPI 처리 여부
  3. data · result업무 결과와 오류 문구
  4. api.cost이번 요청의 과금
업무 실패 응답 data.error
  • 입력값이 맞지 않거나 대상 자료가 없거나 일시적으로 처리하지 못하면 data.error(사유 문구)와 data.success=0을 돌려줍니다. HTTP 상태는 사유에 따라 400·404·408·424 중 하나입니다.
  • 이때 api.cost는 0이며 과금되지 않습니다. data.error 문구를 그대로 기록하고 사용자에게 보여 주세요.
  • 입력 오류(400)는 값을 고친 뒤 다시 요청하세요. 408·424는 잠시 후 한 번 다시 시도하고, 같은 입력으로 짧은 간격의 자동 반복은 하지 마세요.
{
  "data": {
    "error": "입력값을 확인해 주세요.",
    "success": 0
  },
  "api": {
    "success": true,
    "cost": 0,
    "ms": 5
  }
}
서비스 코드·조건

오류와 복구

입력 오류와 처리 중 거절은 api.success 가 false 이고, 실패한 구성원의 오류는 data.failures 에 구성원 코드와 함께 옵니다. 아래 표는 이 묶음의 경로가 돌려주는 오류입니다.

상황
HTTP
오류 코드
해결
구성원 일부가 실패
200
— (failures.<구성원>에 오류 문구)
성공한 구성원 결과는 그대로 받고, 실패한 구성원의 입력을 확인해 다시 요청합니다.
구성원 전부가 실패
200
— (success: false)
failures 의 안내를 확인해 입력을 고친 뒤 다시 요청합니다.
이 묶음을 이용할 수 없는 상태
503
NATIVE_BUNDLE_UNAVAILABLE
잠시 뒤 다시 요청합니다. 이 상품을 계속 쓸 수 없으면 문의게시판으로 알려주세요.
서버 처리 오류
500
NATIVE_BUNDLE_FAILED
잠시 뒤 다시 요청합니다. 반복되면 문의게시판으로 알려주세요.
/rest/req_<묶음> 으로 호출
400
NATIVE_BUNDLE_NO_AUTH
이 묶음은 인증요청 단계가 없습니다. /rest/data_result_doc_verify_bundle 로 요청합니다.
인증·포인트 오류 result.error 문구
코드
HTTP
의미·조치
유효하지 않은 API키 입니다.
401
Authorization: Bearer 헤더의 인증키를 확인하세요.
허용되지 않은 IP주소 입니다.
401
마이페이지의 허용 IP 설정과 요청 서버 IP를 확인하세요.
비활성화된 계정입니다.
401
계정 이용 상태를 고객지원으로 문의하세요.
사용 가능한 포인트이 부족합니다.
200
HTTP 200이어도 result.error가 있으면 실패입니다. 포인트를 충전한 뒤 다시 요청하세요. 이 응답은 과금되지 않습니다.
무료 포인트로 사용할 수 없는 서비스입니다.
200
최소 1회 결제 후 이용할 수 있습니다. result.error 전체 문구를 그대로 표시하세요.
인증 정보를 확인할 수 없습니다.
424
일시적인 확인 실패입니다. 잠시 후 다시 시도하세요.
폼 입력 오류 error.code
코드
HTTP
의미·조치
FORM_DATA_INVALID
400
필드 이름·값의 타입·배열 인덱스를 확인하세요. 인덱스는 0부터 연속으로 사용합니다.
FORM_DATA_FIELD_CONFLICT
400
같은 값과 중첩 경로를 동시에 지정하지 마세요.
MULTIPART_LIMIT_OR_PARSE_ERROR
400·413
boundary·파일 크기·필드 개수를 확인하세요. 서비스별 제한이 우선 적용됩니다.

요금·이용 조건

기본 요금기본 단가 84P · 건당무료 포인트로는 이용할 수 없으며 최소 1회 결제 후 이용할 수 있습니다.

실제 차감 금액은 응답의 api.cost로 확인하세요. 상세 요금은 요금정책에서 볼 수 있습니다.

연동 팁

  • 요청 예제의 오류 처리 포함 모드는 시간 제한과 업무 실패 판정을 함께 보여줍니다.
  • 인증키는 서버 환경변수에 두고 브라우저·앱에 넣지 마세요.
  • HTTP 성공과 업무 결과를 구분하고, 실패 응답의 오류 문구를 그대로 기록하세요.

개발가이드 검색

API 이름·경로·파라미터·오류 코드로 찾을 수 있습니다.

표시 가격은 기본 단가입니다. 상세 과금 조건은 각 가이드에서 확인하세요.