API가이드

보험 업권 정보제공 API 규격

  • DB형 퇴직연금정보 기본정보 조회 (은행, 금투, 보험 공통) v2 2024-10-21

    기본 정보
    API ID DB-001 (보험) HTTP Method GET
    API 제공자 은행업권, 금투업권, 보험업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/insu/db/basic
    설명 정보주체가 보유한 DB형 퇴직연금정보 기본정보 조회
    - DB제도 특성 상 퇴직 후 퇴직금 정산 등 처리기간이 필요하므로 변동사항이 실시간으로 반영되지 않을 수 있음
    기준시점 현재 시점
    Content-Type(요청) - Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급된 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Parameter org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    search_timestamp 조회 타임스탬프 Y N(14) 가장 최근 조회한 시간 (이전 API 호출 시 정보제공자가 회신한 값을 저장하고 있다가 다음 API 호출 시 그 값을 그대로 세팅하여 전송, 최초 API 호출시에는 0으로 세팅)
    - 2.1-[2] 참조
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    search_timestamp 조회 타임스탬프 N N(14) API 처리 시점의 현재시각을 설정하여 회신. 다만 정보제공자는 Timestamp 로직을 의무적으로 구현할 필요가 없으며(선택사항), Timestamp 로직 미제공 시에는 항상 0을 회신 또는 미회신
    is_running_pension 보유여부 Y Boolean DB형 퇴직연금 보유여부
  • DC형 퇴직연금정보 목록정보 조회 (은행, 금투, 보험 공통) v2 2024-10-21

    기본 정보
    API ID DC-001 (보험) HTTP Method GET
    API 제공자 은행업권, 금투업권, 보험업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/insu/dc
    설명 정보주체가 보유한 DC형 퇴직연금정보 목록(Pagination, 상품관리번호 기준 오름차순)
    기준시점 현재 시점
    Content-Type(요청) - Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급한 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Parameter org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    search_timestamp 조회 타임스탬프 N N(14) 가장 최근 조회한 시간 (이전 API 호출 시 정보제공자가 회신한 값을 저장하고 있다가 다음 API 호출 시 그 값을 그대로 세팅하여 전송, 최초 API 호출시에는 0으로 세팅)
    - 2.1-[2] 참조
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체 (설정 시 해당 개체 후 limit 개 반환)
    처음 API 호출 시에는 해당 정보를 세팅하지 않으며, 다음 페이지 요청 시 직전 조회의 응답에서 얻은 기준개체를 그대로 세팅
    - 2.1-[2] 페이지네이션 참조
    limit 최대조회갯수 Y N(3) 기준개체 이후 반환될 개체의 개수
    - 최대 500까지 설정 가능
    - 2.1-[2] 페이지네이션 참조
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    search_timestamp 조회 타임스탬프 N N(14) API 처리 시점의 현재시각을 설정하여 회신. 다만 정보제공자는 Timestamp 로직을 의무적으로 구현할 필요가 없으며(선택사항), Timestamp 로직 미제공 시에는 항상 0을 회신 또는 미회신
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체
    - 다음 페이지 존재하지 않는 경우(마지막 페이지), 미회신
    - 2.1-[2] 페이지네이션 참조
    dc_cnt 퇴직연금수 Y N(3)
    dc_list 퇴직연금목록 Y <object>
    --dc_num 상품관리번호 Y aN(15) 고객이 보유한 DC형 연금제도 관리번호
    - 금융회사에서 개인 또는 (개인이 2개이상 DC제도 보유시) 상품별로 관리하고 있는 상품관리번호 (계좌번호, 원장관리번호 등 내부에서 key값으로 관리중인 일련번호를 회신)
    --dc_name 상품명 Y AH(300) 고객이 보유한 DC형 연금제도 명칭- 사명, 제도명 등 웹 또는 앱에서 보여주고 있는 명칭과 동일하게 전송
    --is_consent 전송요구 여부 Y Boolean 정보주체가 해당 자산(계좌번호)에 대해 개인신용정보 전송요구를 했는지 여부
  • DC형 퇴직연금정보 기본정보 조회 (은행, 금투, 보험 공통) v2 2024-10-21

    기본 정보
    API ID DC-002 (보험) HTTP Method POST
    API 제공자 은행업권, 금투업권, 보험업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/insu/dc/basic
    설명 정보주체가 보유한 DC형 퇴직연금정보 기본 정보 조회
    기준시점 현재 시점
    Content-Type(요청) application/json; charset=UTF-8 Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급된 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Body org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    dc_num 상품관리번호 Y aN(15) 고객이 보유한 DC형 연금제도 관리번호
    - 금융회사에서 개인 또는 (개인이 2개이상 DC제도 보유시) 상품별로 관리하고 있는 상품관리번호 (계좌번호, 원장관리번호 등 내부에서 key값으로 관리중인 일련번호를 회신)
    search_timestamp 조회 타임스탬프 Y N(14) 가장 최근 조회한 시간 (이전 API 호출 시 정보제공자가 회신한 값을 저장하고 있다가 다음 API 호출 시 그 값을 그대로 세팅하여 전송, 최초 API 호출시에는 0으로 세팅)
    - 2.1-[2] 참조
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    search_timestamp 조회 타임스탬프 N N(14) API 처리 시점의 현재시각을 설정하여 회신. 다만 정보제공자는 Timestamp 로직을 의무적으로 구현할 필요가 없으며(선택사항), Timestamp 로직 미제공 시에는 항상 0을 회신 또는 미회신
    balance_amt 계좌잔액 N F(18,3) DC형 연금 계좌의 잔액(각 사 정책에 따라 전송하되, 앱 또는 웹을 고객에게 제공하는 수치와 같은 값)
    - 전일자 또는 실시간 기준 금액
    eval_amt 계좌평가금액 Y F(18,3) 조회 시점 기준의 이자 등 운용수익이 반영된 평가금액
    (각 사 정책, 전산관리 방식 등에 따라 전송하되, 앱 또는 웹에서 고객에서 제공하는 수치와 같은 값으로 제공)
    issue_date 개설일 Y DATE DC형 연금 가입일
    - 각사 내규에 따라 가입자 명부 등록일과 최초 입금일 중 가입일로 판단하는 날짜를 회신
  • DC형 퇴직연금정보 거래내역정보 조회 (은행, 금투, 보험 공통) v2 2024-10-21

    기본 정보
    API ID DC-003 (보험) HTTP Method POST
    API 제공자 은행업권, 금투업권, 보험업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/insu/dc/transactions
    설명 조회 기간 동안 발생한 정보주체의 DC형 퇴직연금정보 거래내역 조회 (Pagination, 거래일시 기준 내림차순)
    - 신용정보법 시행령 제28조의3제4항에 의거, 최근 5년 이내 정보 제공
    기준시점 FROM과 TO를 확인하여 해당 기간의 정보를 회신
    Content-Type(요청) application/json; charset=UTF-8 Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급한 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Body org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    dc_num 상품관리번호 Y aN(15) 고객이 보유한 DC형 연금제도 관리번호
    - 금융회사에서 개인 또는 (개인이 2개이상 DC제도 보유시) 상품별로 관리하고 있는 상품관리번호 (계좌번호, 원장관리번호 등 내부에서 key값으로 관리중인 일련번호를 회신)
    from_date 시작일자 Y DATE 조회 시작일자
    to_date 종료일자 Y DATE 조회 종료일자
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체 (설정 시 해당 개체 후 limit 개 반환)
    처음 API 호출 시에는 해당 정보를 세팅하지 않으며, 다음 페이지 요청 시 직전 조회의 응답에서 얻은 기준개체를 그대로 세팅
    - 2.1-[2] 페이지네이션 참조
    limit 최대조회갯수 Y N(3) 기준개체 이후 반환될 개체의 개수
    - 최대 500까지 설정 가능
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체
    - 다음 페이지 존재하지 않는 경우(마지막 페이지), 미회신
    - 2.1-[2] 페이지네이션 참조
    trans_cnt 거래목록수 Y N(3)
    trans_list 거래목록 Y <object>
    --trans_dtime 거래일시 또는 거래일자 Y DTIME<br>또는<br>DATE 거래가 일어난 날짜와 시간(YYYYMMDDhhmmss)
    - 시각 정보가 없는 경우 거래일자인 YYYYMMDD 회신(일부 기관의 경우 거래일자+거래번호로 관리)
    --trans_no 거래번호 N aN(64) (선택전송) 해당 일자의 거래 특정 번호
    없을 경우 회신 안함
    --trans_type 거래구분 Y aN(2) 해당 거래의 거래 유형
    - <코드값>
    01 : 신규
    02 : 입금
    03 : 출금
    09 : 정정(입금)
    10 : 정정(출금)
    98 : 기타(입금)
    99 : 기타(출금)
    --trans_amt 거래금액 Y F(18,3) 해당 채권번호에서 일어난 해당 거래(상환)의 금액
    - 원금과 이자, 수수료 및 기타비용이 포함된 금액
  • DC형 퇴직연금정보 추가정보 조회 (은행, 금투, 보험 공통) v2 2024-10-21

    기본 정보
    API ID DC-004 (보험) HTTP Method POST
    API 제공자 은행업권, 금투업권, 보험업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/insu/dc/detail
    설명 정보주체가 보유한 DC형 퇴직연금정보 개별운용상품별 추가(평가금액 등) 정보 조회
    (Pagination, 상품유형(코드) 기준 오름차순)
    기준시점 현재 시점
    Content-Type(요청) application/json; charset=UTF-8 Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급된 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Body org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    dc_num 상품관리번호 Y aN(15) 고객이 보유한 DC형 연금제도 관리번호
    - 금융회사에서 개인 또는 (개인이 2개이상 DC제도 보유시) 상품별로 관리하고 있는 상품관리번호 (계좌번호, 원장관리번호 등 내부에서 key값으로 관리중인 일련번호를 회신)
    search_timestamp 조회 타임스탬프 N N(14) 가장 최근 조회한 시간 (이전 API 호출 시 정보제공자가 회신한 값을 저장하고 있다가 다음 API 호출 시 그 값을 그대로 세팅하여 전송, 최초 API 호출시에는 0으로 세팅)
    - 2.1-[2] 참조
    - next_page가 세팅된 경우 요청에서 제외
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체 (설정 시 해당 개체 후 limit 개 반환)
    처음 API 호출 시에는 해당 정보를 세팅하지 않으며, 다음 페이지 요청 시 직전 조회의 응답에서 얻은 기준개체를 그대로 세팅
    - 2.1-[2] 페이지네이션 참조
    limit 최대조회갯수 N N(3) 기준개체 이후 반환될 개체의 개수
    - 최대 500까지 설정 가능
    - 2.1-[2] 페이지네이션 참조
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    search_timestamp 조회 타임스탬프 N N(14) API 처리 시점의 현재시각을 설정하여 회신. 다만 정보제공자는 Timestamp 로직을 의무적으로 구현할 필요가 없으며(선택사항), Timestamp 로직 미제공 시에는 항상 0을 회신 또는 미회신
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체 (설정 시 해당 개체 후 limit 개 반환)
    처음 API 호출 시에는 해당 정보를 세팅하지 않으며, 다음 페이지 요청 시 직전 조회의 응답에서 얻은 기준개체를 그대로 세팅
    - 2.1-[2] 페이지네이션 참조
    dc_cnt 운용상품수 Y N(4) 보유한 DC형 퇴직연금 수
    dc_list 운용상품목록 Y <object>
    --prod_name 개별운용상품명 Y AH(300) 정보제공자의 원장에 기록되어 있는 개별운용상품의 명칭 (예 : 00은행 정기예금 1년 등)
    --prod_num 상품가입번호 N aN(64) (선택전송) 동일상품에 대해 중복 투자한 경우 이를 구분하기 위한 식별값
    --prod_type 상품유형
    (코드)
    Y aN(2) 개별운용상품의 상품 유형
    - <코드값>
    01 : 원리금 보장
    02 : 원리금 비보장
    03 : 기타
    --eval_amt 평가금액 Y F(18,3) 조회 시점 기준의 이자 등 운용수익이 반영된 평가금액
    (각 사 정책, 전산관리 방식 등에 따라 전송하되, 앱 또는 웹에서 고객에서 제공하는 수치와 같은 값으로 제공)
    --principal_amt 납입(투자)원금 Y F(18,3) 납입원본 또는 납입후 이자 재예치후 원금 (개별운용상품 기준 잔액 표기 = 고객이 납입한 총 원금 - 지급 원금)
    --holding_num 보유좌수 N F(18,3) (선택전송) 개별운용상품이 보유한 좌수(원리금보장(예금) 상품일 경우에는 전송하지 않음)
    - 개별운용상품 단위로 정보를 관리하지 않을 경우 미전송
    ex) 단일 개별운용상품에 다수의 계좌상품이 포함되어 해당 정보들이 각기 관리되는 경우
    --issue_date 신규일 N DATE (선택전송) 개별상품 신규일(재예치일)
    - 개별운용상품 단위로 정보를 관리하지 않을 경우 미전송
    ex) 단일 개별운용상품에 다수의 계좌상품이 포함되어 해당 정보들이 각기 관리되는 경우
    --exp_date 만기일 N DATE (선택전송) 개발상품 만기일
    - 개별운용상품 단위로 정보를 관리하지 않을 경우 미전송
    ex) 단일 개별운용상품에 다수의 계좌상품이 포함되어 해당 정보들이 각기 관리되는 경우
    --int_rate 약정이자율 N F(5,3) (선택전송) 해당 개별운용상품이 원리금 보장(예금) 상품일 경우의 이자율
    - 개별운용상품 단위로 정보를 관리하지 않을 경우 미전송
    ex) 단일 개별운용상품에 다수의 계좌상품이 포함되어 해당 정보들이 각기 관리되는 경우
  • 개인형 IRP 계좌 목록 조회 (은행, 금투, 보험 공통) v2 2024-10-21

    기본 정보
    API ID IRP-001 (보험) HTTP Method GET
    API 제공자 은행업권, 금투업권, 보험업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/insu/irps
    설명 정보주체가 보유한 개인형 IRP 계좌목록 조회
    기준시점 현재 시점
    Content-Type(요청) - Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급된 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Parameter org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    search_timestamp 조회 타임스탬프 Y N(14) 가장 최근 조회한 시간 (이전 API 호출 시 정보제공자가 회신한 값을 저장하고 있다가 다음 API 호출 시 그 값을 그대로 세팅하여 전송, 최초 API 호출시에는 0으로 세팅)
    - 2.1-[2] 참조
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    search_timestamp 조회 타임스탬프 N N(14) API 처리 시점의 현재시각을 설정하여 회신. 다만 정보제공자는 Timestamp 로직을 의무적으로 구현할 필요가 없으며(선택사항), Timestamp 로직 미제공 시에는 항상 0을 회신 또는 미회신
    irp_cnt 보유계좌수 Y N(3) 보유한 개인형 IRP 계좌 수
    irp_list 보유계좌목록 Y <object>
    --prod_name 상품명 Y AH(300) 개인형 IRP 상품의 명칭
    --account_num 계좌번호 Y aN(20) 해당 고객이 보유한 개인형 IRP 계좌번호
    - "-" 제외
    --is_consent 전송요구 여부 Y Boolean 정보주체가 해당 자산(계좌번호)에 대해 개인신용정보 전송요구를 했는지 여부
  • 개인형 IRP 계좌 목록 조회 (은행, 금투, 보험 공통) v1 2024-10-21

    기본 정보
    API ID IRP-001 (보험) HTTP Method GET
    API 제공자 은행업권, 금투업권, 보험업권 API 요청자 마이데이터사업자
    API 명 (URI) /v1/insu/irps
    설명 정보주체가 보유한 개인형 IRP 계좌목록 조회
    기준시점 현재 시점
    Content-Type(요청) - Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급된 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Parameter org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    search_timestamp 조회 타임스탬프 Y N(14) 가장 최근 조회한 시간 (이전 API 호출 시 정보제공자가 회신한 값을 저장하고 있다가 다음 API 호출 시 그 값을 그대로 세팅하여 전송, 최초 API 호출시에는 0으로 세팅)
    - 2.1-[2] 참조
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    search_timestamp 조회 타임스탬프 N N(14) API 처리 시점의 현재시각을 설정하여 회신. 다만 정보제공자는 Timestamp 로직을 의무적으로 구현할 필요가 없으며(선택사항), Timestamp 로직 미제공 시에는 항상 0을 회신 또는 미회신
    irp_cnt 보유계좌수 Y N(3) 보유한 개인형 IRP 계좌 수
    irp_list 보유계좌목록 Y <object>
    --prod_name 상품명 Y AH(300) 개인형 IRP 상품의 명칭
    --account_num 계좌번호 Y aN(20) 해당 고객이 보유한 개인형 IRP 계좌번호
    - "-" 제외
    --is_consent 전송요구 여부 Y Boolean 정보주체가 해당 자산(계좌번호)에 대해 개인신용정보 전송요구를 했는지 여부
  • 개인형 IRP 계좌 기본정보 조회 (은행, 금투, 보험 공통) v1 2024-10-21

    기본 정보
    API ID IRP-002 (보험) HTTP Method POST
    API 제공자 은행업권, 금투업권, 보험업권 API 요청자 마이데이터사업자
    API 명 (URI) /v1/insu/irps/basic
    설명 정보주체가 보유한 개인형 IRP 계좌별 기본 정보 조회
    기준시점 현재 시점
    Content-Type(요청) application/json; charset=UTF-8 Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급된 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Body org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    account_num 계좌번호 Y aN(20) 개인형 IRP 계좌번호
    - "-" 제외
    search_timestamp 조회 타임스탬프 Y N(14) 가장 최근 조회한 시간 (이전 API 호출 시 정보제공자가 회신한 값을 저장하고 있다가 다음 API 호출 시 그 값을 그대로 세팅하여 전송, 최초 API 호출시에는 0으로 세팅)
    - 2.1-[2] 참조
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    search_timestamp 조회 타임스탬프 N N(14) API 처리 시점의 현재시각을 설정하여 회신. 다만 정보제공자는 Timestamp 로직을 의무적으로 구현할 필요가 없으며(선택사항), Timestamp 로직 미제공 시에는 항상 0을 회신 또는 미회신
    accum_amt 계좌잔액 Y F(18,3) IRP 계좌의 잔액
    - 각 사 정책에 따라 전송하되, 앱 또는 웹을 고객에게 제공하는 수치와 같은 값(실시간 기준)
    eval_amt 계좌평가금액 Y F(18,3) 조회 시점 전일자 기준의 이자 등 운용수익이 반영된 평가금액(계좌 전체 기준, 수수료관련 이슈는 각 사 정책에 따름
    employer_amt 사용자부담금 Y F(18,3) 적립금액 중 사용자 부담금
    employee_amt 가입자부담금 Y F(18,3) 적립금액 중 가입자 부담금
    - ISA 만기자금 포함
    issue_date 개설일 Y DATE 계좌 개설일
    - 통장이 만들어진 날짜
    first_deposit_date 최초입금일 N DATE 연금계좌 가입일 (DC 최초 부담금 납입일①과 개인형 IRP 최초부담금납입일② 중 빠른 날짜
    reg_date 최초제도가입일 N DATE DB 제도에서 퇴직금이 입금되었을대 DB 제도의 가입일
    rcv_start_date 연금개시시작(예정)일 N DATE 고객이 연금개시가 되도록 지정한 날짜(예정) 또는 연금개시가 시작된 날짜
  • 개인형 IRP 계좌 기본정보 조회 (은행, 금투, 보험 공통) v2 2024-10-21

    기본 정보
    API ID IRP-002 (보험) HTTP Method POST
    API 제공자 은행업권, 금투업권, 보험업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/insu/irps/basic
    설명 정보주체가 보유한 개인형 IRP 계좌별 기본 정보 조회
    기준시점 현재 시점
    Content-Type(요청) application/json; charset=UTF-8 Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급된 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Body org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    account_num 계좌번호 Y aN(20) 개인형 IRP 계좌번호
    - "-" 제외
    search_timestamp 조회 타임스탬프 Y N(14) 가장 최근 조회한 시간 (이전 API 호출 시 정보제공자가 회신한 값을 저장하고 있다가 다음 API 호출 시 그 값을 그대로 세팅하여 전송, 최초 API 호출시에는 0으로 세팅)
    - 2.1-[2] 참조
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    search_timestamp 조회 타임스탬프 N N(14) API 처리 시점의 현재시각을 설정하여 회신. 다만 정보제공자는 Timestamp 로직을 의무적으로 구현할 필요가 없으며(선택사항), Timestamp 로직 미제공 시에는 항상 0을 회신 또는 미회신
    accum_amt 계좌잔액 Y F(18,3) IRP 계좌의 잔액
    - 각 사 정책에 따라 전송하되, 앱 또는 웹을 고객에게 제공하는 수치와 같은 값(실시간 기준)
    eval_amt 계좌평가금액 Y F(18,3) 조회 시점 전일자 기준의 이자 등 운용수익이 반영된 평가금액(계좌 전체 기준, 수수료관련 이슈는 각 사 정책에 따름
    employer_amt 사용자부담금 Y F(18,3) 적립금액 중 사용자 부담금
    employee_amt 가입자부담금 Y F(18,3) 적립금액 중 가입자 부담금
    - ISA 만기자금 포함
    issue_date 개설일 Y DATE 계좌 개설일
    - 통장이 만들어진 날짜
    first_deposit_date 최초입금일 N DATE 연금계좌 가입일 (DC 최초 부담금 납입일①과 개인형 IRP 최초부담금납입일② 중 빠른 날짜
    reg_date 최초제도가입일 N DATE DB 제도에서 퇴직금이 입금되었을대 DB 제도의 가입일
    rcv_start_date 연금개시시작(예정)일 N DATE 고객이 연금개시가 되도록 지정한 날짜(예정) 또는 연금개시가 시작된 날짜
  • 개인형 IRP 계좌 추가정보 조회 (은행, 금투, 보험 공통) v2 2024-10-21

    기본 정보
    API ID IRP-003 (보험) HTTP Method POST
    API 제공자 은행업권, 금투업권, 보험업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/insu/irps/detail
    설명 정보주체가 보유한 개인형 IRP 추가정보(상품정보 등) 조회
    Pagination, 신규일 기준 내림차순 (일부 기관의 경우 운용상품 수가 500개 초과하는 경우 존재)
    기준시점 현재 시점
    Content-Type(요청) application/json; charset=UTF-8 Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급된 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Body org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    account_num 계좌번호 Y aN(20) 개인형 IRP 계좌번호
    - "-" 제외
    search_timestamp 조회 타임스탬프 N N(14) 가장 최근 조회한 시간 (이전 API 호출 시 정보제공자가 회신한 값을 저장하고 있다가 다음 API 호출 시 그 값을 그대로 세팅하여 전송, 최초 API 호출시에는 0으로 세팅)
    - 2.1-[2] 참조
    - next_page가 세팅된 경우 요청에서 제외
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체 (설정 시 해당 개체 후 limit 개 반환)
    처음 API 호출 시에는 해당 정보를 세팅하지 않으며, 다음 페이지 요청 시 직전 조회의 응답에서 얻은 기준개체를 그대로 세팅
    - 2.1-[2] 페이지네이션 참조
    limit 최대조회갯수 Y N(3) 기준개체 이후 반환될 개체의 개수
    - 최대 500까지 설정 가능
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    search_timestamp 조회 타임스탬프 N N(14) API 처리 시점의 현재시각을 설정하여 회신. 다만 정보제공자는 Timestamp 로직을 의무적으로 구현할 필요가 없으며(선택사항), Timestamp 로직 미제공 시에는 항상 0을 회신 또는 미회신
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체
    - 다음 페이지 존재하지 않는 경우(마지막 페이지), 미회신
    - 2.1-[2] 페이지네이션 참조
    irp_cnt 운용상품수 Y N(3)
    irp_list 운용상품목록 Y <object>
    --irp_name 개별운용상품명 Y AH(300) 금융회사의 원장에 기록되어 있는 개별운용상품의 명칭 (예 : 00은행 정기예금 1년 등)
    --irp_no 상품가입번호 N aN(64) 상품관리번호 (동일상품에 대해 여러 번 투자한 경우 이를 구분하기 위한 식별값)
    - 정보제공자가 개별운용상품 단위로 정보를 관리하지 않을 경우 미회신(예: 단일 개별운용상품에 다수의 계좌상품이 포함되어 해당 정보들이 각기 관리되는 경우)
    --irp_type 상품유형
    (코드)
    Y aN(2) 개별운용상품의 상품 유형
    - <코드값>
    01 : 원리금 보장
    02 : 원리금 비보장
    03 : 기타
    --eval_amt 평가금액 Y F(18,3) 기준일자의 이자 등 운용수익이 반영된 평가금액(개별운용상품 기준, 수수료 관련 이슈는 각 사 정책에 따름)
    --inv_principal 납입(투자)원금 Y F(18,3) 납입원본 또는 납입후 이자 재예치후 원금 (개별운용상품 기준 잔액 표기 = 고객이 납입한 총 원금 - 지급 원금)
    --fund_num 보유좌수 N F(18,3) 개별운용상품이 보유한 좌수
    - 원리금 보장(예금) 상품의 경우 (보유좌수를 관리 안함) 미회신- 정보제공자가 개별운용상품 단위로 정보를 관리하지 않을 경우 미회신(예: 단일 개별운용상품에 다수의 계좌상품이 포함되어 해당 정보들이 각기 관리되는 경우)
    --open_date 신규일 N DATE 개별상품 신규일(재예치일)
    - 정보제공자가 개별운용상품 단위로 정보를 관리하지 않을 경우 미회신(예: 단일 개별운용상품에 다수의 계좌상품이 포함되어 해당 정보들이 각기 관리되는 경우)
    --exp_date 만기일 N DATE 개발상품 만기일
    - 없을 경우 회신 안 함
    - 정보제공자가 개별운용상품 단위로 정보를 관리하지 않을 경우 미회신(예: 단일 개별운용상품에 다수의 계좌상품이 포함되어 해당 정보들이 각기 관리되는 경우)
    --int_rate 약정이자율 N F(5,3) 해당 개별운용상품이 원리금 보장(예금) 상품일 경우의 이자율
    - 원리금 보장(예금)만 해당하며, 그 외는 미회신
    - 정보제공자가 개별운용상품 단위로 정보를 관리하지 않을 경우 미회신(예: 단일 개별운용상품에 다수의 계좌상품이 포함되어 해당 정보들이 각기 관리되는 경우)
  • 개인형 IRP 계좌 추가정보 조회 (은행, 금투, 보험 공통) v1 2024-10-21

    기본 정보
    API ID IRP-003 (보험) HTTP Method POST
    API 제공자 은행업권, 금투업권, 보험업권 API 요청자 마이데이터사업자
    API 명 (URI) /v1/insu/irps/detail
    설명 정보주체가 보유한 개인형 IRP 추가정보(상품정보 등) 조회
    Pagination, 신규일 기준 내림차순 (일부 기관의 경우 운용상품 수가 500개 초과하는 경우 존재)
    기준시점 현재 시점
    Content-Type(요청) application/json; charset=UTF-8 Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급된 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Body org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    account_num 계좌번호 Y aN(20) 개인형 IRP 계좌번호
    - "-" 제외
    search_timestamp 조회 타임스탬프 N N(14) 가장 최근 조회한 시간 (이전 API 호출 시 정보제공자가 회신한 값을 저장하고 있다가 다음 API 호출 시 그 값을 그대로 세팅하여 전송, 최초 API 호출시에는 0으로 세팅)
    - 2.1-[2] 참조
    - next_page가 세팅된 경우 요청에서 제외
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체 (설정 시 해당 개체 후 limit 개 반환)
    처음 API 호출 시에는 해당 정보를 세팅하지 않으며, 다음 페이지 요청 시 직전 조회의 응답에서 얻은 기준개체를 그대로 세팅
    - 2.1-[2] 페이지네이션 참조
    limit 최대조회갯수 Y N(3) 기준개체 이후 반환될 개체의 개수
    - 최대 500까지 설정 가능
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    search_timestamp 조회 타임스탬프 N N(14) API 처리 시점의 현재시각을 설정하여 회신. 다만 정보제공자는 Timestamp 로직을 의무적으로 구현할 필요가 없으며(선택사항), Timestamp 로직 미제공 시에는 항상 0을 회신 또는 미회신
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체
    - 다음 페이지 존재하지 않는 경우(마지막 페이지), 미회신
    - 2.1-[2] 페이지네이션 참조
    irp_cnt 운용상품수 Y N(3)
    irp_list 운용상품목록 Y <object>
    --irp_name 개별운용상품명 Y AH(300) 금융회사의 원장에 기록되어 있는 개별운용상품의 명칭 (예 : 00은행 정기예금 1년 등)
    --irp_no 상품가입번호 N aN(64) 상품관리번호 (동일상품에 대해 여러 번 투자한 경우 이를 구분하기 위한 식별값)
    - 정보제공자가 개별운용상품 단위로 정보를 관리하지 않을 경우 미회신(예: 단일 개별운용상품에 다수의 계좌상품이 포함되어 해당 정보들이 각기 관리되는 경우)
    --irp_type 상품유형
    (코드)
    Y aN(2) 개별운용상품의 상품 유형
    - <코드값>
    01 : 원리금 보장
    02 : 원리금 비보장
    03 : 기타
    --eval_amt 평가금액 Y F(18,3) 기준일자의 이자 등 운용수익이 반영된 평가금액(개별운용상품 기준, 수수료 관련 이슈는 각 사 정책에 따름)
    --inv_principal 납입(투자)원금 Y F(18,3) 납입원본 또는 납입후 이자 재예치후 원금 (개별운용상품 기준 잔액 표기 = 고객이 납입한 총 원금 - 지급 원금)
    --fund_num 보유좌수 N F(18,3) 개별운용상품이 보유한 좌수
    - 원리금 보장(예금) 상품의 경우 (보유좌수를 관리 안함) 미회신- 정보제공자가 개별운용상품 단위로 정보를 관리하지 않을 경우 미회신(예: 단일 개별운용상품에 다수의 계좌상품이 포함되어 해당 정보들이 각기 관리되는 경우)
    --open_date 신규일 N DATE 개별상품 신규일(재예치일)
    - 정보제공자가 개별운용상품 단위로 정보를 관리하지 않을 경우 미회신(예: 단일 개별운용상품에 다수의 계좌상품이 포함되어 해당 정보들이 각기 관리되는 경우)
    --exp_date 만기일 N DATE 개발상품 만기일
    - 없을 경우 회신 안 함
    - 정보제공자가 개별운용상품 단위로 정보를 관리하지 않을 경우 미회신(예: 단일 개별운용상품에 다수의 계좌상품이 포함되어 해당 정보들이 각기 관리되는 경우)
    --int_rate 약정이자율 N F(5,3) 해당 개별운용상품이 원리금 보장(예금) 상품일 경우의 이자율
    - 원리금 보장(예금)만 해당하며, 그 외는 미회신
    - 정보제공자가 개별운용상품 단위로 정보를 관리하지 않을 경우 미회신(예: 단일 개별운용상품에 다수의 계좌상품이 포함되어 해당 정보들이 각기 관리되는 경우)
  • 개인형 IRP 계좌 거래내역 조회 (은행, 금투, 보험 공통) v2 2024-10-21

    기본 정보
    API ID IRP-004 (보험) HTTP Method POST
    API 제공자 은행업권, 금투업권, 보험업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/insu/irps/transactions
    설명 정보주체가 보유한 개인형 IRP 거래정보 조회 (Pagination, 거래일시 기준 내림차순)
    - 신용정보법 시행령 제28조의3제4항에 의거, 최근 5년 이내 정보 제공
    기준시점 FROM과 TO를 확인하여 해당 기간의 정보를 회신
    Content-Type(요청) application/json; charset=UTF-8 Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급한 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Body org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    account_num 계좌번호 Y aN(20) 개인형 IRP 계좌번호
    - "-" 제외
    from_date 시작일자 Y DATE 조회 시작일자
    to_date 종료일자 Y DATE 조회 종료일자
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체 (설정 시 해당 개체 후 limit 개 반환)
    처음 API 호출 시에는 해당 정보를 세팅하지 않으며, 다음 페이지 요청 시 직전 조회의 응답에서 얻은 기준개체를 그대로 세팅
    - 2.1-[2] 페이지네이션 참조
    limit 최대조회갯수 Y N(3) 기준개체 이후 반환될 개체의 개수
    - 최대 500까지 설정 가능
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체
    - 다음 페이지 존재하지 않는 경우(마지막 페이지), 미회신
    - 2.1-[2] 페이지네이션 참조
    trans_cnt 거래목록수 Y N(3)
    trans_list 거래목록 Y <object>
    --trans_dtime 거래일시 또는 거래일자 Y DTIME 또는 DATE 거래가 일어난 날짜와 시간(YYYYMMDDhhmmss)
    - 시각 정보가 없는 경우 거래일자인 YYYYMMDD 회신(일부 기관의 경우 거래일자+거래번호로 관리)
    --trans_no 거래번호 N aN(64) 해당일자의 거래 특정 번호
    (없을 경우 미회신)
    --trans_type 거래구분 Y aN(2) 해당 거래의 거래 유형
    - <코드값>
    01 : 입금
    02 : 지급
    --trans_amt 거래금액 Y N(15) 해당 거래의 금액
  • 개인형 IRP 계좌 거래내역 조회 (은행, 금투, 보험 공통) v1 2024-10-21

    기본 정보
    API ID IRP-004 (보험) HTTP Method POST
    API 제공자 은행업권, 금투업권, 보험업권 API 요청자 마이데이터사업자
    API 명 (URI) /v1/insu/irps/transactions
    설명 정보주체가 보유한 개인형 IRP 거래정보 조회 (Pagination, 거래일시 기준 내림차순)
    - 신용정보법 시행령 제28조의3제4항에 의거, 최근 5년 이내 정보 제공
    기준시점 FROM과 TO를 확인하여 해당 기간의 정보를 회신
    Content-Type(요청) application/json; charset=UTF-8 Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급한 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Body org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    account_num 계좌번호 Y aN(20) 개인형 IRP 계좌번호
    - "-" 제외
    from_date 시작일자 Y DATE 조회 시작일자
    to_date 종료일자 Y DATE 조회 종료일자
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체 (설정 시 해당 개체 후 limit 개 반환)
    처음 API 호출 시에는 해당 정보를 세팅하지 않으며, 다음 페이지 요청 시 직전 조회의 응답에서 얻은 기준개체를 그대로 세팅
    - 2.1-[2] 페이지네이션 참조
    limit 최대조회갯수 Y N(3) 기준개체 이후 반환될 개체의 개수
    - 최대 500까지 설정 가능
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체
    - 다음 페이지 존재하지 않는 경우(마지막 페이지), 미회신
    - 2.1-[2] 페이지네이션 참조
    trans_cnt 거래목록수 Y N(3)
    trans_list 거래목록 Y <object>
    --trans_dtime 거래일시 또는 거레일자 Y DTIME 또는 DATE 거래가 일어난 날짜와 시간(YYYYMMDDhhmmss)
    - 시각 정보가 없는 경우 거래일자인 YYYYMMDD 회신(일부 기관의 경우 거래일자+거래번호로 관리)
    --trans_no 거래번호 N aN(64) 해당일자의 거래 특정 번호
    (없을 경우 미회신)
    --trans_type 거래구분 Y aN(2) 해당 거래의 거래 유형
    - <코드값>
    01 : 입금
    02 : 지급
    --trans_amt 거래금액 Y N(15) 해당 거래의 금액
  • 보험 목록 조회 v2 2024-10-21

    기본 정보
    API ID 보험-001 HTTP Method GET
    API 제공자 보험업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/insu/insurances
    설명 정보주체가 계약한 금융회사별 보험 목록 조회
    - pagination, 보혐종류구분(코드) 기준 오름차순
    - 계약자가 정보주체 본인인 상품 회신 (계약자 조회시 계피상이 포함)
    - 2006년 이전 가입 건도 현재 계약상태가 '정상'일 경우 회신
    - 계약상태가 '만기'인 경우, 조회일 기준 5년 이내 만기 계약일 경우에만 회신
    - 일부 기관의 경우 아래와 같은 계약 존재 시 계약상태(주계약)를 ‘소멸’로 회신
    1) 표준화 갱신 상품의 경우 주계약이 ‘소멸’ 상태이나, 특약은 ‘정상’인 계약 존재
    2) ‘주계약만기일 < 특약만기일‘ 상품의 경우 주계약이 ‘소멸’ 상태이나, 특약은 ‘정상’인 계약 존재
    3) 연금전환 처리되는 계약중 주계약만 전환 시 주계약은 ‘해지’ 또는 ‘소멸’ 상태이나, 특약은 ‘정상’인 계약 존재 → 이 경우 계약상태를 ‘소멸’로 회신
    - 세 가지 케이스 모두 해당 상품에 대한 기본정보(보험-002)와 특약정보(보험-003)를 제공
    - 다만, 3)의 경우 주계약이 전환된 신규 연금상품의 경우 기본정보만 제공하고 특약정보는 미제공
    - 보험-001로 수집한 증권번호로 다음의 API를 호출 가능 : 보험-002, 보험-003, 보험-004, 보험-005, 보험-006, 보험-007, 보험-012, 보험-018, 보험-019, 보험-020, 보험-021, 보험-024
    - 손보업권의 경우 물담보 하나라도 포함시 물/일반 API 통해 전송하며, 없는 경우 장기인 API 통해 전송
    기준시점 현재 시점
    Content-Type(요청) - Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급한 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Parameter org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    search_timestamp 조회 타임스탬프 N N(14) 가장 최근 조회한 시간 (이전 API 호출 시 정보제공자가 회신한 값을 저장하고 있다가 다음 API 호출 시 그 값을 그대로 세팅하여 전송, 최초 API 호출시에는 0으로 세팅)
    - 2.1-[2] 참조
    - next_page가 세팅된 경우 요청에서 제외
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체 (설정 시 해당 개체 후 limit 개 반환)
    처음 API 호출 시에는 해당 정보를 세팅하지 않으며, 다음 페이지 요청 시 직전 조회의 응답에서 얻은 기준개체를 그대로 세팅
    - 2.1-[2] 페이지네이션 참조
    limit 최대조회갯수 Y N(3) 기준개체 이후 반환될 개체의 개수
    - 최대 500까지 설정 가능
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    search_timestamp 조회 타임스탬프 N N(14) API 처리 시점의 현재시각을 설정하여 회신. 다만 정보제공자는 Timestamp 로직을 의무적으로 구현할 필요가 없으며(선택사항), Timestamp 로직 미제공 시에는 항상 0을 회신 또는 미회신
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체
    - 다음 페이지 존재하지 않는 경우(마지막 페이지), 미회신
    - 2.1-[2] 페이지네이션 참조
    insu_cnt 보유계약수 Y N(3)
    insu_list 보유계약목록 Y Object
    --insu_num 증권번호 Y aN(20) 보험 계약자가 가입한 증권번호
    - 마스킹 처리 불필요, "-" 제외
    --is_consent 전송요구 여부 Y Boolean 정보주체가 해당 자산(증권번호)에 대해 개인신용정보 전송요구를 했는지 여부
    --prod_name 상품명 Y AH(300) 보험 상품의 공식 명칭
    --insu_type 보험종류 구분 (코드) Y aN(2) 해당 계약의 보험종류 구분
    - [첨부7] 보험종류 코드
    --insu_status 계약상태 (코드) Y aN(2) 현재 주계약의 계약상태
    - <코드값>
    02: 정상(보장개시(초회보험료 납입) 및 승낙처리 된 상태)
    04: 실효(계속보험료 연체로 회사가 연체사실 등을 알린 뒤 효력이 상실된 상태)
    05: 만기(보험기간이 경과하여 보험금이 지급되기 전 상태)
    06: 소멸(지급소멸, 만기소멸, 납입면제 등에 따른 소멸상태. 단, 납입면제 이후 보장이 계속 유지되는 경우에는 정상(02)상태 등록하나, 종신보험의 연금보험 전환 시에는 소멸(06)사용)
    - 만기의 경우, 조회일 기준 5년 이내 만기 계약일 경우에만 회신
  • 보험 목록 조회 v1 2024-10-21

    기본 정보
    API ID 보험-001 HTTP Method GET
    API 제공자 보험업권 API 요청자 마이데이터사업자
    API 명 (URI) /v1/insu/insurances
    설명 정보주체가 계약한 금융회사별 보험 목록 조회
    - pagination, 보혐종류구분(코드) 기준 오름차순
    - 계약자가 정보주체 본인인 상품 회신 (계피상이건도 포함)
    - 2006년 이전 가입 건도 현재 계약상태가 '정상'일 경우 회신
    - 계약상태가 '만기'인 경우, 조회일 기준 5년 이내 만기 계약일 경우에만 회신
    - 일부 기관의 경우 아래와 같은 계약 존재 시 계약상태(주계약)를 ‘소멸’로 회신
    1) 표준화 갱신 상품의 경우 주계약이 ‘소멸’ 상태이나, 특약은 ‘정상’인 계약 존재
    2) ‘주계약만기일 < 특약만기일‘ 상품의 경우 주계약이 ‘소멸’ 상태이나, 특약은 ‘정상’인 계약 존재
    3) 연금전환 처리되는 계약중 주계약만 전환 시 주계약은 ‘해지’ 또는 ‘소멸’ 상태이나, 특약은 ‘정상’인 계약 존재 → 이 경우 계약상태를 ‘소멸’로 회신
    - 세 가지 케이스 모두 해당 상품에 대한 기본정보(보험-002)와 특약정보(보험-003)를 제공
    - 다만, 3)의 경우 주계약이 전환된 신규 연금상품의 경우 기본정보만 제공하고 특약정보는 미제공
    기준시점 현재 시점
    Content-Type(요청) - Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급한 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Parameter org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    search_timestamp 조회 타임스탬프 N N(14) 가장 최근 조회한 시간 (이전 API 호출 시 정보제공자가 회신한 값을 저장하고 있다가 다음 API 호출 시 그 값을 그대로 세팅하여 전송, 최초 API 호출시에는 0으로 세팅)
    - 2.1-[2] 참조
    - next_page가 세팅된 경우 요청에서 제외
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체 (설정 시 해당 개체 후 limit 개 반환)
    처음 API 호출 시에는 해당 정보를 세팅하지 않으며, 다음 페이지 요청 시 직전 조회의 응답에서 얻은 기준개체를 그대로 세팅
    - 2.1-[2] 페이지네이션 참조
    limit 최대조회갯수 Y N(3) 기준개체 이후 반환될 개체의 개수
    - 최대 500까지 설정 가능
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    search_timestamp 조회 타임스탬프 N N(14) API 처리 시점의 현재시각을 설정하여 회신. 다만 정보제공자는 Timestamp 로직을 의무적으로 구현할 필요가 없으며(선택사항), Timestamp 로직 미제공 시에는 항상 0을 회신 또는 미회신
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체
    - 다음 페이지 존재하지 않는 경우(마지막 페이지), 미회신
    - 2.1-[2] 페이지네이션 참조
    insu_cnt 보유계약수 Y N(5)
    insu_list 보유계약목록 Y Object
    --insu_num 증권번호 Y aN(20) 보험 계약자가 가입한 증권번호
    - 마스킹 처리 불필요, "-" 제외
    --is_consent 전송요구 여부 Y Boolean 정보주체가 해당 자산(증권번호)에 대해 개인신용정보 전송요구를 했는지 여부
    --prod_name 상품명 Y AH(300) 보험 상품의 공식 명칭
    --insu_type 보험종류 구분 (코드) Y aN(2) 해당 계약의 보험종류 구분
    - [첨부7] 보험종류 코드
    --insu_status 계약상태 (코드) Y aN(2) 현재 주계약의 계약상태
    - <코드값>
    02: 정상(보장개시(초회보험료 납입) 및 승낙처리 된 상태)
    04: 실효(계속보험료 연체로 회사가 연체사실 등을 알린 뒤 효력이 상실된 상태)
    05: 만기(보험기간이 경과하여 보험금이 지급되기 전 상태)
    06: 소멸(지급소멸, 만기소멸, 납입면제 등에 따른 소멸상태. 단, 납입면제 이후 보장이 계속 유지되는 경우에는 정상(02)상태 등록하나, 종신보험의 연금보험 전환 시에는 소멸(06)사용)
    - 만기의 경우, 조회일 기준 5년 이내 만기 계약일 경우에만 회신
  • 보험 기본정보 조회 v2 2024-10-21

    기본 정보
    API ID 보험-002 HTTP Method POST
    API 제공자 보험업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/insu/insurances/basic
    설명 정보주체가 계약한 보험별 기본정보(주계약정보) 조회
    - 자동차보험 기본 정보는 보험-004 API 사용
    기준시점 현재 시점
    Content-Type(요청) application/json; charset=UTF-8 Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급한 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Body org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    insu_num 증권번호 Y aN(20) 보험 계약자가 가입한 증권번호
    search_timestamp 조회 타임스탬프 Y N(14) 가장 최근 조회한 시간 (이전 API 호출 시 정보제공자가 회신한 값을 저장하고 있다가 다음 API 호출 시 그 값을 그대로 세팅하여 전송, 최초 API 호출시에는 0으로 세팅)
    - 2.1-[2] 참조
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    search_timestamp 조회 타임스탬프 N N(14) API 처리 시점의 현재시각을 설정하여 회신. 다만 정보제공자는 Timestamp 로직을 의무적으로 구현할 필요가 없으며(선택사항), Timestamp 로직 미제공 시에는 항상 0을 회신 또는 미회신
    is_renewable 갱신여부 (여부) Y Boolean 주계약의 갱신형 / 비갱신형 구분
    - 주계약 기준(특약 별 갱신/비갱신 여부는 고려하지 않음)
    - true : 갱신형, false : 비갱신형
    issue_date 계약체결일 Y DATE 보험계약자와 보험회사의 보험계약 체결일, 철회 산정기간의 기준일
    - 보험갱신 시 증권번호를 새로 발급한 경우 신규 계약체결일을 회신하고, 그렇지 않은 경우 기존 계약체결일을 회신
    exp_date 만기일자 Y DATE 보험계약을 보장받을수 있는 일자
    face_amt 보험가입금액 Y F(18,3) 주계약 보험가입금액
    currency_code 통화코드(보험가입금액) N A(3) 통화코드 (ISO 4217 준용)
    - 외화보험의 경우(보험료 납입을 외화로 하는 경우) 통화코드 사용 필요
    - 통화코드값이 명시되어있지 않을 경우 KRW(원)
    is_variable 변액보험 여부 Y Boolean 상품의 변액보험 해당 여부
    is_universal 유니버셜 여부 Y Boolean 상품의 유니버셜 해당 여부
    pension_rcv_start_date 연금개시일 N DATE 연금개시일이 아닌 '연령'을 관리하는 기관의 경우, 연금개시일은 계산하여 회신
    pension_rcv_cycle 연금수령주기 N AN(2) 실제 약정한 내용이 있는 경우에만 <<월, 3개월, 6개월 연단위>>
    (연금보험이 아닌 경우 회신 안 함)
    - <코드값>
    1M : 매월
    3M : 3개월
    6M : 6개월
    1Y : 연단위
    is_loanable 대출실행 가능 상품 여부 Y Boolean 대출 계약이 가능 상품인지 여부(현재 대출실행 가능 여부는 고려하지 않음)
    - 대출 실행 가능 상품이면 대출 실행 가능 금액이 없을 경우에도 해당 값이 'true'로 전송될 수 있음
    - true : 실행가능, false : 실행불가
    insured_cnt 피보험자수 Y N(2) 피보험자수
    insured_list 피보험자목록 Y Object
    --insured_no 피보험자 번호 Y aN(10) 특약 정보 조회(보험-003) 시 피보험자를 구분하기 위한 parameter로 쓰이는 순번
    - 정보제공자 자율적으로 순번을 채번
    --insured_name 피보험자명 Y AH(30) 피보험자 이름
    - 짝수번째 자리 마스킹 전송
    - 피보험자가 본인인 경우 '본인' 회신
    --is_primary 주피보험자여부 Y Boolean 피보험자가 본 계약의 주피보험자에 해당하는지 여부
    - 주피보험자 : True, 종피보험자 : False
  • 보험 기본정보 조회 v1 2024-10-21

    기본 정보
    API ID 보험-002 HTTP Method POST
    API 제공자 보험업권 API 요청자 마이데이터사업자
    API 명 (URI) /v1/insu/insurances/basic
    설명 정보주체가 계약한 보험별 기본정보(주계약정보) 조회
    - 자동차보험 기본 정보는 보험-004 API 사용
    - 피보험자가 10명 이상일 경우(계약자가 개인인 단체보험 등), 10명까지의 피보험자 정보만 전송 가능
    기준시점 현재 시점
    Content-Type(요청) application/json; charset=UTF-8 Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급한 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Body org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    insu_num 증권번호 Y aN(20) 보험 계약자가 가입한 증권번호
    search_timestamp 조회 타임스탬프 Y N(14) 가장 최근 조회한 시간 (이전 API 호출 시 정보제공자가 회신한 값을 저장하고 있다가 다음 API 호출 시 그 값을 그대로 세팅하여 전송, 최초 API 호출시에는 0으로 세팅)
    - 2.1-[2] 참조
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    search_timestamp 조회 타임스탬프 N N(14) API 처리 시점의 현재시각을 설정하여 회신. 다만 정보제공자는 Timestamp 로직을 의무적으로 구현할 필요가 없으며(선택사항), Timestamp 로직 미제공 시에는 항상 0을 회신 또는 미회신
    is_renewable 갱신여부 (여부) Y Boolean 주계약의 갱신형 / 비갱신형 구분
    - 주계약 기준(특약 별 갱신/비갱신 여부는 고려하지 않음)
    - true : 갱신형, false : 비갱신형
    issue_date 계약체결일 Y DATE 보험계약자와 보험회사의 보험계약 체결일, 철회 산정기간의 기준일
    - 보험갱신 시 증권번호를 새로 발급한 경우 신규 계약체결일을 회신하고, 그렇지 않은 경우 기존 계약체결일을 회신
    exp_date 만기일자 Y DATE 보험계약을 보장받을수 있는 일자
    face_amt 보험가입금액 Y F(18,3) 주계약 보험가입금액
    currency_code 통화코드(보험가입금액) N A(3) 통화코드 (ISO 4217 준용)
    - 외화보험의 경우(보험료 납입을 외화로 하는 경우) 통화코드 사용 필요
    - 통화코드값이 명시되어있지 않을 경우 KRW(원)
    is_variable 변액보험 여부 Y Boolean 상품의 변액보험 해당 여부
    is_universal 유니버셜 여부 Y Boolean 상품의 유니버셜 해당 여부
    pension_rcv_start_date 연금개시일 N DATE 연금개시일이 아닌 '연령'을 관리하는 기관의 경우, 연금개시일은 계산하여 회신
    pension_rcv_cycle 연금수령주기 N AN(2) 실제 약정한 내용이 있는 경우에만 <<월, 3개월, 6개월 연단위>>
    (연금보험이 아닌 경우 회신 안 함)
    - <코드값>
    1M : 매월
    3M : 3개월
    6M : 6개월
    1Y : 연단위
    is_loanable 대출실행 가능 상품 여부 Y Boolean 대출 계약이 가능 상품인지 여부(현재 대출실행 가능 여부는 고려하지 않음)
    - 대출 실행 가능 상품이면 대출 실행 가능 금액이 없을 경우에도 해당 값이 'true'로 전송될 수 있음
    - true : 실행가능, false : 실행불가
    insured_cnt 피보험자수 Y N(2) 피보험자수
    insured_list 피보험자목록 Y Object
    --insured_no 피보험자 번호 Y aN(10) 특약 정보 조회(보험-003) 시 피보험자를 구분하기 위한 parameter로 쓰이는 순번
    - 정보제공자 자율적으로 순번을 채번
    --insured_name 피보험자명 Y AH(30) 피보험자 이름
    - 첫글자와 끝글자를 제외하고 마스킹처리
    --is_primary 주피보험자여부 Y Boolean 주피보험자 여부(주피보험자가 아니거나, 주피보험자가 존재하지 않는 보혐계약의 경우 'false' 회신
  • 보험 특약정보 조회 v1 2024-10-21

    기본 정보
    API ID 보험-003 HTTP Method POST
    API 제공자 보험업권 API 요청자 마이데이터사업자
    API 명 (URI) /v1/insu/insurances/contracts
    설명 정보주체가 계약한 보험별/피보험자별 특약정보 조회
    - 자동차보험 특약정보는 보험-004 API 이용
    기준시점 현재 시점
    Content-Type(요청) application/json; charset=UTF-8 Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급한 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(20) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Body org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    insu_num 증권번호 Y aN(20) 보험 계약자가 가입한 증권번호
    insured_no 피보험자 순번 Y aN(10) 계약 기본 정보 조회(보험-002) 시 회신받은 피보험자 순번
    - 순번에 해당하는 피보험자의 특약 정보를 조회
    search_timestamp 조회 타임스탬프 Y N(14) 가장 최근 조회한 시간 (이전 API 호출 시 정보제공자가 회신한 값을 저장하고 있다가 다음 API 호출 시 그 값을 그대로 세팅하여 전송, 최초 API 호출시에는 0으로 세팅)
    - 2.1-[2] 참조
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    search_timestamp 조회 타임스탬프 N N(14) API 처리 시점의 현재시각을 설정하여 회신. 다만 정보제공자는 Timestamp 로직을 의무적으로 구현할 필요가 없으며(선택사항), Timestamp 로직 미제공 시에는 항상 0을 회신 또는 미회신
    contract_cnt 특약목록수 Y N(3)
    contract_list 특약목록 Y Object
    --contract_name 특약명 Y AH(300) 할인할증특약 등 제도성 특약 내용 포함
    --contract_status 특약의 상태 (코드) Y aN(2) 현재 특약의 계약상태
    - <코드값>
    02 : 정상(보장개시(초회보험료 납입) 및 승낙처리 된 상태)
    04 : 실효(계속보험료 연체로 회사가 연체사실 등을 알린 뒤 효력이 상실된 상태)
    05 : 만기(보험기간이 경과하여 보험금이 지급되기 전 상태)
    --contract_exp_date 특약만기일자 Y DATE 특약의 만기일자
    --contract_face_amt 특약가입금액 Y F(18,3) 보험금 지급 사유 발생 시 고객에게 지급되는 금액(특약보험금)
    --currency_code 통화코드 (특약가입금액) N A(3) 통화코드 (ISO 4217 준용)
    - 외화보험의 경우(보험료 납입을 외화로 하는 경우) 통화코드 사용 필요
    - 통화코드값이 명시되어있지 않을 경우 KRW(원)
    --is_required 특약의 유형 (여부) Y Boolean 해당 특약의 필수성 여부(주보험, 의무부가, 고정부가 특약은 필수)
    - true : 필수, false : 선택
  • 보험 특약정보 조회 v2 2024-10-21

    기본 정보
    API ID 보험-003 HTTP Method POST
    API 제공자 보험업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/insu/insurances/contracts
    설명 정보주체가 계약한 보험별/피보험자별 특약정보 조회
    - 자동차보험 특약정보는 보험-004 API 이용
    기준시점 현재 시점
    Content-Type(요청) application/json; charset=UTF-8 Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급한 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(20) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Body org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    insu_num 증권번호 Y aN(20) 보험 계약자가 가입한 증권번호
    insured_no 피보험자 순번 Y aN(10) 계약 기본 정보 조회(보험-002) 시 회신받은 피보험자 순번
    - 순번에 해당하는 피보험자의 특약 정보를 조회
    search_timestamp 조회 타임스탬프 Y N(14) 가장 최근 조회한 시간 (이전 API 호출 시 정보제공자가 회신한 값을 저장하고 있다가 다음 API 호출 시 그 값을 그대로 세팅하여 전송, 최초 API 호출시에는 0으로 세팅)
    - 2.1-[2] 참조
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    search_timestamp 조회 타임스탬프 N N(14) API 처리 시점의 현재시각을 설정하여 회신. 다만 정보제공자는 Timestamp 로직을 의무적으로 구현할 필요가 없으며(선택사항), Timestamp 로직 미제공 시에는 항상 0을 회신 또는 미회신
    contract_cnt 특약목록수 Y N(3)
    contract_list 특약목록 Y Object
    --contract_name 특약명 Y AH(300) 할인할증특약 등 제도성 특약 내용 포함
    --contract_status 특약의 상태 (코드) Y aN(2) 현재 특약의 계약상태
    - <코드값>
    02 : 정상(보장개시(초회보험료 납입) 및 승낙처리 된 상태)
    04 : 실효(계속보험료 연체로 회사가 연체사실 등을 알린 뒤 효력이 상실된 상태)
    05 : 만기(보험기간이 경과하여 보험금이 지급되기 전 상태)
    --contract_exp_date 특약만기일자 Y DATE 특약의 만기일자
    --contract_face_amt 특약가입금액 Y F(18,3) 보험금 지급 사유 발생 시 고객에게 지급되는 금액(특약보험금)
    --currency_code 통화코드 (특약가입금액) N A(3) 통화코드 (ISO 4217 준용)
    - 외화보험의 경우(보험료 납입을 외화로 하는 경우) 통화코드 사용 필요
    - 통화코드값이 명시되어있지 않을 경우 KRW(원)
    --is_required 특약의 유형 (여부) Y Boolean 해당 특약의 필수성 여부(주보험, 의무부가, 고정부가 특약은 필수)
    - true : 필수, false : 선택
  • 자동차보험 정보 조회 v1 2024-10-21

    기본 정보
    API ID 보험-004 HTTP Method POST
    API 제공자 보험업권 API 요청자 마이데이터사업자
    API 명 (URI) /v1/insu/insurances/car
    설명 정보주체가 계약한 보험별 자동차 보험정보 조회
    - 하나의 증권번호에 차량이 여러 대 가입되어 있는 경우가 있어 List로 회신
    기준시점 현재 시점
    Content-Type(요청) application/json; charset=UTF-8 Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급한 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(20) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Body org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    insu_num 증권번호 Y aN(20) 보험 계약자가 가입한 증권번호
    search_timestamp 조회 타임스탬프 Y N(14) 가장 최근 조회한 시간 (이전 API 호출 시 정보제공자가 회신한 값을 저장하고 있다가 다음 API 호출 시 그 값을 그대로 세팅하여 전송, 최초 API 호출시에는 0으로 세팅)
    - 2.1-[2] 참조
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    search_timestamp 조회 타임스탬프 N N(14) API 처리 시점의 현재시각을 설정하여 회신. 다만 정보제공자는 Timestamp 로직을 의무적으로 구현할 필요가 없으며(선택사항), Timestamp 로직 미제공 시에는 항상 0을 회신 또는 미회신
    car_insu_cnt 자동차보험목록수 Y N(3)
    car_insu_list 자동차보험목록 Y Object
    --car_number 차량번호 Y AH(17) 자동차보험 가입 차량번호 (없을 시, 차대번호)
    --car_insu_type 자동차보험 구분 (코드) Y aN(2) 해당 자동차보험의 유형 구분
    - [첨부8] 자동차보험 구분 코드
    --car_name 계약자 차량명 Y AH(60) 해당 자동차보험의 차량 모델명
    - 보험개발원 차량 모델등급 2단계 수준 (ex. 그랜져 IG, 아슬란, G4 렉스턴 등)
    --start_date 보험시기 Y DATE 자동차 보험의 시작일
    --end_date 보험종기 Y DATE 자동차 보험의 종료일
    --contract_age 연령특약 Y AH(60) 전연령(99회신) / 21세 / 26세 / 30세 /"만 30세 이상 만 59세 이하" 등
    - 보험사마다 달라서 코드화 불가 (텍스트 회신)
    - 나이는 텍스트로 회신하고, 전연령은 "99" 회신
    --contract_driver 운전자한정특약 Y AH(60) 누구나 / 기명1인 / 가족한정 / 부부 / 가족 및 지정 1인 한정 등
    - 보험사마다 달라서 코드화 불가 (텍스트 회신)
    --is_own_dmg_coverage 자기차량손해 (여부) Y Boolean 자기차량손해 가입 여부
    - true : 가입, false : 미가입
    --self_pay_rate 자기부담금 구분 (코드) Y aN(2) 해당 자동차보험의 자기부담금 비율
    - <코드값>
    01 : 20%
    02 : 30%
    --self_pay_amt 자기부담금 금액 Y N(15) 해당 자동차보험의 최소 자기부담금 금액
  • 자동차보험 정보 조회 v2 2024-10-21

    기본 정보
    API ID 보험-004 HTTP Method POST
    API 제공자 보험업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/insu/insurances/car
    설명 정보주체가 계약한 보험별 자동차 보험정보 조회
    - 하나의 증권번호에 차량이 여러 대 가입되어 있는 경우가 있어 List로 회신
    기준시점 현재 시점
    Content-Type(요청) application/json; charset=UTF-8 Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급한 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(20) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Body org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    insu_num 증권번호 Y aN(20) 보험 계약자가 가입한 증권번호
    search_timestamp 조회 타임스탬프 Y N(14) 가장 최근 조회한 시간 (이전 API 호출 시 정보제공자가 회신한 값을 저장하고 있다가 다음 API 호출 시 그 값을 그대로 세팅하여 전송, 최초 API 호출시에는 0으로 세팅)
    - 2.1-[2] 참조
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    search_timestamp 조회 타임스탬프 N N(14) API 처리 시점의 현재시각을 설정하여 회신. 다만 정보제공자는 Timestamp 로직을 의무적으로 구현할 필요가 없으며(선택사항), Timestamp 로직 미제공 시에는 항상 0을 회신 또는 미회신
    car_insu_cnt 자동차보험목록수 Y N(3)
    car_insu_list 자동차보험목록 Y Object
    --car_number 차량번호 Y AH(60) 자동차보험 가입 차량번호 (없을 시, 차대번호)
    - 차량번호, 차대번호 모두 없는 경우 임의로 별도 채번
    --car_insu_type 자동차보험 구분 (코드) Y aN(2) 해당 자동차보험의 유형 구분
    - [첨부8] 자동차보험 구분 코드
    --car_name 계약자 차량명 N AH(60) 해당 자동차보험의 차량 모델명
    - 보험개발원 차량 모델등급 2단계 수준 (ex. 그랜져 IG, 아슬란, G4 렉스턴 등)
    - 대리운전, 이륜차의 경우 정보 부재하여 미전송
    --start_date 보험시기 Y DATE 자동차 보험의 시작일
    --end_date 보험종기 Y DATE 자동차 보험의 종료일
    --contract_age 연령특약 N AH(60) 전연령(99회신) / 21세 / 26세 / 30세 /"만 30세 이상 만 59세 이하" 등(없는 경우 미전송)
    - 보험사마다 달라서 코드화 불가 (텍스트 회신)
    - 나이는 텍스트로 회신하고, 전연령은 "99" 회신
    --contract_driver 운전자한정특약 N AH(60) 누구나 / 기명1인 / 가족한정 / 부부 / 가족 및 지정 1인 한정 등(없는 경우 미전송)
    - 보험사마다 달라서 코드화 불가 (텍스트 회신)
    --is_own_dmg_coverage 자기차량손해 (여부) Y Boolean 자기차량손해 가입 여부
    - true : 가입, false : 미가입
    --self_pay_rate 자기부담금 구분 (코드) N aN(2) 해당 자동차보험의 자기부담금 비율
    - <코드값>
    01 : 20%
    02 : 30%
    99 : 자기차량손해 미가입시
    --self_pay_amt 자기부담금 금액 N N(15) 해당 자동차보험의 최소 자기부담금 금액
    (자기차량손해 미가입시 미전송)
  • 보험 납입정보 조회 v2 2024-10-21

    기본 정보
    API ID 보험-005 HTTP Method POST
    API 제공자 보험업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/insu/insurances/payment
    설명 정보주체가 계약한 보험별 보험료 납입 기본정보 조회- 자동차보험 납입정보는 보험-007 API 이용
    기준시점 현재 시점
    Content-Type(요청) application/json; charset=UTF-8 Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급한 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(20) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Body org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    insu_num 증권번호 Y aN(20) 보험 계약자가 가입한 증권번호
    search_timestamp 조회 타임스탬프 Y N(14) 가장 최근 조회한 시간 (이전 API 호출 시 정보제공자가 회신한 값을 저장하고 있다가 다음 API 호출 시 그 값을 그대로 세팅하여 전송, 최초 API 호출시에는 0으로 세팅)
    - 2.1-[2] 참조
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    search_timestamp 조회 타임스탬프 N N(14) API 처리 시점의 현재시각을 설정하여 회신. 다만 정보제공자는 Timestamp 로직을 의무적으로 구현할 필요가 없으며(선택사항), Timestamp 로직 미제공 시에는 항상 0을 회신 또는 미회신
    pay_due 납입기간구분 (코드) Y aN(2) 납입 만기 기간 구분
    - <코드값>
    - 00 : 기타
    - 01 : 일시납
    - 02 : 연납
    - 03 : 세납
    pay_cycle 납입주기 (코드) Y AN(2) 납입 주기 구분
    - 1M : 매월
    - 2M : 2개월납
    - 3M : 3개월
    - 6M : 6개월
    - 1Y : 연단위
    - 00 : 기타
    - 99 : 일시납
    pay_cnt 총 납입 횟수 Y N(5) 보험 약정 납입기간에 따른 총 납입 횟수
    pay_org_code 납입기관 (코드) N aN(8) 보험료의 납입 방법이 '자동이체'일 경우 자동이체가 이루어지는 기관 코드
    - 지원 API로부터 배포되는 기관코드 중 앞 2자리를 제외한 8자리 회신 (자세한 내용은 서비스 가이드라인 참조)
    - 기관코드는 업권코드(2자리), 대표기관코드(4자리), 지점코드(4자리)로 구성되는데, 여러 업권의 정보를 보유한 금융기관은 다수의 기관코드를 보유(업권별 기관코드 할당)할 수 있기 때문에 업권코드를 제외한 8자리 코드를 사용하여 유일성 확보
    - 종합포털로부터 기관코드를 발급받지 않는 기관(예: 상품권 발행사 등)들의 경우 기타기관코드인 “ZZZZ0000” 회신
    - 저축은행에 개설된 계좌의 정보는 저축은행중앙회에 집중되는 과정에서 계좌 개설 기관이 구분되지 않기 때문에, 개별 저축은행의 기관코드가 아닌, 저축은행중앙회의 기관코드로 전송될 수 있음
    pay_date 납입일자 N aN(2) 보험 계약서 상, 계약자가 작성한 지정 이체 혹은 결제일자 (DD)
    - 자동이체, 급여이체 등 날짜 지정 가능한 납입방법 외의 계약(납입예정일자 미존재)의 경우는 미회신
    납입일자를 숫자(DD)가 아닌 “말일”로 지정한 기관의 경우, “99” 회신
    pay_end_date 납입종료일자 Y DATE 보험료 납입 종료일
    pay_amt 납입 보험료 Y F(18,3) 보험료 납입 주기에 따른 보험료 납입금액
    currency_code 통화코드 (납입 보험료) N A(3) 통화코드 (ISO 4217 준용)
    - 외화버험의 경우 통화코드 사용 필요
    - 통화코드값이 명시되어있지 않을 경우 KRW(원)
    is_auto_pay 자동대출납입 신청 여부 Y Boolean 해당 보험사의 대출상품으로 보혐료를 납입하는자동대출납입 신청 여부
    - true:신청, false:미신청
  • 보험 납입정보 조회 v1 2024-10-21

    기본 정보
    API ID 보험-005 HTTP Method POST
    API 제공자 보험업권 API 요청자 마이데이터사업자
    API 명 (URI) /v1/insu/insurances/payment
    설명 정보주체가 계약한 보험별 보험료 납입 기본정보 조회- 자동차보험 납입정보는 보험-007 API 이용
    기준시점 현재 시점
    Content-Type(요청) application/json; charset=UTF-8 Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급한 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(20) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Body org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    insu_num 증권번호 Y aN(20) 보험 계약자가 가입한 증권번호
    search_timestamp 조회 타임스탬프 Y N(14) 가장 최근 조회한 시간 (이전 API 호출 시 정보제공자가 회신한 값을 저장하고 있다가 다음 API 호출 시 그 값을 그대로 세팅하여 전송, 최초 API 호출시에는 0으로 세팅)
    - 2.1-[2] 참조
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    search_timestamp 조회 타임스탬프 N N(14) API 처리 시점의 현재시각을 설정하여 회신. 다만 정보제공자는 Timestamp 로직을 의무적으로 구현할 필요가 없으며(선택사항), Timestamp 로직 미제공 시에는 항상 0을 회신 또는 미회신
    pay_due 납입기간구분 (코드) Y aN(2) 납입 만기 기간 구분
    - <코드값>
    01 : 일시납
    02 : 연납
    03 : 세납
    pay_cycle 납입주기 (코드) Y AN(2) 납입 주기 구분
    - 1M : 매월
    - 2M : 2개월납
    - 3M : 3개월
    - 6M : 6개월
    - 1Y : 연단위
    - 99 : 일시납
    pay_cnt 총 납입 횟수 Y N(5) 보험 약정 납입기간에 따른 총 납입 횟수
    pay_org_code 납입기관 (코드) N aN(8) 보험료의 납입 방법이 '자동이체'일 경우 자동이체가 이루어지는 기관 코드
    - 지원 API로부터 배포되는 기관코드 중 앞 2자리를 제외한 8자리 회신 (자세한 내용은 서비스 가이드라인 참조)
    - 기관코드는 업권코드(2자리), 대표기관코드(4자리), 지점코드(4자리)로 구성되는데, 여러 업권의 정보를 보유한 금융기관은 다수의 기관코드를 보유(업권별 기관코드 할당)할 수 있기 때문에 업권코드를 제외한 8자리 코드를 사용하여 유일성 확보
    - 종합포털로부터 기관코드를 발급받지 않는 기관(예: 상품권 발행사 등)들의 경우 기타기관코드인 “ZZZZ0000” 회신
    - 저축은행에 개설된 계좌의 정보는 저축은행중앙회에 집중되는 과정에서 계좌 개설 기관이 구분되지 않기 때문에, 개별 저축은행의 기관코드가 아닌, 저축은행중앙회의 기관코드로 전송될 수 있음
    pay_date 납입일자 N aN(2) 보험 계약서 상, 계약자가 작성한 지정 이체 혹은 결제일자 (DD)
    - 자동이체, 급여이체 등 날짜 지정 가능한 납입방법 외의 계약(납입예정일자 미존재)의 경우는 미회신
    납입일자를 숫자(DD)가 아닌 “말일”로 지정한 기관의 경우, “99” 회신
    pay_end_date 납입종료일자 Y DATE 보험료 납입 종료일
    pay_amt 납입 보험료 Y F(18,3) 보험료 납입 주기에 따른 보험료 납입금액
    currency_code 통화코드 (납입 보험료) N A(3) 통화코드 (ISO 4217 준용)
    - 외화버험의 경우 통화코드 사용 필요
    - 통화코드값이 명시되어있지 않을 경우 KRW(원)
    is_auto_pay 자동대출납입 신청 여부 Y Boolean 해당 보험사의 대출상품으로 보혐료를 납입하는자동대출납입 신청 여부
    - true:신청, false:미신청
  • 보험 거래내역 조회 v2 2024-10-21

    기본 정보
    API ID 보험-006 HTTP Method POST
    API 제공자 보험업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/insu/insurances/transactions
    설명 정보주체가 계약한 보험에서 조회기간 동안 발생한 납입내역 조회 (Pagination, 납입일자 기준 내림차순)
    - 신용정보법 시행령 제28조의3제4항에 의거, 최근 5년 이내 정보 제공
    - 자동차보험 거래내역은 보험-007 API 사용
    기준시점 FROM과 TO를 확인하여 해당 기간의 정보를 회신
    Content-Type(요청) application/json; charset=UTF-8 Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급한 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(20) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Body org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    insu_num 증권번호 Y aN(20) 보험 계약자가 가입한 증권번호
    from_date 시작일자 Y DATE 조회 시작일자
    to_date 종료일자 Y DATE 조회 종료일자
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체 (설정 시 해당 개체 후 limit 개 반환)
    처음 API 호출 시에는 해당 정보를 세팅하지 않으며, 다음 페이지 요청 시 직전 조회의 응답에서 얻은 기준개체를 그대로 세팅
    - 2.1-[2] 페이지네이션 참조
    limit 최대조회갯수 Y N(3) 기준개체 이후 반환될 개체의 개수
    - 최대 500까지 설정 가능
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체
    - 다음 페이지 존재하지 않는 경우(마지막 페이지), 미회신
    - 2.1-[2] 페이지네이션 참조
    trans_cnt 납입내역수 Y N(3)
    trans_list 납입내역목록 Y Object
    --trans_date 납입일자 Y DATE 해당 납입 내역의 납입일자
    --trans_applied_month 납입연월 Y N(6) 해당 납입 내역의 유효년월(YYYYMM)- 납입종료일자 이후의 납입내역의 경우, 납입연월는 '월대체보험료 충당월' 회신
    --paid_in_cnt 납입회차 Y N(3) 해당 납입 내역의 납입 회차- 납입종료일자 이후의 납입내역의 경우, 납입회차는 '월대체보험료 충당 회차' 회신
    --paid_amt 실납입 보혐료 Y F(18,3) 고객이 실제로 납입한 금액
    --currency_code 통화코드 (납입 보험료) N A(3) 통화코드 (ISO 4217 준용)
    외화보험의 경우 통화코드 사용 필요
    - 통화코드값이 명시되어있지 않을 경우 KRW(원)
    --pay_method 수금방법 (코드) Y aN(2) 고객의 보험료 납입 방법 유형 (일부 보험사의 경우 수금방법 기준이 상이(예:신용카드를 직납에 포함)하여 이 경우 각 보험사 내부 기준에 따라 회신)
    - <코드값>
    01 : 지로
    02 : 자동이체
    03 : 직납
    04 : 신용카드
    05 : 급여공제
    06 : 간편결제
    99 : 기타)
  • 보험 거래내역 조회 v1 2024-10-21

    기본 정보
    API ID 보험-006 HTTP Method POST
    API 제공자 보험업권 API 요청자 마이데이터사업자
    API 명 (URI) /v1/insu/insurances/transactions
    설명 정보주체가 계약한 보험에서 조회기간 동안 발생한 납입내역 조회 (Pagination, 납입일자 기준 내림차순)
    - 신용정보법 시행령 제28조의3제4항에 의거, 최근 5년 이내 정보 제공
    - 자동차보험 거래내역은 보험-007 API 사용
    기준시점 FROM과 TO를 확인하여 해당 기간의 정보를 회신
    Content-Type(요청) application/json; charset=UTF-8 Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급한 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(20) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Body org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    insu_num 증권번호 Y aN(20) 보험 계약자가 가입한 증권번호
    from_date 시작일자 Y DATE 조회 시작일자
    to_date 종료일자 Y DATE 조회 종료일자
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체 (설정 시 해당 개체 후 limit 개 반환)
    처음 API 호출 시에는 해당 정보를 세팅하지 않으며, 다음 페이지 요청 시 직전 조회의 응답에서 얻은 기준개체를 그대로 세팅
    - 2.1-[2] 페이지네이션 참조
    limit 최대조회갯수 Y N(3) 기준개체 이후 반환될 개체의 개수
    - 최대 500까지 설정 가능
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체
    - 다음 페이지 존재하지 않는 경우(마지막 페이지), 미회신
    - 2.1-[2] 페이지네이션 참조
    trans_cnt 납입내역수 Y N(3)
    trans_list 납입내역목록 Y Object
    --trans_date 납입일자 Y DATE 해당 납입 내역의 납입일자
    --trans_applied_month 납입연월 Y N(6) 해당 납입 내역의 유효년월(YYYYMM)- 납입종료일자 이후의 납입내역의 경우, 납입연월는 '월대체보험료 충당월' 회신
    --paid_in_cnt 납입회차 Y N(3) 해당 납입 내역의 납입 회차- 납입종료일자 이후의 납입내역의 경우, 납입회차는 '월대체보험료 충당 회차' 회신
    --paid_amt 실납입 보혐료 Y F(18,3) 고객이 실제로 납입한 금액
    --currency_code 통화코드 (납입 보험료) N A(3) 통화코드 (ISO 4217 준용)
    외화보험의 경우 통화코드 사용 필요
    - 통화코드값이 명시되어있지 않을 경우 KRW(원)
    --pay_method 수금방법 (코드) Y aN(2) 고객의 보험료 납입 방법 유형 (일부 보험사의 경우 수금방법 기준이 상이(예:신용카드를 직납에 포함)하여 이 경우 각 보험사 내부 기준에 따라 회신)
    - <코드값>
    01 : 지로
    02 : 자동이체
    03 : 직납
    04 : 신용카드
    05 : 급여공제
    06 : 간편결제
    99 : 기타)
  • 자동차보험 거래내역 조회 v2 2024-10-21

    기본 정보
    API ID 보험-007 HTTP Method POST
    API 제공자 보험업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/insu/insurances/car/transactions
    설명 정보주체가 계약한 자동차보험에서 조회기간 동안 발생한 납입내역 조회 (Pagination, ”거래일시 또는 거래일자“ 기준 내림차순)
    - 신용정보법 시행령 제28조의3제4항에 의거, 최근 5년 이내 정보 제공
    기준시점 FROM과 TO를 확인하여 해당 기간의 정보를 회신
    Content-Type(요청) application/json; charset=UTF-8 Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급한 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(20) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Body org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    insu_num 증권번호 Y aN(20) 보험 계약자가 가입한 증권번호
    car_number 차량번호 Y AH(60) 하나의 증권번호에 차량이 여러대 가입되어 있는 경우가 있어 차량번호를 PK로 추가
    from_date 시작일자 Y DATE 조회 시작일자
    to_date 종료일자 Y DATE 조회 종료일자
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체 (설정 시 해당 개체 후 limit 개 반환)
    처음 API 호출 시에는 해당 정보를 세팅하지 않으며, 다음 페이지 요청 시 직전 조회의 응답에서 얻은 기준개체를 그대로 세팅
    - 2.1-[2] 페이지네이션 참조
    limit 최대조회갯수 Y N(3) 기준개체 이후 반환될 개체의 개수
    - 최대 500까지 설정 가능
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체
    - 다음 페이지 존재하지 않는 경우(마지막 페이지), 미회신
    - 2.1-[2] 페이지네이션 참조
    trans_cnt 납입내역수 Y N(3)
    trans_list 납입내역목록 Y Object
    --trans_dtime 거래일시 또는 거래일자 Y DTIME 또는 DATE 거래가 일어난 날짜와 시간(YYYYMMDDhhmmss)
    - 시각 정보가 없을 경우 거래일자인 YYYYMMDD 회신 (일부 기관의 경우 거래일자+거래번호로 관리
    --trans_no 거래번호 N aN(64) 해당 일자의 거래 특정 번호 (없을 경우 미회신)
    --face_amt 자동차보험 보혐료 Y N(15) 자동차보험의 총 보험료
    --paid_in_cnt 납입회차 Y N(3) 해당 납입 내역의 납입 회차
    --paid_amt 실납입 보험료 Y N(15) 고객이 실제로 납입한 금액
    --pay_method 수금방법 (코드) Y aN(2) 고객의 보험료 납입 방법 유형 (일부 보험사의 경우 수금방법 기준이 상이(예:신용카드를 직납에 포함)하여 이 경우 각 보험사 내부 기준에 따라 회신)
    - <코드값>
    01 : 지로
    02 : 자동이체
    03 : 직납
    04 : 신용카드
    05 : 급여공제
    06 : 간편결제
    99 : 기타)
    --pay_org_code 납입기관 (코드) N aN(8) 보험료의 납입 방법이 '자동이체'일 경우 자동이체가 이루어지는 기관 코드
    - 지원 API로부터 배포되는 기관코드 중 앞 2자리를 제외한 8자리 회신 (자세한 내용은 서비스 가이드라인 참조)
    - 기관코드는 업권코드(2자리), 대표기관코드(4자리), 지점코드(4자리)로 구성되는데, 여러 업권의 정보를 보유한 금융기관은 다수의 기관코드를 보유(업권별 기관코드 할당)할 수 있기 때문에 업권코드를 제외한 8자리 코드를 사용하여 유일성 확보
    - 종합포털로부터 기관코드를 발급받지 않는 기관(예: 상품권 발행사 등)들의 경우 기타기관코드인 “ZZZZ0000” 회신
    - 저축은행에 개설된 계좌의 정보는 저축은행중앙회에 집중되는 과정에서 계좌 개설 기관이 구분되지 않기 때문에, 개별 저축은행의 기관코드가 아닌, 저축은행중앙회의 기관코드로 전송될 수 있음
    --pay_account_num 납입계좌번호(자동이체) N aN(20) 보험료의 납입 방법이 '자동이체'일 경우 자동이체가 이루어지는 기관 계좌번호(납입 계좌가 본인 소유가 맞는 경우에만 전송)
  • 자동차보험 거래내역 조회 v1 2024-10-21

    기본 정보
    API ID 보험-007 HTTP Method POST
    API 제공자 보험업권 API 요청자 마이데이터사업자
    API 명 (URI) /v1/insu/insurances/car/transactions
    설명 정보주체가 계약한 자동차보험에서 조회기간 동안 발생한 납입내역 조회 (Pagination, ”거래일시 또는 거래일자“ 기준 내림차순)
    - 신용정보법 시행령 제28조의3제4항에 의거, 최근 5년 이내 정보 제공
    기준시점 FROM과 TO를 확인하여 해당 기간의 정보를 회신
    Content-Type(요청) application/json; charset=UTF-8 Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급한 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(20) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Body org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    insu_num 증권번호 Y aN(20) 보험 계약자가 가입한 증권번호
    car_number 차량번호 Y AH(17) 하나의 증권번호에 차량이 여러대 가입되어 있는 경우가 있어 차량번호를 PK로 추가
    from_date 시작일자 Y DATE 조회 시작일자
    to_date 종료일자 Y DATE 조회 종료일자
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체 (설정 시 해당 개체 후 limit 개 반환)
    처음 API 호출 시에는 해당 정보를 세팅하지 않으며, 다음 페이지 요청 시 직전 조회의 응답에서 얻은 기준개체를 그대로 세팅
    - 2.1-[2] 페이지네이션 참조
    limit 최대조회갯수 Y N(3) 기준개체 이후 반환될 개체의 개수
    - 최대 500까지 설정 가능
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체
    - 다음 페이지 존재하지 않는 경우(마지막 페이지), 미회신
    - 2.1-[2] 페이지네이션 참조
    trans_cnt 납입내역수 Y N(3)
    trans_list 납입내역목록 Y Object
    --trans_dtime 거래일시 또는 거래일자 Y DTIME 또는 DATE 거래가 일어난 날짜와 시간(YYYYMMDDhhmmss)
    - 시각 정보가 없을 경우 거래일자인 YYYYMMDD 회신 (일부 기관의 경우 거래일자+거래번호로 관리
    --trans_no 거래번호 N aN(64) 해당 일자의 거래 특정 번호 (없을 경우 미회신)
    --face_amt 자동차보험 보혐료 Y N(15) 자동차보험의 총 보험료
    --paid_in_cnt 납입회차 Y N(3) 해당 납입 내역의 납입 회차
    --paid_amt 실납입 보험료 Y N(15) 고객이 실제로 납입한 금액
    --pay_method 수금방법 (코드) Y aN(2) 고객의 보험료 납입 방법 유형 (일부 보험사의 경우 수금방법 기준이 상이(예:신용카드를 직납에 포함)하여 이 경우 각 보험사 내부 기준에 따라 회신)
    - <코드값>
    01 : 지로
    02 : 자동이체
    03 : 직납
    04 : 신용카드
    05 : 급여공제
    06 : 간편결제
    99 : 기타)
  • 대출상품 목록 조회 v2 2024-10-21

    기본 정보
    API ID 보험-008 HTTP Method GET
    API 제공자 보험업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/insu/loans
    설명 정보주체가 계약한 금융회사별 대출상품(약관대출, 신용대출, 담보대출) 목록 조회
    - pagination, 계좌번호별 구분 코드 기준 오름차순
    기준시점 현재 시점
    Content-Type(요청) - Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급한 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(20) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Parameter org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    search_timestamp 조회 타임스탬프 N N(14) 가장 최근 조회한 시간 (이전 API 호출 시 정보제공자가 회신한 값을 저장하고 있다가 다음 API 호출 시 그 값을 그대로 세팅하여 전송, 최초 API 호출시에는 0으로 세팅)
    - 2.1-[2] 참조
    - next_page가 세팅된 경우 요청에서 제외
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체 (설정 시 해당 개체 후 limit 개 반환)
    처음 API 호출 시에는 해당 정보를 세팅하지 않으며, 다음 페이지 요청 시 직전 조회의 응답에서 얻은 기준개체를 그대로 세팅
    - 2.1-[2] 페이지네이션 참조
    limit 최대조회갯수 Y N(3) 기준개체 이후 반환될 개체의 개수
    - 최대 500까지 설정 가능
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    search_timestamp 조회 타임스탬프 N N(14) API 처리 시점의 현재시각을 설정하여 회신. 다만 정보제공자는 Timestamp 로직을 의무적으로 구현할 필요가 없으며(선택사항), Timestamp 로직 미제공 시에는 항상 0을 회신 또는 미회신
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체
    - 다음 페이지 존재하지 않는 경우(마지막 페이지), 미회신
    - 2.1-[2] 페이지네이션 참조
    loan_cnt 보유대출수 Y N(3)
    loan_list 보유계약목록 Y Object
    --prod_name 상품명 Y AH(300) 보험 상품의 공식 명칭
    --account_num 계좌번호 Y aN(20) 해당 고객이 보유한 대출 원장의 대출 식별번호
    - 신용정보원의 일반신용정보관리규약에 의거하여 집중하고 있는 항목 중 '계좌번호' 항목과 동일
    - "-" 제외
    --is_consent 전송요구 여부 Y Boolean 정보주체가 해당 자산(계좌번호)에 대해 개인신용정보 전송요구를 했는지 여부
    --account_type 계좌번호 별 구분 코드 Y aN(4) 해당 계좌번호의 유형 구분 코드
    - [첨부3] 계좌번호 별 구분 코드
    --account_status 계좌번호 별 상태 코드 Y aN(2) 해당 계좌번호의 상태 구분 코드
    - <코드값>
    01 : 활동(사고포함)
  • 대출상품 목록 조회 v1 2024-10-21

    기본 정보
    API ID 보험-008 HTTP Method GET
    API 제공자 보험업권 API 요청자 마이데이터사업자
    API 명 (URI) /v1/insu/loans
    설명 정보주체가 계약한 금융회사별 대출상품(약관대출, 신용대출, 담보대출) 목록 조회
    - pagination, 계좌번호별 구분 코드 기준 오름차순
    기준시점 현재 시점
    Content-Type(요청) - Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급한 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(20) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Parameter org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    search_timestamp 조회 타임스탬프 N N(14) 가장 최근 조회한 시간 (이전 API 호출 시 정보제공자가 회신한 값을 저장하고 있다가 다음 API 호출 시 그 값을 그대로 세팅하여 전송, 최초 API 호출시에는 0으로 세팅)
    - 2.1-[2] 참조
    - next_page가 세팅된 경우 요청에서 제외
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체 (설정 시 해당 개체 후 limit 개 반환)
    처음 API 호출 시에는 해당 정보를 세팅하지 않으며, 다음 페이지 요청 시 직전 조회의 응답에서 얻은 기준개체를 그대로 세팅
    - 2.1-[2] 페이지네이션 참조
    limit 최대조회갯수 Y N(3) 기준개체 이후 반환될 개체의 개수
    - 최대 500까지 설정 가능
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    search_timestamp 조회 타임스탬프 N N(14) API 처리 시점의 현재시각을 설정하여 회신. 다만 정보제공자는 Timestamp 로직을 의무적으로 구현할 필요가 없으며(선택사항), Timestamp 로직 미제공 시에는 항상 0을 회신 또는 미회신
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체
    - 다음 페이지 존재하지 않는 경우(마지막 페이지), 미회신
    - 2.1-[2] 페이지네이션 참조
    loan_cnt 보유대출수 Y N(3)
    loan_list 보유계약목록 Y Object
    --prod_name 상품명 Y AH(300) 보험 상품의 공식 명칭
    --account_num 계좌번호 Y aN(20) 해당 고객이 보유한 대출 원장의 대출 식별번호
    - 신용정보원의 일반신용정보관리규약에 의거하여 집중하고 있는 항목 중 '계좌번호' 항목과 동일
    - "-" 제외
    --is_consent 전송요구 여부 Y Boolean 정보주체가 해당 자산(계좌번호)에 대해 개인신용정보 전송요구를 했는지 여부
    --account_type 계좌번호 별 구분 코드 Y aN(4) 해당 계좌번호의 유형 구분 코드
    - [첨부3] 계좌번호 별 구분 코드
    --account_status 계좌번호 별 상태 코드 Y aN(2) 해당 계좌번호의 상태 구분 코드
    - <코드값>
    01 : 활동(사고포함)
  • 대출상품 기본정보 조회 v1 2024-10-21

    기본 정보
    API ID 보험-009 HTTP Method POST
    API 제공자 보험업권 API 요청자 마이데이터사업자
    API 명 (URI) /v1/insu/loans/basic
    설명 정보주체가 계약한 보험별 대출(약관대출/신용대출/담보대출) 현황 정보 조회
    기준시점 현재 시점
    Content-Type(요청) application/json; charset=UTF-8 Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급한 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(20) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Body org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    account_num 계좌번호 Y aN(20) 해당 고객이 보유한 대출 원장의 대출 식별번호
    search_timestamp 조회 타임스탬프 Y N(14) 가장 최근 조회한 시간 (이전 API 호출 시 정보제공자가 회신한 값을 저장하고 있다가 다음 API 호출 시 그 값을 그대로 세팅하여 전송, 최초 API 호출시에는 0으로 세팅)
    - 2.1-[2] 참조
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    search_timestamp 조회 타임스탬프 N N(14) API 처리 시점의 현재시각을 설정하여 회신. 다만 정보제공자는 Timestamp 로직을 의무적으로 구현할 필요가 없으며(선택사항), Timestamp 로직 미제공 시에는 항상 0을 회신 또는 미회신
    loan_start_date 대출일 Y DATE 대출 실행일자 (보험계약대출의 경우 가장 최근에 대출을 실행한 일자)
    loan_exp_date 만기일 Y DATE 해당 대출이 만기(종료)되는 날짜 (보험계약 대출의 경우 가장 최근에 실행한 대출의 만기일자)
    repay_method 상환방식 (코드) Y aN(2) 해당 대출의 상환방식 구분 코드
    - [첨부4] 상환방식 코드
    insu_num 증권번호 N aN(20) 해당 대출과 연계된 보험 주계약의 증권번호
    - 계좌번호 별 구분 코드(보험-008 API의 account_type)의 값이 '3400(보험계약대출)'일 경우
  • 대출상품 기본정보 조회 v2 2024-10-21

    기본 정보
    API ID 보험-009 HTTP Method POST
    API 제공자 보험업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/insu/loans/basic
    설명 정보주체가 계약한 보험별 대출(약관대출/신용대출/담보대출) 현황 정보 조회
    기준시점 현재 시점
    Content-Type(요청) application/json; charset=UTF-8 Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급한 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(20) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Body org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    account_num 계좌번호 Y aN(20) 해당 고객이 보유한 대출 원장의 대출 식별번호
    search_timestamp 조회 타임스탬프 Y N(14) 가장 최근 조회한 시간 (이전 API 호출 시 정보제공자가 회신한 값을 저장하고 있다가 다음 API 호출 시 그 값을 그대로 세팅하여 전송, 최초 API 호출시에는 0으로 세팅)
    - 2.1-[2] 참조
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    search_timestamp 조회 타임스탬프 N N(14) API 처리 시점의 현재시각을 설정하여 회신. 다만 정보제공자는 Timestamp 로직을 의무적으로 구현할 필요가 없으며(선택사항), Timestamp 로직 미제공 시에는 항상 0을 회신 또는 미회신
    loan_start_date 대출일 Y DATE 대출 실행일자 (보험계약대출의 경우 가장 최근에 대출을 실행한 일자)
    loan_exp_date 만기일 Y DATE 해당 대출이 만기(종료)되는 날짜 (보험계약 대출의 경우 가장 최근에 실행한 대출의 만기일자)
    repay_method 상환방식 (코드) Y aN(2) 해당 대출의 상환방식 구분 코드
    - [첨부4] 상환방식 코드
    insu_num 증권번호 N aN(20) 해당 대출과 연계된 보험 주계약의 증권번호
    - 계좌번호 별 구분 코드(보험-008 API의 account_type)의 값이 '3400(보험계약대출)'일 경우
    repay_org_code 납입기관 (코드) N aN(8) 대출 상환방식이 '자동이체'일 경우 자동이체가 이루어지는 기관 코드(대출실행 시 상환 계좌번호를 미지정하거나, 지정 후 해제하는 등 자동이체 관련 정보가 없는 경우 미회신
    - 지원 API로부터 배포되는 기관코드 중 앞 2자리를 제외한 8자리 회신 (자세한 내용은 서비스 가이드라인 참조)
    - 기관코드는 업권코드(2자리), 대표기관코드(4자리), 지점코드(4자리)로 구성되는데, 여러 업권의 정보를 보유한 금융기관은 다수의 기관코드를 보유(업권별 기관코드 할당)할 수 있기 때문에 업권코드를 제외한 8자리 코드를 사용하여 유일성 확보
    - 종합포털로부터 기관코드를 발급받지 않는 기관(예: 상품권 발행사 등)들의 경우 기타기관코드인 “ZZZZ0000” 회신
    - 저축은행에 개설된 계좌의 정보는 저축은행중앙회에 집중되는 과정에서 계좌 개설 기관이 구분되지 않기 때문에, 개별 저축은행의 기관코드가 아닌, 저축은행중앙회의 기관코드로 전송될 수 있음
    repay_account_num 납입계좌번호(자동이체) N aN(20) 대출 상환방식일 경우 자동이체가 이루어지는 기관 계좌번호(납입 계좌가 본인 소유가 맞는 경우에만 전송)(대출실행 시 상환계좌번호를 미지정하거나, 지정 후 해제하는 등 자동이체 관련 정보가 없는 경우 미회신
    repay_date 월상환일 N aN(2) 이자, 원금 상환일 포함(대출실행 시 상환계좌번호를 미지정하거나, 지정 후 해제하는 등 자동이체 관련 정보가 없는 경우 미회신)
  • 대출상품 추가정보 조회 v1 2024-10-21

    기본 정보
    API ID 보험-010 HTTP Method POST
    API 제공자 보험업권 API 요청자 마이데이터사업자
    API 명 (URI) /v1/insu/loans/detail
    설명 정보주체가 계약한 보험별 대출 잔액 등 추가정보 조회
    기준시점 현재 시점
    Content-Type(요청) application/json; charset=UTF-8 Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급한 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(20) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Body org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    account_num 계좌번호 Y aN(20) 해당 고객이 보유한 대출 원장의 대출 식별번호
    search_timestamp 조회 타임스탬프 Y N(14) 가장 최근 조회한 시간 (이전 API 호출 시 정보제공자가 회신한 값을 저장하고 있다가 다음 API 호출 시 그 값을 그대로 세팅하여 전송, 최초 API 호출시에는 0으로 세팅)
    - 2.1-[2] 참조
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    search_timestamp 조회 타임스탬프 N N(14) API 처리 시점의 현재시각을 설정하여 회신. 다만 정보제공자는 Timestamp 로직을 의무적으로 구현할 필요가 없으며(선택사항), Timestamp 로직 미제공 시에는 항상 0을 회신 또는 미회신
    currency_code 통화코드 (대출원금 및 대출원금잔액) N A(3) 통화코드 (ISO 4217 준용)
    - 통화코드값이 명시되어있지 않을 경우 KRW(원)
    balance_amt 대출잔액 Y F(18,3) 해당 대출상품에 상환해야 하는 잔여 금액
    loan_principal 대출원금 Y F(18,3) 총 대출한 금액, 대출합계금액
    - 추가 대출을 받을 경우 대출원금도 변경(합계)
    next_repay_date 다음 이자 상환일 Y DATE 다음 이자 상환 예정일
  • 대출상품 추가정보 조회 v2 2024-10-21

    기본 정보
    API ID 보험-010 HTTP Method POST
    API 제공자 보험업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/insu/loans/detail
    설명 정보주체가 계약한 보험별 대출 잔액 등 추가정보 조회
    기준시점 현재 시점
    Content-Type(요청) application/json; charset=UTF-8 Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급한 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(20) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Body org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    account_num 계좌번호 Y aN(20) 해당 고객이 보유한 대출 원장의 대출 식별번호
    search_timestamp 조회 타임스탬프 Y N(14) 가장 최근 조회한 시간 (이전 API 호출 시 정보제공자가 회신한 값을 저장하고 있다가 다음 API 호출 시 그 값을 그대로 세팅하여 전송, 최초 API 호출시에는 0으로 세팅)
    - 2.1-[2] 참조
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    search_timestamp 조회 타임스탬프 N N(14) API 처리 시점의 현재시각을 설정하여 회신. 다만 정보제공자는 Timestamp 로직을 의무적으로 구현할 필요가 없으며(선택사항), Timestamp 로직 미제공 시에는 항상 0을 회신 또는 미회신
    currency_code 통화코드 (대출원금 및 대출원금잔액) N A(3) 통화코드 (ISO 4217 준용)
    - 통화코드값이 명시되어있지 않을 경우 KRW(원)
    balance_amt 대출잔액 Y F(18,3) 해당 대출상품에 상환해야 하는 잔여 금액
    loan_principal 대출원금 Y F(18,3) 총 대출한 금액, 대출합계금액
    - 추가 대출을 받을 경우 대출원금도 변경(합계)
    next_repay_date 다음 이자 상환일 Y DATE 다음 이자 상환 예정일
    - 다음 이자 상환일이 존재하지 않는 경우 ‘99999999’로 전송
  • 대출상품 거래내역 조회 v2 2024-10-21

    기본 정보
    API ID 보험-011 HTTP Method POST
    API 제공자 보험업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/insu/loans/transactions
    설명 정보주체가 계약한 보험별 대출이자 납입 및 대출원금 상환내역 조회 (Pagination, 거래일시 기준 내림차순)
    - 신용정보법 제28조의3제4항에 의거, 최근 5년 이내 정보 제공
    기준시점 FROM과 TO를 확인하여 해당 기간의 정보를 회신
    Content-Type(요청) application/json; charset=UTF-8 Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급한 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(20) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Body org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    account_num 계좌번호 Y aN(20) 해당 고객이 보유한 대출 원장의 대출 식별번호
    from_date 시작일자 Y DATE 조회 시작일자
    to_date 종료일자 Y DATE 조회 종료일자
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체 (설정 시 해당 개체 후 limit 개 반환)
    처음 API 호출 시에는 해당 정보를 세팅하지 않으며, 다음 페이지 요청 시 직전 조회의 응답에서 얻은 기준개체를 그대로 세팅
    - 2.1-[2] 페이지네이션 참조
    limit 최대조회갯수 Y N(3) 기준개체 이후 반환될 개체의 개수
    - 최대 500까지 설정 가능
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체
    - 다음 페이지 존재하지 않는 경우(마지막 페이지), 미회신
    - 2.1-[2] 페이지네이션 참조
    trans_cnt 납입내역수 Y N(3)
    trans_list 납입내역목록 Y Object
    --trans_no 거래번호 N aN(20) 거래가 이루어진 일자 별 해당 거래의 순번
    --trans_dtime 거래일시 또는 거래일자 Y DTIME 또는 DATE 대출 상환일시(YYYYMMDDhhmmss)
    - 시각 정보가 없는 경우 거래일자인 YYYYMMDD 회신
    --currency_code 통화코드(대출원금상환액 및 이자납입액) N A(3) 통화코드 (ISO 4217 준용)
    - 통화코드값이 명시되어있지 않을 경우 KRW(원)
    --loan_paid_amt 대출원금상환액 Y F(18,3) 해당 거래의 원금 상환 금액
    --int_paid_amt 이자납입액 Y F(18,3) 해당 거래의 이자 납입 금액
    --int_cnt 이자적용수 N N(3) 약관대출 등 일부 대출상품에 대하여 이자율 정보를 저장 및 관리하지 않는 경우 미회신
    --int_list 이자적용목록 N Object 약관대출 등 일부 대출상품에 대하여 이자율 정보를 저장 및 관리하지 않는 경우 미회신
    ----int_start_date 이자적용시작일 N DATE 이자 계산기간의 시작일
    ----int_end_date 이자적용종료일 N DATE 이자 계산기간의 종료일
    ----int_rate 적용이율 N F(5,3) 해당 대출 거래(상환)시 납입한 이자의 이자율
    ----int_type 이자종류 (코드) N aN(2) 해당 거래의 이자 종류를 나타내는 구분 코드
    - <코드값>
    01 : 정상이자
    02 : 연체(지연)이자
    99 : 기타
  • 대출상품 거래내역 조회 v1 2024-10-21

    기본 정보
    API ID 보험-011 HTTP Method POST
    API 제공자 보험업권 API 요청자 마이데이터사업자
    API 명 (URI) /v1/insu/loans/transactions
    설명 정보주체가 계약한 보험별 대출이자 납입 및 대출원금 상환내역 조회 (Pagination, 거래일시 기준 내림차순)
    - 신용정보법 제28조의3제4항에 의거, 최근 5년 이내 정보 제공
    기준시점 FROM과 TO를 확인하여 해당 기간의 정보를 회신
    Content-Type(요청) application/json; charset=UTF-8 Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급한 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(20) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Body org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    account_num 계좌번호 Y aN(20) 해당 고객이 보유한 대출 원장의 대출 식별번호
    from_date 시작일자 Y DATE 조회 시작일자
    to_date 종료일자 Y DATE 조회 종료일자
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체 (설정 시 해당 개체 후 limit 개 반환)
    처음 API 호출 시에는 해당 정보를 세팅하지 않으며, 다음 페이지 요청 시 직전 조회의 응답에서 얻은 기준개체를 그대로 세팅
    - 2.1-[2] 페이지네이션 참조
    limit 최대조회갯수 Y N(3) 기준개체 이후 반환될 개체의 개수
    - 최대 500까지 설정 가능
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체
    - 다음 페이지 존재하지 않는 경우(마지막 페이지), 미회신
    - 2.1-[2] 페이지네이션 참조
    trans_cnt 납입내역수 Y N(3)
    trans_list 납입내역목록 Y Object
    --trans_no 거래번호 N aN(20) 거래가 이루어진 일자 별 해당 거래의 순번
    --trans_dtime 거래일시 또는 거래일자 Y DTIME 또는 DATE 대출 상환일시(YYYYMMDDhhmmss)
    - 시각 정보가 없는 경우 거래일자인 YYYYMMDD 회신
    --currency_code 통화코드(대출원금상환액 및 이자납입액) N A(3) 통화코드 (ISO 4217 준용)
    - 통화코드값이 명시되어있지 않을 경우 KRW(원)
    --loan_paid_amt 대출원금상환액 Y F(18,3) 해당 거래의 원금 상환 금액
    --int_paid_amt 이자납입액 Y F(18,3) 해당 거래의 이자 납입 금액
    --int_cnt 이자적용수 N N(3) 약관대출 등 일부 대출상품에 대하여 이자율 정보를 저장 및 관리하지 않는 경우 미회신
    --int_list 이자적용목록 N Object 약관대출 등 일부 대출상품에 대하여 이자율 정보를 저장 및 관리하지 않는 경우 미회신
    ----int_start_date 이자적용시작일 N DATE 이자 계산기간의 시작일
    ----int_end_date 이자적용종료일 N DATE 이자 계산기간의 종료일
    ----int_rate 적용이율 N F(5,3) 해당 대출 거래(상환)시 납입한 이자의 이자율
    ----int_type 이자종류 (코드) N aN(2) 해당 거래의 이자 종류를 나타내는 구분 코드
    - <코드값>
    01 : 정상이자
    02 : 연체(지연)이자
    99 : 기타
  • 보험 보장정보 조회 v2 2024-10-21

    기본 정보
    API ID 보험-012 HTTP Method POST
    API 제공자 보험업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/insu/insurances/coverages
    설명 정보주체가 계약한 보험별 보장정보 조회
    기준시점 현재 시점
    Content-Type(요청) application/json; charset=UTF-8 Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급한 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(20) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Body org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    insu_num 증권번호 Y aN(20) 보험 계약자가 가입한 증권번호
    search_timestamp 조회 타임스탬프 Y N(14) 가장 최근 조회한 시간 (이전 API 호출 시 정보제공자가 회신한 값을 저장하고 있다가 다음 API 호출 시 그 값을 그대로 세팅하여 전송, 최초 API 호출시에는 0으로 세팅)
    - 2.1-[2] 참조
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    search_timestamp 조회 타임스탬프 N N(14) API 처리 시점의 현재시각을 설정하여 회신. 다만 정보제공자는 Timestamp 로직을 의무적으로 구현할 필요가 없으며(선택사항), Timestamp 로직 미제공 시에는 항상 0을 회신 또는 미회신
    - 2.1-[2] 참조
    coverage_cnt 보장목록수 Y N(3)
    coverage_list 보장목록 Y Object
    --subject 계약관계자 구분 (코드) Y A(1) 계약관계자(계약자, 피보험자 등) (‘C’ 고정값 사용)
    <코드값>
    C : 계약자
    I : 피보험자
    O : 소유자 (보험금 청구권을 갖는 소유자 (물(物)보험 계약 전용))
    --relation 피보험자계약자관계 (코드) Y aN(2) 계약자 기준, 피보험자와 계약자와의 관계 (‘01’ 고정값 사용)
    - [첨부15]-[1] 계약관계자 구분 코드
    - 예 : 피보험자(A)는 아들, 계약자(B)는 아버지일 경우, 피보험자계약자관계코드는 자녀(03)로 입력
    - 본 데이터 항목은 추후 확장성을 고려하여 전송항목에 포함되었으며, 현재 전송요구는 계약자 본인만이 가능함에 따라 '01'(본인)로 고정
    --status 담보상태 (코드) Y aN(1) 담보별 계약상태에 대한 상태코드
    - [첨부15]-[2] 담보상태 코드
    --coverage_code 담보 (코드) Y AN(5) 담보 코드
    - [첨부15]-[3] 실손 외 담보 코드
    - [첨부15]-[5] 실손 담보 코드
    --type 담보특성 (코드) N N(1) 담보특성 코드
    - 실손보장일 경우만 회신
    - [첨부15]-[4] 실손 담보특성 코드
    --coverage_num 회사담보일련번호 Y aNS(20) 보험회사 등에서 관리하고 있는 담보코드[번호] 또는 실손담보일련번호
    - 실손담보일련번호(2자리) : 동일 보장내용코드, 담보특성코드가 여러 건이 있을 경우 순차적으로 증가(기본은 '01'로 입력)
    --coverage_name 회사담보명 Y AH(300) 보험회사 등에서 관리하고 있는 담보명
    - 실손보장담보의 경우 '담보(코드)명'으로 전송
    --coverage_amt 담보금액 Y N(10) 담보별 보장금액(단위:천원, 1,000원=1, 천원 단위 미만 절사)
    - 해당 담보만으로 순수하게 보장하는 보장금액
    - 예1 : 일반사망시 1억원, 재해사망시 2억원(일반사망담보 1억원+재해사망담보 1억원)을 받는 계약인 경우 → 일반사망 1억원, 재해사망 1억원을 입력
    - 예2 : 선지급형 1급 장기간병요양진단(50%) 또는 질병사망 담보(최대 1억원까지 보장)인 계약인 경우 → 장기간병요양(1급) 5000만원, 질병사망 1억원을 담보금액으로 각각 입력
    --start_date 담보기간 시작일자 N DATE 담보의 원보험기간 시작일자
    - 갱신시 갱신된 시작일 전송
    --end_date 담보기간 종료일자 N DATE 담보의 원보험기간 종료일자
    - 갱신시 갱신된 종료일 전송
  • 보험 보장정보 조회 v1 2024-10-21

    기본 정보
    API ID 보험-012 HTTP Method POST
    API 제공자 보험업권 API 요청자 마이데이터사업자
    API 명 (URI) /v1/insu/insurances/coverages
    설명 정보주체가 계약한 보험별 보장정보 조회
    기준시점 현재 시점
    Content-Type(요청) application/json; charset=UTF-8 Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급한 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(20) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Body org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    insu_num 증권번호 Y aN(20) 보험 계약자가 가입한 증권번호
    search_timestamp 조회 타임스탬프 Y N(14) 가장 최근 조회한 시간 (이전 API 호출 시 정보제공자가 회신한 값을 저장하고 있다가 다음 API 호출 시 그 값을 그대로 세팅하여 전송, 최초 API 호출시에는 0으로 세팅)
    - 2.1-[2] 참조
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    search_timestamp 조회 타임스탬프 N N(14) API 처리 시점의 현재시각을 설정하여 회신. 다만 정보제공자는 Timestamp 로직을 의무적으로 구현할 필요가 없으며(선택사항), Timestamp 로직 미제공 시에는 항상 0을 회신 또는 미회신
    - 2.1-[2] 참조
    coverage_cnt 보장목록수 Y N(3)
    coverage_list 보장목록 Y Object
    --subject 계약관계자 구분 (코드) Y A(1) 계약관계자(계약자, 피보험자 등) (‘C’ 고정값 사용)
    <코드값>
    C : 계약자
    I : 피보험자
    O : 소유자 (보험금 청구권을 갖는 소유자 (물(物)보험 계약 전용))
    - 본 데이터 항목은 추후 확장성을 고려하여 전송항목에 포함되었으며, 현재 전송요구는 계약자 본인만이 가능함에 따라 'C'(계약자)로 고정
    --relation 피보험자계약자관계 (코드) Y aN(2) 계약자 기준, 피보험자와 계약자와의 관계 (‘01’ 고정값 사용)
    - [첨부15]-[1] 계약관계자 구분 코드
    - 예 : 피보험자(A)는 아들, 계약자(B)는 아버지일 경우, 피보험자계약자관계코드는 자녀(03)로 입력
    - 본 데이터 항목은 추후 확장성을 고려하여 전송항목에 포함되었으며, 현재 전송요구는 계약자 본인만이 가능함에 따라 '01'(본인)로 고정
    --status 담보상태 (코드) Y aN(2) 담보별 계약상태에 대한 상태코드
    - [첨부15]-[2] 담보상태 코드
    --coverage_code 담보 (코드) Y AN(5) 담보 코드
    - [첨부15]-[3] 실손 외 담보 코드
    - [첨부15]-[5] 실손 담보 코드
    --type 담보특성 (코드) N N(1) 담보특성 코드
    - 실손보장일 경우만 회신
    - [첨부15]-[4] 실손 담보특성 코드
    --coverage_num 회사담보일련번호 Y aNS(20) 보험회사 등에서 관리하고 있는 담보코드[번호] 또는 실손담보일련번호
    - 실손담보일련번호(2자리) : 동일 보장내용코드, 담보특성코드가 여러 건이 있을 경우 순차적으로 증가(기본은 '01'로 입력)
    --coverage_name 회사담보명 N AH(300) 보험회사 등에서 관리하고 있는 담보명
    --coverage_amt 담보금액 Y N(10) 담보별 보장금액(단위:천원, 1,000원=1)
    - 해당 담보만으로 순수하게 보장하는 보장금액
    - 예1 : 일반사망시 1억원, 재해사망시 2억원(일반사망담보 1억원+재해사망담보 1억원)을 받는 계약인 경우 → 일반사망 1억원, 재해사망 1억원을 입력
    - 예2 : 선지급형 1급 장기간병요양진단(50%) 또는 질병사망 담보(최대 1억원까지 보장)인 계약인 경우 → 장기간병요양(1급) 5000만원, 질병사망 1억원을 담보금액으로 각각 입력
    --start_date 담보기간 시작일자 N DATE 담보의 원보험기간 시작일자
    --end_date 담보기간 종료일자 N DATE 담보의 원보험기간 종료일자
  • 피보험자 보험 목록 조회 v2 2024-10-21

    기본 정보
    API ID 보험-013 HTTP Method GET
    API 제공자 보험업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/insu/insured
    설명 계약자가 아닌 피보험자(계피상이 계약의 피보험자)의 보험상품(장기인, 물/일반, 자동차보험) 목록 조회
    - Pagination, 보험종류구분(코드) 기준 오름차순
    - 보험-013으로 수집한 증권번호로 다음의 API를 호출 가능 : 보험-014, 보험-015, 보험-016, 보험-017, 보험-022, 보험-023, 보험-025
    - 손보업권의 경우 물담보 하나라도 포함시 물/일반 API 통해 전송하며, 없는 경우 장기인 API 통해 전송
    기준시점 현재 시점
    Content-Type(요청) - Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급한 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Parameter org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    search_timestamp 조회 타임스탬프 N N(14) 가장 최근 조회한 시간 (이전 API 호출 시 정보제공자가 회신한 값을 저장하고 있다가 다음 API 호출 시 그 값을 그대로 세팅하여 전송, 최초 API 호출시에는 0으로 세팅)
    - 2.1-[2] 참조
    - next_page가 세팅된 경우 요청에서 제외
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체 (설정 시 해당 개체 후 limit 개 반환)
    처음 API 호출 시에는 해당 정보를 세팅하지 않으며, 다음 페이지 요청 시 직전 조회의 응답에서 얻은 기준개체를 그대로 세팅
    - 2.1-[2] 페이지네이션 참조
    limit 최대조회갯수 Y N(3) 기준개체 이후 반환될 개체의 개수
    - 최대 500까지 설정 가능
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    search_timestamp 조회 타임스탬프 N N(14) API 처리 시점의 현재시각을 설정하여 회신. 다만 정보제공자는 Timestamp 로직을 의무적으로 구현할 필요가 없으며(선택사항), Timestamp 로직 미제공 시에는 항상 0을 회신 또는 미회신
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체
    - 다음 페이지 존재하지 않는 경우(마지막 페이지), 미회신
    - 2.1-[2] 페이지네이션 참조
    insu_cnt 보유보험수 Y N(3)
    insu_list 보유보험목록 Y Object
    --insu_num 증권번호 Y aN(20) 보험 계약자가 가입한 증권번호
    - 마스킹 처리 불필요, "-" 제외
    --is_consent 전송요구 여부 Y Boolean 정보주체가 해당 자산(증권번호)에 대해 개인신용정보 전송요구를 했는지 여부
    --prod_name 상품명 Y AH(300) 보험 상품의 공식 명칭
    --insu_type 보험종류 구분 (코드) Y aN(2) 해당 계약의 보험종류 구분
    - [첨부7] 보험종류 코드
    --insu_status 계약상태 (코드) Y aN(2) 현재 주계약의 계약상태
    - <코드값>
    02: 정상(보장개시(초회보험료 납입) 및 승낙처리 된 상태)
    04: 실효(계속보험료 연체로 회사가 연체사실 등을 알린 뒤 효력이 상실된 상태)
    05: 만기(보험기간이 경과하여 보험금이 지급되기 전 상태)
    06: 소멸(지급소멸, 만기소멸, 납입면제 등에 따른 소멸상태. 단, 납입면제 이후 보장이 계속 유지되는 경우에는 정상(02)상태 등록하나, 종신보험의 연금보험 전환 시에는 소멸(06)사용)
    - 만기의 경우, 조회일 기준 5년 이내 만기 계약일 경우에만 회신
  • 피보험자 보험 기본정보 조회 v2 2024-10-21

    기본 정보
    API ID 보험-014 HTTP Method POST
    API 제공자 보험업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/insu/insured/basic
    설명 정보주체(장기인/계피상이 계약의 피보험자)의 보험별 기본정보(주계약정보) 조회
    기준시점 현재 시점
    Content-Type(요청) application/json; charset=UTF-8 Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급한 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Body org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    insu_num 증권번호 Y aN(20) 보험 계약자가 가입한 증권번호
    search_timestamp 조회 타임스탬프 Y N(14) 가장 최근 조회한 시간 (이전 API 호출 시 정보제공자가 회신한 값을 저장하고 있다가 다음 API 호출 시 그 값을 그대로 세팅하여 전송, 최초 API 호출시에는 0으로 세팅)
    - 2.1-[2] 참조
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    search_timestamp 조회 타임스탬프 N N(14) API 처리 시점의 현재시각을 설정하여 회신. 다만 정보제공자는 Timestamp 로직을 의무적으로 구현할 필요가 없으며(선택사항), Timestamp 로직 미제공 시에는 항상 0을 회신 또는 미회신
    is_renewable 갱신여부 (여부) Y Boolean 주계약의 갱신형 / 비갱신형 구분
    - 주계약 기준(특약 별 갱신/비갱신 여부는 고려하지 않음)
    - true : 갱신형, false : 비갱신형
    issue_date 계약체결일 Y DATE 보험계약자와 보험회사의 보험계약 체결일, 철회 산정기간의 기준일
    - 보험갱신 시 증권번호를 새로 발급한 경우 신규 계약체결일을 회신하고, 그렇지 않은 경우 기존 계약체결일을 회신
    exp_date 만기일자 Y DATE 보험계약을 보장받을수 있는 일자
    face_amt 보험가입금액 Y F(18,3) 주계약 보험가입금액
    currency_code 통화코드(보험가입금액) N A(3) 통화코드 (ISO 4217 준용)
    - 외화보험의 경우(보험료 납입을 외화로 하는 경우) 통화코드 사용 필요
    - 통화코드값이 명시되어있지 않을 경우 KRW(원)
    is_variable 변액보험 여부 Y Boolean 상품의 변액보험 해당 여부
    is_universal 유니버셜 여부 Y Boolean 상품의 유니버셜 해당 여부
    contractor_name 계약자명 Y AH(30) 마스킹하여 제공(짝수번째 자리 마스킹 전송)
    is_primary 주피보험자여부 Y Boolean 피보험자가 본 계약의 주피보험자에 해당하는지 여부
    - 주피보험자 : True, 종피보험자 : False
  • 피보험자 보험 특약 정보 v2 2024-10-21

    기본 정보
    API ID 보험-015 HTTP Method POST
    API 제공자 보험업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/insu/insured/contracts
    설명 정보주체(장기인/계피상이 계약의 피보험자)의 보험별 특약정보 조회
    기준시점 현재 시점
    Content-Type(요청) application/json; charset=UTF-8 Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급한 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(20) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Body org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    insu_num 증권번호 Y aN(20) 보험 계약자가 가입한 증권번호
    search_timestamp 조회 타임스탬프 Y N(14) 가장 최근 조회한 시간 (이전 API 호출 시 정보제공자가 회신한 값을 저장하고 있다가 다음 API 호출 시 그 값을 그대로 세팅하여 전송, 최초 API 호출시에는 0으로 세팅)
    - 2.1-[2] 참조
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    search_timestamp 조회 타임스탬프 N N(14) API 처리 시점의 현재시각을 설정하여 회신. 다만 정보제공자는 Timestamp 로직을 의무적으로 구현할 필요가 없으며(선택사항), Timestamp 로직 미제공 시에는 항상 0을 회신 또는 미회신
    contract_cnt 특약목록수 Y N(3)
    contract_list 특약목록 Y Object
    --contract_name 특약명 Y AH(300) 할인할증특약 등 제도성 특약 내용 포함
    --contract_status 특약의 상태 (코드) Y aN(2) 현재 특약의 계약상태
    - <코드값>
    02 : 정상(보장개시(초회보험료 납입) 및 승낙처리 된 상태)
    04 : 실효(계속보험료 연체로 회사가 연체사실 등을 알린 뒤 효력이 상실된 상태)
    05 : 만기(보험기간이 경과하여 보험금이 지급되기 전 상태)
    --contract_exp_date 특약만기일자 Y DATE 특약의 만기일자
    --contract_face_amt 특약가입금액 Y F(18,3) 보험금 지급 사유 발생 시 고객에게 지급되는 금액(특약보험금)
    --currency_code 통화코드 (특약가입금액) N A(3) 통화코드 (ISO 4217 준용)
    - 외화보험의 경우(보험료 납입을 외화로 하는 경우) 통화코드 사용 필요
    - 통화코드값이 명시되어있지 않을 경우 KRW(원)
    --is_required 특약의 유형 (여부) Y Boolean 해당 특약의 필수성 여부(주보험, 의무부가, 고정부가 특약은 필수)
    - true : 필수, false : 선택
  • 피보험자 자동차보험 정보 조회 v2 2024-10-21

    기본 정보
    API ID 보험-016 HTTP Method POST
    API 제공자 보험업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/insu/insured/car
    설명 정보주체(자동차보험/계피상이 계약의 피보험자)의 보험별 자동차 보험 정보 조회
    - 하나의 증권번호에 차량이 여러 대 가입되어 있는 경우가 있어 List로 회신
    기준시점 현재 시점
    Content-Type(요청) application/json; charset=UTF-8 Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급한 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Body org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    insu_num 증권번호 Y aN(20) 보험 계약자가 가입한 증권번호
    search_timestamp 조회 타임스탬프 Y N(14) 가장 최근 조회한 시간 (이전 API 호출 시 정보제공자가 회신한 값을 저장하고 있다가 다음 API 호출 시 그 값을 그대로 세팅하여 전송, 최초 API 호출시에는 0으로 세팅)
    - 2.1-[2] 참조
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    search_timestamp 조회 타임스탬프 N N(14) API 처리 시점의 현재시각을 설정하여 회신. 다만 정보제공자는 Timestamp 로직을 의무적으로 구현할 필요가 없으며(선택사항), Timestamp 로직 미제공 시에는 항상 0을 회신 또는 미회신
    car_insu_cnt 자동차보험목록수 Y N(3)
    car_insu_list 자동차보험목록 Y Object
    --car_number 차량번호 Y AH(60) 자동차보험 가입 차량번호 (없을 시, 차대번호)
    - 차량번호, 차대번호 모두 없는 경우 임의로 별도 채번
    --car_insu_type 자동차보험 구분 (코드) Y aN(2) 해당 자동차보험의 유형 구분
    - [첨부8] 자동차보험 구분 코드
    --car_name 계약자 차량명 N AH(60) 해당 자동차보험의 차량 모델명
    - 보험개발원 차량 모델등급 2단계 수준 (ex. 그랜져 IG, 아슬란, G4 렉스턴 등)
    - 대리운전, 이륜차의 경우 정보 부재하여 미전송
    --start_date 보험시기 Y DATE 자동차 보험의 시작일
    --end_date 보험종기 Y DATE 자동차 보험의 종료일
    --contract_age 연령특약 N AH(60) 전연령(99회신) / 21세 / 26세 / 30세 /"만 30세 이상 만 59세 이하" 등(없는 경우 미전송)
    - 보험사마다 달라서 코드화 불가 (텍스트 회신)
    - 나이는 텍스트로 회신하고, 전연령은 "99" 회신
    --contract_driver 운전자한정특약 N AH(60) 누구나 / 기명1인 / 가족한정 / 부부 / 가족 및 지정 1인 한정 등(없는 경우 미전송)
    - 보험사마다 달라서 코드화 불가 (텍스트 회신)
    --is_own_dmg_coverage 자기차량손해 (여부) Y Boolean 자기차량손해 가입 여부
    - true : 가입, false : 미가입
    --self_pay_rate 자기부담금 구분 (코드) Y aN(2) 해당 자동차보험의 자기부담금 비율(자기차량손해 미가입시 미전송)
    - <코드값>
    01 : 20%
    02 : 30%
    99 : NA
    --self_pay_amt 자기부담금 금액 N N(15) 해당 자동차보험의 최소 자기부담금 금액
    (자기차량손해 미가입시 미전송)
  • 피보험자 보험 보장정보 조회 v2 2024-10-21

    기본 정보
    API ID 보험-017 HTTP Method POST
    API 제공자 보험업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/insu/insured/coverages
    설명 정보주체(장기인/계피상이 계약의 피보험자)의 보험별 보장정보 조회
    기준시점 현재 시점
    Content-Type(요청) application/json; charset=UTF-8 Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급한 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(20) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Body org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    insu_num 증권번호 Y aN(20) 보험 계약자가 가입한 증권번호
    search_timestamp 조회 타임스탬프 Y N(14) 가장 최근 조회한 시간 (이전 API 호출 시 정보제공자가 회신한 값을 저장하고 있다가 다음 API 호출 시 그 값을 그대로 세팅하여 전송, 최초 API 호출시에는 0으로 세팅)
    - 2.1-[2] 참조
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    search_timestamp 조회 타임스탬프 N N(14) API 처리 시점의 현재시각을 설정하여 회신. 다만 정보제공자는 Timestamp 로직을 의무적으로 구현할 필요가 없으며(선택사항), Timestamp 로직 미제공 시에는 항상 0을 회신 또는 미회신
    - 2.1-[2] 참조
    coverage_cnt 보장목록수 Y N(3)
    coverage_list 보장목록 Y Object
    --subject 계약관계자 구분 (코드) Y A(1) 계약관계자(계약자, 피보험자 등) (‘I’ 고정값 사용)
    <코드값>
    C : 계약자
    I : 피보험자
    O : 소유자 (보험금 청구권을 갖는 소유자 (물(物)보험 계약 전용))
    --relation 피보험자계약자관계 (코드) Y aN(2) -계약자 기준, 피보험자와 계약자와의 관계
    - [첨부15]-[1] 계약관계자 구분 코드
    - 예 : 피보험자(A)는 아들, 계약자(B)는 아버지일 경우, 피보험자계약자관계코드는 자녀(03)로 입력
    --status 담보상태 (코드) Y aN(1) 담보별 계약상태에 대한 상태코드
    - [첨부15]-[2] 담보상태 코드
    --coverage_code 담보 (코드) Y AN(5) 담보 코드
    - [첨부15]-[3] 실손 외 담보 코드
    - [첨부15]-[5] 실손 담보 코드
    --type 담보특성 (코드) N N(1) 담보특성 코드
    - 실손보장일 경우만 회신
    - [첨부15]-[4] 실손 담보특성 코드
    --coverage_num 회사담보일련번호 Y aNS(20) 보험회사 등에서 관리하고 있는 담보코드[번호] 또는 실손담보일련번호
    - 실손담보일련번호(2자리) : 동일 보장내용코드, 담보특성코드가 여러 건이 있을 경우 순차적으로 증가(기본은 '01'로 입력)
    --coverage_name 회사담보명 Y AH(300) 보험회사 등에서 관리하고 있는 담보명
    --coverage_amt 담보금액 Y N(10) 담보별 보장금액(단위:천원, 1,000원=1, 천원 단위 미만 절사)
    - 해당 담보만으로 순수하게 보장하는 보장금액
    - 예1 : 일반사망시 1억원, 재해사망시 2억원(일반사망담보 1억원+재해사망담보 1억원)을 받는 계약인 경우 → 일반사망 1억원, 재해사망 1억원을 입력
    - 예2 : 선지급형 1급 장기간병요양진단(50%) 또는 질병사망 담보(최대 1억원까지 보장)인 계약인 경우 → 장기간병요양(1급) 5000만원, 질병사망 1억원을 담보금액으로 각각 입력
    --start_date 담보기간 시작일자 N DATE 담보의 원보험기간 시작일자
    - 갱신시 갱신된 시작일 전송
    --end_date 담보기간 종료일자 N DATE 담보의 원보험기간 종료일자
    - 갱신시 갱신된 종료일 전송
  • 물, 일반보험 기본정보 조회 v2 2024-10-21

    기본 정보
    API ID 보험-018 HTTP Method POST
    API 제공자 보험업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/insu/insurances/general/basic
    설명 정보주체가 계약한 물, 일반보험별 기본정보(주계약정보) 조회
    기준시점 현재 시점
    Content-Type(요청) application/json; charset=UTF-8 Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급한 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Body org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    insu_num 증권번호 Y aN(20) 보험 계약자가 가입한 증권번호
    search_timestamp 조회 타임스탬프 Y N(14) 가장 최근 조회한 시간 (이전 API 호출 시 정보제공자가 회신한 값을 저장하고 있다가 다음 API 호출 시 그 값을 그대로 세팅하여 전송, 최초 API 호출시에는 0으로 세팅)
    - 2.1-[2] 참조
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    search_timestamp 조회 타임스탬프 N N(14) API 처리 시점의 현재시각을 설정하여 회신. 다만 정보제공자는 Timestamp 로직을 의무적으로 구현할 필요가 없으며(선택사항), Timestamp 로직 미제공 시에는 항상 0을 회신 또는 미회신
    is_renewable 갱신여부 (여부) Y Boolean 주계약의 갱신형 / 비갱신형 구분
    - 주계약 기준(특약 별 갱신/비갱신 여부는 고려하지 않음)
    - true : 갱신형, false : 비갱신형
    issue_date 계약체결일 Y DATE 보험계약자와 보험회사의 보험계약 체결일, 철회 산정기간의 기준일
    - 보험갱신 시 증권번호를 새로 발급한 경우 신규 계약체결일을 회신하고, 그렇지 않은 경우 기존 계약체결일을 회신
    exp_date 만기일자 Y DATE 보험계약을 보장받을수 있는 일자
    face_amt 보험가입금액 Y F(18,3) 주계약 보험가입금액
    currency_code 통화코드(보험가입금액) N A(3) 통화코드 (ISO 4217 준용)
    - 외화보험의 경우(보험료 납입을 외화로 하는 경우) 통화코드 사용 필요
    - 통화코드값이 명시되어있지 않을 경우 KRW(원)
    prize_cnt 목적물수 Y N(3) 해당 보험 계약에 포함된 목적물의 수
    prize_list 목적물목록 Y Object
    --is_person 인/물 구분코드 Y aN(2) 인/물 구분코드
    01 : 인
    02 : 물
    --prize_num 피보험인/물 번호 Y aN(15) 정보제공자가 임의로 설정한 해당 보험 상품의 피보험인/물별 데이터를 관리하기 위한 번호
    (각 목적물이 구분가능하면 됨)
    --prize_name 피보험인/물 명 Y AH(300) 해당 보험 상품의 피보험인/물 이름
    - 피보험물인 경우 보험목적물명 회신
    - 피보험인의 경우 짝수번째 자리 마스킹처리
    - 피보험인이 본인인 경우 '본인' 회신
    --is_primary 주피보험자여부 Y Boolean 피보험자가 본 계약의 주피보험자에 해당하는지 여부
    - 주피보험자 : True, 종피보험자 : False
    그 외 : 미전송
    --prize_addr 소재지 Y AH(300) 목적물 소재지 세부주소
    --object_code 물건구분(코드) Y aN(2) 물건 구분
    01 : 주택물건
    02 : 일반물건
    03 : 기타
    --prize_code 목적물(코드) Y aN(2) 목적물 구분
    - (첨부17) 목적물 구분 코드 참고
  • 물, 일반보험 특약정보 조회 v2 2024-10-21

    기본 정보
    API ID 보험-019 HTTP Method POST
    API 제공자 보험업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/insu/insurances/general/contracts
    설명 정보주체가 계약한 물, 일반보험별 특약 정보 조회
    기준시점 현재 시점
    Content-Type(요청) application/json; charset=UTF-8 Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급한 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Body org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    insu_num 증권번호 Y aN(20) 보험 계약자가 가입한 증권번호
    insured_no 피보험인/물 순번 Y aN(20) 인물 구분코드 + 피보험인/물 번호
    search_timestamp 조회 타임스탬프 Y N(14) 가장 최근 조회한 시간 (이전 API 호출 시 정보제공자가 회신한 값을 저장하고 있다가 다음 API 호출 시 그 값을 그대로 세팅하여 전송, 최초 API 호출시에는 0으로 세팅)
    - 2.1-[2] 참조
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    search_timestamp 조회 타임스탬프 N N(14) API 처리 시점의 현재시각을 설정하여 회신. 다만 정보제공자는 Timestamp 로직을 의무적으로 구현할 필요가 없으며(선택사항), Timestamp 로직 미제공 시에는 항상 0을 회신 또는 미회신
    contract_cnt 특약목록수 Y N(3)
    contract_list 특약목록 Y Object
    --contract_name 특약명 Y AH(300) 기본담보 포함, 할인할증특약 등 제도성 특약 내용 포함
    --contract_status 특약의 상태 (코드) Y aN(2) 현재 특약의 계약상태
    - <코드값>
    02 : 정상(보장개시(초회보험료 납입) 및 승낙처리 된 상태)
    04 : 실효(계속보험료 연체로 회사가 연체사실 등을 알린 뒤 효력이 상실된 상태)
    05 : 만기(보험기간이 경과하여 보험금이 지급되기 전 상태)
    --contract_exp_date 특약만기일자 Y DATE 특약의 만기일자
    --contract_face_amt 특약가입금액 Y F(18,3) 보험금 지급 사유 발생 시 고객에게 지급되는 금액(특약보험금)
    - 전문인 배상책임보험의 경우 보상한도액(MAX제공)을 의미(배책만 1:N 구조임)
    - 텍스트로 제공
    ※ 물/일반 보험에서 가입금액을 숫자가 아닌 '가입금액'/'법정한도액'으로 관리하는 경우 999(가입금액), 9999(법정한도액)로 전송
    --currency_code 통화코드 (특약가입금액) N A(3) 통화코드 (ISO 4217 준용)
    - 외화보험의 경우(보험료 납입을 외화로 하는 경우) 통화코드 사용 필요
    - 통화코드값이 명시되어있지 않을 경우 KRW(원)
    --is_required 특약의 유형 (여부) Y Boolean 해당 특약의 필수성 여부(주보험, 의무부가, 고정부가 특약은 필수)
    - true : 필수, false : 선택
  • 물, 일반보험 납입정보 조회 v2 2024-10-21

    기본 정보
    API ID 보험-020 HTTP Method POST
    API 제공자 보험업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/insu/insurances/general/payment
    설명 정보주체가 계약한 물, 일반보험별 보험료 납입 기본정보 조회
    기준시점 현재 시점
    Content-Type(요청) application/json; charset=UTF-8 Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급한 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Body org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    insu_num 증권번호 Y aN(20) 보험 계약자가 가입한 증권번호
    search_timestamp 조회 타임스탬프 Y N(14) 가장 최근 조회한 시간 (이전 API 호출 시 정보제공자가 회신한 값을 저장하고 있다가 다음 API 호출 시 그 값을 그대로 세팅하여 전송, 최초 API 호출시에는 0으로 세팅)
    - 2.1-[2] 참조
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    search_timestamp 조회 타임스탬프 N N(14) API 처리 시점의 현재시각을 설정하여 회신. 다만 정보제공자는 Timestamp 로직을 의무적으로 구현할 필요가 없으며(선택사항), Timestamp 로직 미제공 시에는 항상 0을 회신 또는 미회신
    pay_due 납입기간구분 (코드) Y aN(2) 납입 만기 기간 구분
    - <코드값>
    - 00 : 기타
    - 01 : 일시납
    - 02 : 연납
    - 03 : 세납
    - 04 : 전기납
    pay_cycle 납입주기 (코드) Y AN(2) 납입 주기 구분
    - 1M : 매월
    - 2M : 2개월납
    - 3M : 3개월
    - 6M : 6개월
    - 1Y : 연단위
    - 00 : 기타
    - 99 : 일시납
    pay_cnt 총 납입 횟수 Y N(5) 보험 약정 납입기간에 따른 총 납입 횟수
    pay_org_code 납입기관 (코드) N aN(8) 보험료의 납입 방법이 '자동이체'일 경우 자동이체가 이루어지는 기관 코드
    - 지원 API로부터 배포되는 기관코드 중 앞 2자리를 제외한 8자리 회신 (자세한 내용은 서비스 가이드라인 참조)
    - 기관코드는 업권코드(2자리), 대표기관코드(4자리), 지점코드(4자리)로 구성되는데, 여러 업권의 정보를 보유한 금융기관은 다수의 기관코드를 보유(업권별 기관코드 할당)할 수 있기 때문에 업권코드를 제외한 8자리 코드를 사용하여 유일성 확보
    - 종합포털로부터 기관코드를 발급받지 않는 기관(예: 상품권 발행사 등)들의 경우 기타기관코드인 “ZZZZ0000” 회신
    - 저축은행에 개설된 계좌의 정보는 저축은행중앙회에 집중되는 과정에서 계좌 개설 기관이 구분되지 않기 때문에, 개별 저축은행의 기관코드가 아닌, 저축은행중앙회의 기관코드로 전송될 수 있음
    pay_account_num 납입계좌번호(자동이체) N aN(20) 보험료의 납입 방법이 '자동이체'일 경우 자동이체가 이루어지는 기관 계좌번호(납입 계좌가 본인 소유가 맞는 경우에만 전송)
    pay_date 납입일자 N aN(2) 보험 계약서 상, 계약자가 작성한 지정 이체 혹은 결제일자 (DD)
    - 자동이체, 급여이체 등 날짜 지정 가능한 납입방법 외의 계약(납입예정일자 미존재)의 경우는 미회신
    납입일자를 숫자(DD)가 아닌 “말일”로 지정한 기관의 경우, “99” 회신
    pay_end_date 납입종료일자 Y DATE 보험료 납입 종료일
    pay_amt 납입 보험료 Y F(18,3) 보험료 납입 주기에 따른 보험료 납입금액
    currency_code 통화코드 (납입 보험료) N A(3) 통화코드 (ISO 4217 준용)
    - 외화버험의 경우 통화코드 사용 필요
    - 통화코드값이 명시되어있지 않을 경우 KRW(원)
    is_auto_pay 자동대출납입 신청 여부 Y Boolean 해당 보험사의 대출상품으로 보혐료를 납입하는자동대출납입 신청 여부
    - true:신청, false:미신청
  • 물, 일반보험 거래내역 조회 v2 2024-10-21

    기본 정보
    API ID 보험-021 HTTP Method POST
    API 제공자 보험업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/insu/insurances/general/transactions
    설명 정보주체가 계약한 물, 일반보험에서 조회기간 동안 발생한 납입내역 조회 (Pagination, 납입일자 기준 내림차순)
    - 신용정보법 시행령 제28조의3제4항에 의거, 최근 5년 이내 정보 제공
    기준시점 FROM과 TO를 확인하여 해당 기간의 정보를 회신
    Content-Type(요청) application/json; charset=UTF-8 Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급한 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Body org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    insu_num 증권번호 Y aN(20) 보험 계약자가 가입한 증권번호
    from_date 시작일자 Y DATE 조회 시작일자
    to_date 종료일자 Y DATE 조회 종료일자
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체 (설정 시 해당 개체 후 limit 개 반환)
    처음 API 호출 시에는 해당 정보를 세팅하지 않으며, 다음 페이지 요청 시 직전 조회의 응답에서 얻은 기준개체를 그대로 세팅
    - 2.1-[2] 페이지네이션 참조
    limit 최대조회갯수 Y N(3) 기준개체 이후 반환될 개체의 개수
    - 최대 500까지 설정 가능
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체
    - 다음 페이지 존재하지 않는 경우(마지막 페이지), 미회신
    - 2.1-[2] 페이지네이션 참조
    trans_cnt 납입내역수 Y N(3)
    trans_list 납입내역목록 Y Object
    --trans_date 납입일자 Y DATE 해당 납입 내역의 납입일자
    --trans_applied_month 납입연월 Y N(6) 해당 납입 내역의 유효년월(YYYYMM)- 납입종료일자 이후의 납입내역의 경우, 납입연월는 '월대체보험료 충당월' 회신
    --paid_in_cnt 납입회차 Y N(3) 해당 납입 내역의 납입 회차- 납입종료일자 이후의 납입내역의 경우, 납입회차는 '월대체보험료 충당 회차' 회신
    --paid_amt 실납입 보혐료 Y F(18,3) 고객이 실제로 납입한 금액
    --currency_code 통화코드 (납입 보험료) N A(3) 통화코드 (ISO 4217 준용)
    외화보험의 경우 통화코드 사용 필요
    - 통화코드값이 명시되어있지 않을 경우 KRW(원)
    --pay_method 수금방법 (코드) Y aN(2) 고객의 보험료 납입 방법 유형 (일부 보험사의 경우 수금방법 기준이 상이(예:신용카드를 직납에 포함)하여 이 경우 각 보험사 내부 기준에 따라 회신)
    - <코드값>
    01 : 지로
    02 : 자동이체
    03 : 직납
    04 : 신용카드
    05 : 급여공제
    06 : 간편결제
    99 : 기타
  • 피보험자 물, 일반보험 기본정보 조회 v2 2024-10-21

    기본 정보
    API ID 보험-022 HTTP Method POST
    API 제공자 보험업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/insu/insured/general/basic
    설명 정보주체(물, 일반보험/계피상이 계약의 피보험자)가 계약의 피보험자인 물, 일반보험별 기본정보(주계약정보) 조회
    기준시점 현재 시점
    Content-Type(요청) application/json; charset=UTF-8 Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급한 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Body org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    insu_num 증권번호 Y aN(20) 보험 계약자가 가입한 증권번호
    search_timestamp 조회 타임스탬프 Y N(14) 가장 최근 조회한 시간 (이전 API 호출 시 정보제공자가 회신한 값을 저장하고 있다가 다음 API 호출 시 그 값을 그대로 세팅하여 전송, 최초 API 호출시에는 0으로 세팅)
    - 2.1-[2] 참조
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    search_timestamp 조회 타임스탬프 N N(14) API 처리 시점의 현재시각을 설정하여 회신. 다만 정보제공자는 Timestamp 로직을 의무적으로 구현할 필요가 없으며(선택사항), Timestamp 로직 미제공 시에는 항상 0을 회신 또는 미회신
    is_renewable 갱신여부 (여부) Y Boolean 주계약의 갱신형 / 비갱신형 구분
    - 주계약 기준(특약 별 갱신/비갱신 여부는 고려하지 않음)
    - true : 갱신형, false : 비갱신형
    issue_date 계약체결일 Y DATE 보험계약자와 보험회사의 보험계약 체결일, 철회 산정기간의 기준일
    - 보험갱신 시 증권번호를 새로 발급한 경우 신규 계약체결일을 회신하고, 그렇지 않은 경우 기존 계약체결일을 회신
    exp_date 만기일자 Y DATE 보험계약을 보장받을수 있는 일자
    face_amt 보험가입금액 Y F(18,3) 주계약 보험가입금액
    currency_code 통화코드(보험가입금액) N A(3) 통화코드 (ISO 4217 준용)
    - 외화보험의 경우(보험료 납입을 외화로 하는 경우) 통화코드 사용 필요
    - 통화코드값이 명시되어있지 않을 경우 KRW(원)
    contractor_name 계약자명 Y AH(30) 해당 보험 상품의 계약자 이름(짝수번째 자리 마스킹하여 제공)
    prize_cnt 목적물수 Y N(3) 해당 보험 계약에 포함된 목적물의 수
    prize_list 목적물목록 Y Object
    --is_person 인/물 구분코드 Y aN(2) 인/물 구분코드
    01 : 인
    02 : 물
    --prize_num 피보험인/물 번호 Y aN(15) 정보제공자가 임의로 설정한 해당 보험 상품의 피보험인/물별 데이터를 관리하기 위한 번호
    (각 목적물이 구분가능하면 됨)
    --prize_name 피보험인/물 명 Y AH(300) 해당 보험 상품의 피보험인/물 이름
    - 피보험물인 경우 보험목적물명 회신
    - 피보험인의 경우 짝수번째 자리 마스킹처리
    - 피보험인이 본인인 경우 '본인' 회신
    --is_primary 주피보험자여부 Y Boolean 피보험자가 본 계약의 주피보험자에 해당하는지 여부
    - 주피보험자 : True, 종피보험자 : False
    그 외 : 미전송
    --prize_addr 소재지 Y AH(300) 목적물 소재지 세부주소
    --object_code 물건구분(코드) Y aN(2) 물건 구분
    01 : 주택물건
    02 : 일반물건
    03 : 기타
    --prize_code 목적물(코드) Y aN(2) 목적물 구분
    - (첨부17) 목적물 구분 코드 참고
  • 피보험자 물, 일반보험 특약정보 조회 v2 2024-10-21

    기본 정보
    API ID 보험-023 HTTP Method POST
    API 제공자 보험업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/insu/insured/general/contracts
    설명 정보주체(물, 일반보험/계피상이 계약의 피보험자)가 계약의 피보험자인 물, 일반보험별 특약 정보 조회
    기준시점 현재 시점
    Content-Type(요청) application/json; charset=UTF-8 Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급한 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Body org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    insu_num 증권번호 Y aN(20) 보험 계약자가 가입한 증권번호
    insured_no 피보험인/물 순번 Y aN(20) 인물 구분코드 + 피보험인/물 번호
    search_timestamp 조회 타임스탬프 Y N(14) 가장 최근 조회한 시간 (이전 API 호출 시 정보제공자가 회신한 값을 저장하고 있다가 다음 API 호출 시 그 값을 그대로 세팅하여 전송, 최초 API 호출시에는 0으로 세팅)
    - 2.1-[2] 참조
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    search_timestamp 조회 타임스탬프 N N(14) API 처리 시점의 현재시각을 설정하여 회신. 다만 정보제공자는 Timestamp 로직을 의무적으로 구현할 필요가 없으며(선택사항), Timestamp 로직 미제공 시에는 항상 0을 회신 또는 미회신
    contract_cnt 특약목록수 Y N(3)
    contract_list 특약목록 Y Object
    --contract_name 특약명 Y AH(300) 기본담보 포함, 할인할증특약 등 제도성 특약 내용 포함
    --contract_status 특약의 상태 (코드) Y aN(2) 현재 특약의 계약상태
    - <코드값>
    02 : 정상(보장개시(초회보험료 납입) 및 승낙처리 된 상태)
    04 : 실효(계속보험료 연체로 회사가 연체사실 등을 알린 뒤 효력이 상실된 상태)
    05 : 만기(보험기간이 경과하여 보험금이 지급되기 전 상태)
    --contract_exp_date 특약만기일자 Y DATE 특약의 만기일자
    --contract_face_amt 특약가입금액 Y F(18,3) 보험금 지급 사유 발생 시 고객에게 지급되는 금액(특약보험금)
    - 전문인 배상책임보험의 경우 보상한도액(MAX제공)을 의미(배책만 1:N 구조임)
    ※ 물/일반 보험에서 가입금액을 숫자가 아닌 '가입금액'/'법정한도액'으로 관리하는 경우 999(가입금액), 9999(법정한도액)로 전송
    --currency_code 통화코드 (특약가입금액) N A(3) 통화코드 (ISO 4217 준용)
    - 외화보험의 경우(보험료 납입을 외화로 하는 경우) 통화코드 사용 필요
    - 통화코드값이 명시되어있지 않을 경우 KRW(원)
    --is_required 특약의 유형 (여부) Y Boolean 해당 특약의 필수성 여부(주보험, 의무부가, 고정부가 특약은 필수)
    - true : 필수, false : 선택
  • 물, 일반 보장정보 조회 v2 2024-10-21

    기본 정보
    API ID 보험-024 HTTP Method POST
    API 제공자 보험업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/insu/insurances/general/coverages
    설명 정보주체가 계약한 물, 일반 보험별 보장정보 조회
    기준시점 현재 시점
    Content-Type(요청) application/json; charset=UTF-8 Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급한 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Body org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    insu_num 증권번호 Y aN(20) 보험 계약자가 가입한 증권번호
    search_timestamp 조회 타임스탬프 Y N(14) 가장 최근 조회한 시간 (이전 API 호출 시 정보제공자가 회신한 값을 저장하고 있다가 다음 API 호출 시 그 값을 그대로 세팅하여 전송, 최초 API 호출시에는 0으로 세팅)
    - 2.1-[2] 참조
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    search_timestamp 조회 타임스탬프 N N(14) API 처리 시점의 현재시각을 설정하여 회신. 다만 정보제공자는 Timestamp 로직을 의무적으로 구현할 필요가 없으며(선택사항), Timestamp 로직 미제공 시에는 항상 0을 회신 또는 미회신
    - 2.1-[2] 참조
    coverage_cnt 보장목록수 Y N(3)
    coverage_list 보장목록 Y Object
    --subject 계약관계자 구분 (코드) Y A(1) 계약관계자(계약자, 피보험자 등) (‘I’ 고정값 사용)
    <코드값>
    C : 계약자
    I : 피보험자
    O : 소유자 (보험금 청구권을 갖는 소유자 (물(物)보험 계약 전용))
    --relation 피보험자계약자관계 (코드) Y aN(2) -계약자 기준, 피보험자와 계약자와의 관계
    - [첨부15]-[1] 계약관계자 구분 코드
    - 예 : 피보험자(A)는 아들, 계약자(B)는 아버지일 경우, 피보험자계약자관계코드는 자녀(03)로 입력
    --status 담보상태 (코드) Y aN(1) 담보별 계약상태에 대한 상태코드
    - [첨부15]-[2] 담보상태 코드
    --coverage_code 담보 (코드) Y AN(5) 담보 코드
    - [첨부15]-[3] 실손 외 담보 코드
    - [첨부15]-[5] 실손 담보 코드
    --type 담보특성 (코드) N N(1) 담보특성 코드
    - 실손보장일 경우만 회신
    - [첨부15]-[4] 실손 담보특성 코드
    --coverage_num 회사담보일련번호 Y aNS(20) 보험회사 등에서 관리하고 있는 담보코드[번호] 또는 실손담보일련번호
    - 실손담보일련번호(2자리) : 동일 보장내용코드, 담보특성코드가 여러 건이 있을 경우 순차적으로 증가(기본은 '01'로 입력)
    --coverage_name 회사담보명 N AH(300) 보험회사 등에서 관리하고 있는 담보명
    --coverage_amt 담보금액 Y N(10) 담보별 보장금액(단위:천원, 1,000원=1)
    - 해당 담보만으로 순수하게 보장하는 보장금액
    - 예1 : 일반사망시 1억원, 재해사망시 2억원(일반사망담보 1억원+재해사망담보 1억원)을 받는 계약인 경우 → 일반사망 1억원, 재해사망 1억원을 입력
    - 예2 : 선지급형 1급 장기간병요양진단(50%) 또는 질병사망 담보(최대 1억원까지 보장)인 계약인 경우 → 장기간병요양(1급) 5000만원, 질병사망 1억원을 담보금액으로 각각 입력
    ※ 물/일반 보험에서 가입금액을 숫자가 아닌 '가입금액' / '법정한도액'으로 관리하는 경우 999(가입금액), 9999(법정한도액)로 전송
    --start_date 담보기간 시작일자 N DATE 담보의 원보험기간 시작일자
    - 갱신시 갱신된 시작일 전송
    --end_date 담보기간 종료일자 N DATE 담보의 원보험기간 종료일자
    - 갱신시 갱신된 종료일 전송
  • 피보험자 물, 일반 보장정보 조회 v2 2024-10-21

    기본 정보
    API ID 보험-025 HTTP Method POST
    API 제공자 보험업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/insu/insured/general/coverages
    설명 정보주체(장기인/계피상이 계약의 피보험자)의 물, 일반 보험별 보장정보 조회
    기준시점 현재 시점
    Content-Type(요청) application/json; charset=UTF-8 Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급한 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Body org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    insu_num 증권번호 Y aN(20) 보험 계약자가 가입한 증권번호
    search_timestamp 조회 타임스탬프 Y N(14) 가장 최근 조회한 시간 (이전 API 호출 시 정보제공자가 회신한 값을 저장하고 있다가 다음 API 호출 시 그 값을 그대로 세팅하여 전송, 최초 API 호출시에는 0으로 세팅)
    - 2.1-[2] 참조
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    search_timestamp 조회 타임스탬프 N N(14) API 처리 시점의 현재시각을 설정하여 회신. 다만 정보제공자는 Timestamp 로직을 의무적으로 구현할 필요가 없으며(선택사항), Timestamp 로직 미제공 시에는 항상 0을 회신 또는 미회신
    - 2.1-[2] 참조
    coverage_cnt 보장목록수 Y N(3)
    coverage_list 보장목록 Y Object
    --subject 계약관계자 구분 (코드) Y A(1) 계약관계자(계약자, 피보험자 등) (‘C’ 고정값 사용)
    <코드값>
    C : 계약자
    I : 피보험자
    O : 소유자 (보험금 청구권을 갖는 소유자 (물(物)보험 계약 전용))
    --relation 피보험자계약자관계 (코드) Y aN(2) 계약자 기준, 피보험자와 계약자와의 관계
    - [첨부15]-[1] 계약관계자 구분 코드
    - 예 : 피보험자(A)는 아들, 계약자(B)는 아버지일 경우, 피보험자계약자관계코드는 자녀(03)로 입력
    --status 담보상태 (코드) Y aN(1) 담보별 계약상태에 대한 상태코드
    - [첨부15]-[2] 담보상태 코드
    --coverage_code 담보 (코드) Y AN(5) 담보 코드
    - [첨부15]-[3] 실손 외 담보 코드
    - [첨부15]-[5] 실손 담보 코드
    --type 담보특성 (코드) N N(1) 담보특성 코드
    - 실손보장일 경우만 회신
    - [첨부15]-[4] 실손 담보특성 코드
    --coverage_num 회사담보일련번호 Y aNS(20) 보험회사 등에서 관리하고 있는 담보코드[번호] 또는 실손담보일련번호
    - 실손담보일련번호(2자리) : 동일 보장내용코드, 담보특성코드가 여러 건이 있을 경우 순차적으로 증가(기본은 '01'로 입력)
    --coverage_name 회사담보명 Y AH(300) 보험회사 등에서 관리하고 있는 담보명
    --coverage_amt 담보금액 Y N(10) 담보별 보장금액(단위:천원, 1,000원=1, 천원 단위 미만 절사)
    - 해당 담보만으로 순수하게 보장하는 보장금액
    - 예1 : 일반사망시 1억원, 재해사망시 2억원(일반사망담보 1억원+재해사망담보 1억원)을 받는 계약인 경우 → 일반사망 1억원, 재해사망 1억원을 입력
    - 예2 : 선지급형 1급 장기간병요양진단(50%) 또는 질병사망 담보(최대 1억원까지 보장)인 계약인 경우 → 장기간병요양(1급) 5000만원, 질병사망 1억원을 담보금액으로 각각 입력
    ※ 물/일반 보험에서 가입금액을 숫자가 아닌 '가입금액'/'법정한도액'으로 관리하는 경우 999(가입금액), 9999(법정한도액)로 전송
    --start_date 담보기간 시작일자 N DATE 담보의 원보험기간 시작일자
    - 갱신시 갱신된 시작일 전송
    --end_date 담보기간 종료일자 N DATE 담보의 원보험기간 종료일자
    - 갱신시 갱신된 종료일 전송
  • 숨은 금융자산(미출연) 목록 조회 v2 2024-10-21

    기본 정보
    API ID 숨은금융-001(보험) HTTP Method GET
    API 제공자 보험 업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/insu/sleep_noncont
    설명 정보주체가 보유한 휴면예금, 휴면보험금, 미청구 보험금 조회
    - 미출연 휴면예금, 휴면보험금, 미청구보험금은 조회 시점 최신 정보이며, 실시간 계산정보는 아님(매주 또는 매월말 등의 마감정보이며, 기관별로 기준은 상이)
    - 휴면보험금, 미청구보험금은 보험협회에서 운영하는 내보험 찾아줌 기준과 동일하게 정보 제공
    기준시점 현재 시점
    Content-Type(요청) - Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급한 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Parameter org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    search_timestamp 조회 타임스탬프 N N(14) 가장 최근 조회한 시간 (이전 API 호출 시 정보제공자가 회신한 값을 저장하고 있다가 다음 API 호출 시 그 값을 그대로 세팅하여 전송, 최초 API 호출시에는 0으로 세팅)
    - 2.1-[2] 참조
    - next_page가 세팅된 경우 요청에서 제외
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체 (설정 시 해당 개체 후 limit 개 반환)
    처음 API 호출 시에는 해당 정보를 세팅하지 않으며, 다음 페이지 요청 시 직전 조회의 응답에서 얻은 기준개체를 그대로 세팅
    - 2.1-[2] 페이지네이션 참조
    limit 최대조회갯수 Y N(3) 기준개체 이후 반환될 개체의 개수
    - 최대 500까지 설정 가능
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    search_timestamp 조회 타임스탬프 N N(14) API 처리 시점의 현재시각을 설정하여 회신. 다만 정보제공자는 Timestamp 로직을 의무적으로 구현할 필요가 없으며(선택사항), Timestamp 로직 미제공 시에는 항상 0을 회신 또는 미회신
    - 2.1-[2] 참조
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체
    - 다음 페이지 존재하지 않는 경우(마지막 페이지), 미회신
    - 2.1-[2] 페이지네이션 참조
    sleep_cnt 보유계좌수 Y N(3)
    sleep_list 보유계좌 Y Object
    --sleep_num 계좌번호 또는 보험증권번호 Y aN(20) 숨은금융자산의 계좌번호 또는 보험증권번호
    --is_consent 전송요구 여부 Y Boolean 정보주체가 해당 자산(계약관리번호)에 대해 개인신용정보 전송요구를 했는지 여부
    --seqno 회차번호 N aN(7) 동일 계좌번호 내에서 회차별 특성이 상이한 상품(중소기업채권 등 채권류 상품 등에 적용)의 경우 회차 번호 (이 경우 PK는 계좌번호와 회차번호가 됨)
    - 동일계좌번호라 하더라도 회차번호에 따라 별도의 복수개의 계좌로 관리하는 기관(기업은행, 산업은행 등)만 회신
    - 계좌번호만으로 PK처리가 가능한 경우, 회신하면 안됨
    --prod_name 상품명 Y AH(300) 해당 계좌의 상품명
    --sleep_type 숨은 금융자산 구분(코드) Y aN(2) 해당 자산의 상품 구분 코드
    <코드값>
    - 10 : 은행예금
    - 20 : 생명보험 상품
    - 30 : 손해보험 상품
    - 40 : 우체국예금
    - 50 : 우체국보험
    - 70 : 상호저축은행 예금
    - 99 : 기타
    --insu_type 보험 구분(코드) N aN(2) 해당 자산의 상품 구분 코드
    <코드값>
    - 10 : 휴면보험금
    - 02 : 미청구보험금
  • 휴면보험금 정보조회 v2 2024-10-21

    기본 정보
    API ID 숨은금융-003 HTTP Method POST
    API 제공자 보험업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/insu/sleep_noncont/insu
    설명 정보주체가 보유한 휴면보험금 정보조회 (전송요구한 자산에 대해)
    - 숨은금융-003은 보험업권 정보제공자만 정보제공
    기준시점 현재 시점
    Content-Type(요청) application/json; charset=UTF-8 Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급한 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Body org_code 정보제공자 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    insu_num 증권번호 Y aN(20) 보험 계약자가 가입한 증권번호
    search_timestamp 조회 타임스탬프 Y N(14) 가장 최근 조회한 시간 (이전 API 호출 시 정보제공자가 회신한 값을 저장하고 있다가 다음 API 호출 시 그 값을 그대로 세팅하여 전송, 최초 API 호출시에는 0으로 세팅)
    - 2.1-[2] 참조
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    search_timestamp 조회 타임스탬프 N N(14) API 처리 시점의 현재시각을 설정하여 회신. 다만 정보제공자는 Timestamp 로직을 의무적으로 구현할 필요가 없으며(선택사항), Timestamp 로직 미제공 시에는 항상 0을 회신 또는 미회신
    - 2.1-[2] 참조
    industry_code 업권 구분(코드) Y aN(2) 해당 자산의 업권 구분 코드
    <코드값>
    - 01 : 생명보험
    - 02 : 손해보험
    - 03 : 우체국보험
    main_phone_num 기관 대표 전화 번호 Y aNS(64) 기관 대표전화번호
    currency_code 톻화코드 N A(3) 해당 계좌번호에 적용된 통화코드(ISO 4217 준용)
    - 통화코드 값이 명시되어 있지 않을 경우 KRW(원)
    sleep_amt 휴면계좌금액 Y F(18,3) 휴면계좌 금액
    ext_pres_date 소멸시효 완성일 Y DATE 내부적으로 미출연 휴면예금, 잡수익 등 각사 기준에 따라 미출연 휴면예금으로 편입된 날짜
    trans_memo 거래메모 N F(18,3) 해당 거래의 부가 정보
    - 영업점 안내, 압류, 질권 등 거래제한 사유, 환급신청 안내 등
  • 미청구보험금(중도, 만기보험금 등) 정보 조회 v2 2024-10-21

    기본 정보
    API ID 숨은금융-004 HTTP Method POST
    API 제공자 보험업권 API 요청자 마이데이터사업자
    API 명 (URI) /v2/insu/sleep_noncont/insu/unclaimed
    설명 정보주체가 보유한 미청구보험금(중도, 만기보험금 등) 정보조회 (전송요구한 자산에 대해)
    - 숨은금융-004는 보험업권 정보제공자만 정보제공
    기준시점 현재 시점
    Content-Type(요청) application/json; charset=UTF-8 Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급한 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Body org_code 정보제공자 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    insu_num 증권번호 Y aN(20) 보험 계약자가 가입한 증권번호
    search_timestamp 조회 타임스탬프 Y N(14) 가장 최근 조회한 시간 (이전 API 호출 시 정보제공자가 회신한 값을 저장하고 있다가 다음 API 호출 시 그 값을 그대로 세팅하여 전송, 최초 API 호출시에는 0으로 세팅)
    - 2.1-[2] 참조
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    search_timestamp 조회 타임스탬프 N N(14) API 처리 시점의 현재시각을 설정하여 회신. 다만 정보제공자는 Timestamp 로직을 의무적으로 구현할 필요가 없으며(선택사항), Timestamp 로직 미제공 시에는 항상 0을 회신 또는 미회신
    - 2.1-[2] 참조
    prod_name 상품명 Y AH(300) 보험 상품의 공식 명칭
    branch_phone_num 기관 대표 전화 번호 Y aNS(64) 취급지점의 대표버호 혹은 담당자 전화번호
    relation 계약관계(코드) Y aN(2) 해당 자산의 업권 구분 코드
    <코드값>
    - 01 : 보험계약자
    - 02 : 피보험자
    - 03 : 보험수익자
    - 04 : 계약자/피보험자
    - 05 : 계약자/수익자
    unclaimed_insu_cnt 휴면계좌금액 Y F(18,3)
    unclaimed_insu_list 운용상품목록 Y <object>
    --prod_type 상품구분(코드) Y aN(2) 해당 자산의 상품 구분 코드
    <코드값>
    - 01 : 중도(급부)보험금
    - 02 : 사고분할보험금
    - 03 : 배당금
    - 04 : 만기보험금
    - 05 : 생존연금
    --currency_code 톻화코드 N A(3) 해당 계좌번호에 적용된 통화코드(ISO 4217 준용)
    - 통화코드 값이 명시되어 있지 않을 경우 KRW(원)
    --unclaimed_amt 미청구보험 금액 Y F(18,3) 미청구보험금 발생금액
    --pri_calc_date 원금산출기준일 N DATE 미청구보험금의 원금산출기준일
    --int_calc_date 이자산출기준일 N DATE 미청구보험금의 이자산출기준일
    --issue_date 계약체결일 Y DATE 최초 보험계약 체결일
    --trans_memo 거래메모 N AH(90) 해당 거래의 부가 정보
    - 영업점 안내, 압류, 질권 등 거래제한 사유, 환급신청 안내 등
  • API 목록 조회 (공통) v1 2024-10-21

    기본 정보
    API ID 정보제공-공통-001 (보험) HTTP Method GET
    API 제공자 공통 API 요청자 마이데이터사업자, 종합포털
    API 명 (URI) /insu/apis
    설명 정보제공자가 제공하는 정보제공 API 목록(정보제공-공통-001, 정보제공-공통-002 포함)을 회신
    - 인증 API는 모든 정보제공자(또는 중계기관)가 공통적으로 구축해야 하므로, 목록을 조회하는 것이 불필요
    - 지원 API는 종합포털과 주고받는 API이기 때문에 API 요청자인 마이데이터사업자가 목록을 조회하는 것이 불필요
    기준시점 현재 시점
    Content-Type(요청) - Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    x-api-type API 유형 N aNS(12) 정기적/비정기적 전송 API 유형- 비정기적 전송일 경우 미설정
    Parameter org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    client_id 클라이언트ID Y aN(50) 종합포털에 마이데이터 서비스 등록 시 발급받은 클라이언트 식별값
    - API 요청자가 “종합포털”인 경우, client_id는 PDS 자격증명의 client_id로 요청
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    version 현재 버전 Y aN(10) API 현재 버전 (업권별 정보제공 API)
    - 참고 : 업권별로 버전이 관리되기 때문에 해당 업권의 정보제공API들의 현재버전(버전정보가 존재하지 않는 정보제공-공통-001 API제외)은 모두 동일하며, 해당 현재버전을 회신
    min_version 호환가능 최소 버전 N aN(10) 마이데이터사업자가 이전 버전 호출 시 응답 가능한 최소 버전
    (예: 최신 버전이 v5, min_version=v2이라고 가정 시, 마이데이터사업자는 v2를 호출해도 정보제공자는 해당 버전의 API를 처리하여 회신- 현재버전이 v1인 경우 미회신
    api_cnt API 개수 Y N(3) 제공 API 개수
    api_list API 목록 Y <object>
    --api_code API 구분 코드 Y AN(4) API 구분 코드
    --api_uri API 명 Y aN(50) URI 계층구조 중 에 해당하는 정보 (예: /account, /accounts/deposit/basic 등)
  • 전송요구 내역 조회 (공통) v2 2024-10-21

    기본 정보
    API ID 정보제공-공통-002 (보험) HTTP Method GET
    API 제공자 공통 API 요청자 마이데이터사업자
    API 명 (URI) /v2/insu/consents
    설명 정보주체가 특정한 전송요구 내역 조회
    - 시행 초기 전산 용량 등을 감안하여 초기에는 전송 주기(fnd_cycle, add_cycle)를 주1회(“1/w”)로 고정하고, 추후 논의 과정을 거쳐 고객의 선택권을 다양화할 예정
    기준시점 현재 시점
    Content-Type(요청) - Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급한 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Parameter org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    is_scheduled 정기적 전송 여부 Y Boolean 정기적 전송을 요구하는지 여부
    fnd_cycle 전송 주기(기본정보) N aNS(5) 정기적 전송 주기
    - 규격 : 횟수/기준 (기준:월=“m”, 주=“w”, 일=“d”)
    <예시>
    1/w : 주1회
    1/d : 일1회
    - is_scheduled='true'인 경우 회신
    add_cycle 전송 주기(추가정보) N aNS(5) 추가정보의 정기적 전송 주기
    - 규격 : fnd_cycle과 동일
    - is_scheduled='true'인 경우 회신
    end_date 종료시점 Y DATE 전송요구 종료 시점
    - 자산목록 전송요구(1차 통합인증) 시 : 전송요구시점부터 7일째 되는 일자 (예: 2021.12.1. 전송요구 시 종료시점은 +7일인 2021.12.8.)
    - 개별인증 시 또는 자산에 대한 세부 전송요구(2차 통합인증) 시 : 전송요구시점부터 1년째 되는 일자 (예: 2021.12.1. 전송요구 시 종료시점은 +1년인 2022.12.1.) 또는 고객이 선택한 일자
    purpose 목적 Y AH(150) 전송을 요구하는 목적
    period 보유기간 Y DATE 전송을 요구하는 개인신용정보의 보유기간
    - 자산목록 전송요구(1차 통합인증) 시 : 전송요구시점부터 7일째 되는 일자 (예: 2021.12.1. 전송요구 시 보유기간은 +7일인 2021.12.8.)
    - 개별인증 시 또는 자산에 대한 세부 전송요구(2차 통합인증) 시 : '99991231' 고정값
    - '99991231' : '서비스 이용 종료시 또는 삭제요구시 까지'를 의미
    is_consent_trans_memo 적요/거래메모 전송요구 여부 N Boolean 정보주체가 보유한 수신계좌의 거래내역 중 적요/거래메모(trans_memo) 정보에 대해 개인신용정보 전송요구를 했는지 여부
    - 적용업권 : 은행업권, 금투업권, 전자금융업권 (그 외 업권은 미회신)
    - “true”인 경우 :
    - 은행업권 : 은행-004, 은행-014에서 적요 회신
    - 금투업권 : 금투-003, 금투-006에서 적요 회신
    - 전자금융업권 : 전금-004, 전금-103에서 거래메모 회신
    - “false”인 경우 :
    - 은행업권 : 은행-004, 은행-014에서 적요 미회신
    - 금투업권 : 금투-003, 금투-006에서 적요 미회신
    - 전자금융업권 : 전금-004, 전금-103에서 거래메모 미회신
    is_consent_merchant_name_regno 가맹점명/사업자등록번호 전송요구 여부 N Boolean 가맹점명(merchant_name) 및 사업자등록번호(merchant_regno) 정보에 대해 개인신용정보 전송요구를 했는지 여부
    - 적용업권 : 카드업권, 전자금융업권, 통신업권 (그 외 업권은 미회신)
    - “true”인 경우 :
    - 카드업권 : 카드-005, 카드-008, 카드-014, 선불-004에서 가맹점명 및 사업자등록번호 회신, 카드-009에서 가맹점명 회신
    - 전자금융업권 : 전금-004에서 가맹점명 회신, 전금-103에서 가맹점명 및 사업자등록번호 회신
    - 통신업권 : 통신-004에서 가맹점명 및 사업자등록번호 회신
    - “false”인 경우 :
    - 카드업권 : 카드-005, 카드-008, 카드-014, 선불-004에서 가맹점명 및 사업자등록번호 미회신, 카드-009에서 가맹점명 미회신
    - 전자금융업권 : 전금-004에서 가맹점명 미회신, 전금-103에서 가맹점명 및 사업자등록번호 미회신
    - 통신업권 : 통신-004에서 가맹점명 및 사업자등록번호 미회신
    is_consent_trans_category 상품(구매)분류 전송요구 여부 N Boolean 정보주체의 결제내역 중 상품(구매)분류(코드)(trans_category) 정보에 대해 개인신용정보 전송요구를 했는지 여부
    - 적용업권 : 전자금융업권 (그 외 업권은 미회신)
    - “true”인 경우 :
    - 전자금융업권 : 전금-004, 전금-103에서 상품(구매)분류 (코드) 회신
    - “false”인 경우 :
    - 전자금융업권 : 전금-004, 전금-103에서 상품(구매)분류 (코드) 미회신
  • 전송요구 내역 조회 (공통) v1 2024-10-21

    기본 정보
    API ID 정보제공-공통-002 (보험) HTTP Method GET
    API 제공자 공통 API 요청자 마이데이터사업자
    API 명 (URI) /v1/insu/consents
    설명 정보주체가 특정한 전송요구 내역 조회
    - 시행 초기 전산 용량 등을 감안하여 초기에는 전송 주기(fnd_cycle, add_cycle)를 주1회(“1/w”)로 고정하고, 추후 논의 과정을 거쳐 고객의 선택권을 다양화할 예정
    기준시점 현재 시점
    Content-Type(요청) - Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header Authorization 접근토큰 Y aNS(1500) 발급한 접근토큰
    - 접근토큰 유형(Bearer)을 명시
    예) Authorization: Bearer 접근토큰
    x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    x-api-type API 유형 Y aNS(12) 정기적/비정기적 전송 API 유형
    Parameter org_code 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    is_scheduled 정기적 전송 여부 Y Boolean 정기적 전송을 요구하는지 여부
    fnd_cycle 전송 주기(기본정보) N aNS(5) 정기적 전송 주기
    - 규격 : 횟수/기준 (기준:월=“m”, 주=“w”, 일=“d”)
    <예시>
    1/w : 주1회
    1/d : 일1회
    - is_scheduled='true'인 경우 회신
    add_cycle 전송 주기(추가정보) N aNS(5) 추가정보의 정기적 전송 주기
    - 규격 : fnd_cycle과 동일
    - is_scheduled='true'인 경우 회신
    end_date 종료시점 Y DATE 전송요구 종료 시점
    - 자산목록 전송요구(1차 통합인증) 시 : 전송요구시점부터 7일째 되는 일자 (예: 2021.12.1. 전송요구 시 종료시점은 +7일인 2021.12.8.)
    - 개별인증 시 또는 자산에 대한 세부 전송요구(2차 통합인증) 시 : 전송요구시점부터 1년째 되는 일자 (예: 2021.12.1. 전송요구 시 종료시점은 +1년인 2022.12.1.) 또는 고객이 선택한 일자
    purpose 목적 Y AH(150) 전송을 요구하는 목적
    period 보유기간 Y DATE 전송을 요구하는 개인신용정보의 보유기간
    - 자산목록 전송요구(1차 통합인증) 시 : 전송요구시점부터 7일째 되는 일자 (예: 2021.12.1. 전송요구 시 보유기간은 +7일인 2021.12.8.)
    - 개별인증 시 또는 자산에 대한 세부 전송요구(2차 통합인증) 시 : '99991231' 고정값
    - '99991231' : '서비스 이용 종료시 또는 삭제요구시 까지'를 의미
    is_consent_trans_memo 적요/거래메모 전송요구 여부 N Boolean 정보주체가 보유한 수신계좌의 거래내역 중 적요/거래메모(trans_memo) 정보에 대해 개인신용정보 전송요구를 했는지 여부
    - 적용업권 : 은행업권, 전자금융업권 (그 외 업권은 미회신)
    - “true”인 경우 :
    - 은행업권 : 은행-004에서 적요 회신
    - 전자금융업권 : 전금-004, 전금-103에서 거래메모 회신
    - “false”인 경우 :
    - 은행업권 : 은행-004에서 적요 미회신
    - 전자금융업권 : 전금-004, 전금-103에서 거래메모 미회신
    is_consent_merchant_name_regno 가맹점명/사업자등록번호 전송요구 여부 N Boolean 가맹점명(merchant_name) 및 사업자등록번호(merchant_regno) 정보에 대해 개인신용정보 전송요구를 했는지 여부
    - 적용업권 : 카드업권, 전자금융업권, 통신업권 (그 외 업권은 미회신)
    - “true”인 경우 :
    - 카드업권 : 카드-005, 카드-008, 선불-004에서 가맹점명 및 사업자등록번호 회신, 카드-009에서 가맹점명 회신
    - 전자금융업권 : 전금-004에서 가맹점명 회신, 전금-103에서 가맹점명 및 사업자등록번호 회신
    - 통신업권 : 통신-004에서 가맹점명 회신
    - “false”인 경우 :
    - 카드업권 : 카드-005, 카드-008, 선불-004에서 가맹점명 및 사업자등록번호 미회신, 카드-009에서 가맹점명 미회신
    - 전자금융업권 : 전금-004에서 가맹점명 미회신, 전금-103에서 가맹점명 및 사업자등록번호 미회신
    - 통신업권 : 통신-004에서 가맹점명 미회신
    is_consent_trans_category 상품(구매)분류 전송요구 여부 N Boolean 정보주체의 결제내역 중 상품(구매)분류(코드)(trans_category) 정보에 대해 개인신용정보 전송요구를 했는지 여부
    - 적용업권 : 전자금융업권 (그 외 업권은 미회신)
    - “true”인 경우 :
    - 전자금융업권 : 전금-004, 전금-103에서 상품(구매)분류 (코드) 회신
    - “false”인 경우 :
    - 전자금융업권 : 전금-004, 전금-103에서 상품(구매)분류 (코드) 미회신
보험 업권 정보제공 API 규격