금융보안원 로고

회원가입 로그인

API가이드

지원 API(종합포털 제공)

  • 접근토근 발급 (지원API 호출용) v1 2021-10-18

    기본 정보
    API ID 지원-001 HTTP Method POST
    API 제공자 종합포털 API 요청자 마이데이터사업자, 정보제공자, 통합인증기관
    API 명 (URI) /mgmts/oauth/2.0/token
    설명 종합포털이 사전에 발급해준 '지원 API 호출용 자격증명'을 이용하여 접근토큰 발급
    - 중계기관을 이용하는 기관의 경우, 중계기관이 본 API를 호출하여 접근토큰을 대표로 발급 받음
    - 따라서 중계기관도 포털에 기관 등록 및 자격증명 발급 필요
    기준시점 현재 시점
    Content-Type(요청) application/x-www-form-urlencoded Content-Type (응답) application/json; charset=UTF-8
    요청 메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body grant_type 권한부여방식 Y aNS(18) 권한부여 방식
    ('client_credentials' 고정값)
    client_id 클라이언트 ID Y aN(50) 종합포털에서 발급한 지원 API 호출용 클라이언트 식별값
    client_secret 클라이언트 Secret Y aN(50) 종합포털에서 발급한 지원 API 호출 클라이언트 Secret 값
    scope 권한 범위 Y a(6) 고정값 : 'manage'
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    token_type 접근토큰 유형 Y a(6) 접근토큰 유형
    - 'Bearer' 고정값
    access_token 접근토큰 Y aNS(1500) 발급된 접근토큰
    expires_in 접근토큰 유효기간 Y N(9) 접근토큰 유효기간(단위 : 초)
    scope 권한 범위 Y a(6) 고정값 : manage

  • 기관정보 조회 v2 2022-10-19

    기본 정보
    API ID 지원-002 HTTP Method GET
    API 제공자 종합포털 API 요청자 마이데이터사업자, 정보제공자, 통합인증기관(사설인증서)
    API 명 (URI) /v2/mgmts/orgs
    설명 정보제공자/마이데이터사업자/통합인증기관이 타기관의 기관정보를 종합포털로부터 제공받기 위한 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) 거래고유번호
    Parameter 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을 회신 또는 미회신
    org_cnt 기관목록수 Y N(5) N(5)
    org_list 기관목록 Y Object
    --op_type 기관정보의 신규/수정/삭제 구분 Y A(1) 해당 기관정보가 신규/수정/삭제인지를 구분자로 전송 (수정내역이 없는 기관의 기관정보는 회신하지않음)
    - <코드값>
    'I' : 신규
    'M' : 수정
    'D' : 삭제
    --org_code 기관코드 Y aN(10) 기관코드
    --org_type 기관구분 Y aN(2) 기관구분 코드
    - <코드값>
    '01' : 정보제공자 (API 자체구축)
    '02' : 정보제공자 (중계기관 이용)
    '03' : 마이데이터사업자
    '04' : 중계기관
    '05' : 통합인증기관(인증서 본인확인기관)
    '06' : 통합인증기관(전자서명인증사업자)
    '07' : 종합포털
    '99' : 기타
    * 공공기관의 경우 '02' 회신
    --is_rcv_org 정보수신자 여부 N Boolean 해당 기관이 「개인신용정보 전송요구권 표준API 규격」 상 정보수신자(마이데이터사업자 제외)인지 여부
    - op_type='D'인 경우 미회신
    - org_type=’03’~‘06’인 경우 미회신
    --org_name 기관명 N AH(60) 기관명
    * op_type='D'인 경우 미회신
    --org_regno 사업자등록번호 N NS(12) 사업자 등록번호
    - op_type='D'인 경우 미회신
    - “-” 포함
    --corp_regno 법인등록번호 N aN(13) 법인 등록번호
    - op_type='D'인 경우 미회신
    - 법인등록번호가 없는 기관(예:우정사업본부 등)의 경우 미회신
    --serial_num TLS 인증서 시리얼넘버 N aNS(20) TLS인증서 내 SERIALNUMBER
    (Subject:serialNumber(OID:2.5.4.5)) 값
    - 기관 간 상호인증을 위한 TLS 인증서(EV등급)내 SERIALNUMBER에 기재된 값(일반적으로 사업자등록번호이지만 그렇지 않은 경우 존재)
    - op_type='D'인 경우 미회신
    - op_type='05'(인증서 본인확인기관)인 경우 미회신(불필요)
    - 타기관과 전용선 또는 VPN으로만 접속하는 기관의 경우 미회신(불필요)
    --address 주소 N AH(150) 주소
    - op_type='D'인 경우 미회신
    --domain API 서버 도메인명 N aNS(70) API 서버의 도메인명
    - op_type='D'인 경우 미회신
    - op_type='02'(중계기관 이용기관)인 경우 미회신(불필요)
    - op_type='05'(인증서 본인확인기관)인 경우 도메인명을 사용하지 않는 경우 미회신(불필요) (일부 인증서 본인확인기관의 경우 도메인명 제공)
    --domain_ip_cnt API서버 공인IP 목록수 N N(3) API서버 공인IP 목록 수
    - API서버 도메인명만 제공 시 아웃바운드 방화벽 정책 설정(API 요청자)의 어려움 등 존재하여 공인IP도 함께 제공
    - 일부 기관의 경우 동일 API서버 도메인명에 대해 복수 개의 공인IP를 사용(예: 멀티IDC 기반 Global load balancer 도입 등)하고 있어 List로 회신
    - op_type='D'인 경우 미회신
    - org_type='02'(중계기관 이용기관)인 경우 미회신(불필요)
    --domain_ip_list API서버 공인IP 목록 N Object - op_type='D'인 경우 미회신
    - org_type='02'(중계기관 이용기관)인 경우 미회신(불필요)
    - op_type='06'(전자서명인증사업자)인 경우 미회신(통합인증 중계시스템 이용으로 불필요)
    ----domain_ip API서버 공인IP N aNS(21) API 서버의 공인IP 주소
    - PORT가 필요한 경우 IP와 PORT간 구분자는 콜론(:)을 사용
    - op_type='D'인 경우 미회신
    - org_type='02'(중계기관 이용기관)인 경우 미회신(불필요)
    - org_type='05'(인증서 본인확인기관)인 경우 PORT 필수 제공
    --relay_org_code 중계기관/거점중계기관 기관코드 N aN(10) 중계기관/거점중계기관 기관코드
    - 중계기관 이용기관(org_type=’02’)의 경우, 해당 기관이 이용 중인 중계기관(거점중계기관과 동일) 기관코드를 회신
    * 공공기관의 경우 신용정보원 중계기관 코드 회신
    - API 자체구축 정보제공자(org_type=’01’)의 경우, 해당 기관이 이용 중인 거점중계기관 기관코드를 회신
    --industry 업권 N a(10) 정보제공자의 업권 정보
    - op_type='D'인 경우 미회신
    - 정보제공자(org_type='01' 또는 '02')인 경우만 회신
    - <코드값>
    'bank' : 은행
    'card' : 카드
    'invest' : 금융투자
    'insu' : 보험
    'efin' : 전자금융
    'capital' : 할부금융
    'ginsu' : 보증보험
    'telecom' : 통신
    'p2p' : P2P
    'bond' : 인수채권
    'usury' : 대부
    'public' : 공공
    --auth_type 제공 인증방식 N aN(2) 정보제공자가 제공하는 인증방식(개별인증/통합인증) 종류
    - op_type='D'인 경우 미회신
    - 정보제공자(org_type='01' 또는 '02')인 경우만 회신
    - <코드값>
    '01' : 통합인증만 제공
    '03' : 개별인증/통합인증 모두 제공
    --cert_issuer_dn 통합인증기관의 DN 값(인증서 본인확인기관 DN의 o 값) N aNS(15) 통합인증기관의 DN 값([별첨] 금융분야 마이데이터 통합인 절차 및 규격 참조)
    - op_type='05'(인증서 본인확인기관)인 경우만 회신
    - op_type='D'인 경우 미회신
    --cert_oid 허용 통합인증서 OID N aNS(300) 허용 통합인증서 OID (별첨1 참조)
    - op_type='05'(인증서 본인확인기관)인 경우만 회신
    - 허용 인증서 OID가 다수일 경우에는 구분자('_')로 구분하여 제공
    - op_type='D'인 경우 미회신
    --ip_cnt IP 목록수 N N(3) 해당기관이 API 요청자인 경우, API 제공자(서버)인 상대기관이 방화벽 등으로 접근을 허용(화이트리스트)해야 하는 API 요청자의 IP목록
    <예시>
    - 마이데이터사업자의 IP목록 : 정보제공자(API 자체구축), 중계기관, 종합포털의 방화벽 오픈
    - 정보제공자(API 차제구축) 및 중계기관의 IP목록 : 종합포털의 방화벽 오픈
    - 중계기관의 IP목록 : 종합포털 필요시 정보제공자(중계기관 이용)의 방화벽 오픈 등
    - 통합인증기관의 IP 목록 : 종합포털의 방화벽 오픈 등
    - op_type='D'인 경우 미회신
    --ip_list IP목록 Y Object - op_type='D'인 경우 미회신
    ----ip IP N aNS(15) 해당기관의 IP 주소
    - op_type='D'인 경우 미회신
    --np_time_cnt 정기적 전송가능 시간대 목록수 N N(3) 정보제공자가 정기적 전송을 허용하는 Non-Peak 시간대 목록 수 (최대 3개까지 등록 허용, 시간대 합산하여 6시간 이상 필수)
    - op_type='D'인 경우 미회신
    - 정보제공자(org_type='01' 또는 '02')인 경우만 회신
    --np_time_list 정기적 전송가능 시간대 목록 Y Object - op_type='D'인 경우 미회신
    - 정보제공자(org_type='01' 또는 '02')인 경우만 회신
    ----np_time 정기적 전송가능 시간 N NS(9) 정기적 전송가능 시간 (30분 단위 등록 가능)
    - 규격 : 'hhmm:hhmm'
    <예시>
    0030:0530 (0시30분 ~ 5시30분)
    2230:2300 (22시30분 ~ 23시00분)
    - op_type='D'인 경우 미회신
    - 정보제공자(org_type='01' 또는 '02')인 경우만 회신

  • 기관정보 조회 v1 2021-10-18

    기본 정보
    API ID 지원-002 HTTP Method GET
    API 제공자 종합포털 API 요청자 마이데이터사업자, 정보제공자, 통합인증기관(사설인증서)
    API 명 (URI) /v1/mgmts/orgs
    설명 정보제공자/마이데이터사업자/통합인증기관이 타기관의 기관정보를 종합포털로부터 제공받기 위한 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) 거래고유번호
    Parameter 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을 회신 또는 미회신
    org_cnt 기관목록수 Y N(5) N(5)
    org_list 기관목록 Y Object
    --op_type 기관정보의 신규/수정/삭제 구분 Y A(1) 해당 기관정보가 신규/수정/삭제인지를 구분자로 전송 (수정내역이 없는 기관의 기관정보는 회신하지않음)
    - <코드값>
    'I' : 신규
    'M' : 수정
    'D' : 삭제
    --org_code 기관코드 Y aN(10) 기관코드
    --org_type 기관구분 Y aN(2) 기관구분 코드
    - <코드값>
    '01' : 정보제공자 (API 자체구축)
    '02' : 정보제공자 (중계기관 이용)
    '03' : 마이데이터사업자
    '04' : 중계기관
    '05' : 통합인증기관(인증서 본인확인기관)
    '06' : 통합인증기관(전자서명인증사업자)
    '07' : 종합포털
    '99' : 기타
    --is_rcv_org 정보수신자 여부 N Boolean 해당 기관이 「개인신용정보 전송요구권 표준API 규격」 상 정보수신자(마이데이터사업자 제외)인지 여부
    - op_type='D'인 경우 미회신
    - org_type=’03’~‘07’인 경우 미회신
    --org_name 기관명 N AH(60) 기관명
    * op_type='D'인 경우 미회신
    --org_regno 사업자등록번호 N aN(12) 사업자 등록번호
    - op_type='D'인 경우 미회신
    - “-” 포함
    --corp_regno 법인등록번호 N aN(13) 법인 등록번호
    - op_type='D'인 경우 미회신
    - 법인등록번호가 없는 기관(예:우정사업본부 등)의 경우 미회신
    --serial_num TLS 인증서 시리얼넘버 N aNS(20) TLS인증서 내 SERIALNUMBER
    (Subject:serialNumber(OID:2.5.4.5)) 값
    - 기관 간 상호인증을 위한 TLS 인증서(EV등급)내 SERIALNUMBER에 기재된 값(일반적으로 사업자등록번호이지만 그렇지 않은 경우 존재)
    - op_type='D'인 경우 미회신
    - op_type='05'(인증서 본인확인기관)인 경우 미회신(불필요)
    - 타기관과 전용선 또는 VPN으로만 접속하는 기관의 경우 미회신(불필요)
    --address 주소 N AH(150) 주소
    - op_type='D'인 경우 미회신
    --domain API 서버 도메인명 N aNS(70) API 서버의 도메인명
    - op_type='D'인 경우 미회신
    - op_type='02'(중계기관 이용기관)인 경우 미회신(불필요)
    - op_type='05'(인증서 본인확인기관)인 경우 도메인명을 사용하지 않는 경우 미회신(불필요) (일부 인증서 본인확인기관의 경우 도메인명 제공)
    --domain_ip_cnt API서버 공인IP 목록수 N N(3) API서버 공인IP 목록 수
    - API서버 도메인명만 제공 시 아웃바운드 방화벽 정책 설정(API 요청자)의 어려움 등 존재하여 공인IP도 함께 제공
    - 일부 기관의 경우 동일 API서버 도메인명에 대해 복수 개의 공인IP를 사용(예: 멀티IDC 기반 Global load balancer 도입 등)하고 있어 List로 회신
    - op_type='D'인 경우 미회신
    - org_type=’02‘(중계기관 이용기관)인 경우 미회신(불필요)
    --domain_ip_list API서버 공인IP 목록 N Object - op_type='D'인 경우 미회신
    - org_type=’02‘(중계기관 이용기관)인 경우 미회신(불필요)
    ----domain_ip API서버 공인IP N aNS(21) API 서버의 공인IP 주소
    - PORT가 필요한 경우 IP와 PORT간 구분자는 콜론(:)을 사용
    - op_type='D'인 경우 미회신
    - org_type='02'(중계기관 이용기관)인 경우 미회신(불필요)
    - org_type='05'(인증서 본인확인기관)인 경우 PORT 필수 제공
    --relay_org_code 중계기관/거점중계기관 기관코드 N aN(10) 중계기관/거점중계기관 기관코드
    - 중계기관 이용기관(org_type=’02’)의 경우, 해당 기관이 이용 중인 중계기관(거점중계기관과 동일) 기관코드를 회신
    - API 자체구축 정보제공자(org_type=’01’)의 경우, 해당 기관이 이용 중인 거점중계기관 기관코드를 회신
    --industry 업권 N a(10) 정보제공자의 업권 정보
    - op_type='D'인 경우 미회신
    - 정보제공자(org_type='01' 또는 '02')인 경우만 회신
    - <코드값>
    'bank' : 은행
    'card' : 카드
    'invest' : 금융투자
    'insu' : 보험
    'efin' : 전자금융
    'capital' : 할부금융
    'ginsu' : 보증보험
    'telecom' : 통신
    'p2p' : P2P
    'bond' : 인수채권
    'usury' : 대부
    --auth_type 제공 인증방식 N aN(2) 정보제공자가 제공하는 인증방식(개별인증/통합인증) 종류
    - op_type='D'인 경우 미회신
    - 정보제공자(org_type='01' 또는 '02')인 경우만 회신
    - <코드값>
    '01' : 통합인증만 제공
    '03' : 개별인증/통합인증 모두 제공
    --cert_issuer_dn 통합인증기관의 DN 값(인증서 본인확인기관 DN의 o 값) N aNS(15) 통합인증기관의 DN 값([별첨] 금융분야 마이데이터 통합인 절차 및 규격 참조)
    - op_type='05'(인증서 본인확인기관)인 경우만 회신
    - op_type='D'인 경우 미회신
    --cert_oid 허용 통합인증서 OID N aNS(300) 허용 통합인증서 OID (별첨1 참조)
    - op_type='05'(인증서 본인확인기관)인 경우만 회신
    - 허용 인증서 OID가 다수일 경우에는 구분자('_')로 구분하여 제공
    - op_type='D'인 경우 미회신
    --ip_cnt IP 목록수 N N(3) 해당기관이 API 요청자인 경우, API 제공자(서버)인 상대기관이 방화벽 등으로 접근을 허용(화이트리스트)해야 하는 API 요청자의 IP목록
    <예시>
    - 마이데이터사업자의 IP목록 : 정보제공자(API 자체구축), 중계기관, 종합포털의 방화벽 오픈
    - 정보제공자(API 차제구축) 및 중계기관의 IP목록 : 통합인증기관, 종합포털의 방화벽 오픈
    - 중계기관의 IP목록 : 통합인증기관, 종합포털 필요시 정보제공자(중계기관 이용)의 방화벽 오픈 등
    - 통합인증기관의 IP 목록 : 종합포털의 방화벽 오픈 등
    - op_type='D'인 경우 미회신
    --ip_list IP목록 Y Object - op_type='D'인 경우 미회신
    ----ip IP N aNS(15) 해당기관의 IP 주소
    - op_type='D'인 경우 미회신
    --np_time_cnt 정기적 전송가능 시간대 목록수 N N(3) 정보제공자가 정기적 전송을 허용하는 Non-Peak 시간대 목록 수 (최대 3개까지 등록 허용, 시간대 합산하여 6시간 이상 필수)
    - op_type='D'인 경우 미회신
    - 정보제공자(org_type='01' 또는 '02')인 경우만 회신
    --np_time_list 정기적 전송가능 시간대 목록 Y Object - op_type='D'인 경우 미회신
    - 정보제공자(org_type='01' 또는 '02')인 경우만 회신
    ----np_time 정기적 전송가능 시간 N NS(9) 정기적 전송가능 시간 (30분 단위 등록 가능)
    - 규격 : 'hhmm:hhmm'
    <예시>
    0030:0530 (0시30분 ~ 5시30분)
    2230:2300 (22시30분 ~ 23시00분)
    - op_type='D'인 경우 미회신
    - 정보제공자(org_type='01' 또는 '02')인 경우만 회신

  • 서비스정보 조회 v1 2021-10-18

    기본 정보
    API ID 지원-003 HTTP Method GET
    API 제공자 종합포털 API 요청자 정보제공자
    API 명 (URI) /v1/mgmts/services
    설명 정보제공자가 타기관(마이데이터사업자)의 서비스정보를 종합포털로부터 제공받기 위한 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) 거래고유번호
    Parameter 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 처리 시점의 현재시각을 설정하여 회신
    - 2.1-[2] 참조
    org_cnt 기관목록수 Y N(5)
    org_list 기관목록 Y Object
    --org_code 기관코드 Y aN(10) 마이데이터사업자 기관코드
    --service_cnt 서비스목록수 Y N(3)
    --service_list 서비스목록 Y Object
    ----service_name 서비스명 Y AH(30) 서비스명
    ----op_type 서비스정보의 신규/수정/삭제 구분 Y A(1) 해당 서비스정보가 신규/수정/삭제인지를 구분자로 전송
    - 수정내역이 없는 서비스정보는 회신하지 않음
    - <코드값>
    'I' : 신규
    'M' : 수정
    'D' : 삭제
    ----client_id 클라이언트 ID Y aN(50) 종합포털에 마이데이터 서비스 등록 시 발급 받은 클라이언트 식별값
    ----client_secret 클라이언트 Secret N aN(50) 종합포털에 마이데이터 서비스 등록 시 발급 받은 클라이언트 Secret 값
    - op_type'D'인 경우 미회신
    ----redirect_uri_cnt Callback URL 개수 N N(1) 마이데이터 서비스 Callback URL 개수(4개 까지 등록 허용)
    - op_type='D'인 경우 미회신
    ----redirect_uri_list Callback URL 목록 N Object - op_type='D'인 경우 미회신
    ------redirect_url Callback URL N aNS(100) 마이테이터 서비스 Callback URL
    - op_type='D'인 경우 미회신
    ----app_scheme_cnt 앱 URL 스킴 목록수 N N(1) 마이데이터 서비스 앱 스킴 개수
    - 정보제공자가 앱방식 개별인증 제공 시, 인증완료 후 다시 마이데이터서비스 앱으로 전화하기 위해 필요
    - op_type='D'인 경우 미회신
    ----app_scheme_list 앱 URL 스킴 목록 N Object - op_type='D'인 경우 미회신
    ------app_scheme 앱 URL 스킴 N aNS(100) 마이데이터 서비스 앱 스킴
    - op_type='D'인 경우 미회신

  • 서비스정보 조회 v2 2022-10-19

    기본 정보
    API ID 지원-003 HTTP Method GET
    API 제공자 종합포털 API 요청자 정보제공자
    API 명 (URI) /v2/mgmts/services
    설명 정보제공자가 타기관(마이데이터사업자)의 서비스정보를 종합포털로부터 제공받기 위한 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) 거래고유번호
    Parameter 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 처리 시점의 현재시각을 설정하여 회신
    - 2.1-[2] 참조
    org_cnt 기관목록수 Y N(5)
    org_list 기관목록 Y Object
    --org_code 기관코드 Y aN(10) 마이데이터사업자 기관코드
    --service_cnt 서비스목록수 Y N(3)
    --service_list 서비스목록 Y Object
    ----service_name 서비스명 Y AH(30) 서비스명
    ----op_type 서비스정보의 신규/수정/삭제 구분 Y A(1) 해당 서비스정보가 신규/수정/삭제인지를 구분자로 전송
    - 수정내역이 없는 서비스정보는 회신하지 않음
    - <코드값>
    'I' : 신규
    'M' : 수정
    'D' : 삭제
    ----client_id 클라이언트 ID Y aN(50) 종합포털에 마이데이터 서비스 등록 시 발급 받은 클라이언트 식별값
    ----client_secret 클라이언트 Secret N aN(50) 종합포털에 마이데이터 서비스 등록 시 발급 받은 클라이언트 Secret 값
    - op_type'D'인 경우 미회신
    ----redirect_uri_cnt Callback URL 개수 N N(1) 마이데이터 서비스 Callback URL 개수(4개 까지 등록 허용)
    - op_type='D'인 경우 미회신
    ----redirect_uri_list Callback URL 목록 N Object - op_type='D'인 경우 미회신
    ------redirect_url Callback URL N aNS(100) 마이테이터 서비스 Callback URL
    - op_type='D'인 경우 미회신
    ----app_scheme_cnt 앱 URL 스킴 목록수 N N(1) 마이데이터 서비스 앱 스킴 개수
    - 정보제공자가 앱방식 개별인증 제공 시, 인증완료 후 다시 마이데이터서비스 앱으로 전화하기 위해 필요
    - op_type='D'인 경우 미회신
    ----app_scheme_list 앱 URL 스킴 목록 N Object - op_type='D'인 경우 미회신
    ------app_scheme 앱 URL 스킴 N aNS(100) 마이데이터 서비스 앱 스킴
    - op_type='D'인 경우 미회신

  • 마이데이터사업자/정보수신자 통계자료 전송 v2 2022-10-19

    기본 정보
    API ID 지원-004 HTTP Method POST
    API 제공자 종합포털 API 요청자 마이데이터사업자
    API 명 (URI) /v2/mgmts/statistics/mydata
    설명 마이데이터사업자 또는 정보수신자는 통계자료를 종합포털에 주 단위 집중
    - 기준일자는 일요일로 한정하며 전주 일요일 ~ 토요일 데이터를 일요일에 전송함
    - (예시) 9.12(일).에 통계자료 전송 시 9.5(일)., 9.6(월)., 9.7(화)., 9.8(수)., 9.9(목)., 9.10(금)., 9.11(토). 자의 일별 데이터를 전송
    - 집중항목 : API 송·수신 기관코드, 자격증명(Client ID), 생년, 성별, 전송 API 종류, 전송시간, 전송성공여부, 응답시간, 실패사유 등

    - 마이데이터사업자 또는 정보수신자는 목록 전송, 정기적 전송, 비정기적 전송을 구분(type parameter)하여 API 통계자료를 전송
    ※ '목록 전송' 전송 시 1차 통합인증을 완료하고 발급받은 접근토큰(유효기간7일)으로 알고하는 동의 '가입상품 목록 전송요구서'를 작성하여 본인의 가입상품 목록조회를 요구하기 위해 호출하는 업권별 가입상품 목록조회 API만을 대상으로 API 통계자료를 전송
    - '목록 전송' 전송시 포함되야 하는 업권별 가입상품 목록조회 API는 '2.2 인증 규격-[3] 권한(scope)-자산목록 scope'에 기술된 업권별 자산목록 scope 중 '전송요구 내역 조회(정보제공-공통-002 API)'를 제외한 모든 API
    - 즉, 주 단위로 총 3회의 API 호출 필요(정기적 전송 관련 통계자료 전송(type='1'), 비정기적 전송 관련 통계자료 전송(type='2'), 목록 전송 관련 통계자료 전송(type='3'))
    - 마이데이터사업자가 복수의 마이데이터서비스를 운영할 경우 해당 마이데이터서비스 별로 복수 번 API 통계자료를 전송 (즉, 매 주 서비스앱별 세 번씩 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) 거래고유번호
    Body type 통계정보구분 Y N(1) 1 : 정기적 전송
    2 : 비정기적 전송(정보주체 개입)
    3 : 목록 전송
    client_id 클라이언트 ID Y aN(50) 해당 마이데이터사업자 또는 정보수신자의 클라이언트 ID (종합포털로부터 발급받은 클라이언트 식별값)
    - 마이데이터사업자 : 종합포털에 등록한 서비스가 복수개인 경우, 서비스 개수만큼 본 API를 호출
    inquiry_date 전송 기준일자 Y DATE 통계자료를 전송할 기준일자
    - 본 기준일자를 기준으로 직전7일에 대한 통계자료 전송
    - 기준일자는 일요일로 한정
    stat_date_cnt 통계일자수 Y N(1) '7' 고정값
    (전송 기준일자(inquiry_date) 기준 직전 7일)
    stat_date_list 통계일자별 통계정보 목록 Y Object
    --stat_date 통계일자 Y DATE 통계자료의 해당 일자
    --svr_usr_cnt 마이데이터 서비스 가입자 수 Y N(10) 마이데이터서비스 가입 동의여부를 기준으로 해당 통계일자에 서비스 가입동의서가 유효한 가입자수
    --trsms_dem_cnt 전송요구 완료자 수 Y N(10) 마이데이터 서비스 가입자수 중 1개 이상 기관에 전송 요구하여 자산 연결을 완료한 가입자 수
    ※ 연결 해지시 차감, 중복 전송요구 미포함
    예) 가입자가 A은행을 5월에 전송요구완료하고 철회했다가, 9월에 다시 전송요구를 완료하는 경우는 2명이 아닌 1명으로 집계
    --org_cnt 정보제공자수 Y N(4)
    --org_list 정보제공자 별 통계정보 목록 Y Object
    ----org_code 정보제공자 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    ----consent_new 신규 또는 변경 전송요구 수 N N(10) 통계일자에 정보주체가 전송요구(신규)하거나 전송요구 변경한 수
    - type이 ‘1’(정기적 전송), ‘3’(목록 전송), 인 경우 미전송
    - 정보주체가 개별인증 또는 통합인증을 통해 전송요구권(신규 또는 변경)을 행사한 횟수를 의미
    ----consent_revoke 철회된 전송요구 수 N N(10) 통계일자에 철회된 전송요구 수
    - type이 ‘1’(정기적 전송), ‘3’(목록 전송),인 경우 미전송
    - 정보주체가 직접 전송요구 철회를 행사(개별인증-004 API 호출)한 횟수를 의미
    ----consent_own 최종 유효한 전송요구 수 N N(10) 통계일자에 최종 유효한 전송요구 수
    - type이 ‘1’(정기적 전송), ‘3’(목록 전송),인 경우 미전송
    ----api_type_cnt API 구분 수 Y N(3) API 구분 수
    ----api_type_list API 구분 별 통계정보 목록 Y Object
    ------api_type API 구분 코드 Y aN(4) API 구분 코드
    - [첨부12] API 구분코드
    ------tm_slot_cnt 통계시점 시간대역 수 Y N(2) 통계시청 시간대역 ('2' 고정값)
    ------tm_slot_list 시간대별 통계정보 목록 Y Object
    --------tm_slot 통계시점 시간대역 Y aN(2) 총 2개 시간대역
    - [첨부11] 참조
    --------rsp_avg 응답시간 (평균값) Y N(6) 해당 시간대역 응답시간 평균값 (단위:ms)
    --------rsp_total 응답시간 (합계) Y N(15) 해당 시간대역 응답시간 합계 (단위:ms)
    --------rsp_stdev 응답시간 (표준편차) Y N(6) 해당 시간대역 응답시간 표준편차 (단위:ms)
    --------success_api_cnt 성공한 API 호출 횟수 Y N(10) 성공한 API 호출 횟수
    --------fail_api_cnt 실패한 API 호출 횟수 Y N(10) 실패한 API 호출 횟수
    --------err_code_1_400_invalid_request 에러코드별 API 호출 횟수(1-400-invalid_request) N N(10) [첨부1]-1.인가코드발급-(1) 요청메세지 내 client_id 또는 redirect_uri가 유효하지 않은 경우 등
    HTTP응답코드:400-에러코드:invalid_request의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------err_code_1_405_method_not_allowed 에러코드별 API 호출 횟수(1-405-method_not_allowed) N N(10) [첨부1]-1.인가코드발급-(1) 요청메세지 내 client_id 또는 redirect_uri가 유효하지 않은 경우 등
    HTTP응답코드:405-에러코드:method_not_allowed의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------err_code_1_302_invalid_request 에러코드별 API 호출 횟수(1-302-invalid_request) N N(10) [첨부1]-1.인가코드발급-(1) 요청메세지 내 client_id 또는 redirect_uri가 유효하지 않은 경우 등
    HTTP응답코드:302-에러코드:invalid_request의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------err_code_1_302_unauthorized_client 에러코드별 API 호출 횟수(1-302-unauthorized_client) N N(10) [첨부1]-1.인가코드발급-(1) 요청메세지 내 client_id 또는 redirect_uri가 유효하지 않은 경우 등
    HTTP응답코드:302-에러코드:unauthorized_client의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------err_code_1_302_access_denied 에러코드별 API 호출 횟수(1-302-access_denied) N N(10) [첨부1]-1.인가코드발급-(1) 요청메세지 내 client_id 또는 redirect_uri가 유효하지 않은 경우 등
    HTTP응답코드:302-에러코드:access_denied의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------err_code_1_302_unsupported_response_type 에러코드별 API 호출 횟수(1-302-unsupported_response_type) N N(10) [첨부1]-1.인가코드발급-(2) 그 외 (Callback URL로 리다이렉트)-
    HTTP응답코드:302-에러코드:unsupported_response_type의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------err_code_1_302_server_error 에러코드별 API 호출 횟수(1-302-server_error) N N(10) [첨부1]-1.인가코드발급-(2) 그 외 (Callback URL로 리다이렉트)-
    HTTP응답코드:302-에러코드:server_error의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------err_code_1_302_temporarily_unavailable 에러코드별 API 호출 횟수(1-302-temporarily_unavailable) N N(10) [첨부1]-1.인가코드발급-(2) 그 외 (Callback URL로 리다이렉트)-
    HTTP응답코드:302-에러코드:temporarily_unavailable의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------err_code_1_302_unauthorized_user 에러코드별 API 호출 횟수(1-302-unauthorized_user) N N(10) [첨부1]-1.인가코드발급-(2) 그 외 (Callback URL로 리다이렉트)-
    HTTP응답코드:302-에러코드:unauthorized_user의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------err_code_2_400_invalid_request 에러코드별 API 호출 횟수(2-400-invalid_request) N N(10) [첨부1]-2.접근토큰 발급/갱신/폐기--
    HTTP응답코드:400-에러코드:invalid_request의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------err_code_2_400_invalid_client 에러코드별 API 호출 횟수(2-400-invalid_client) N N(10) [첨부1]-2.접근토큰 발급/갱신/폐기--
    HTTP응답코드:400-에러코드:invalid_client의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------err_code_2_400_invalid_grant 에러코드별 API 호출 횟수(2-400-invalid_grant) N N(10) [첨부1]-2.접근토큰 발급/갱신/폐기--
    HTTP응답코드:400-에러코드:invalid_grant의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------err_code_2_400_unauthorized_client 에러코드별 API 호출 횟수(2-400_unauthorized_client) N N(10) [첨부1]-2.접근토큰 발급/갱신/폐기--
    HTTP응답코드:400_unauthorized_client의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------err_code_2_400_unsupported_grant_type 에러코드별 API 호출 횟수(2-400_unsupported_grant_type) N N(10) [첨부1]-2.접근토큰 발급/갱신/폐기--
    HTTP응답코드:400_unsupported_grant_type
    ※ 값이 0일 경우 미전송 가능
    --------err_code_2_400_invalid_scope 에러코드별 API 호출 횟수(2_400_invalid_scope) N N(10) [첨부1]-2.접근토큰 발급/갱신/폐기--
    HTTP응답코드:400-에러코드:invalid_scope의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------err_code_2_400_unauthorized_user 에러코드별 API 호출 횟수(2-400_unauthorized_user) N N(10) [첨부1]-2.접근토큰 발급/갱신/폐기--
    HTTP응답코드:400-에러코드:unauthorized_user의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------err_code_2_405_method_not_allowed 에러코드별 API 호출 횟수(2-405_method_not_allowed) N N(10) [첨부1]-2.접근토큰 발급/갱신/폐기--
    HTTP응답코드:405-에러코드:method_not_allowed의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------err_code_2_500_server_error 에러코드별 API 호출 횟수(2_500_server_error) N N(10) [첨부1]-2.접근토큰 발급/갱신/폐기--
    HTTP응답코드:500-에러코드:server-error의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------err_code_2_503_temporarily_unavailable 에러코드별 API 호출 횟수(2-503_temporarily_unavailable) N N(10) [첨부1]-2.접근토큰 발급/갱신/폐기--
    HTTP응답코드:503-에러코드:temporarily_unavailable의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------err_code_3_200_00000 에러코드별 API 호출 횟수(3_200_00000 N N(10) [첨부1]-3.그 외 API-HTTP응답코드:200-에러코드:00000의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------err_code_3_200_00001 에러코드별 API 호출 횟수(3_200_00001) N N(10) [첨부1]-3.그 외 API-HTTP응답코드:200-에러코드:00001의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------err_code_3_400_40001 에러코드별 API 호출 횟수(3_400_40001) N N(10) [첨부1]-3.그 외 API-HTTP응답코드:400-에러코드:40001의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------err_code_3_400_40002 에러코드별 API 호출 횟수(3_400_40002) N N(10) [첨부1]-3.그 외 API-HTTP응답코드:400-에러코드:40002의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------err_code_3_400_40003 에러코드별 API 호출 횟수(3_400_40003) N N(10) [첨부1]-3.그 외 API-HTTP응답코드:400-에러코드:40003의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------err_code_3_400_40004 에러코드별 API 호출 횟수(3_400_40004) N N(10) [첨부1]-3.그 외 API-HTTP응답코드:400-에러코드:40004의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------err_code_3_401_40101 에러코드별 API 호출 횟수(3_401_40101) N N(10) [첨부1]-3.그 외 API-HTTP응답코드:401-에러코드:40101의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------err_code_3_401_40102 에러코드별 API 호출 횟수(3_401_40102) N N(10) [첨부1]-3.그 외 API-HTTP응답코드:401-에러코드:40102의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------err_code_3_401_40103 에러코드별 API 호출 횟수(3_401_40103) N N(10) [첨부1]-3.그 외 API-HTTP응답코드:401-에러코드:40103의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------err_code_3_401_40104 에러코드별 API 호출 횟수(3_401_40104) N N(10) [첨부1]-3.그 외 API-HTTP응답코드:401-에러코드:40104의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------err_code_3_401_40105 에러코드별 API 호출 횟수(3_401_40105) N N(10) [첨부1]-3.그 외 API-HTTP응답코드:401-에러코드:40105의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------err_code_3_401_40106 에러코드별 API 호출 횟수(3_401_40106) N N(10) [첨부1]-3.그 외 API-HTTP응답코드:401-에러코드:40106의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------err_code_3_403_40301 에러코드별 API 호출 횟수(3_403_40301) N N(10) [첨부1]-3.그 외 API-HTTP응답코드:403-에러코드:40301의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------err_code_3_403_40302 에러코드별 API 호출 횟수(3_403_40302) N N(10) [첨부1]-3.그 외 API-HTTP응답코드:403-에러코드:40302의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------err_code_3_403_40303 에러코드별 API 호출 횟수(3_403_40303) N N(10) [첨부1]-3.그 외 API-HTTP응답코드:403-에러코드:40303의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------err_code_3_403_40304 에러코드별 API 호출 횟수(3_403_40304) N N(10) [첨부1]-3.그 외 API-HTTP응답코드:403-에러코드:40304의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------err_code_3_403_40305 에러코드별 API 호출 횟수(3_403_40305) N N(10) [첨부1]-3.그 외 API-HTTP응답코드:403-에러코드:40305의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------err_code_3_404_40401 에러코드별 API 호출 횟수(3_404_40401) N N(10) [첨부1]-3.그 외 API-HTTP응답코드:404-에러코드:40401의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------err_code_3_404_40402 에러코드별 API 호출 횟수(3_404_40402) N N(10) [첨부1]-3.그 외 API-HTTP응답코드:404-에러코드:40402의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------err_code_3_404_40403 에러코드별 API 호출 횟수(3_404_40403) N N(10) [첨부1]-3.그 외 API-HTTP응답코드:404-에러코드:40403의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------err_code_3_405_40501 에러코드별 API 호출 횟수(3_405_40501) N N(10) [첨부1]-3.그 외 API-HTTP응답코드:405-에러코드:40501의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------err_code_3_429_42901 에러코드별 API 호출 횟수(3_429_42901) N N(10) [첨부1]-3.그 외 API-HTTP응답코드:429-에러코드:42901의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------err_code_3_500_50001 에러코드별 API 호출 횟수(3_500_50001) N N(10) [첨부1]-3.그 외 API-HTTP응답코드:500-에러코드:50001의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------err_code_3_500_50002 에러코드별 API 호출 횟수(3_500_50002) N N(10) [첨부1]-3.그 외 API-HTTP응답코드:500-에러코드:50002의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------err_code_3_500_50003 에러코드별 API 호출 횟수(3_500_50003) N N(10) [첨부1]-3.그 외 API-HTTP응답코드:500-에러코드:50003의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------err_code_3_500_50004 에러코드별 API 호출 횟수(3_500_50004) N N(10) [첨부1]-3.그 외 API-HTTP응답코드:500-에러코드:50004의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------err_code_3_500_50005 에러코드별 API 호출 횟수(3_500_50005) N N(10) [첨부1]-3.그 외 API-HTTP응답코드:500-에러코드:50005의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------err_code_3_500_50006 에러코드별 API 호출 횟수(3_500_50006) N N(10) [첨부1]-3.그 외 API-HTTP응답코드:500-에러코드:50006의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------err_code_3_500_50007 에러코드별 API 호출 횟수(3_500_50007) N N(10) [첨부1]-3.그 외 API-HTTP응답코드:500-에러코드:50007의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------err_code_3_500_50008 에러코드별 API 호출 횟수(3_500_50008) N N(10) [첨부1]-3.그 외 API-HTTP응답코드:500-에러코드:50008의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------err_code_3_500_50009 에러코드별 API 호출 횟수(3_500_50009) N N(10) [첨부1]-3.그 외 API-HTTP응답코드:500-에러코드:50009의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)

  • 마이데이터사업자/정보수신자 통계자료 전송 v1 2021-10-18

    기본 정보
    API ID 지원-004 HTTP Method POST
    API 제공자 종합포털 API 요청자 마이데이터사업자
    API 명 (URI) /v1/mgmts/statistics/mydata
    설명 마이데이터사업자 또는 정보수신자는 통계자료를 종합포털에 주 단위 집중
    - 기준일자는 일요일로 한정하며 전주 일요일 ~ 토요일 데이터를 일요일에 전송함
    - (예시) 9.12(일).에 통계자료 전송 시 9.5(일)., 9.6(월)., 9.7(화)., 9.8(수)., 9.9(목)., 9.10(금)., 9.11(토). 자의 일별 데이터를 전송
    - 집중항목 : API 송·수신 기관코드, 자격증명(Client ID), 생년, 성별, 전송 API 종류, 전송시간, 전송성공여부, 응답시간, 실패사유 등

    마이데이터사업자 또는 정보수신자는 정기적 전송과 비정기적 전송을 구분(type parameter)하여 API 통계자료를 전송
    - 마이데이터사업자가 복수의 마이데이터서비스를 운영할 경우 해당 마이데이터서비스 별로 복수 번 API 통계자료를 전송 (즉, 매 주 서비스앱별 두 번씩 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) 거래고유번호
    Body type 통계정보구분 Y N(1) 1 : 정기적 전송
    2 : 비정기적 전송(정보주체 개입)
    client_id 클라이언트 ID Y aN(50) 해당 마이데이터사업자 또는 정보수신자의 클라이언트 ID (종합포털로부터 발급받은 클라이언트 식별값)
    - 마이데이터사업자 : 종합포털에 등록한 서비스가 복수개인 경우, 서비스 개수만큼 본 API를 호출
    inquiry_date 전송 기준일자 Y DATE 통계자료를 전송할 기준일자
    - 본 기준일자를 기준으로 직전7일에 대한 통계자료 전송
    - 기준일자는 일요일로 한정
    stat_date_cnt 통계일자수 Y N(1) '7' 고정값
    (전송 기준일자(inquiry_date) 기준 직전 7일)
    stat_date_list 통계일자별 통계정보 목록 Y Object
    --stat_date 통계일자 Y DATE 통계자료의 해당 일자
    --org_cnt 정보제공자수 Y N(4)
    --org_list 정보제공자 별 통계정보 목록 Y Object
    ----org_code 정보제공자 기관코드 Y aN(10) 정보제공자 기관코드
    - 지원 API로부터 배포
    ----consent_new 신규 또는 변경 전송요구 수 N N(10) 통계일자에 정보주체가 전송요구(신규)하거나 전송요구 변경한 수
    - type이 ‘1’(정기적 전송)인 경우 미회신
    - 정보주체가 개별인증 또는 통합인증을 통해 전송요구권(신규 또는 변경)을 행사한 횟수를 의미
    ----consent_revoke 철회된 전송요구 수 N N(10) 통계일자에 철회된 전송요구 수
    - type이 ‘1’(정기적 전송)인 경우 미회신
    - 정보주체가 직접 전송요구 철회를 행사(개별인증-004 API 호출)한 횟수를 의미
    ----consent_own 최종 유효한 전송요구 수 N N(10) 통계일자에 최종 유효한 전송요구 수
    - type이 ‘1’(정기적 전송)인 경우 미회신
    ----api_type_cnt API 구분 수 Y N(3) API 구분 수
    ----api_type_list API 구분 별 통계정보 목록 Y Object
    ------api_type API 구분 코드 Y aN(4) API 구분 코드
    - [첨부12] API 구분코드
    ------tm_slot_cnt 통계시점 시간대역 수 Y N(2) 통계시청 시간대역 ('2' 고정값)
    ------tm_slot_list 시간대별 통계정보 목록 Y Object
    --------tm_slot 통계시점 시간대역 Y aN(2) 총 2개 시간대역
    - [첨부11] 참조
    --------rsp_avg 응답시간 (평균값) Y N(6) 해당 시간대역 응답시간 평균값 (단위:ms)
    --------rsp_total 응답시간 (합계) Y N(15) 해당 시간대역 응답시간 합계 (단위:ms)
    --------rsp_stdev 응답시간 (표준편차) Y N(6) 해당 시간대역 응답시간 표준편차 (단위:ms)
    --------success_api_cnt 성공한 API 호출 횟수 Y N(10) 성공한 API 호출 횟수
    --------fail_api_cnt 실패한 API 호출 횟수 Y N(10) 실패한 API 호출 횟수
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)

  • 정보제공자 통계자료 전송 v1 2021-10-18

    기본 정보
    API ID 지원-005 HTTP Method POST
    API 제공자 종합포털 API 요청자 정보제공자
    API 명 (URI) /v1/mgmts/statistics/provider
    설명 정보제공자는 통계자료를 종합포털에 주 단위 집중
    - 기준일자는 일요일로 한정하며 전주 일요일 ~ 토요일 데이터를 월요일에 전송함 (부하를 줄이기 위해 지원-004와 다르게 월요일에 전송)
    - (예시) 9.13(월).에 통계자료 전송 시 9.12(일).을 기준일자로 9.5(일)., 9.6(월)., 9.7(화)., 9.8(수)., 9.9(목)., 9.10(금)., 9.11(토). 자의 일별 데이터를 전송

    정보제공자는 정기적 전송과 비정기적 전송을 구분(type parameter)하여 API 통계자료를 전송
    - 즉, 주 단위로 총 2회의 API 호출 필요(정기적 전송 관련 통계자료 전송(type=“1”), 비정기적 전송 관련 통계자료 전송(type=“2”))

    중계기관은 중계기관을 이용하는 정보제공자 별로 본 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) 거래고유번호
    Body org_code 정보제공자기관코드 N aN(10) 통계자료 대상 정보제공자 기관코드
    - API 요청자가 중계기관인 경우만 설정 (중계기관 이용기관 중 어느 기관의 통계자료를 송신하는지를 명시하기 위한 목적)
    - API자체구축 정보제공자는 해당사항 없음
    - 지원 API로부터 배포
    type 통계정보구분 Y N(1) 1 : 정기적 전송
    2 : 비정기적 전송(정보주체 개입)
    inquiry_date 전송 기준일자 Y DATE 통계자료를 전송할 기준일자
    - 본 기준일자를 기준으로 직전7일에 대한 통계자료 전송
    - 기준일자는 일요일로 한정
    stat_date_cnt 통계일자수 Y N(1) '7' 고정값
    (전송 기준일자(inquiry_date) 기준 직전 7일)
    stat_date_list 통계일자별 통계정보 목록 Y Object
    --stat_date 통계일자 Y DATE 통계자료의 해당 일자
    --mydata_svc_cnt 마이데이터 서비스/정보수신자 수 Y N(3) 마이데이터서비스, 정보수신자 및 종합포털(PDS)에 대한 통계정보를 모두 회신
    --mydata_svc_list 마이데이터 서비스/정보수신자 별 통계정보 목록 Y Object 동일 마이데이터사업자의 서비스가 복수 개인 경우, 서비스 개수만큼 List에 포함
    ----org_code 기관코드 Y aN(10) 마이테이터사업자/정보수신자/종합포털 기관코드
    - 지원 API로부터 배포
    ----client_id 클라이언트 ID Y aN(50) 해당 마이데이터사업자/정보수신자의 클라이언트 ID (종합포털로부터 발급받은 클라이언트 식별값)
    ----consent_new 신규 또는 변경 전송요구 수 N N(10) 통계일자에 정보주체가 전송요구(신규)하거나 전송요구 변경한 수
    - type이 ‘1’(정기적 전송)인 경우 미회신
    - 정보주체가 개별인증 또는 통합인증을 통해 전송요구권(신규 또는 변경)을 행사한 횟수를 의미
    ----consent_revoke 철회된 전송요구 수 N N(10) 통계일자에 철회된 전송요구 수
    - type이 ‘1’(정기적 전송)인 경우 미회신
    - 정보주체가 직접 전송요구 철회를 행사(개별인증-004 API 호출)한 횟수를 의미
    ----consent_own 최종 유효한 전송요구 수 N N(10) 통계일자에 최종 유효한 전송요구 수
    - type이 ‘1’(정기적 전송)인 경우 미회신
    ----api_type_cnt API 구분 수 Y N(3) API 구분 수
    ----api_type_list API 구분 별 통계정보 목록 Y Object
    ------api_type API 구분 코드 Y aN(4) API 구분 코드
    - [별첨12] API 구분코드
    ------tm_slot_cnt 통계시점 시간대역 수 Y N(2) 통계시점 시간대역 ('2' 고정값)
    ------tm_slot_list 시간대별 통계정보 목록 Y Object
    --------tm_slot 통계시점 시간대역 Y aN(2) 총 2개 시간대역
    - [첨부11] 참조
    --------success_api_cnt 성공한 API 호출 횟수 Y N(10) 성공한 API 호출 횟수
    --------fail_api_cnt 실패한 API 호출 횟수 Y N(10) 실패한 API 호출 횟수
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)

  • 정보제공자 통계자료 전송 v2 2022-10-19

    기본 정보
    API ID 지원-005 HTTP Method POST
    API 제공자 종합포털 API 요청자 정보제공자
    API 명 (URI) /v2/mgmts/statistics/provider
    설명 정보제공자는 통계자료를 종합포털에 주 단위 집중
    - 기준일자는 일요일로 한정하며 전주 일요일 ~ 토요일 데이터를 월요일에 전송함 (부하를 줄이기 위해 지원-004와 다르게 월요일에 전송)
    - (예시) 9.13(월).에 통계자료 전송 시 9.12(일).을 기준일자로 9.5(일)., 9.6(월)., 9.7(화)., 9.8(수)., 9.9(목)., 9.10(금)., 9.11(토). 자의 일별 데이터를 전송

    - 정보제공자는 정기적 전송, 비정기적 전송, 목록 전송을 구분(type parameter)하여 API 통계자료를 전송
    ※ '목록 전송' 전송 시 1차 통합인증을 완료하고 발급받은 접근토큰(유효기간7일)으로 알고하는 동의 '가입상품 목록 전송요구서'를 작성하여 본인의 가입상품 목록조회를 요구하기 위해 호출하는 업권별 가입상품 목록조회 API만을 대상으로 API 통계자료를 전송
    - '목록 전송' 전송시 포함되야 하는 업권별 가입상품 목록조회 API는 '2.2 인증 규격-[3] 권한(scope)-자산목록 scope'에 기술된 업권별 자산목록 scope 중 '전송요구 내역 조회(정보제공-공통-002 API)'를 제외한 모든 API
    - 즉, 주 단위로 총 3회의 API 호출 필요(정기적 전송 관련 통계자료 전송(type='1'), 비정기적 전송 관련 통계자료 전송(type='2'), 목록 전송 관련 통계자료 전송(type='3'))

    중계기관은 중계기관을 이용하는 정보제공자 별로 본 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) 거래고유번호
    Body org_code 정보제공자기관코드 N aN(10) 통계자료 대상 정보제공자 기관코드
    - API 요청자가 중계기관인 경우만 설정 (중계기관 이용기관 중 어느 기관의 통계자료를 송신하는지를 명시하기 위한 목적)
    - API자체구축 정보제공자는 해당사항 없음
    - 지원 API로부터 배포
    type 통계정보구분 Y N(1) 1 : 정기적 전송
    2 : 비정기적 전송(정보주체 개입)
    3 : 목록 전송
    inquiry_date 전송 기준일자 Y DATE 통계자료를 전송할 기준일자
    - 본 기준일자를 기준으로 직전7일에 대한 통계자료 전송
    - 기준일자는 일요일로 한정
    stat_date_cnt 통계일자수 Y N(1) '7' 고정값
    (전송 기준일자(inquiry_date) 기준 직전 7일)
    stat_date_list 통계일자별 통계정보 목록 Y Object
    --stat_date 통계일자 Y DATE 통계자료의 해당 일자
    --mydata_svc_cnt 마이데이터 서비스/정보수신자 수 Y N(3) 마이데이터서비스, 정보수신자 및 종합포털(PDS)에 대한 통계정보를 모두 전송
    --mydata_svc_list 마이데이터 서비스/정보수신자 별 통계정보 목록 Y Object 동일 마이데이터사업자의 서비스가 복수 개인 경우, 서비스 개수만큼 List에 포함
    ----org_code 기관코드 Y aN(10) 마이테이터사업자/정보수신자/종합포털 기관코드
    - 지원 API로부터 배포
    ----client_id 클라이언트 ID Y aN(50) 해당 마이데이터사업자/정보수신자의 클라이언트 ID (종합포털로부터 발급받은 클라이언트 식별값)
    ----consent_new 신규 또는 변경 전송요구 수 N N(10) 통계일자에 정보주체가 전송요구(신규)하거나 전송요구 변경한 수
    - type이 ‘1’(정기적 전송), ‘3’(목록 전송), 인 경우 미전송
    - 정보주체가 개별인증 또는 통합인증을 통해 전송요구권(신규 또는 변경)을 행사한 횟수를 의미
    ----consent_revoke 철회된 전송요구 수 N N(10) 통계일자에 철회된 전송요구 수
    - type이 ‘1’(정기적 전송), ‘3’(목록 전송), 인 경우 미전송
    - 정보주체가 직접 전송요구 철회를 행사(개별인증-004 API 호출)한 횟수를 의미
    ----consent_own 최종 유효한 전송요구 수 N N(10) 통계일자에 최종 유효한 전송요구 수
    - type이 ‘1’(정기적 전송), ‘3’(목록 전송), 인 경우 미전송
    ----api_type_cnt API 구분 수 Y N(3) API 구분 수
    ----api_type_list API 구분 별 통계정보 목록 Y Object
    ------api_type API 구분 코드 Y aN(4) API 구분 코드
    - [별첨12] API 구분코드
    ------tm_slot_cnt 통계시점 시간대역 수 Y N(2) 통계시점 시간대역 ('2' 고정값)
    ------tm_slot_list 시간대별 통계정보 목록 Y Object
    --------tm_slot 통계시점 시간대역 Y aN(2) 총 2개 시간대역
    - [첨부11] 참조
    --------success_api_cnt 성공한 API 호출 횟수 N N(10) 성공한 API 호출 횟수
    --------fail_api_cnt 실패한 API 호출 횟수 N N(10) 실패한 API 호출 횟수
    --------err_code_1_400_invalid_request 에러코드별 API 호출 횟수(1-400-invalid_request) Y N(10) [첨부1]-1.인가코드발급-(1) 요청메세지 내 client_id 또는 redirect_uri가
    유효하지 않은 경우 등-HTTP응답코드:400-에러코드:invalid_request의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------err_code_1_302_method_not_allowed 에러코드별 API 호출 횟수(1-400-invalid_request) Y N(10) [첨부1]-1.인가코드발급-(1) 요청메세지 내 client_id 또는 redirect_uri가
    유효하지 않은 경우 등-HTTP응답코드:405-에러코드:method_not_allowed의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------err_code_1_302_invalid_request 에러코드별 API 호출 횟수(1-302-invalid_request) Y N(10) [첨부1]-1.인가코드발급-(1) 요청메세지 내 client_id 또는 redirect_uri가
    유효하지 않은 경우 등-HTTP응답코드:302-에러코드:invalid_request의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------err_code_1_302_unauthorized_client 에러코드별 API 호출 횟수(1-302-unauthorized_client) Y N(10) [첨부1]-1.인가코드발급-(2) 그 외 (Callback URL로 리다이렉트)
    -HTTP응답코드:302-에러코드:unauthorized_client의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------err_code_1_302_access_denied 에러코드별 API 호출 횟수(1-302_access_denied) Y N(10) [첨부1]-1.인가코드발급-(2) 그 외 (Callback URL로 리다이렉트)
    -HTTP응답코드:302-에러코드:unsupported_response_type의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------err_code_1_302_unsupported_response_type 에러코드별 API 호출 횟수(1-302-unsupported_response_type) Y N(10) [첨부1]-1.인가코드발급-(2) 그 외 (Callback URL로 리다이렉트)
    -HTTP응답코드:302-에러코드:unsupported_response_type의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------err_code_1_302_server_error 에러코드별 API 호출 횟수(1-302_server_error) Y N(10) [첨부1]-1.인가코드발급-(2) 그 외 (Callback URL로 리다이렉트)
    -HTTP응답코드:302-에러코드:server_error의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------err_code_1_302_temporarily_unavailable 에러코드별 API 호출 횟수(1-302_temporarily_unavailable) Y N(10) [첨부1]-1.인가코드발급-(2) 그 외 (Callback URL로 리다이렉트)
    -HTTP응답코드:302-에러코드:temporarily_unavailable의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------err_code_1_302_unauthorized_user 에러코드별 API 호출 횟수(1-302_unauthorized_user) Y N(10) [첨부1]-1.인가코드발급-(2) 그 외 (Callback URL로 리다이렉트)
    -HTTP응답코드:302-에러코드:unauthorized_user의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------err_code_2_400_invalid_request 에러코드별 API 호출 횟수(2-400_invalid_request) Y N(10) [첨부1]-2.접근토크 발급/갱신/폐기--
    HTTP응답코드:400-에러코드:invalid_request의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------err_code_2_400_invalid_client 에러코드별 API 호출 횟수(2-400_invalid_client) Y N(10) [첨부1]-2.접근토크 발급/갱신/폐기--
    HTTP응답코드:400-에러코드:invalid_client의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------err_code_2_400_invalid_grant 에러코드별 API 호출 횟수(2-400_invalid_grant) Y N(10) [첨부1]-2.접근토크 발급/갱신/폐기--
    HTTP응답코드:400-에러코드:invalid_grant의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------err_code_2_400_unauthorized_client 에러코드별 API 호출 횟수(2-400_unauthorized_client) Y N(10) [첨부1]-2.접근토크 발급/갱신/폐기--
    HTTP응답코드:400-에러코드:unauthorized_client의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------err_code_2_400_unsupported_grant_type 에러코드별 API 호출 횟수(2-400_invalid_grant) Y N(10) [첨부1]-2.접근토크 발급/갱신/폐기--
    HTTP응답코드:400-에러코드:unsupported_grant_type의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------err_code_2_400_invalid_scope 에러코드별 API 호출 횟수(2-400_invalid_scope) Y N(10) [첨부1]-2.접근토크 발급/갱신/폐기--
    HTTP응답코드:400-에러코드:invalid_scope의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------err_code_2_400_unauthorized_user 에러코드별 API 호출 횟수(2-400_unauthorized_user) Y N(10) [첨부1]-2.접근토크 발급/갱신/폐기--
    HTTP응답코드:400-에러코드:unauthorized_user의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------err_code_2_405_method_not_allowed 에러코드별 API 호출 횟수(2-405_method_not_allowed) Y N(10) [첨부1]-2.접근토크 발급/갱신/폐기--
    HTTP응답코드:405-에러코드:method_not_allowed의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------err_code_2_500_server_error 에러코드별 API 호출 횟수(2-500-server_error) Y N(10) [첨부1]-2.접근토크 발급/갱신/폐기--
    HTTP응답코드:500-에러코드:server_error의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------err_code_2_503_temporarily_unavailable 에러코드별 API 호출 횟수(2-503_temporarily_unavailable) Y N(10) [첨부1]-2.접근토크 발급/갱신/폐기--
    HTTP응답코드:405-에러코드:temporarily_unavailable의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------rsp_code_3_200_00000 에러코드별 API 호출 횟수(3-200-00000) Y N(10) [첨부1]-3. 그 외 API--
    HTTP응답코드:200-에러코드:00000의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------rsp_code_3_200_00001 에러코드별 API 호출 횟수(3-200-00001) Y N(10) [첨부1]-3. 그 외 API--
    HTTP응답코드:200-에러코드:00001의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------rsp_code_3_400_40001 에러코드별 API 호출 횟수(3-400-40001) Y N(10) [첨부1]-3. 그 외 API--
    HTTP응답코드:400-에러코드:40001의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------rsp_code_3_400_40002 에러코드별 API 호출 횟수(3-400-40002) Y N(10) [첨부1]-3. 그 외 API--
    HTTP응답코드:400-에러코드:40002의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------rsp_code_3_400_40003 에러코드별 API 호출 횟수(3-400-40003) Y N(10) [첨부1]-3. 그 외 API--
    HTTP응답코드:400-에러코드:40003의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------rsp_code_3_400_40004 에러코드별 API 호출 횟수(3-400-40004) Y N(10) [첨부1]-3. 그 외 API--
    HTTP응답코드:400-에러코드:40004의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------rsp_code_3_401_40101 에러코드별 API 호출 횟수(3-401-40101) Y N(10) [첨부1]-3. 그 외 API--
    HTTP응답코드:401-에러코드:40101의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------rsp_code_3_401_40102 에러코드별 API 호출 횟수(3-401-40102) Y N(10) [첨부1]-3. 그 외 API--
    HTTP응답코드:401-에러코드:40102의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------rsp_code_3_401_40103 에러코드별 API 호출 횟수(3-401-40103) Y N(10) [첨부1]-3. 그 외 API--
    HTTP응답코드:401-에러코드:40103의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------rsp_code_3_401_40104 에러코드별 API 호출 횟수(3-401-40104) Y N(10) [첨부1]-3. 그 외 API--
    HTTP응답코드:401-에러코드:40104의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------rsp_code_3_401_40105 에러코드별 API 호출 횟수(3-401-40105) Y N(10) [첨부1]-3. 그 외 API--
    HTTP응답코드:401-에러코드:40105의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------rsp_code_3_401_40106 에러코드별 API 호출 횟수(3-401-40106) Y N(10) [첨부1]-3. 그 외 API--
    HTTP응답코드:401-에러코드:40106의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------rsp_code_3_403_40301 에러코드별 API 호출 횟수(3-403-40301) Y N(10) [첨부1]-3. 그 외 API--
    HTTP응답코드:403-에러코드:40301의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------rsp_code_3_403_40302 에러코드별 API 호출 횟수(3-403_40302) Y N(10) [첨부1]-3. 그 외 API--
    HTTP응답코드:403-에러코드:40302의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------rsp_code_3_403_40303 에러코드별 API 호출 횟수(3-403_40303) Y N(10) [첨부1]-3. 그 외 API--
    HTTP응답코드:403-에러코드:40303의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------rsp_code_3_403_40304 에러코드별 API 호출 횟수(3-403_40304) Y N(10) [첨부1]-3. 그 외 API--
    HTTP응답코드:403-에러코드:40304의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------rsp_code_3_403_40305 에러코드별 API 호출 횟수(3-403_40305) Y N(10) [첨부1]-3. 그 외 API--
    HTTP응답코드:403-에러코드:40305의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------rsp_code_3_404_40401 에러코드별 API 호출 횟수(3-404_40401) Y N(10) [첨부1]-3. 그 외 API--
    HTTP응답코드:404-에러코드:40401의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------rsp_code_3_404_40402 에러코드별 API 호출 횟수(3-404_40402) Y N(10) [첨부1]-3. 그 외 API--
    HTTP응답코드:404-에러코드:40402의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------rsp_code_3_404_40403 에러코드별 API 호출 횟수(3-404_40403) Y N(10) [첨부1]-3. 그 외 API--
    HTTP응답코드:404-에러코드:40403의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------rsp_code_3_405_40501 에러코드별 API 호출 횟수(3-405_40501) Y N(10) [첨부1]-3. 그 외 API--
    HTTP응답코드:405-에러코드:40501의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------rsp_code_3_429_42901 에러코드별 API 호출 횟수(3-429_42901) Y N(10) [첨부1]-3. 그 외 API--
    HTTP응답코드:429-에러코드:42901의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------rsp_code_3_500_50001 에러코드별 API 호출 횟수(3-500_50001) Y N(10) [첨부1]-3. 그 외 API--
    HTTP응답코드:500-에러코드:50001의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------rsp_code_3_500_50002 에러코드별 API 호출 횟수(3-500_50002) Y N(10) [첨부1]-3. 그 외 API--
    HTTP응답코드:500-에러코드:50002의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------rsp_code_3_500_50003 에러코드별 API 호출 횟수(3-500_50003) Y N(10) [첨부1]-3. 그 외 API--
    HTTP응답코드:500-에러코드:50003의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------rsp_code_3_500_50004 에러코드별 API 호출 횟수(3-500_50004) Y N(10) [첨부1]-3. 그 외 API--
    HTTP응답코드:500-에러코드:50004의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------rsp_code_3_500_50005 에러코드별 API 호출 횟수(3-500_50005) Y N(10) [첨부1]-3. 그 외 API--
    HTTP응답코드:500-에러코드:50005의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------rsp_code_3_500_50006 에러코드별 API 호출 횟수(3-500_50006) Y N(10) [첨부1]-3. 그 외 API--
    HTTP응답코드:500-에러코드:50006의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------rsp_code_3_500_50007 에러코드별 API 호출 횟수(3-500_50007) Y N(10) [첨부1]-3. 그 외 API--
    HTTP응답코드:500-에러코드:50007의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------rsp_code_3_500_50008 에러코드별 API 호출 횟수(3-500_50008) Y N(10) [첨부1]-3. 그 외 API--
    HTTP응답코드:500-에러코드:50008의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    --------rsp_code_3_500_50009 에러코드별 API 호출 횟수(3-500_50009) Y N(10) [첨부1]-3. 그 외 API--
    HTTP응답코드:500-에러코드:50009의 호출횟수
    ※ 값이 0일 경우 미전송 가능
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)

  • 통합인증기관용 기관정보 조회 v2 2022-10-19

    기본 정보
    API ID 지원-006 HTTP Method GET
    API 제공자 종합포털 API 요청자 통합인증기관(인증서 본인확인기관)
    API 명 (URI) /v2/mgmts/orgs_for_ca
    설명 통합인증기관(인증서 본인확인기관)이 통합인증(본인확인) 처리에 필요한 정보제공자, 마이테이터사업자, 중계기관의 기관정보를 요청 및 수집하기 위한 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) 거래고유번호
    Parameter 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 처리 시점의 현재시각을 설정하여 회신
    org_cnt 기관목록수 Y N(5)
    org_list 기관목록 Y Object
    --org_code 기관코드 Y aN(10) 기관코드
    --op_type 기관정보의 신규/수정/삭제 구분 Y A(1) 해당 서비스정보가 신규/수정/삭제인지를 구분자로 전송
    - 수정내역이 없는 정보제공자 및 중계기관
    - <코드값>
    'I' : 신규
    'M' : 수정
    'D' : 삭제
    --org_type 기관구분 Y aN(2) 기관구분 코드
    - <코드값>
    '01' : 정보제공자(API 자체구축)
    '02' : 정보제공자(중계기관 이용)
    '03' : 마이테이터사업자
    '04' : 중계기관
    '07' : 종합포털
    * 공공기관의 경우 '02' 회신
    --is_rcv_org 정보수신자 여부 N Boolean 해당 기관이 「개인신용정보 전송요구권 표준API 규격」 상 정보수신자(마이데이터사업자 제외)인지 여부
    - op_type='D'인 경우 미회신
    - org_type=’03’~‘07’인 경우 미회신
    --org_name 기관명 N AH(60) 기관명
    - op_type='D'인 경우 미회신
    --domain API서버 도메인명 N aNS(70) - org_type='01', ‘03’, ‘04’, ‘07’인 경우(정보제공자(API 자체구축), 마이데이터사업자, 중계기관, 종합포털)만 회신
    - API 서버의 도메인명
    --cp_code 본인확인용기관코드 N aN(12) org_type='01', '02', '04'인 경우(정보제공자, 중계기관)만 회신
    - 본인확인용 기관코드(cpCode)
    --relay_org_code 중계기관 N aN(10) org_type='02'인 경우(정보제공자(중계기관 이용))만 회신
    - 중계기관을 이용 중인 정보제공자가 해당 중계기관의 기관코드를 회신
    * 공공기관의 경우 신용정보원 중계기관 코드 회신
    --server_cert_issuer_dn 서버용 공동인증서 발급자 정보 N AH(300) org_type='01', '04', '07'인 경우(정보제공자(API자체구축), 중계기관, 종합포털)만 회신
    - 통합인증시 사용할 서버용 공동인증서의 issuer DN 값
    - DN 값 하위 필드들은 콤마(',')를 구분자로 하여 단일 문자열로 생성
    - (예시) 'cn=yessignCA,ou=AccreditedCA,o=yessign,c=kr'
    --server_cert_subject_dn 서버용 공동인증서 소유자 정보 N AH(300) org_type='01', '04', '07'인 경우(정보제공자(API자체구축), 중계기관, 종합포털)만 회신
    - 통합인증시 사용할 서버용 공동인증서의 subject DN 값
    - (예시) 'cn=yessignCA,ou=AccreditedCA,o=yessign,c=kr'
    --ip_cnt 클라이언트 IP목록수 Y N(3) org_type='01', '04', '07'인 경우(정보제공자(API자체구축), 중계기관, 종합포털)만 회신
    - 통합인증기관에게 본인확인을 요청할 정보제공자 및 중계기관의 IP목록만을 제공(통합인증기관은 본 IP 목록(화이트리스트)을 방화벽 등으로 접근제어) * 본인확인 외 타 용도 IP는 제공되지 않아야 함
    --ip_list 클라이언트 IP목록 Y Object org_type='01', '04', '07'인 경우(정보제공자(API자체구축), 중계기관, 종합포털)만 회신
    ----ip 클라이언트 IP Y aNS(15) org_type='01', '04', '07'인 경우(정보제공자(API자체구축), 중계기관)만 회신

  • 통합인증기관용 기관정보 조회 v1 2021-10-18

    기본 정보
    API ID 지원-006 HTTP Method GET
    API 제공자 종합포털 API 요청자 통합인증기관
    API 명 (URI) /v1/mgmts/orgs_for_ca
    설명 통합인증기관이 통합인증(본인확인) 처리에 필요한 정보제공자, 마이테이터사업자, 중계기관의 기관정보를 요청 및 수집하기 위한 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) 거래고유번호
    Parameter 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 처리 시점의 현재시각을 설정하여 회신
    org_cnt 기관목록수 Y N(5)
    org_list 기관목록 Y Object
    --org_code 기관코드 Y aN(10) 기관코드
    --op_type 기관정보의 신규/수정/삭제 구분 Y A(1) 해당 서비스정보가 신규/수정/삭제인지를 구분자로 전송
    - 수정내역이 없는 정보제공자 및 중계기관
    - <코드값>
    'I' : 신규
    'M' : 수정
    'D' : 삭제
    --org_type 기관구분 Y aN(2) 기관구분 코드
    - <코드값>
    '01' : 정보제공자(API 자체구축)
    '02' : 정보제공자(중계기관 이용)
    '03' : 마이테이터사업자
    '04' : 중계기관
    --org_name 기관명 N AH(60) - org_type='01', ‘02’, ‘03’, ‘04’인 경우(정보제공자, 마이데이터사업자, 중계기관)만 회신
    - 기관명
    --domain API서버 도메인명 N aNS(70) - org_type='01', ‘03’, ‘04’인 경우(정보제공자(API 자체구축), 마이데이터사업자, 중계기관)만 회신
    - API 서버의 도메인명
    --cp_code 본인확인용기관코드 N aN(12) org_type='01', '02', '04'인 경우(정보제공자, 중계기관)만 회신
    - 본인확인용 기관코드(cpCode)
    --relay_org_code 중계기관 기관코드 N aN(10) org_type='02'인 경우(정보제공자(중계기관 이용))만 회신
    - 중계기관을 이용 중인 정보제공자가 해당 중계기관의 기관코드를 회신
    --server_cert_issuer_dn 서버용 공동인증서 발급자 정보 N AH(300) org_type='01', '04'인 경우(정보제공자(API자체구축), 중계기관)만 회신
    - 통합인증시 사용할 서버용 공동인증서의 issuer DN 값
    - DN 값 하위 필드들은 콤마(',')를 구분자로 하여 단일 문자열로 생성
    - (예시) 'cn=yessignCA,ou=AccreditedCA,o=yessign,c=kr'
    --server_cert_subject_dn 서버용 공동인증서 소유자 정보 N AH(300) org_type='01', '04'인 경우(정보제공자(API자체구축), 중계기관)만 회신
    - 통합인증시 사용할 서버용 공동인증서의 subject DN 값
    - (예시) 'cn=yessignCA,ou=AccreditedCA,o=yessign,c=kr'
    --ip_cnt 클라이언트 IP목록수 Y N(3) org_type='01', '04'인 경우(정보제공자(API자체구축), 중계기관)만 회신
    - 통합인증기관에게 본인확인을 요청할 정보제공자 및 중계기관의 IP목록 (통합인증기관은 본 IP 목록(화이트리스트)을 방화벽 등으로 접근제어)
    --ip_list 클라이언트 IP목록 Y Object org_type='01', '04'인 경우(정보제공자(API자체구축), 중계기관)만 회신
    ----ip 클라이언트 IP Y aNS(15) org_type='01', '04'인 경우(정보제공자(API자체구축), 중계기관)만 회신

  • 개인(신용)정보 제3자 제공동의 내역 요청 v2 2023-10-05

    기본 정보
    API ID 지원-105 HTTP Method POST
    API 제공자 마이데이터사업자, 정보수신자 API 요청자 종합포털
    API 명 (URI) /v2/mgmts/agreements
    설명 고객이 제3자 제공을 위해 마이데이터사업자/정보수신자에 동의하였던 내역을 조회 할 수 있도록 지원하는 API로 종합포털은 마이데이터사업자/정보수신자에게 고객정보를 전달 사업자/수신자는 고객의 재3자 동의내역을 회신
    기준시점 현재 시점
    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) 거래고유번호 (첨부14 참조)
    Body org_code 기관코드 Y aN(10) 마이데이터사업자/정보수신자의 기관코드
    - 지원 API로부터 배포
    user_ci 정보주체 식별값 Y B64(100) 정보주체 식별을 위한 연계정보 (Connection Information)
    from_dtime 시작 일시 Y DTIME 조회 시작 일시
    - 동의일시가 시작 일시~종료 일시에 해당하는 건만 제공
    to_dtime 종료 일시 Y DTIME 조회 종료 일시(동의일시 기준)
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체 (설정 시 해당 개체 후 limit 개 반환)
    처음 API 호출 시에는 해당 정보를 세팅하지 않으며, 다음 페이지 요청 시 직전 조회의 응답에서 얻은 기준개체를 그대로 세팅
    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) 다음 페이지 요청을 위한 기준개체
    - 다음 페이지 존재하지 않는 경우(마지막 페이지), 미회신
    prov_consent_cnt 서비스목록수 Y N(10) 동의 내역 수
    - 0인 경우 아래 항목 미회신
    prov_consent_list 동의 내역 목록 N Object
    --prov_consent_num 관리번호 N aN(50) 동의내역 고유 관리번호 동의내역 별 고유 코드로 식별값
    - 제3자 제공 동의 관련 API에서 식별 값으로 사용(지원-105, 지원-106, 지원-107)
    - 기관코드(10)+기관 자율 채변(40)
    --prov_consent_status 동의서 상태 (코드) N N(2) 동의서의 현재 상태
    <코드값>
    01: 정상
    02: 철회 중
    03: 철회완료
    04: 업무완료(제공 기간 종료 등으로 제3자에게 더 이상 정보제공을 하지 않음)
    --is_once 일회성 제공 여부 N Boolean 고객동의 후 제3자에게 고객정보를 1회만 제공하는지 여부
    --prov_revoke_dtime 철회 일시 N DTIME 동의서 철회 일시
    - 동의서 상태(prov_consent_status)가 철회완료(03)인 경우만 미회신
    --revoke_info 철회 요청시 안내 문구 N AH(300) 고객이 종합포털에서 동의 철회 요청 시 안내 할 문구
    --prov_service_name 서비스 명 N AH(100) 고객이 제3자 제공 동의를 한 서비스 명
    --prov_consent_name 고객이 동의한 동의서명 N AH(100) 고객이 제3자 제공 동의를 한 서비스 명
    --prov_consent_dtime 동의 일시 N DTIME 고객이 제3자 제공 동의에 동의한 일시
    --snd_org_code 제공하는자(기관코드) N aN(10) 고객의 동의를 받은 마이데이터사업자/정보수신자의 기관코드
    --consent_rcv_name 제공받는자 N AH(200) 고객 정보를 제공받는 제3자
    - 개인의 경우 짝수번째 글자 마스킹
    -<예시>
    홍길동 -> 홍*동, 제갈공명 -> 제*공* ,철수 -> 철*
    --prov_consent_purpose_type 제공받는자의 이용목적 구분(코드) N aN(2) 제공받는 자의 이용목적 구분(코드)
    <코드값>
    01: 마케팅
    02: 부가혜택 제공
    03: 부가서비스 제공
    04: 업무서비스 제공
    05: 데이터 중계 및 판매)
    --prov_consent_purpose 제공받는자의 이용목적 N AH(1000) 고객 동의 획득 시 안내 한 이용 목적
    --prov_consent_period 보유 및 이용기간 N AH(300) 고객 동의 획득 시 안내 한 보유 및 이용기간
    --prov_consent_asset 제공항목 N AH(5000) 고객 동의 획득 시 안내 한 제공항목

  • 개인(신용)정보 제3자 제공동의에 따른 제공 내역 요청 v2 2023-10-05

    기본 정보
    API ID 지원-106 HTTP Method POST
    API 제공자 마이데이터사업자, 정보수신자 API 요청자 종합포털
    API 명 (URI) /v2/mgmts/agreements/detail
    설명 고객의 동의를 받아 마이데이터사업자/정보수신자가 제3자에게 고객정보를 제공한 내역을 고객 본인이 조회 할 수 있도록 지원하는 API로 종합포털은 마이데이터사업자/정보수신자에게 동의내역 정보를 전달, 사업자/수신자는 고객의 제3자 제공 상세 내역을 회신
    기준시점 현재 시점
    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) 거래고유번호(첨부14 참조)
    Body org_code 기관코드 Y aN(10) 마이데이터사업자/정보수신자의 기관코드
    - 지원 API로부터 배포
    prov_consent_num 관리번호 Y aN(50) 동의내역 고유 관리번호 동의내역 별 고유 코드로 식별값(지원-105를 통해 마이데이터사업자/정보수신자로부터 회신 받은 관리번호를 이용하여 셋팅)
    - 제3자 제공 동의 관련 API에서 식별 값으로 사용(지원-105, 106, 107)
    - 기관코드(10)+기관 자율 채변(40)
    from_dtime 시작일시 Y DTIME 조회 시작 일시
    - 제공일시가 시작 일시 ~ 종료 일시에 해당하는 건만 제공
    to_dtime 종료일시 Y DTIME 조회 종료 일시(제공일시 기준)
    next_page 다음 페이지 기준개체 N aNS(1000) 다음 페이지 요청을 위한 기준개체 (설정 시 해당 개체 후 limit 개 반환)
    처음 API 호출 시에는 해당 정보를 세팅하지 않으며, 다음 페이지 요청 시 직전 조회의 응답에서 얻은 기준개체를 그대로 세팅
    limit 최대조회갯수 N 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) 다음 페이지 요청을 위한 기준개체
    - 다음 페이지 존재하지 않는 경우(마지막 페이지), 미회신
    prov_cnt 제공 내역 수 Y N(10) 제공 내역 수
    - 0인 경우 아래 항목 미회신
    prov_list 제공 내역 목록 N Object
    --snd_org_code 제공하는자(기관코드) N aN(10) 고객의 동의를 받은 마이데이터사업자/정보수신자의 기관코드
    --prov_rcv_name 제공받는자 N AH(200) 고객 정보를 제공받는 제3자
    - 동의서에서 안내한(지원-105 회시한) 제공받는자 내에서 세부적으로 응답
    - 개인의 경우 짝수번째 글자 마스킹
    -예)홍길동 -> 홍*동, 제갈공명 -> 제*공* ,철수 -> 철*
    - 단 지원-105의 'prov_consent_purpose(제공받는자의 이용목적)' 과 동일한 경우 미회신
    --prov_purpose_type 제공받는자의 이용목적 구분(코드) N aN(2) 제공받는 자의 이용목적 구분(코드)
    <코드값>
    01: 마케팅
    02: 부가혜택 제공
    03: 부가서비스 제공
    04: 업무서비스 제공
    05: 데이터 중계 및 판매
    - 단, 지원-105의 “prov_consent_purpose_type(제공받는자의 이용목적 구분(코드))”과 동일한 경우 미회신)
    --prov_purpose 제공받는자의 이용목적 N AH(1000) 고객정보를 제공받는 제3자의 이용목적
    - 동의서에서 안내한(지원-105로 회신한) 목적 내에서 세부적으로 응답
    - 단, 지원-105의 'prov_consent_purpose(제공받는자의 이용목적)'과 동일한 경우 미회신
    --prov_period 제공받는자의 보유 및 이용기간 N AH(300) 고객정보를 제공받는 제3자의 보유 및 이용 기간
    - 동의서에서 안내한(지원-105로 회신한) 보유 및 이용기간 내에서 세부적으로 응답
    - <예시>
    고객이 동의한 이용기간
    - 23년 12월 31일까지
    실제 제3자의 이용기간
    - 23년8월 31일까지
    - 단, 지원-105의 'prov_consent_period(보유 및 이용기간)'과 동일한 경우 미회신
    --prov_asset 제공받는자에게 제공한 항목 N AH(5000) 제3자에게 제공한 고객정보
    - 동의서에서 안내한(지원-105로 회신한)제공정보 내어서 세부적으로 응답
    -<예시>
    고객이 동의한 제공항목: 이름, 나이, 성별
    제3자에게 제공한 항목: 이름,나이
    - 단, 지원-105의 'prov_consent_asset(제공항목)'과 동일한 경우 미회신
    --reward 지급 대가 N aN(2) 제3자 제공을 통해 마이데이터사업자/정보수신자가 얻는 대가
    - 정보 제공 후 특정 시점 혹은 특정 업무 완료 후 대가를 지급받는 경우 "대가없음(00)"이 아닌 지급 받을 대가를 "금전(01), 정보(02)"로 분류하여 회신
    - 단, 금전, 정보 등 다수의 대가를 지급받을 시 "금전"이 포함되어 있을 경우 "금전(01)"으로 회신
    - 포인트 등 금전으로 해석될 여지가 있는 대가는 "금전(01)"으로 회신
    - <코드값>
    00 : 대가 없음
    01 : 금전
    02 : 정보
    - 계약 시 금전을 지급 받은 경우 : 01
    - 고객 정보를 제공함으로써, 추가 정보를 지급받는 경우 : 02
    - 고객 정보 제공 후 고객이 제3자의 서비스를 이용(상품구입, 보험가입 등)하였을 떄 금전을 지급받는 경우 : 01
    정보를 제공하여 금전, 정보 등을 제공받는 경우 : 01(금전이 포함되어 있으므로 01로 회신)
    --prov_dtime 제공 일시 N DTIME 고객정보를 제3자에게 제공한 일시

  • 개인(신용)정보 제3자 제공 동의 내역 철회 요청 v2 2023-10-05

    기본 정보
    API ID 지원-107 HTTP Method POST
    API 제공자 마이데이터사업자, 정보수신자 API 요청자 종합포털
    API 명 (URI) /v2/mgmts/agreements/revoke
    설명 고객이 제3자 정보 제공 동의 한 내역을 철회할 수 있도록 지원하는 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) 거래고유번호(첨부14 참조)
    Body org_code 기관코드 Y aN(10) 마이데이터사업자/정보수신자의 기관코드
    - 지원 API로부터 배포
    prov_consent_num 관리번호 Y aN(50) 동의내역 고유 관리번호 동의내역 별 고유 코드로 식별값
    - 제3자 제공 동의 관련 API에서 식별 값으로 사용(지원-105, 106, 107)
    - 기관코드(10)+기관 자율 채변(40)
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)

Table of contents

지원 API(종합포털 제공)