본문
전송지원 API 규격
기본정보
API코드
SU001
API URL 주소
/v1/support/oauth/2.0/token
API아이디
전송지원-001
API명
연계지원용 접근토큰 발급
HTTP메서드명
POST
사용여부
예
API제공자명
지원플랫폼, 중계전문기관, 정보수신자(서비스)
API요청자명
지원플랫폼, 중계전문기관, 정보수신자(서비스), 인증기관
HTTP요청유형명
application/x-www-form-urlencoded
※ (참고) charset=UTF-8
HTTP응답유형명
application/json; charset=UTF-8
API설명
OAuth2.0 기반의 API 통신을 위한 접근토큰 발급(플랫폼에 등록된 자격증명 확인)
-(플랫폼 연계용) 중계전문기관, 정보수신자(서비스), 인증기관에게 발급
-(중계전문기관 연계용) 지원플랫폼, 정보수신자(서비스)에게 발급
-(정보수신자 연계용) 지원플랫폼에게 발급
요청 메세지 명세
| HTTP유형명 | HTTP항목명 | HTTP항목설명 | 필수여부 | 항목자료유형명 | API상세설명 |
|---|---|---|---|---|---|
| Header | X-Src-Inst-Cd | API 요청기관 | 예 | String(12) | API 요청메시지를 작성하는 기관코드 지원플랫폼 등록시 발급 |
| Header | X-Dst-Inst-Cd | API 응답기관 | 예 | String(12) | API 응답메시지를 작성하는 기관코드 전송지원-002(기관정보) 조회에서 확인 |
| Header | X-Api-Tx-Id | 거래고유번호 | 예 | String(36) | 거래고유번호 |
| Body | grant_type | 권한부여방식 | 예 | String(18) | 권한부여방식 (‘client_credentials’ 고정 값) |
| Body | client_id | 클라이언트 ID | 예 | String(32) | 지원플랫폼에 등록된 자격증명 |
| Body | client_secret | 클라이언트 Secret | 예 | String(50) | 지원플랫폼에 등록된 자격증명(보안을 위해 추가 확인하는 값) |
| Body | scope | 권한 | 예 | String(7) | 권한값 (‘support’ 고정값) |
응답 메세지 명세
| HTTP유형명 | HTTP항목명 | HTTP항목설명 | 필수여부 | 항목자료유형명 | API상세설명 |
|---|---|---|---|---|---|
| Header | X-Api-Tx-Id | 거래고유번호 | 예 | String(36) | 거래고유번호 |
| Body | rsp_code | 세부 응답코드 | 예 | String(5) | API 처리결과코드 |
| Body | rsp_msg | 세부 응답메시지 | 예 | String(1550) | 응답코드에 해당하는 메시지 |
| Body | token_type | 접근토큰 유형 | 예 | String(6) | 접근토큰 유형 ‘Bearer’ 고정 값 |
| Body | access_token | 접근토큰 | 예 | String(1500) | 발급된 접근토큰 |
| Body | expires_in | 접근토큰 유효기간 | 예 | String(9) | 접근토큰의 유효기간(단위: 초) 23~24시간 중 무작위 값 |
기본정보
API코드
SU002
API URL 주소
/v1/support/insts
API아이디
전송지원-002
API명
기관정보 조회
HTTP메서드명
GET
사용여부
예
API제공자명
지원플랫폼
API요청자명
정보수신자(서비스), 중계전문기관
HTTP요청유형명
-
HTTP응답유형명
application/json; charset=UTF-8
API설명
정보수신자/중계전문기관이 타 기관의 기관정보를 플랫폼으로부터 제공받기 위한 API
-수정내역이 없는 기관의 정보는 회신하지 않음
-자격증명에 따라 요청자가 받을 수 있는 기관(조회대상 기관)의 정보만 제공
요청 메세지 명세
| HTTP유형명 | HTTP항목명 | HTTP항목설명 | 필수여부 | 항목자료유형명 | API상세설명 |
|---|---|---|---|---|---|
| Header | Authorization | 인증정보 | 예 | String(1500) | 연계지원용 접근토큰(Bearer) |
| Header | X-Src-Inst-Cd | API 요청기관 | 예 | String(12) | API 요청메시지를 작성하는 기관코드 지원플랫폼 등록시 발급 |
| Header | X-Dst-Inst-Cd | API 응답기관 | 예 | String(12) | API 응답메시지를 작성하는 기관코드 전송지원-002(기관정보) 조회에서 확인 |
| Header | X-Api-Tx-Id | 거래고유번호 | 예 | String(36) | 거래고유번호 |
| Parameter | search_timestamp | 조회타임스탬프 | 예 | String(14) | 요청자가 처리한 마지막 API 처리시각(YYYYMMDDhhmmss) 최초 호출값은 0, 이후에는 마지막 호출 시 search_timestamp 응답값 |
| Parameter | next_page | 다음 페이지 기준개체 | 아니오 | String(1000) | 다음 페이지 요청을 위한 기준개체(설정 시 해당 개체 후 limit개 반환) 최초 호출 시 값이 없고, 이후 요청 시 응답값의 다음페이지 기준개체 사용 - Pagination, 기관코드 기준 오름차순 |
| Parameter | limit | 최대조회갯수 | 아니오 | String(3) | 최대값 500 |
응답 메세지 명세
| HTTP유형명 | HTTP항목명 | HTTP항목설명 | 필수여부 | 항목자료유형명 | API상세설명 |
|---|---|---|---|---|---|
| Header | X-Api-Tx-Id | 거래고유번호 | 예 | String(36) | 거래고유번호 |
| Body | rsp_code | 세부 응답코드 | 예 | String(5) | API 처리결과코드 |
| Body | rsp_msg | 세부 응답메세지 | 예 | String(1550) | 응답코드에 해당하는 메시지 |
| Body | search_timestamp | 조회 타임스탬프 | 예 | String(14) | 처리 시각(YYYYMMDDhhmmss) |
| Body | next_page | 다음 페이지 기준개체 | 아니오 | String(1000) | 다음 페이지 요청을 위한 기준개체 (다음 페이지 존재하지 않는 경우(마지막 페이지), 미회신) |
| Body | inst_cnt | 기관정보 개수 | 예 | String(4) | |
| Body | inst_list | 기관정보목록 | 아니오 | Object | |
| @기관공통정보(기관코드 오름차순) | |||||
| Body | --modification_flag | 정보변경플래그 | 아니오 | String(1) | 조회 대상 기관의 정보가 가장 최근의 API 처리 시각(search_timestamp의 값)을 기준으로 변경된 유형에 대한 구분자 - <코드값> 'I' : 신규 / 'M' : 수정 / 'D' : 삭제 최초 요청에 대한 응답값은 모두 ‘I’이고 ‘D’인 경우 기관코드(inst_cd)만 제공 |
| Body | --inst_cd | 기관코드 | 아니오 | String(12) | 조회 대상 기관코드 |
| Body | --inst_nm | 기관명 | 아니오 | String(60) | 조회 대상 기관의 이름 |
| Body | --tls_cert_fingerprint_info | TLS 인증서 지문정보 | 아니오 | String(64) | 중계전문기관/정보전송자/인증기관/지원플랫폼의 TLS인증서 지문정보 - SHA256 알고리즘 이용, Hex 표현식으로 64byte 길이 |
| Body | --renewal_tls_cert_fingerprint_info | 갱신예정 TLS 인증서 지문정보 | 아니오 | String(64) | 중계전문기관/정보전송자/인증기관/지원플랫폼의 갱신예정 TLS인증서 지문정보 - SHA256 알고리즘 이용, Hex 표현식으로 64byte 길이 |
| Body | --domain_nm | API서버 도메인명 | 아니오 | String(70) | 중계전문기관/정보전송자/인증기관/지원플랫폼의 API 제공 서버의 도메인 명 |
| Body | --domain_ip_addr_cnt | API서버 공인IP주소 개수 | 아니오 | String(4) | 중계전문기관/정보전송자/인증기관/지원플랫폼의 API 제공 서버의 공인 IP주소 및 포트(IP주소:포트) |
| Body | --domain_ip_addr_list | API서버 공인IP주소 목록 | 아니오 | object | |
| Body | ----domain_ip_addr | API서버 공인IP주소 | 아니오 | String(21) | |
| Body | --request_ip_addr_cnt | 요청IP주소목록 개수 | 아니오 | String(4) | 중계전문기관/지원플랫폼의 API 요청을 하는 서버의 IP주소 |
| Body | --request_ip_addr_list | 요청IP주소목록 | 아니오 | object | |
| Body | ----request_ip_addr | 요청IP주소 | 아니오 | String(15) | |
| @(조회 대상 유형)정보전송자정보 | |||||
| Body | --trans_inst_cd | 중계전문기관 기관코드 | 아니오 | String(12) | 정보전송자를 대행하는 중계전문기관의 기관코드 |
| Body | --ident_mgt_tp | 식별자유형 | 아니오 | String(1) | 정보전송자의 정보주체 식별자유형에 대한 구분자 - 1:연계정보(CI) / 2:개별식별자 / 3:주민등록번호 / 4:연계정보(CI)+개별식별자 / 5:연계정보(CI)+주민등록번호 / 6:개별식별자+주민등록번호 / 7.연계정보(CI)+주민등록번호+개별식별자 |
| Body | --idvd_auth_url | 개별인증 URL | 아니오 | String(100) | 정보주체 식별자가 개별식별자인 경우, 정보전송자의 개별인증 URL |
| Body | --np_time_cnt | 정기적 전송가능 시간대 개수 | 아니오 | String(4) | |
| Body | --np_time_list | 정기적 전송가능 시간대 목록 | 아니오 | Object | 정보전송자가 정기적 전송을 허용하는 Non-peak 시간대 목록 |
| Body | ----np_time | 정기적 전송 가능 시간 | 아니오 | String(9) | 정기적 전송가능시간(30분 단위) : “hhmm:hhmm” <예시> 0030:0530(0시30분~5시30분) 2230:2300(22시30분~23시0분) |
| Body | --maintenence_cnt | 점검 시간 개수 | 아니오 | String(4) | |
| Body | --maintenence_list | 점검 시간 목록 | 아니오 | Object | 주기적 점검 시간 목록 |
| Body | ----maintenence_start_dtime | 점검 시작일시 | 아니오 | String(14) | 시스템 점검이 시작되는 일시(YYYYMMDDhhmmss) |
| Body | ----maintenence_end_dtime | 점검 종료일시 | 아니오 | String(14) | 시스템 점검이 종료되는 일시(YYYYMMDDhhmmss) |
| Body | ----maintenence_reason | 점검 사유 | 아니오 | String(5000) | 시스템 점검 사유 |
| @(조회 대상 유형)중계전문기관정보 | |||||
| Body | --social_security_number_url | 주민등록번호입력창 URL | 아니오 | String(100) | 정보주체 식별자가 주민등록번호인 경우, 주민등록번호를 입력하는 화면의 URL |
| @(조회 대상 유형)정보수신자정보(서비스정보) | |||||
| Body | --service_cnt | 서비스 개수 | 아니오 | String(4) | |
| Body | --service_list | 서비스정보목록 | 아니오 | Object | 서비스코드 기준 오름차순 |
| Body | ----service_cd | 서비스코드 | 아니오 | String(16) | 서비스 코드 |
| Body | ----service_nm | 서비스명 | 아니오 | String(60) | 서비스의 이름 |
| Body | ----domain_nm | API서버 도메인명 | 아니오 | String(70) | API 제공 서버의 도메인 명 |
| Body | ----domain_ip_addr_cnt | API서버 공인IP주소 개수 | 아니오 | String(4) | |
| Body | ----domain_ip_addr_list | API서버 공인IP주소 목록 | 아니오 | object | API 제공 서버의 공인 IP주소 및 포트 목록(IP주소:포트) |
| Body | ------domain_ip_addr | API서버 공인IP주소 | 아니오 | String(21) | |
| Body | ----request_ip_addr_cnt | 요청IP주소목록 개수 | 아니오 | String(4) | |
| Body | ----request_ip_addr_list | 요청IP주소목록 | 아니오 | object | API 요청을 하는 서버의 IP주소 목록 |
| Body | ------request_ip_addr | 요청IP주소 | 아니오 | String(15) | API 요청을 하는 서버의 IP주소 |
| Body | ----tls_cert_fingerprint_info | TLS 인증서 지문정보 | 아니오 | String(64) | TLS인증서 지문정보. - SHA256 알고리즘 이용, Hex 표현식으로 64byte 길이 |
| Body | ----renewal_tls_cert_fingerprint_info | 갱신예정 TLS 인증서 지문정보 | 아니오 | String(64) | 갱신예정 TLS인증서 지문정보 - SHA256 알고리즘 이용, Hex 표현식으로 64byte 길이 |
| Body | ----redirect_uri_cnt | redirect uri 개수 | 아니오 | String(4) | |
| Body | ----redirect_uri_list | redirect uri 목록 | 아니오 | Object | |
| Body | ------redirect_uri | redirect uri | 아니오 | String(100) | 정보전송자의 개별인증 URL 호출 후 redirect될 정보수신자 서비스의 URI |
| Body | ----redirect_app_scheme_cnt | redirect 앱 스킴 개수 | 아니오 | String(4) | |
| Body | ----redirect_app_scheme_list | redirect 앱 스킴 목록 | 아니오 | Object | |
| Body | ------redirect_app_scheme | redirect 앱 스킴 | 아니오 | String(100) | 정보전송자의 개별인증 URL 호출 후 redirect될 정보수신자 서비스의 앱 스킴 |
| @(조회 대상 유형)인증기관정보(인증서 본인확인기관 또는 전자서명 인증사업자) | |||||
| Body | --iss_distu_name | 인증서발급기관명 | 아니오 | String(15) | 정보수신자의 정보주체 인증 시, 인증서 본인확인이 가능한 인증기관의 인증서 발급기관 정보 - 인증서 발급자 DN의 o값 (예시) SignKorea - 인증서 본인확인기관인 경우만 회신 |
| Body | --certifcation_oid | 인증서식별값 | 아니오 | String(300) | 정보수신자의 정보주체 인증 시, 인증서 본인확인이 가능한 인증기관의 인증서 발급기관 정보 - 인증서 OID (예시) 1.2.410.200004.5.1.1.5 - 복수 개의 경우 “;”로 구분 - 인증서 본인확인기관인 경우만 회신 |
| Body | --ca_code | 전자서명인증사업자 코드 | 아니오 | String(20) | 전자서명인증사업자 코드 (예시) kakao 전자서명인증사업자인 경우만 회신 |
기본정보
API코드
SU003
API URL 주소
/v1/support/credentials
API아이디
전송지원-003
API명
자격증명 조회
HTTP메서드명
GET
사용여부
예
API제공자명
지원플랫폼
API요청자명
중계전문기관, 정보수신자(서비스)
HTTP요청유형명
-
HTTP응답유형명
application/json; charset=UTF-8
API설명
전송지원/정보요청API를 호출하는 권한 및 scope를 제공
- 수정내역이 없는 자격증명의 정보는 회신하지 않음
- 요청자에 해당되는 정보만 전송
요청 메세지 명세
| HTTP유형명 | HTTP항목명 | HTTP항목설명 | 필수여부 | 항목자료유형명 | API상세설명 |
|---|---|---|---|---|---|
| Header | Authorization | 인증정보 | 예 | String(1500) | 연계지원용 접근토큰(Bearer) |
| Header | X-Src-Inst-Cd | API 요청기관 | 예 | String(12) | API 요청메시지를 작성하는 기관코드 지원플랫폼 등록시 발급 |
| Header | X-Dst-Inst-Cd | API 응답기관 | 예 | String(12) | API 응답메시지를 작성하는 기관코드 전송지원-002(기관정보) 조회에서 확인 |
| Header | X-Api-Tx-Id | 거래고유번호 | 예 | String(36) | 거래고유번호 |
| Parameter | search_timestamp | 조회타임스탬프 | 예 | String(14) | 요청자가 처리한 마지막 API 처리시각(YYYYMMDDhhmmss) 최초 호출값은 0, 이후에는 마지막 호출 시 search_timestamp 응답값 |
| Parameter | next_page | 다음페이지 기준개체 | 아니오 | String(1000) | 다음 페이지 요청을 위한 기준개체(설정 시 해당 개체 후 limit개 반환) 최초 호출 시 값이 없고, 이후 요청 시 응답값의 다음페이지 기준개체 사용 - Pagination, 클라이언트ID 기준 오름차순 |
| Parameter | limit | 최대조회개수 | 아니오 | String(3) | 최대값 500 |
응답 메세지 명세
| HTTP유형명 | HTTP항목명 | HTTP항목설명 | 필수여부 | 항목자료유형명 | API상세설명 |
|---|---|---|---|---|---|
| Header | X-Api-Tx-Id | 거래고유번호 | 예 | String(36) | 거래고유번호 |
| Body | rsp_code | 세부 응답코드 | 예 | String(5) | API 처리결과코드 |
| Body | rsp_msg | 세부 응답메세지 | 예 | String(1550) | 응답코드에 해당하는 메시지 |
| Body | search_timestamp | 조회타임스탬프 | 예 | String(14) | 처리 시각(YYYYMMDDhhmmss) |
| Body | next_page | 다음페이지 기준개체 | 아니오 | String(1000) | 다음 페이지 요청을 위한 기준개체 (다음 페 이지 존재하지 않는 경우(마지막 페이지), 미 회신) |
| Body | credentials_cnt | 자격증명 수 | 예 | String(4) | |
| Body | credentials_list | 자격증명 목록 | 아니오 | Object | -클라이언트ID 기준 오름차순 |
| Body | --modification_flag | 정보변경플래그 | 아니오 | String(1) | 조회 대상 기관의 정보가 가장 최근의 API 처리 시각(search_timestamp의 값)을 기준으로 변경된 유형에 대한 구분자 - <코드값> 'I' : 신규 / 'M' : 수정 / 'D' : 삭제 최초 요청에 대한 응답값은 모두 ‘I’이고 ‘D’인 경우 클라이언트ID만 제공 |
| Body | --client_id | 클라이언트ID | 아니오 | String(32) | 지원플랫폼이 발급한 자격증명 ID |
| Body | --client_secret | 클라이언트Secret | 아니오 | String(50) | 지원플랫폼이 발급한 자격증명 시크릿값 |
| Body | --credential_type | 자격증명 유형 | 아니오 | String(1) | 자격증명의 유형 1: 플랫폼 연계지원용(포털 화면에서 조회) 2: 중계전문기관 연계지원용 3: 정보요청용 4: 정보수신자 연계지원용 |
| Body | --server_inst_cd | 서버 기관코드 | 아니오 | String(12) | 해당 자격증명을 검증하여 접근토큰을 발급하는 기관코드 |
| Body | --server_service_cd | 서버 서비스코드 | 아니오 | String(16) | 해당 자격증명을 검증하여 접근토큰을 발급하는 정보수신자 서비스 코드 - 접근토큰 발급 주체가 정보수신자 서비스인 경우만 해당 |
| Body | --client_inst_cd | 클라이언트 기관코드 | 아니오 | String(12) | 해당 자격증명을 이용하여 접근토큰 발급을 요청하는 기관코드 |
| Body | --client_service_cd | 클라이언트 서비스코드 | 아니오 | String(16) | 해당 자격증명을 이용하여 접근토큰 발급을 요청하는 정보수신자 서비스 코드 - 접근토큰 발급요청 주체가 정보수신자 서비스인 경우만 해당 |
| Body | --scope | 권한범위 | 아니오 | String(500) | 이 자격증명의 권한범위(API 호출 기관이 접근 가능한 API그룹) - 자격증명 유형이 “3”(정보전송용)인 경우만 해당. 공백으로 구분된 다중 권한 범위 |
기본정보
API코드
SU004
API URL 주소
/v1/support/ca_certs
API아이디
전송지원-004
API명
CA 인증서 목록 조회
HTTP메서드명
GET
사용여부
예
API제공자명
지원플랫폼
API요청자명
중계전문기관, 정보수신자(서비스), 인증기관
HTTP요청유형명
-
HTTP응답유형명
application/json; charset=UTF-8
API설명
mTLS 통신에 필요한 TLS인증서의 Root CA와 Intermediate CA의 인증서 목록을 조회
요청 메세지 명세
| HTTP유형명 | HTTP항목명 | HTTP항목설명 | 필수여부 | 항목자료유형명 | API상세설명 |
|---|---|---|---|---|---|
| Header | Authorization | 인증정보 | 예 | String(1500) | 연계지원용 접근토큰(Bearer) |
| Header | X-Src-Inst-Cd | API 요청기관 | 예 | String(12) | API 요청메시지를 작성하는 기관코드 지원플랫폼 등록시 발급 |
| Header | X-Dst-Inst-Cd | API 응답기관 | 예 | String(12) | API 응답메시지를 작성하는 기관코드 전송지원-002(기관정보) 조회에서 확인 |
| Header | X-Api-Tx-Id | 거래고유번호 | 예 | String(36) | 거래고유번호 |
응답 메세지 명세
| HTTP유형명 | HTTP항목명 | HTTP항목설명 | 필수여부 | 항목자료유형명 | API상세설명 |
|---|---|---|---|---|---|
| Header | X-Api-Tx-Id | 거래고유번호 | 예 | String(36) | 거래고유번호 |
| Body | rsp_code | 세부 응답코드 | 예 | String(5) | API 처리결과코드 |
| Body | rsp_msg | 세부 응답메세지 | 예 | String(1550) | 응답코드에 해당하는 메시지 |
| Body | ca_cert_cnt | CA인증서개수 | 예 | String(4) | CA 인증서 개수 조회 대상이 없는 경우 0을 회신, 아래 항목은 미회신 |
| Body | ca_cert_list | CA인증서목록 | 아니오 | Object | CA 인증서 목록 |
| Body | --cert_content | CA인증서 | 아니오 | String(3000) | CA 인증서(pem 형식) |
기본정보
API코드
SU005
API URL 주소
/v1/support/statistics
API아이디
전송지원-005
API명
통계 전송
HTTP메서드명
POST
사용여부
예
API제공자명
지원플랫폼
API요청자명
중계전문기관
HTTP요청유형명
application/json; charset=UTF-8
HTTP응답유형명
application/json; charset=UTF-8
API설명
중계전문기관이 관리하는 전송요구 및 정보전송 관련 통계를 제공하는 API
- 기준일자는 일요일로 한정하며, 기준일자에 전주 7일간 일별 통계를 전송함
(예시) 9.12(일)에 9.5(일)~9.11(토)까지의 일별 통계를 전송
중계전문기관은 생성일자(일별)로 정보수신자 서비스와 정보전송자 간의 통계를 집계
통계가 없는 경우에는 기준일자(criteria_ymd)와 서비스 개수(service_cnt)만을 전송
기관코드와 서비스코드는 지원플랫폼에 등록된 값이어야 함
집중항목 : 전송요구 신청 수, 전송요구 철회 수, API 호출 횟수, 정기적/비정기적 API 호출 횟수, 수신데이터 트래픽량 등
요청 메세지 명세
| HTTP유형명 | HTTP항목명 | HTTP항목설명 | 필수여부 | 항목자료유형명 | API상세설명 |
|---|---|---|---|---|---|
| Header | Authorization | 인증정보 | 예 | String(1500) | 연계지원용 접근토큰(Bearer) |
| Header | X-Src-Inst-Cd | API 요청기관 | 예 | String(12) | API 요청메시지를 작성하는 기관코드 지원플랫폼 등록시 발급 |
| Header | X-Dst-Inst-Cd | API 응답기관 | 예 | String(12) | API 응답메시지를 작성하는 기관코드 전송지원-002(기관정보) 조회에서 확인 |
| Header | X-Api-Tx-Id | 거래고유번호 | 예 | String(36) | 거래고유번호 |
| Body | criteria_ymd | 기준일자 | 예 | String(8) | 통계 전송의 기준일자(YYYYMMDD) |
| Body | service_cnt | 서비스 개수 | 예 | String(4) | 통계가 없을 경우 0, 아래 항목은 미회신 |
| Body | service_list | 서비스목록 | 아니오 | object | |
| Body | --service_cd | 서비스코드 | 아니오 | String(16) | 정보수신자 서비스코드 정보수신자(서비스)별 통계 |
| Body | --statistics_cnt | 목록 개수 | 아니오 | String(4) | |
| Body | --statistics_list | 목록 | 아니오 | Object | |
| Body | ----statistics_ymd | 생성일자 | 아니오 | String(8) | 통계정보 집계 대상 일자(YYYYMMDD) (예시) 기준일자가 9.12(일)인 경우, 9.5(일), 9.6(월), 9.7(화), 9.8(수), 9.9(목), 9.10(금), 9.11(토) 각각의 일자가 생성일자에 해당 생성일자에 해당하는 통계가 없을 경우 정보전송자 개수 0, 아래 항목은 미회신 |
| Body | ----prv_cnt | 정보전송자 개수 | 아니오 | String(4) | |
| Body | ----prv_list | 정보전송자 목록 | 아니오 | Object | 정보전송자 목록 |
| Body | ------inst_cd | 기관코드 | 아니오 | String(12) | 정보전송자 기관코드 -전송요구를 처리한 정보전송자 |
| Body | ------consent_new_cnt | 전송요구 신청 수 | 아니오 | String(10) | 전송요구API를 통해 발급한 접근토큰의 수 |
| Body | ------consent_revoked_cnt | 전송요구 철회 수 | 아니오 | String(10) | 전송요구API를 통해 철회한 접근토큰의 수 |
| Body | ------success_api_cnt | API 호출 횟수 | 아니오 | String(10) | 성공한 정보요청 API 호출 횟수 |
| Body | ------regular_api_cnt | 정기적 API 호출 횟수 | 아니오 | String(10) | 성공한 정기적 정보요청 API 호출 횟수 |
| Body | ------irregular_api_cnt | 비정기적 API 호출 횟수 | 아니오 | String(10) | 성공한 비정기적 정보요청 API 호출 횟수 |
| Body | ------receiv_traffic_amount | 수신데이터 트래픽량 | 아니오 | String(12) | 성공한 정보요청 API의 응답 데이터 합계 (단위: KB) 정보요청 API별 응답메시지 내 Body |
응답 메세지 명세
| HTTP유형명 | HTTP항목명 | HTTP항목설명 | 필수여부 | 항목자료유형명 | API상세설명 |
|---|---|---|---|---|---|
| Header | X-Api-Tx-Id | 거래고유번호 | 예 | String(36) | 거래고유번호 |
| Body | rsp_code | 세부 응답코드 | 예 | String(5) | API 처리결과코드 |
| Body | rsp_msg | 세부 응답메세지 | 예 | String(1550) | 응답코드에 해당하는 메시지 |
기본정보
API코드
SU101
API URL 주소
/v1/support/request/history
API아이디
전송지원-101
API명
전송요구 내역 조회
HTTP메서드명
POST
사용여부
예
API제공자명
중계전문기관
API요청자명
지원플랫폼
HTTP요청유형명
application/json; charset=UTF-8
HTTP응답유형명
application/json; charset=UTF-8
API설명
중계전문기관이 보관하고 있는 정보주체의 전송요구 내역(정보수신자, 정보전송자, 요구일자 등)을 마이데이터 서비스별로 제공
요청 메세지 명세
| HTTP유형명 | HTTP항목명 | HTTP항목설명 | 필수여부 | 항목자료유형명 | API상세설명 |
|---|---|---|---|---|---|
| Header | Authorization | 인증정보 | 예 | String(1500) | 연계지원용 접근토큰(Bearer) |
| Header | X-Src-Inst-Cd | API 요청기관 | 예 | String(12) | API 요청메시지를 작성하는 기관코드 지원플랫폼 등록시 발급 |
| Header | X-Dst-Inst-Cd | API 응답기관 | 예 | String(12) | API 응답메시지를 작성하는 기관코드 전송지원-002(기관정보) 조회에서 확인 |
| Header | X-Api-Tx-Id | 거래고유번호 | 예 | String(36) | 거래고유번호 |
| Body | ci | 연계정보 | 예 | String(100) | 정보주체 연계정보 |
| Body | from_date | 조회 시작일자 | 예 | String(8) | 조회 시작 일자(전송요구 일자 기준)(YYYYMMDD) -조회일자 기준 최대 3년 전까지 설정 가능 |
| Body | to_date | 조회 종료일자 | 예 | String(8) | 조회 종료 일자(전송요구 일자 기준)(YYYYMMDD) -조회 시작일자 기준 1년 단위로 설정 가능 |
응답 메세지 명세
| HTTP유형명 | HTTP항목명 | HTTP항목설명 | 필수여부 | 항목자료유형명 | API상세설명 |
|---|---|---|---|---|---|
| Header | X-Api-Tx-Id | 거래고유번호 | 예 | String(36) | 거래고유번호 |
| Body | rsp_code | 세부 응답코드 | 예 | String(5) | API 처리결과코드 |
| Body | rsp_msg | 세부 응답메세지 | 예 | String(1550) | 응답코드에 해당하는 메시지 |
| Body | service_cnt | 서비스 개수 | 예 | String(4) | 조회 대상이 없으면 0, 아래 항목은 미회신 |
| Body | service_list | 서비스 목록 | 아니오 | Object | |
| Body | --service_cd | 서비스코드 | 아니오 | String(16) | 정보수신자 서비스코드 |
| Body | --request_cnt | 전송요구 내역 개수 | 아니오 | String(3) | 전송요구(동의) 내역 수 |
| Body | --request_list | 전송요구 내역 목록 | 아니오 | Object | |
| Body | ----request_msg_id | 전송요구서ID | 아니오 | String(82) | 전송요구에 대해 중계전문기관이 관리하는 전송요구서별 고유ID |
| Body | ----prv_inst_cd | 정보전송자 기관코드 | 아니오 | String(12) | 정보전송자 기관코드 |
| Body | ----request_stcd | 전송요구 상태코드 | 아니오 | String(1) | 0:전송요구(동의 – 현재 이 전송요구서를 통해 정보전송이 이뤄지고 있음) 1:전송요구 철회 2:전송요구 종료 |
| Body | ----prov_consent_yn | 제3자 제공 동의여부 | 아니오 | String(1) | 해당 전송요구에 대한 제3자 제공 여부(Y/N) |
| Body | ----request_ymd | 전송요구 일자 | 아니오 | String(8) | 정보주체의 전송요구(동의) 일자(YYYYMMDD) |
| Body | ----request_revoke_ymd | 전송요구 철회일자 | 아니오 | String(8) | 정보주체의 전송요구(동의) 철회 일자(YYYYMMDD) 전송요구 상태코드가 1일 경우에만 값 존재 |
| Body | ----request_end_ymd | 전송요구 종료일자 | 아니오 | String(8) | 정보주체의 전송요구(동의) 종료(예정) 일자(YYYYMMDD) |
| Body | ----purpose | 전송요구 목적 | 아니오 | String(150) | 전송을 요구하는 목적 |
| Body | ----request_cycle | 전송 주기 | 아니오 | String(3) | 정기적 전송 주기(정기적 전송인 경우에만 해당) -형식(횟수/기준) : (예시) “1/w”(주1회) -기준은 ‘m’(월 단위) / ‘w’(주 단위) / ‘d’(일 단위) |
| Body | ----request_period | 개인정보 보유기간 | 아니오 | String(8) | 개인정보의 보유기간에 따른 파기일자(YYYYMMDD) ‘서비스 탈퇴시까지’ 등 파기일자를 특정하지 않은 경우는 ‘99991231’ |
| Body | ----scope | 권한범위 | 아니오 | String(500) | 전송요구서의 권한범위(접근 가능한 API그룹) 공백으로 구분된 다중 권한 범위 |
기본정보
API코드
SU102
API URL 주소
/v1/support/request/transmission
API아이디
전송지원-102
API명
전송 이력 조회
HTTP메서드명
POST
사용여부
예
API제공자명
중계전문기관
API요청자명
지원플랫폼
HTTP요청유형명
application/json
HTTP응답유형명
application/json
API설명
전송요구에 대한 상세 전송이력을 제공하며, 중계전문기관이 관리하고 있는 정보요청API 처리 이력을 월 단위로 집계하여 제공
-중계전문기관은 전일까지의 데이터를 월별로 집계함
요청 메세지 명세
| HTTP유형명 | HTTP항목명 | HTTP항목설명 | 필수여부 | 항목자료유형명 | API상세설명 |
|---|---|---|---|---|---|
| header | Authorization | 인증정보 | 예 | String(1500) | 연계지원용 접근토큰(Bearer) |
| header | X-Src-Inst-Cd | API 요청기관 | 예 | String(12) | API 요청메시지를 작성하는 기관코드 지원플랫폼 등록시 발급 |
| header | X-Dst-Inst-Cd | API 응답기관 | 예 | String(12) | API 응답메시지를 작성하는 기관코드 전송지원-002(기관정보) 조회에서 확인 |
| header | X-Api-Tx-Id | 거래고유번호 | 예 | String(36) | 거래고유번호 |
| body | request_msg_id | 전송요구서ID | 예 | String(82) | 전송요구에 대해 중계전문기관이 관리하는 전송요구서별 고유ID |
| body | from_date | 조회 시작일자 | 예 | String(8) | 조회 시작 일자(전송요구 일자 기준)(YYYYMMDD) -조회일자 기준 최대 3년 전까지 설정 가능 |
| body | to_date | 조회 종료일자 | 예 | String(8) | 조회 종료 일자(전송요구 일자 기준)(YYYYMMDD) -조회 시작일자 기준 1년 단위로 설정 가능 |
응답 메세지 명세
| HTTP유형명 | HTTP항목명 | HTTP항목설명 | 필수여부 | 항목자료유형명 | API상세설명 |
|---|---|---|---|---|---|
| header | X-Api-Tx-Id | 거래고유번호 | 예 | String(36) | 거래고유번호 |
| body | rsp_code | 세부 응답코드 | 예 | String(5) | API 처리결과코드 |
| body | rsp_msg | 세부 응답메시지 | 예 | String(1550) | 응답코드에 해당하는 메시지 |
| body | aggregate_cnt | 집계 개수 | 예 | String(4) | 대상이 없으면 0, 아래 항목은 미회신 |
| body | aggregate_list | 집계 목록 | 아니오 | Object | |
| body | --aggregate_ymd | 집계 일자 | 아니오 | String(8) | 전송 내역 집계에 대한 기준 년월(YYYYMMDD) |
| body | --api_code | API CODE | 아니오 | String(5) | API 규격의 기본 정보 중 API CODE 항목 예) [무선통신-001]의 경우 : WC001 |
| body | --total_transmission_cnt | 총 전송 건수 | 아니오 | String(4) | 총 전송 건수 - 정보요청API 응답건수 기준 - 0인 경우, 아래 항목 미회신 |
| body | --total_transmission_success_cnt | 총 전송 성공 건수 | 아니오 | String(4) | 총 전송 성공 건수 |
| body | --total_transmission_fail_cnt | 총 전송 실패 건수 | 아니오 | String(4) | 총 전송 실패 건수 정상적 요청이 있었으나 에러코드 반환 등 정상적으로 처리하지 못한 건수 |
| body | --total_reg_transmission_cnt | 총 정기적 전송 건수 | 아니오 | String(4) | 총 정기적 전송 건수 |
| body | --total_reg_transmission_success_cnt | 총 정기적 전송 성공 건수 | 아니오 | String(4) | 총 정기적 전송 성공 건수 |
| body | --total_reg_transmission_fail_cnt | 총 정기적 전송 실패 건수 | 아니오 | String(4) | 총 정기적 전송 실패 건수 정상적 요청이 있었으나 에러코드 반환 등 정상적으로 처리하지 못한 건수 |
| body | --total_irreg_transmission_cnt | 총 비정기적 전송 건수 | 아니오 | String(4) | 총 비정기적 전송 건수 |
| body | --total_irreg_transmission_success_cnt | 총 비정기적 전송 성공 건수 | 아니오 | String(4) | 총 비정기적 전송 성공 건수 |
| body | --total_irreg_transmission_successcnt | 총 비정기적 전송 실패 건수 | 아니오 | String(4) | 총 비정기적 전송 실패 건수 정상적 요청이 있었으나 에러코드 반환 등 정상적으로 처리하지 못한 건수 |
| body | --total_transmission_fail_cnt | 총 전송 실패 건수 | 아니오 | String(4) | 총 전송 실패 건수 정상적 요청이 있었으나 에러코드 반환 등 정상적으로 처리하지 못한 건수 |
기본정보
API코드
SU103
API URL 주소
/v1/support/request/revoke
API아이디
전송지원-103
API명
전송요구 철회 요청
HTTP메서드명
POST
사용여부
예
API제공자명
중계전문기관
API요청자명
지원플랫폼
HTTP요청유형명
application/json; charset=UTF-8
HTTP응답유형명
application/json; charset=UTF-8
API설명
정보주체가 전송요구를 지원플랫폼에서 철회하는 API
전송요구 철회 요청 시 중계전문기관은 전송요구에 대한 접근토큰을 폐기해야 함
요청 메세지 명세
| HTTP유형명 | HTTP항목명 | HTTP항목설명 | 필수여부 | 항목자료유형명 | API상세설명 |
|---|---|---|---|---|---|
| Header | Authorization | 인증정보 | 예 | String(1500) | 연계지원용 접근토큰(Bearer) |
| Header | X-Src-Inst-Cd | API 요청기관 | 예 | String(12) | API 요청메시지를 작성하는 기관코드 지원플랫폼 등록시 발급 |
| Header | X-Dst-Inst-Cd | API 응답기관 | 예 | String(12) | API 응답메시지를 작성하는 기관코드 전송지원-002(기관정보) 조회에서 확인 |
| Header | X-Api-Tx-Id | 거래고유번호 | 예 | String(36) | 거래고유번호 |
| Body | request_msg_id | 전송요구서ID | 예 | String(82) | 전송요구에 대해 중계전문기관이 관리하는 전송요구서별 고유ID |
응답 메세지 명세
| HTTP유형명 | HTTP항목명 | HTTP항목설명 | 필수여부 | 항목자료유형명 | API상세설명 |
|---|---|---|---|---|---|
| Header | X-Api-Tx-Id | 거래고유번호 | 예 | String(36) | 거래고유번호 |
| Body | rsp_code | 세부 응답코드 | 예 | String(5) | API 처리결과코드 |
| Body | rsp_msg | 세부 응답메세지 | 예 | String(1550) | 응답코드에 해당하는 메시지 |
기본정보
API코드
SU104
API URL 주소
/v1/support/agreements
API아이디
전송지원-104
API명
제3자 제공동의 내역 조회
HTTP메서드명
POST
사용여부
예
API제공자명
중계전문기관
API요청자명
지원플랫폼
HTTP요청유형명
application/json; charset=UTF-8
HTTP응답유형명
application/json; charset=UTF-8
API설명
전송받은 개인정보를 제3자에게 제공한 경우, 정보수신자는 제3자 제공 동의내역을 중계전문기관에 제출하고, 중계전문기관이 관리하는 제3자 제공동의 내역을 확인하는 API
요청 메세지 명세
| HTTP유형명 | HTTP항목명 | HTTP항목설명 | 필수여부 | 항목자료유형명 | API상세설명 |
|---|---|---|---|---|---|
| Header | Authorization | 인증정보 | 예 | String(1500) | 연계지원용 접근토큰(Bearer) |
| Header | X-Src-Inst-Cd | API 요청기관 | 예 | String(12) | API 요청메시지를 작성하는 기관코드 지원플랫폼 등록시 발급 |
| Header | X-Dst-Inst-Cd | API 응답기관 | 예 | String(12) | API 응답메시지를 작성하는 기관코드 전송지원-002(기관정보) 조회에서 확인 |
| Header | X-Api-Tx-Id | 거래고유번호 | 예 | String(36) | 거래고유번호 |
| Body | request_msg_id | 전송요구서ID | 예 | String(82) | 전송요구에 대해 중계전문기관이 관리하는 전송요구서별 고유ID |
응답 메세지 명세
| HTTP유형명 | HTTP항목명 | HTTP항목설명 | 필수여부 | 항목자료유형명 | API상세설명 |
|---|---|---|---|---|---|
| Header | X-Api-Tx-Id | 거래고유번호 | 예 | String(36) | 거래고유번호 |
| Body | rsp_code | 세부 응답코드 | 예 | String(5) | API 처리결과코드 |
| Body | rsp_msg | 세부 응답메세지 | 예 | String(1550) | 응답코드에 해당하는 메시지 |
| Body | prov_consent_cnt | 동의 내역 개수 | 예 | String(4) | 동의 내역 개수 - 대상이 없으면 0, 아래 항목은 미회신 |
| Body | prov_consent_list | 동의 내역 목록 | 아니오 | Object | |
| Body | --prov_consent_nm | 동의서명 | 아니오 | String(100) | 정보주체가 동의한 동의서 이름 |
| Body | --prov_consent_dtime | 동의일시 | 아니오 | String(14) | 정보주체가 제3자 제공 동의에 동의한 일시(YYYYMMDDhhmmss) |
| Body | --snd_inst_cd | 제공하는자(서비스 코드) | 아니오 | String(16) | 정보주체의 동의를 받은 정보수신자의 서비스코드 |
| Body | --consent_rcv_nm | 제공받는자 | 아니오 | String(200) | 정보주체 정보를 제공받은 제3자 -개인정보를 포함한 경우 비식별자 처리 -복수 개의 경우 “,”로 구분 |
| Body | --prov_consent_purpose | 제공받는자의 이용목적 | 아니오 | String(1000) | 정보주체 동의 획득 시 안내한 이용 목적 |
| Body | --prov_consent_period | 보유 및 이용기간 | 아니오 | String(300) | 정보주체 동의 획득 시 안내한 보유 및 이용기간 |
| Body | --prov_consent_asset | 제공항목 | 아니오 | String(5000) | 정보주체 동의 획득 시 안내한 제공항목 |
기본정보
API코드
SU105
API URL 주소
/v1/support/rcv/agreements
API아이디
전송지원-105
API명
제3자 제공동의 내역 전송
HTTP메서드명
POST
사용여부
예
API제공자명
중계전문기관
API요청자명
정보수신자
HTTP요청유형명
application/json; charset=UTF-8
HTTP응답유형명
application/json; charset=UTF-8
API설명
정보수신자가 전송정보의 제3자 제공동의 내역을 중계전문기관에 제출
중계전문기관은 제3자 제공동의 내역을 보관하고, 제3자 제공동의 내역 조회(전송지원-104)시 회신
요청 메세지 명세
| HTTP유형명 | HTTP항목명 | HTTP항목설명 | 필수여부 | 항목자료유형명 | API상세설명 |
|---|---|---|---|---|---|
| Header | Authorization | 인증정보 | 예 | String(1500) | 연계지원용 접근토큰(Bearer) |
| Header | X-Src-Inst-Cd | API 요청기관 | 예 | String(12) | API 요청메시지를 작성하는 기관코드 지원플랫폼 등록시 발급 |
| Header | X-Dst-Inst-Cd | API 응답기관 | 예 | String(12) | API 응답메시지를 작성하는 기관코드 전송지원-002(기관정보) 조회에서 확인 |
| Header | X-Api-Tx-Id | 거래고유번호 | 예 | String(36) | 거래고유번호 |
| Body | request_msg_id | 전송요구서ID | 예 | String(82) | 전송요구에 대해 중계전문기관이 관리하는 전송요구서별 고유ID |
| Body | prov_consent_nm | 동의서명 | 아니오 | String(100) | 정보주체가 동의한 동의서 이름 |
| Body | prov_consent_dtime | 동의일시 | 아니오 | String(14) | 정보주체가 제3자 제공 동의에 동의한 일시 |
| Body | snd_inst_cd | 제공하는자(서비스 코드) | 아니오 | String(16) | 정보주체의 동의를 받은 정보수신자의 서비스코드 |
| Body | consent_rcv_nm | 제공받는자 | 아니오 | String(200) | 정보주체 정보를 제공받은 제3자 - 개인의 경우 짝수 번째 글자 마스킹 <예시> 홍길동 -> 홍*동 제갈공명 -> 제*공* 철수 -> 철* -복수 개의 경우 “,”로 구분 |
| Body | prov_consent_purpose | 제공받는자의 이용목적 | 아니오 | String(1000) | 정보주체 동의 획득 시 안내한 이용 목적 |
| Body | prov_consent_period | 보유 및 이용기간 | 아니오 | String(300) | 정보주체 동의 획득 시 안내한 보유 및 이용기간 |
| Body | prov_consent_asset | 제공항목 | 아니오 | String(5000) | 정보주체 동의 획득 시 안내한 제공항목 |
응답 메세지 명세
| HTTP유형명 | HTTP항목명 | HTTP항목설명 | 필수여부 | 항목자료유형명 | API상세설명 |
|---|---|---|---|---|---|
| Header | X-Api-Tx-Id | 거래고유번호 | 예 | String(36) | 거래고유번호 |
| Body | rsp_code | 세부 응답코드 | 예 | String(5) | API 처리결과코드 |
| Body | rsp_msg | 세부응답 메세지 | 예 | String(1550) | 응답코드에 해당하는 메시지 |
기본정보
API코드
SU106
API URL 주소
/v1/support/re_statistics
API아이디
전송지원-106
API명
통계정보 재전송 요청
HTTP메서드명
GET
사용여부
예
API제공자명
중계전문기관
API요청자명
지원플랫폼
HTTP요청유형명
-
HTTP응답유형명
application/json; charset=UTF-8
API설명
중계전문기관에게 기준일자 통계 재전송을 요청
재전송 기준일자에 해당하는 통계 데이터 전체를 응답해야 함
요청 메세지 명세
| HTTP유형명 | HTTP항목명 | HTTP항목설명 | 필수여부 | 항목자료유형명 | API상세설명 |
|---|---|---|---|---|---|
| Header | Authorization | 인증정보 | 예 | String(1500) | 연계지원용 접근토큰(Bearer) |
| Header | X-Src-Inst-Cd | API 요청기관 | 예 | String(12) | API 요청메시지를 작성하는 기관코드 지원플랫폼 등록시 발급 |
| Header | X-Dst-Inst-Cd | API 응답기관 | 예 | String(12) | API 응답메시지를 작성하는 기관코드 전송지원-002(기관정보) 조회에서 확인 |
| Header | X-Api-Tx-Id | 거래고유번호 | 예 | String(36) | 거래고유번호 |
| Parameter | criteria_ymd | 재전송 기준일자 | 예 | String(8) | 통계정보 재전송 요청의 기준일자(YYYYMMDD) -본 기준일자를 기준으로 직전 집계주기 (7일)에 대한 통계정보를 재전송 -기준일자는 일요일로 한정 -재전송이 필요한 통계정보의 기준일자를 의미 |
응답 메세지 명세
| HTTP유형명 | HTTP항목명 | HTTP항목설명 | 필수여부 | 항목자료유형명 | API상세설명 |
|---|---|---|---|---|---|
| Header | X-Api-Tx-Id | 거래고유번호 | 예 | String(36) | 거래고유번호 |
| Body | rsp_code | 세부 응답코드 | 예 | String(5) | API 처리결과코드 |
| Body | rsp_msg | 세부 응답메세지 | 예 | String(1550) | 응답코드에 해당하는 메시지 |
기본정보
API코드
SU201
API URL 주소
/v1/support/service/verify
API아이디
전송지원-201
API명
서비스 회원 여부 확인
HTTP메서드명
POST
사용여부
예
API제공자명
정보수신자(서비스)
API요청자명
지원플랫폼
HTTP요청유형명
application/json; charset=UTF-8
HTTP응답유형명
application/json; charset=UTF-8
API설명
지원플랫폼을 통해 전송요구항목을 전달하기 위해 정보주체의 마이데이터 서비스 가입여부를 확인하는 API
요청 메세지 명세
| HTTP유형명 | HTTP항목명 | HTTP항목설명 | 필수여부 | 항목자료유형명 | API상세설명 |
|---|---|---|---|---|---|
| Header | Authorization | 인증정보 | 예 | String(1500) | 연계지원용 접근토큰(Bearer) |
| Header | X-Src-Inst-Cd | API 요청기관 | 예 | String(12) | API 요청메시지를 작성하는 기관코드 지원플랫폼 등록시 발급 |
| Header | X-Dst-Inst-Cd | API 응답기관 | 예 | String(12) | API 응답메시지를 작성하는 기관코드 전송지원-002(기관정보) 조회에서 확인 |
| Header | X-Api-Tx-Id | 거래고유번호 | 예 | String(36) | 거래고유번호 |
| Body | ci | 연계정보 | 예 | String(100) | 정보주체 연계정보 |
응답 메세지 명세
| HTTP유형명 | HTTP항목명 | HTTP항목설명 | 필수여부 | 항목자료유형명 | API상세설명 |
|---|---|---|---|---|---|
| Header | X-Api-Tx-Id | 거래고유번호 | 예 | String(36) | 거래고유번호 |
| Body | rsp_code | 세부 응답코드 | 예 | String(5) | API 처리결과코드 |
| Body | rsp_msg | 세부 응답메세지 | 예 | String(1550) | 응답코드에 해당하는 메시지 |
| Body | is_member | 회원여부 | 예 | String(1) | 회원 여부 회원 : 1 비회원 : 2 |
기본정보
API코드
SU202
API URL 주소
/v1/support/service/request_content
API아이디
전송지원-202
API명
전송요구항목 전송
HTTP메서드명
POST
사용여부
예
API제공자명
정보수신자(서비스)
API요청자명
지원플랫폼
HTTP요청유형명
application/json; charset=UTF-8
HTTP응답유형명
application/json; charset=UTF-8
API설명
지원플랫폼을 통해 정보주체가 선택한 전송요구항목 정보를 정보수신자(서비스)에 전송
요청 메세지 명세
| HTTP유형명 | HTTP항목명 | HTTP항목설명 | 필수여부 | 항목자료유형명 | API상세설명 |
|---|---|---|---|---|---|
| Header | Authorization | 인증정보 | 예 | String(1500) | 연계지원용 접근토큰(Bearer) |
| Header | X-Src-Inst-Cd | API 요청기관 | 예 | String(12) | API 요청메시지를 작성하는 기관코드 지원플랫폼 등록시 발급 |
| Header | X-Dst-Inst-Cd | API 응답기관 | 예 | String(12) | API 응답메시지를 작성하는 기관코드 전송지원-002(기관정보) 조회에서 확인 |
| Header | X-Api-Tx-Id | 거래고유번호 | 예 | String(36) | 거래고유번호 |
| Body | ci | 연계정보 | 예 | String(100) | 정보주체 연계정보 |
| Body | request_item_cnt | 전송요구항목 개수 | 예 | String(4) | 전송요구항목 개수 |
| Body | request_item_list | 전송요구항목 목록 | 예 | Object | |
| Body | --request_item | 전송요구항목 | 예 | String(40) | 전송요구 신청한 항목 API그룹 단위 |
응답 메세지 명세
| HTTP유형명 | HTTP항목명 | HTTP항목설명 | 필수여부 | 항목자료유형명 | API상세설명 |
|---|---|---|---|---|---|
| Header | X-Api-Tx-Id | 거래고유번호 | 예 | String(36) | 거래고유번호 |
| Body | rsp_code | 세부 응답코드 | 예 | String(5) | API 처리결과코드 |
| Body | rsp_msg | 세부 응답메세지 | 예 | String(1550) | 응답코드에 해당하는 메시지 |