{"openapi":"3.0.3","info":{"title":"APICK [Text] 주민등록등본 진위 확인","version":"1.0.0","description":"주민등록등본의 진위여부를 확인합니다."},"servers":[{"url":"https://apick.app"}],"paths":{"/rest/identi_card/4":{"post":{"summary":"[Text] 주민등록등본 진위 확인","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는 항상 4이며, 요청의 발급 경로 구분(type)과는 다른 값입니다.1: 주민등록증2: 운전면허증3: 여권4: 주민등록등본5: 외국인등록증"},"result":{"type":"integer","description":"판정 결과입니다. 1일 때만 진위 확인 통과로 처리하세요.1: 실제 발급된 등본0: 일치하는 발급 문서 없음2: 판정을 확정하지 못함(msg 안내 확인 후 다시 요청)3: 처리 시간 초과(잠시 후 다시 요청)2·3은 판정이 끝나지 않아 과금되지 않습니다(api.cost 0)."},"msg":{"type":"string","description":"결과 안내 문구입니다. 빈 문자열일 수 있으므로 판정은 문구가 아니라 result 값으로 하세요."},"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":{"doc_num1":{"type":"string","description":"문서확인번호 1구획 (4자리) 문자열로 보내며, 빼거나 빈 값으로 보내면 요청이 거부됩니다. (string)","example":"1234"},"doc_num2":{"type":"string","description":"문서확인번호 2구획 (4자리) 문자열로 보내며, 빼거나 빈 값으로 보내면 요청이 거부됩니다. (string)","example":"5678"},"doc_num3":{"type":"string","description":"문서확인번호 3구획 (4자리) 문자열로 보내며, 빼거나 빈 값으로 보내면 요청이 거부됩니다. (string)","example":"9012"},"doc_num4":{"type":"string","description":"문서확인번호 4구획 (4~5자리) 문자열로 보내며, 빼거나 빈 값으로 보내면 요청이 거부됩니다. (string)","example":"3456"},"type":{"type":"string","description":"발급 경로 구분 (1: 인터넷으로 발급한 등본, 2: 그 밖의 경로로 발급한 등본) (string)","example":"1"}},"required":["doc_num1","doc_num2","doc_num3","doc_num4","type"]}}}}}}},"x-code-tables":[{"title":"오류 응답","columns":["HTTP","data.error","원인·조치"],"rows":[["400","입력 항목이 잘못됐습니다.","문서확인번호 구획 중 빠진 값이 있거나 type이 1·2가 아닙니다. 값을 고쳐 다시 요청하세요."],["408","처리 시간 초과로 실패했습니다. 잠시후 다시 시도해 주세요.","제한 시간 안에 판정을 받지 못했습니다(data.result 3). 잠시 후 같은 값으로 다시 요청하세요."],["424","알 수 없는 이유로 실패했습니다.","일시적인 처리 실패입니다. 잠시 후 다시 요청하고, 반복되면 ic_id와 함께 문의하세요."]]}],"x-service-errors":[],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}}}