{"openapi":"3.0.3","info":{"title":"APICK [Image/PDF] 외국인등록증 진위 확인","version":"1.0.0","description":"외국인등록증의 진위여부를 확인합니다."},"servers":[{"url":"https://apick.app"}],"paths":{"/rest/identi_card_image/5":{"post":{"summary":"[Image/PDF] 외국인등록증 진위 확인","description":"외국인등록증의 진위여부를 확인합니다.","security":[{"bearerAuth":[]}],"parameters":[],"responses":{"200":{"description":"서비스별 성공·처리 상태 응답","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"ic_id":{"type":"integer","description":"이번 진위 확인 요청에 부여된 번호입니다. 결과 기록이나 문의 때 함께 전달하세요. 값을 읽지 못해 접수되지 않은 요청에는 없습니다."},"type":{"type":"integer","description":"신분증 종류입니다. 이 API는 항상 5(외국인등록증)입니다."},"result":{"type":"integer","description":"판정 결과입니다. 1일 때만 진위 확인 통과로 처리하세요.1: 일치0: 불일치2: 판정을 확정하지 못함(msg 안내 확인 후 다시 요청)3: 처리 시간 초과(잠시 후 다시 요청)"},"msg":{"type":"string","description":"결과 안내 문구입니다. 등록번호·발급일자 같은 입력값이 함께 들어 있을 수 있으므로 화면이나 로그에 그대로 남기지 마세요. 판정은 result 값으로 하세요."},"parsed":{"type":"object","properties":{"name":{"type":"string","description":"읽은 성명입니다. 판정에는 쓰이지 않습니다."},"rrn1":{"type":"string","description":"읽은 외국인등록번호 앞 6자리입니다."},"rrn2":{"type":"string","description":"읽은 외국인등록번호 뒤 7자리입니다. 저장·로그에 남기지 마세요. 문서 예시는 가린 값입니다."},"rrn":{"type":"string","description":"읽은 외국인등록번호 13자리입니다. 판정에 이 값을 씁니다."},"made_date":{"type":"string","description":"읽은 발급일자입니다. 10자리(YYYY-MM-DD)입니다."},"card_sn":{"type":"string","description":"요청에 보낸 뒷면 일련번호입니다. 보내지 않았다면 빈 문자열입니다."}},"description":"파일에서 읽은 값입니다. 판정에 쓴 값이 무엇인지 확인하거나, 실패했을 때 어느 항목을 읽지 못했는지 확인할 때 씁니다. 읽지 못한 항목은 null입니다.","nullable":true},"success":{"type":"integer","description":"처리 상태입니다. 1이면 판정이 끝난 정상 응답, 0이면 실패 응답(요금 차감 없음)입니다."},"error":{"type":"string","description":"실패 사유 문구입니다. 정상 응답에는 없으며, 값이 있으면 아래 오류 응답 표에서 원인과 조치를 확인하세요."}},"description":"진위 확인 결과 묶음입니다. 실패하면 error 문구가 함께 들어 있으므로 먼저 error 유무를 확인하세요."},"api":{"type":"object","properties":{"success":{"type":"boolean","description":"요청을 정상적으로 받아 처리했는지 여부입니다. true여도 진위 판정은 data.result로 따로 확인해야 합니다."},"cost":{"type":"integer","description":"이번 호출에서 차감된 포인트입니다. data.error가 있는 실패 응답은 0입니다."},"ms":{"type":"integer","description":"요청을 받아 응답을 만들기까지 걸린 시간(밀리초)입니다. 네트워크 왕복 시간은 포함되지 않습니다."},"pl_id":{"type":"integer","description":"포인트 차감 기록 번호입니다. 차감이 있었던 호출에만 값이 있으며 과금 문의 때 사용합니다."}},"description":"호출 공통 정보입니다. 처리 여부·차감 포인트·처리 시간·차감 기록 번호가 들어 있습니다."}}}}}},"default":{"description":"HTTP 상태 및 서비스 오류코드 확인","content":{"application/json":{"schema":{"type":"object"}}}}},"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"image":{"type":"string","description":"외국인등록증 앞면 이미지(JPG·PNG 등) 또는 PDF 파일 하나입니다. 50MB 이하이며, PDF는 첫 페이지만 확인합니다. (file)","format":"binary"},"card_sn":{"type":"string","description":"신분증 뒷면의 일련번호 11자리입니다. 2011-01-01 이후 발급된 문서는 필수이며, 값이 없으면 진위 확인이 실패할 수 있습니다. (string)","example":"12345678901"}},"required":["image"]}}}}}}},"x-code-tables":[{"title":"오류 응답","columns":["HTTP","data.error","원인·조치"],"rows":[["400","입력 항목이 잘못됐습니다.","파일에서 등록번호·발급일자를 읽지 못했거나 card_sn이 11자리가 아닙니다. data.parsed를 확인하고 다시 요청하세요."],["400","파일 유형이 맞지 않습니다. 이미지 또는 PDF 형식의 파일만 허용됩니다.","이미지나 PDF가 아닌 파일입니다. JPG·PNG 이미지나 PDF로 다시 보내세요."],["424","첨부파일이 없습니다.","image 항목에 파일 본문이 첨부되지 않았습니다. multipart/form-data로 파일을 첨부했는지 확인하세요."],["424","지원되지 않는 이미지 유형입니다. JPG 형태로 변환하여 재시도 해주세요.","읽을 수 없는 이미지 형식입니다. JPG로 변환해 다시 요청하세요."],["408","처리 시간 초과로 실패했습니다. 잠시후 다시 시도해 주세요.","제한 시간 안에 판정을 받지 못했습니다(data.result 3). 잠시 후 같은 파일로 다시 요청하세요."],["424","알 수 없는 이유로 실패했습니다.","일시적인 처리 실패입니다. 잠시 후 다시 요청하세요."]]}],"x-service-errors":[],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}}}