{"openapi":"3.0.3","info":{"title":"APICK 주택금융 통합 조회","version":"1.0.0","description":"본인 간편인증 후 한국주택금융공사의 주택금융 통합 조회 자료를 확인합니다. 신고금액: 신고된 주택담보대출 금액.원 단위 금액이 숫자가 아닌 문자열로 온다. 대상이 없으면 \"0\" 이 온다."},"servers":[{"url":"https://apick.app"}],"paths":{"/rest/req_housing_bundle":{"post":{"summary":"주택금융 통합 조회","description":"본인 간편인증 후 한국주택금융공사의 주택금융 통합 조회 자료를 확인합니다. 신고금액: 신고된 주택담보대출 금액.원 단위 금액이 숫자가 아닌 문자열로 온다. 대상이 없으면 \"0\" 이 온다.","security":[{"bearerAuth":[]}],"parameters":[],"responses":{"200":{"description":"서비스별 성공·처리 상태 응답","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"schemaVersion":{"type":"string","description":"결과 스키마 버전 (고정값: \"1.0\")"},"transactionId":{"type":"string","description":"결과 조회에 사용하는 트랜잭션 ID"},"product":{"type":"string","description":"조회 항목 코드. 결과조회에도 같은 값이 오므로 어느 항목의 결과인지 대조할 수 있습니다."},"status":{"type":"string","description":"처리 상태 (AUTH_REQUESTED: 인증 요청 완료)"},"resultAvailable":{"type":"boolean","description":"결과 데이터 포함 여부. 인증 요청 응답은 항상 false 입니다."},"charged":{"type":"boolean","description":"이번 호출의 과금 발생 여부. 실제 발송에 성공하면 true 입니다."},"sources":{"type":"array","items":{}},"message":{"type":"string","description":"상태 메시지 (고정값: \"인증 대기중입니다.\")"},"expiresAt":{"type":"string","description":"인증 유효 기한(ISO 8601). 이 시각까지 승인하지 못하면 인증 실패 처리됩니다."},"success":{"type":"integer","description":"과금 여부0: 실패 또는 재사용(무과금)1: 발송 성공(과금)"},"approvals":{"type":"integer","description":"필요한 간편인증 승인 횟수. 조회 항목 하나당 1회입니다."}},"description":"인증 요청 결과"},"api":{"type":"object","properties":{"success":{"type":"boolean","description":"API 서버 정상 응답 여부"},"cost":{"type":"integer","description":"API 호출 요금"},"ms":{"type":"integer","description":"API 응답 시간"},"pl_id":{"type":"integer","description":"API 결제 로그 ID"}},"description":"API 호출 공통 데이터"}}}}}},"default":{"description":"HTTP 상태 및 서비스 오류코드 확인","content":{"application/json":{"schema":{"type":"object"}}}}},"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"이름 (string)","example":"홍길동"},"birthDate":{"type":"string","description":"생년월일 8자리(YYYYMMDD) (string)","example":"19900101"},"phone":{"type":"string","description":"휴대전화 번호 (본인 명의, 숫자만) (string)","example":"01011112222"},"authProvider":{"type":"string","description":"간편인증 방식 (아래 지원 목록 참고) (string)","example":"kakao"}},"required":["name","birthDate","phone","authProvider"]}}}}}},"/rest/get_housing_bundle":{"post":{"summary":"주택금융 통합 조회","description":"본인 간편인증 후 한국주택금융공사의 주택금융 통합 조회 자료를 확인합니다. 신고금액: 신고된 주택담보대출 금액.원 단위 금액이 숫자가 아닌 문자열로 온다. 대상이 없으면 \"0\" 이 온다.","security":[{"bearerAuth":[]}],"parameters":[],"responses":{"200":{"description":"서비스별 성공·처리 상태 응답","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"schemaVersion":{"type":"string","description":"결과 스키마 버전 (고정값: \"1.0\")"},"transactionId":{"type":"string","description":"트랜잭션 ID"},"product":{"type":"string","description":"조회 항목 코드. 인증요청 응답과 같은 값입니다."},"status":{"type":"string","description":"처리 상태 (위 표 참고)"},"resultAvailable":{"type":"boolean","description":"실제 결과 포함 여부. 과금 여부도 이 값으로 결정됩니다."},"charged":{"type":"boolean","description":"이번 호출의 과금 발생 여부. 최초 결과 반환에서만 true 입니다."},"sources":{"type":"array","items":{"type":"object","properties":{"source":{"type":"string"},"type":{"type":"string"},"status":{"type":"string"}}},"description":"항상 포함됩니다. 값이 없으면 빈 배열 [] 입니다. 항목이 여러 개인 상품에서 어느 것이 성공·실패했는지 알려줍니다. 각 항목은 source(제공 기관명), type(데이터 종류), status(SUCCESS/FAILED). 수집이 끝나기 전에는 아직 확정되지 않은 기관이 FAILED 로 보일 수 있습니다."},"message":{"type":"string","description":"상태 메시지"},"expiresAt":{"type":"string"},"success":{"type":"integer","description":"과금 여부0: 결과 없음 또는 재조회(무과금)1: 최초 결과 반환(과금)"},"progress":{"type":"object","properties":{"total":{"type":"integer"},"completed":{"type":"integer"}},"description":"진행률(COLLECTING 일 때). total(전체 항목), completed(완료 항목)"},"checkedAt":{"type":"string","description":"실제 정보를 확인한 시각. 한국시간(UTC+09:00) ISO 8601 이며 재조회 유효기간의 기준입니다."},"resultExpiresAt":{"type":"string","description":"결과 재조회 만료 시각. 한국시간(UTC+09:00) ISO 8601 입니다."},"result":{"type":"object","properties":{"mortgageLoan":{"type":"object","additionalProperties":true,"properties":{"신고금액":{"type":"string","description":"신고된 주택담보대출 금액.원 단위 금액이 숫자가 아닌 문자열로 온다. 대상이 없으면 \"0\" 이 온다."}},"description":"이 조회 항목의 결과입니다. 항목은 결과 규격을 참고하세요."},"housingRefundBalance":{"type":"object","properties":{"미환급 보증료":{"type":"string","description":"미환급 보증료 금액.원 단위 금액이 숫자가 아닌 문자열로 온다. 대상이 없으면 \"0\" 이 온다."}},"description":"이 조회 항목의 결과입니다. 항목은 결과 규격을 참고하세요."},"housingPensionBalance":{"type":"object","properties":{"가입자명":{"type":"string","description":"주택연금 가입자 이름"},"가입자생년월일":{"type":"string","description":"가입자 생년월일 8자리"},"배우자명":{"type":"string","description":"배우자 이름. 배우자가 없으면 빈 값이다."},"배우자생년월일":{"type":"string","description":"배우자 생년월일 8자리"},"보증번호":{"type":"string","description":"보증 번호"},"지급방식":{"type":"string","description":"연금 지급 방식"},"월지급금액":{"type":"string","description":"매달 지급되는 금액.원 단위 금액이 숫자가 아닌 문자열로 온다."},"지급유형":{"type":"string","description":"지급 유형"},"담보방식":{"type":"string","description":"담보 방식"},"종신한도금액":{"type":"string","description":"종신 한도 금액.원 단위 금액이 숫자가 아닌 문자열로 온다."},"고정지급금액":{"type":"string","description":"고정 지급 금액.원 단위 금액이 숫자가 아닌 문자열로 온다."},"변동지급연수":{"type":"string","description":"변동 지급 연수"},"월지급기간":{"type":"string","description":"월 지급 기간 표기"},"보증일자":{"type":"string","description":"보증 개시일"},"관할지사":{"type":"string","description":"관할 지사명"},"취급지점":{"type":"string","description":"취급 지점명"},"조회기관전화":{"type":"string","description":"조회 기관 연락처"},"보증잔액":{"type":"string","description":"보증 잔액.원 단위 금액이 숫자가 아닌 문자열로 온다."},"보증금액":{"type":"string","description":"보증 금액.원 단위 금액이 숫자가 아닌 문자열로 온다."},"대출이자금액":{"type":"string","description":"대출 이자 금액.원 단위 금액이 숫자가 아닌 문자열로 온다."},"개인종신금액":{"type":"string","description":"개인 종신 금액.원 단위 금액이 숫자가 아닌 문자열로 온다."},"해지금액":{"type":"string","description":"해지 금액.원 단위 금액이 숫자가 아닌 문자열로 온다."},"조회기준일자":{"type":"string","description":"잔액을 조회한 기준일"},"공고일자":{"type":"string","description":"공고일"},"가입증서번호":{"type":"string","description":"가입증서 번호"}},"description":"이 조회 항목의 결과입니다. 항목은 결과 규격을 참고하세요."},"housingLoanStage":{"type":"object","properties":{"조회결과":{"type":"string","description":"진행 중인 대출이 없을 때만 이 항목 하나가 온다. 이때 다른 항목은 담기지 않는다."}},"additionalProperties":{"type":"string","description":"진행 중인 대출이 있으면 기관이 돌려준 항목명을 키로 값이 온다. 항목 구성이 신청 건마다 달라 고정할 수 없다. 대표 항목이며 자료에 따라 이름·값 타입이 다르고 생략되거나 추가될 수 있습니다."},"description":"이 조회 항목의 결과입니다. 항목은 결과 규격을 참고하세요."},"mortgageApplication":{"type":"object","properties":{"조회결과":{"type":"string","description":"신청 내역이 없을 때만 이 항목 하나가 온다. 이때 다른 항목은 담기지 않는다."}},"additionalProperties":{"type":"string","description":"신청 내역이 있으면 기관이 돌려준 항목명을 키로 값이 온다. 항목 구성이 신청 건마다 달라 고정할 수 없다. 대표 항목이며 자료에 따라 이름·값 타입이 다르고 생략되거나 추가될 수 있습니다."},"description":"이 조회 항목의 결과입니다. 항목은 결과 규격을 참고하세요."}},"description":"조회된 결과 묶음. 실제 데이터가 있을 때만 포함됩니다."},"errorCode":{"type":"string","description":"오류 구분. RESULT_EXPIRED(재조회 기간 만료) / AUTH_EXPIRED / AUTH_REJECTED / COLLECT_FAILED"}},"description":"상태·결과"},"api":{"type":"object","properties":{"success":{"type":"boolean","description":"API 서버 정상 응답 여부"},"cost":{"type":"integer","description":"API 호출 요금"},"ms":{"type":"integer","description":"API 응답 시간"},"pl_id":{"type":"integer","description":"API 결제 로그 ID"}},"description":"API 호출 공통 데이터"}}}}}},"default":{"description":"HTTP 상태 및 서비스 오류코드 확인","content":{"application/json":{"schema":{"type":"object"}}}}},"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"transactionId":{"type":"string","description":"/rest/req_housing_bundle 가 반환한 트랜잭션 ID (string)","example":"9f2c4a7b1d8e35c60a4f7b2d1e9c803a"}},"required":["transactionId"]}}}}}}},"x-code-tables":[],"x-service-errors":[],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}}}