금융보안원 로고

회원가입 로그인

API가이드

지원 API(마이데이터사업자/정보제공자 제공)

  • 접근토큰 발급 (지원API 제공용) v1 2021-10-18

    기본 정보
    API ID 지원-101 HTTP Method POST
    API 제공자 마이데이터사업자, 정보제공자 API 요청자 종합포털
    API 명 (URI) /mgmts/oauth/2.0/token
    설명 종합포털이 마이데이터사업자, 정보제공자 또는 중계기관에게 접근토큰 발급을 요청(종합포털이 사전에 공유한 '종합포털 자격증명'을 이용하여 검증)
    - 중계기관을 이용하는 기관의 경우, 중계기관이 '종합포털 자격증명'을 검증한 후 접근토큰을 대표로 하나만 발급해줌
    - 따라서 중계기관도 종합포털에 기관 등록 및 자격증명 발급 필요
    기준시점 현재 시점
    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) 종합포털이 사전에 공유한 종합포털 자격증명의 클라이언트 식별값
    client_secret 클라이언트 Secret Y aN(50) 종합포털이 사전에 공유한 종합포털 자격증명의 클라이언트 Secret 값
    scope 권한 범위 Y a(6) 고정값 : 'manage'
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body token_type 접근토큰 유형 Y a(6) 접근토큰 유형
    - ('Bearer' 고정값)
    access_token 접근토큰 Y aNS(1500) 각 기관이 발급한 접근토큰
    expires_in 접근토큰 유효기간 Y N(9) 접근토큰 유효기간(단위 : 초)
    scope 권한 범위 Y a(6) 고정값 : manage

  • 정보제공자 상태 조회 v1 2021-10-18

    기본 정보
    API ID 지원-102 HTTP Method GET
    API 제공자 정보제공자 API 요청자 종합포털
    API 명 (URI) /v1/mgmts/status
    설명 마이데이터사업자가 종합포털에서 요청 시, 종합포털은 본 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) 거래고유번호
    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)
    availability API 서버 가용 여부 Y aN(2) API 서버 가용 여부
    - <코드값>
    01 : 정상
    02 : 장애
    03 : 시스템 점검
    99 : 기타

  • 정보주체 별 전송요구 내역 조회 v1 2021-10-18

    기본 정보
    API ID 지원-103 HTTP Method POST
    API 제공자 마이데이터사업자 API 요청자 종합포털
    API 명 (URI) /v1/mgmts/consents
    설명 정보주체가 종합포털에서 요청 시, 종합포털은 본 API를 호출하여 마이데이터사업자로부터 전송 요구 내역을 조회
    - 정보제공자별 전송 요구 내역을 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) 거래고유번호
    Body org_code 기관코드 Y aN(10) 마이데이터사업자의 기관코드
    - 지원 API로부터 배포
    user_ci 정보주체 식별값 Y B64(100) 정보주체 식별을 위한 연계정보 (Connection Information)
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)
    is_member 회원 가입 여부 Y Boolean 해당 정보주체가 마이데이터사업자의 가입 고객인지 여부
    - is_member = false인 경우, 아래 내용들 회신 안 함
    service_cnt 서비스목록수 N N(5) 전송요구 대상 마이데이터 서비스 수
    - 해당 마이데이터사업자가 복수개의 마이데이터서비스를 제공할 수 있기 때문에 List로 회신
    service_list 서비스목록 N Object
    --client_id 클라이언트 ID N aN(50) 종합포털에 마이데이터 서비스 등록 시 발급 받은 클라이언트 식별값
    --consent_cnt 전송요구 내역 수 N N(3) 전송요구 내역 수
    --consent_list 전송요구 내역 목록 N Object
    ----org_code 기관코드 N aN(10) 정보제공자 기관코드
    ----scope 권한 범위 N aNS(200) 정보제공자가 발급한 접근토큰의 권한 범위(다중 scope 가능)
    - 접근토큰 권한 범위(scope)를 통해 정보주체가 전송요구한 내역(중분류)을 확인 가능
    - 전송요구 상세내역(예: 특정 계좌번호를 전송 요구했는지 등)은 종합포털에서 보여주지 않고, 각 마이데이터 사업자 App을 통해 조회
    ----consent_date 전송요구 일자 N DATE 정보주체가 전송요구한 일자
    ----consent_end_date 전송요구 종료 시점 N DATE 전송요구 종료 시점)
    - 정보제공-공통-002 "종료 시점(end_date)"과 동일한 값

  • 통계자료 재전송 요청 v1 2021-10-18

    기본 정보
    API ID 지원-104 HTTP Method GET
    API 제공자 마이데이터사업자, 정보제공자 API 요청자 종합포털
    API 명 (URI) /v1/mgmts/req-statistics
    설명 마이데이터사업자, 정보수신자 및 정보제공자는 통계자료를 종합포털에 집중하도록 하고 있으나(지원-004, 지원-005), 마이데이터사업자 또는 정보제공자가 API규격 오류, 전송 실패, 또는 잘못된 정보 집중 등 통계자료 집중이 정상적으로 이루어지지 않았을 경우 종합포털에서 재전송을 요청하기 위한 API
    - 마이데이터사업자 또는 정보수신자는 본 API 수신 시, 지원-004 API를 이용하여 정보를 재전송
    - 정보제공자는 본 API 수신 시, 지원-005 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 org_code 기관코드 Y aN(10) API 제공자(마이데이터사업자, 정보수신자 또는 정보제공자)의 기관코드
    - 지원 API로부터 배포
    org_type 기관구분 Y aN(2) 종합포털이 통계자료 재전송을 요청하는 기관 구분
    - <코드값>
    01 : 마이데이터사업자
    02 : 정보수신자
    03 : 정보제공자
    inquiry_date 재전송 기준일자 Y DATE 통계자료를 재전송할 기준일자
    - 본 기준일자를 기준으로 직전 7일에 대한 통계자료 재전송
    - 기준일자는 일요일로 한정
    type 재전송 통계정보 구분 Y N(1) 0 : 목록 / 정기적 전송 / 비정기적 전송(정보주체 개입) 통계자료 모두 재전송 요청
    1 : 정기적 전송 통계자료에 대한 재전송 요청
    2 : 비정기적 전송(정보주체 개입) 통계자료에 대한 재전송 요청
    3 : 목록 전송
    응답메세지 명세
    HTTP 항목명 항목설명 필수 타입(길이) 설명(비고)
    Header x-api-tran-id 거래고유번호 Y AN(25) 거래고유번호
    Body rsp_code 세부 응답코드 Y aN(5)
    rsp_msg 세부 응답메시지 Y AH(450)

Table of contents

지원 API(마이데이터사업자/정보제공자 제공)