- 호출 한 번이 결과 하나입니다. 제출건(submission)을 만들지 않습니다.
- 모든 호출은 동기로 처리됩니다. 결과는 응답으로 바로 받고, 웹훅은 없습니다.
- 결과가 나온 호출만 과금합니다. 오류로 결과가 나오지 않은 호출은 과금하지 않습니다.
Unit API 레퍼런스
모든 API의 요청·응답 명세를 확인하고, 언어별 호출 코드를 복사하고, OpenAPI 명세 파일을 내려받을 수 있습니다.
제공 API
이미지·텍스트 분석
외부 기관 조회
외부 기관 조회는 기관의 답을
verdict(판정)와 verdictReason(판정 이유)으로 정리해 돌려줍니다. 판정을 읽는 방법은 판정 읽기를 참고하세요.
시작 순서
1
Unit API 키 복사
대시보드 Unit API > Unit API 키에서 키를 복사합니다. 프로젝트를 만들 때 자동으로 발급되므로 따로 신청할 필요가 없습니다. Member 이상 권한이 필요합니다.
2
대시보드에서 실행해 보기
API 테스트에서 API를 골라 값을 넣고 실행합니다. 응답과 TX ID, 호출 주소, cURL 예시를 확인합니다.
3
서버에서 호출
cURL 예시와 같은 요청을 서버에서 보냅니다. 키는 반드시 서버에서만 쓰세요.
4
결과와 TX ID 저장
응답을 받는 즉시 결과와
txId를 시스템에 저장합니다. ARGOS는 요청·응답 본문을 저장하지 않습니다.호출 주소
모든 Unit API는POST 요청입니다. 프로젝트가 속한 리전의 호스트로 호출합니다.
{api}는 각 API 페이지에 있는 경로입니다. 예:/v1/units/id-ocr- 모든 리전에서 14종을 모두 쓸 수 있습니다.
- 키는 프로젝트의 리전에서만 통합니다. 다른 리전 호스트로 호출하면
401이 돌아옵니다. 프로젝트 리전은 리전 안내에서 확인하세요.
인증
요청 헤더x-api-key에 프로젝트의 Unit API 키를 넣습니다.
키 재발급
- 키가 노출됐거나 오남용이 의심되면 Owner·Leader가 대시보드에서 키를 재발급합니다.
- 재발급하면 이전 키는 즉시 폐기됩니다. 이전 키로 들어온 호출은
401 INVALID_API_KEY로 거절되고 과금되지 않습니다. - 재발급한 사람과 시각은 키 발급 이력과 이벤트 로그에 남습니다.
요청 규칙
- 본문은 JSON으로 보내고
Content-Type: application/json을 붙입니다. 다른 타입은415 UNSUPPORTED_MEDIA_TYPE으로 거절됩니다. - 계약에 없는 필드를 보내면
400 UNKNOWN_PARAMETER로 거절됩니다. 오타가 조용히 무시되어 엉뚱한 결과로 과금되는 일을 막기 위해서입니다. - 빈 문자열(
"")과null은 값을 보내지 않은 것으로 보지 않고400 INVALID_PARAMETER_FORMAT으로 거절합니다. 선택 필드는 값이 없으면 키째 빼고 보내세요. - 날짜는
YYYY-MM-DD형식입니다. 예:2019-03-14
이미지
- Base64 문자열로 보냅니다.
data:image/jpeg;base64,같은 접두어는 붙여도 되고 빼도 됩니다. - JPEG와 PNG만 받습니다. iPhone HEIC, GIF, BMP 등은 JPEG로 변환해서 보내세요.
- 한 장당 원본 약 3 MB(접두어를 뺀 Base64 4,000,064자)까지 받습니다. 넘으면
400 PARAMETER_OUT_OF_RANGE입니다. 휴대폰으로 찍은 신분증 사진은 대부분 그대로 보낼 수 있습니다.
referenceId
모든 API에서 선택 필드referenceId를 받습니다.
호출마다 다른 값을 보내면, 응답을 받지 못한 호출도 나중에 찾을 수 있습니다. 중복 호출과 재시도를 참고하세요.
공통 응답
성공(200) 응답은 모든 API가 같은 모양입니다. 호출을 설명하는 필드가 바깥에 있고, API가 만든 결과는 data 안에 있습니다.
string
필수
이번 호출의 TX ID입니다. 대시보드 호출 내역 검색과 문의에 씁니다. 응답 헤더
X-Tx-Id와 같은 값입니다.string
필수
호출한 API의 코드입니다. 예:
ID_OCR, GC_KOR_NIDstring
필수
요청을 받은 시각입니다. 밀리초까지 표기한 UTC(RFC 3339)입니다.
integer
필수
요청을 받아 응답하기까지 걸린 시간(ms)입니다.
object
필수
이번 호출의 과금 내역입니다.
string | null
필수
요청에 보낸
referenceId입니다. 보내지 않았으면 null입니다.object
필수
API가 만든 결과입니다. 구조는 각 API 페이지를 참고하세요.
정의된 응답 필드는 값이 없어도 생략하지 않고
null로 옵니다. 반대로 같은 v1 안에서도 응답 필드와 enum 값은 늘어날 수 있으므로, 모르는 필드나 값을 만나도 실패하지 않게 구현하세요. 버전 정책판정 읽기
외부 기관 조회 API는data 안에 아래 필드를 줍니다. GC-MEX-CURP만 예외로, 판정 없이 기관의 등록 상태를 그대로 줍니다.
MATCH: 기관 기록과 일치합니다.MISMATCH: 기관이 불일치로 답했습니다. 조회는 이루어졌으므로 과금됩니다.REJECTED: 진본이지만 지금은 효력이 없습니다(효력을 잃은 여권, 휴업·폐업 사업자).
과금 기준
결과가 나온 호출만 크레딧이 차감됩니다. 차감한 크레딧은 응답의billing.credit과 대시보드 호출 내역에서 확인할 수 있습니다.
- 결과가 나오면 차감됩니다. 얼굴 유사도가 낮게 나오거나 기관이 불일치(
MISMATCH)로 답해도 결과가 나온 것이므로 차감됩니다. - 오류로 결과가 나오지 않으면 차감되지 않습니다. HTTP 상태가
200이 아닌 모든 응답입니다. - 대시보드 API 테스트로 실행한 호출도 같은 기준으로 차감됩니다.
- 체험(Trial) 프로젝트는 차감되지 않습니다. 대신 월 호출 수가 제한됩니다. 프로젝트 상태별 이용 범위
- 같은 요청을 두 번 보내면 두 건으로 처리하고 두 번 차감합니다.
API별 단가
프로젝트의 요금제가v3.1_USA이면 USA 단가, 그 밖의 요금제는 KOR 단가를 적용합니다. 단위는 크레딧입니다.
내 프로젝트에 적용되는 단가는 대시보드 Unit API > API 테스트에서도 확인할 수 있습니다.
프로젝트 상태별 이용 범위
- 체험 한도는 오류를 포함한 호출 수로 셉니다. 차감되지 않은 오류 호출과 한도 초과로 거절된 호출도 포함됩니다.
- 한도는 매월 1일 00:00 UTC(한국시간 오전 9시)에 초기화됩니다.
- 한도를 넘기면
429 TRIAL_LIMIT_EXCEEDED가 돌아오고,Retry-After헤더에 초기화까지 남은 초가 들어 있습니다.
데이터 보관과 개인정보
- 요청·응답 본문은 저장되지 않습니다. 응답을 받는 즉시 결과를
txId와 함께 시스템에 저장해 두세요. ARGOS에서 결과를 다시 조회할 수 없습니다. - 호출 기록은 3년간 보관됩니다. 호출 시각, API, 결과, 오류 코드, 처리 시간, Count, 크레딧, 소스(라이브·API 테스트), 실행자,
referenceId가 남습니다. - 테스트라도 실제 개인정보를 넣으려면 정보주체의 동의 등 처리 근거가 있어야 합니다.
다음 단계
오류 코드와 재시도
오류 응답 형식, 코드별 대응, 재시도 기준
대시보드 Unit API
API 테스트, 호출 내역, 키 관리