범정부 마이데이터 개발시험지원센터(테스트베드)

기본정보

API코드

AT001

API URL 주소

/v1/user/verify

API아이디

전송요구-001

API명

정보전송자 회원 여부

HTTP메서드명

POST

사용여부

예

API제공자명

중계 전문기관

API요청자명

정보수신자

HTTP요청유형명

application/json; charset=UTF-8

HTTP응답유형명

application/json; charset=UTF-8

API설명

정보수신자는 전송요구 단계 전, 정보주체가 정보전송자의 회원인지 여부를 확인 • 정보수신자는 해당 API를 통해 회원으로 확인된 정보주체에 대해 전송요구 절차 진행

요청 메세지 명세

**응답 메시지 명세**
HTTP유형명, HTTP항목명, HTTP항목설명, 필수여부, 항목자료유형명, 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상세설명
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코드

AT002

API URL 주소

/v1/oauth/2.0/token

API아이디

전송요구-002

API명

정보요청용 접근토큰 발급(공동인증기관)

HTTP메서드명

POST

사용여부

예

API제공자명

중계 전문기관

API요청자명

정보수신자

HTTP요청유형명

application/x-www-form-urlencoded; charset=UTF-8

HTTP응답유형명

application/json; charset=UTF-8

API설명

정보수신자는 정보주체의 전송요구에 대한 접근토큰 발급 요청(전자서명 전송) • 정보수신자는 해당 API를 통해 전자서명된 전송요구서를 중계전문기관에 전송하고 서비스별 접근토큰을 발급

요청 메세지 명세

**응답 메시지 명세**
HTTP유형명, HTTP항목명, HTTP항목설명, 필수여부, 항목자료유형명, 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	tx_id	트랜잭션 ID	예	String(82)	정보수신자가 생성 * [붙임1] 트랜잭션 ID 생성 규칙 참고
body	grant_type	권한부여 방식	예	String(8)	권한부여 방식 • 'password’ 고정 값
body	client_id	클라이언트 ID	예	String(32)	지원플랫폼에 등록된 자격증명
body	client_secret	클라이언트 Secret	예	String(50)	지원플랫폼에 등록된 자격증명(보안을 위해 추가 확인하는 값)
body	ca_code	통합인증기관 코드	예	String(12)	통합인증수단을 발급한 통합인증기관 기관코드 (지원플랫폼에 등록된 기관코드(inst_cd))
body	ci	연계정보	예	String(100)	정보주체 연계정보
body	id_token	ID 토큰	아니오	String(1500)	정보주체에 해당되는 ID 토큰 값으로, 개별인증 수행 시 정보수신자가 정보전송자에게 발급받은 id_token 값
body	password_len	password 항목 길이	예	String(5)	전송요구내역 전자서명(signedData) 길이
body	password	전송요구내역 전자서명 (signedConsent)	예	String(10000)	전송요구내역 전자서명(CMS SignedData, Base64 url-safe 인코딩) ※ 항목명 password는 OAuth 표준 준용함
body	signed_person_info_req_len	본인확인 이용동의 전자서명 항목 길이 (signedPersonInfoReq의 길이)	아니오	String(5)	signed_person_info_req의 길이 적용
body	signed_person_info_req	본인확인 이용동의 전자서명 (signedPersonInfoReq)	아니오	String(10000)	본인확인 이용동의 전자서명(CMS SignedData, Base64 url-safe 인코딩)
body	consent_nonce	재전송공격 방지정보 1 (consentNonce)	아니오	String(30)	전송요구내역 전자서명(signedConsent)에 포함된 Nonce 값(Base64 url-safe 인코딩, 패딩(‘=’) 포함) • 정보전송자 및 중계 전문기관은 패딩(‘=’) 포함 여부와 상관 없이 nonce 비교·검증이 가능하도록 개발
body	ucpid_nonce	재전송공격 방지정보 2 (ucpidNonce)	아니오	String(30)	본인확인 이용 동의내역 전자서명(signedPersonInfoReq)에 포함된 Nonce 값(Base64 url-safe 인코딩, 패딩(‘=’) 포함) • 정보전송자 및 중계 전문기관은 패딩(‘=’) 포함 여부와 상관 없이 nonce 비교·검증이 가능하도록 개발

응답 메세지 명세

**응답 메시지 명세**
HTTP유형명, HTTP항목명, HTTP항목설명, 필수여부, 항목자료유형명, API상세설명
HTTP유형명	HTTP항목명	HTTP항목설명	필수여부	항목자료유형명	API상세설명
header	X-Api-Tx-Id	거래고유번호	예	String(36)	거래고유번호
body	rsp_code	세부 응답코드	예	String(5)	API 처리결과코드
body	rsp_msg	세부 응답메시지	예	String(1550)	응답코드에 해당하는 메시지
body	tx_id	트랜잭션 ID	예	String(82)	API 요청시 포함되어 있던 tx_id
body	token_type	접근토큰 유형	예	String(6)	접근토큰 유형 • 'Bearer' 고정값
body	access_token	접근토큰	예	String(1500)	정보요청용 접근토큰(Bearer)
body	expires_in	접근토큰 유효기간	예	String(9)	접근토큰 유효기간(단위: 초)
body	refresh_token	갱신토큰	예	String(1500)	접근토큰 갱신을 위한 토큰
body	refresh_token_expires_in	갱신토큰 유효기간	예	String(9)	갱신토큰 유효기간(단위: 초)
body	scope	권한 범위	예	String(500)	접근토큰 권한 범위 (다중 scope 가능)

기본정보

API코드

AT003

API URL 주소

/v1/oauth/2.0/token

API아이디

전송요구-003

API명

정보요청용 접근토큰 발급(간편인증기관)

HTTP메서드명

POST

사용여부

예

API제공자명

중계 전문기관

API요청자명

정보수신자

HTTP요청유형명

application/x-www-form-urlencoded

HTTP응답유형명

application/json; charset=UTF-8

API설명

정보수신자는 정보주체가 선택한 정보전송자를 대상으로 통합인증을 요청(전자서명 전송) • 정보전송자 서버는 1개 이상의 정보전송자에게 해당 기관을 대상으로 하는 전자서명을 각각 전송

요청 메세지 명세

**응답 메시지 명세**
HTTP유형명, HTTP항목명, HTTP항목설명, 필수여부, 항목자료유형명, API상세설명
HTTP유형명	HTTP항목명	HTTP항목설명	필수여부	항목자료유형명	API상세설명
header	X-Api-Tx-Id	거래고유번호	예	String(36)	거래고유번호
header	X-Src-Inst-Cd	API 요청기관	예	String(12)	API 요청메시지를 작성하는 기관코드 - 지원플랫폼 등록시 발급
header	X-Dst-Inst-Cd	API 응답기관	예	String(12)	API 응답메시지를 작성하는 기관코드 - 전송지원-002(기관정보) 조회에서 확인
body	tx_id	트랜잭션 ID	예	String(82)	마이데이터 사업자가 생성 * [참고] 트랜잭션 ID 생성 규칙
body	grant_type	권한부여 방식	예	String(8)	권한부여 방식 • 'password’ 고정값
body	client_id	클라이언트 ID	예	String(32)	지원플랫폼에 등록된 자격증명
body	client_secret	클라이언트 Secret	예	String(50)	지원플랫폼에 등록된 자격증명(보안을 위해 추가 확인하는 값)
body	ca_code	통합인증기관 코드	예	String(12)	통합인증수단을 발급한 통합인증기관 기관코드 (지원플랫폼에 등록시 할당된 기관코드)
body	ci	연계정보	예	String(100)	정보주체 연계정보
body	id_token	ID 토큰	아니오	String(1500)	개별인증 시 정보수신자가 정보전송자에게 발급받은 id_token 값
body	password_len	password 항목 길이	예	String(5)	전송요구내역 전자서명(signedData) 길이
body	password	전송요구내역 전자서명 (signedConsent)	예	String(10000)	전송요구내역 전자서명 요청(request) 응답으로 받은 signed_content 값 ※ 항목명 password는 OAuth 표준 준용함
body	consent_len	consent 항목 길이	아니오	String(5)	consent 항목의 길이(전송요구내역 원문의 길이)
body	consent	전송요구내역	아니오	String(10000)	전송요구내역 원문
body	kcert_tx_id	인증사업자 트랜잭션 아이디	예	String(120)	전자서명 요청(request) 응답으로 받은 tx_id
body	sign_client_i	인증사업자 client_id	예	String(50)	전자서명 요청(request) 한 인증사업자로부터 발급받은 정보수신자의 client_id 정보
body	content_id	전자서명 원문 id	예	String(120)	전자서명 요청(request) API 호출 시 사용했던 전자서명 원문에 부여한 구분값

응답 메세지 명세

**응답 메시지 명세**
HTTP유형명, HTTP항목명, HTTP항목설명, 필수여부, 항목자료유형명, API상세설명
HTTP유형명	HTTP항목명	HTTP항목설명	필수여부	항목자료유형명	API상세설명
header	X-Api-Tx-Id	거래고유번호	예	String(36)	거래고유번호
body	rsp_code	세부 응답코드	예	String(5)	API 처리결과코드
body	rsp_msg	세부 응답메시지	예	String(1550)	응답코드에 해당하는 메시지
body	tx_id	트랜잭션 ID	예	String(74)	API 요청시 포함되어 있던 tx_id
body	token_type	접근토큰 유형	예	String(6)	접근토큰 유형 • 'Bearer' 고정값
body	access_token	접근토큰	예	String(1500)	정보요청용 접근토큰(Bearer)
body	expires_in	접근토큰 유효기간	예	String(9)	접근토큰 유효기간(단위: 초)
body	refresh_token	갱신토큰	예	String(1500)	접근토큰 갱신을 위한 토큰
body	refresh_token	갱신토큰 유효기간	예	String(9)	갱신토큰 유효기간(단위: 초)
body	scope	권한 범위	예	String(500)	접근토큰 권한 범위 (다중 scope 가능)

기본정보

API코드

AT004

API URL 주소

/v1/oauth/2.0/authorize

API아이디

전송요구-004

API명

개별인증 인가코드 발급

HTTP메서드명

GET

사용여부

예

API제공자명

정보전송자

API요청자명

정보수신자

HTTP요청유형명

application/x-www-form-urlencoded ※ (참고) charset=UTF-8

HTTP응답유형명

application/json; charset=UTF-8

API설명

정보수신자는 정보주체가 로그인하는 정보전송자를 대상으로 인가코드 발급을 요청

요청 메세지 명세

**응답 메시지 명세**
HTTP유형명, HTTP항목명, HTTP항목설명, 필수여부, 항목자료유형명, 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)	거래고유번호
parameter	response_type	타입	예	String(4)	수신하려는 응답값의 형태 • 'code’ 고정 값
parameter	client_id	클라이언트 ID	예	String(32)	지원플랫폼에 등록된 자격증명 ID
parameter	redirect_uri	리다이렉트 URI	예	String(100)	마이데이터 플랫폼에 마이데이터 서비스 등록 시 입력한 Redirect URI • URL 인코딩 필요 (정보전송자는 디코딩 후 검증)
parameter	state	상태값	예	String(40)	CSRF 보안위협에 대응하기 위해 임의 설정하는 값
parameter	nonce	재전송 공격 방지 정보	예	String(30)	ID토큰에 포함될 Nonce 값 (Base64 url-safe 인코딩, 패딩(‘=’) 포함)
parameter	hci	암호화된 정보주체 식별값	예	String(64)	(nonce \|\| 정보주체 CI)의 SHA-256 해시값

응답 메세지 명세

**응답 메시지 명세**
HTTP유형명, HTTP항목명, HTTP항목설명, 필수여부, 항목자료유형명, API상세설명
HTTP유형명	HTTP항목명	HTTP항목설명	필수여부	항목자료유형명	API상세설명
parameter	api_tx_id	거래고유번호	예	String(36)	거래고유번호 • 요청시 전달받은 거래고유번호 헤더값과 동일한 값 • 헤더값은 리다이렉트 되지 않으므로 다른 API와 달리 parameter로 거래고유번호 회신
parameter	code	인가코드	예	String(128)	발급한 인가코드(Authorization code)
parameter	state	상태값	예	String(40)	요청 Parameter로 전달받은 'state'와 동일한 값 설정

기본정보

API코드

AT005

API URL 주소

/v1/oauth/2.0/token

API아이디

전송요구-005

API명

개별인증 ID 토큰 발급

HTTP메서드명

POST

사용여부

예

API제공자명

정보전송자

API요청자명

정보수신자

HTTP요청유형명

application/x-www-form-urlencoded ※ (참고) charset=UTF-8

HTTP응답유형명

application/json; charset=UTF-8

API설명

정보전송자는 정보수신자에게 정보주체에 해당하는 ID 토큰 발급

요청 메세지 명세

**응답 메시지 명세**
HTTP유형명, HTTP항목명, HTTP항목설명, 필수여부, 항목자료유형명, 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)	권한부여 방식 • 'authorization_code’ 고정값
body	code	인가코드	예	String(128)	발급한 인가코드
body	client_id	클라이언트 ID	예	String(32)	지원플랫폼에 등록된 자격증명
body	client_secret	클라이언트 Secret	예	String(50)	지원플랫폼에 등록된 자격증명(보안을 위해 추가 확인하는 값)
body	redirect_uri	리다이렉트 URI	예	String(100)	마이데이터 플랫폼에 마이데이터 서비스 등록 시 입력한 Redirect URI • URL 인코딩 필요 (정보전송자는 디코딩 후 검증)

응답 메세지 명세

**응답 메시지 명세**
HTTP유형명, HTTP항목명, HTTP항목설명, 필수여부, 항목자료유형명, API상세설명
HTTP유형명	HTTP항목명	HTTP항목설명	필수여부	항목자료유형명	API상세설명
header	X-Api-Tx-Id	거래고유번호	예	String(36)	거래고유번호
body	rsp_code	세부 응답코드	예	String(5)	API 처리결과코드
body	rsp_msg	세부 응답메시지	예	String(1550)	응답코드에 해당하는 메시지
body	expire_in	ID 토큰 유효기간	예	String(9)	ID 토큰 유효기간(단위: 초)
body	id_token	ID 토큰	예	String(1500)	정보주체에 해당되는 ID 토큰 값
body	token_type	접근토큰 유형	예	String(6)	접근토큰 유형 • 'Bearer' 고정값

기본정보

API코드

AT006

API URL 주소

/v1/oauth/2.0/token

API아이디

전송요구-006

API명

접근토큰 갱신

HTTP메서드명

POST

사용여부

예

API제공자명

중계 전문기관

API요청자명

정보수신자

HTTP요청유형명

application/x-www-form-urlencoded ※ (참고) charset=UTF-8

HTTP응답유형명

application/json; charset=UTF-8

API설명

접근토큰 발급 시 수신한 갱신토큰을 이용하여 새로운 접근토큰과 갱신토큰을 발급

요청 메세지 명세

**응답 메시지 명세**
HTTP유형명, HTTP항목명, HTTP항목설명, 필수여부, 항목자료유형명, 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(13)	권한부여방식 • ‘refresh_token’ 고정값
body	refresh_token	갱신토큰	예	String(1500)	갱신토큰
body	client_id	클라이언트 ID	예	String(32)	지원플랫폼에 등록된 자격증명
body	client_secret	클라이언트 Secret	예	String(50)	지원플랫폼에 등록된 자격증명(보안을 위해 추가 확인하는 값)

응답 메세지 명세

**응답 메시지 명세**
HTTP유형명, HTTP항목명, HTTP항목설명, 필수여부, 항목자료유형명, API상세설명
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)	접근토큰 유효기간(단위: 초)
body	refresh_token	갱신토큰	예	String(1500)	접근토큰 갱신을 위한 토큰
body	refresh_token_expires_in	갱신토큰 유효기간	예	String(9)	갱신토큰 유효기간(단위: 초)

기본정보

API코드

AT007

API URL 주소

/v1/oauth/2.0/revoke

API아이디

전송요구-007

API명

전송요구 철회

HTTP메서드명

POST

사용여부

예

API제공자명

중계 전문기관

API요청자명

정보수신자

HTTP요청유형명

application/x-www-form-urlencoded ※ (참고) charset=UTF-8

HTTP응답유형명

application/json; charset=UTF-8

API설명

접근토큰 및 갱신토큰 폐기 • 전송요구를 통해 발급받은 접근토큰 및 갱신토큰을 유효기간 만료 전 폐기하기 위한 API (정보주체가 전송요구 철회하기 위함) • 접근토큰 페기시 갱신토큰 또한 함께 폐기

요청 메세지 명세

**응답 메시지 명세**
HTTP유형명, HTTP항목명, HTTP항목설명, 필수여부, 항목자료유형명, 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	token	폐기하고자 하는 토큰	예	String(1500)	폐기하고자 하는 접근 토큰 또는 갱신 토큰 ※ 토큰유형에 관계없이 해당 전송요구 철회
body	client_id	클라이언트 ID	예	String(32)	지원플랫폼에 등록된 자격증명
body	client_secret	클라이언트 Secret	예	String(50)	지원플랫폼에 등록된 자격증명(보안을 위해 추가 확인하는 값)

응답 메세지 명세

**응답 메시지 명세**
HTTP유형명, HTTP항목명, HTTP항목설명, 필수여부, 항목자료유형명, API상세설명
HTTP유형명	HTTP항목명	HTTP항목설명	필수여부	항목자료유형명	API상세설명
header	X-Api-Tx-Id	거래고유번호	예	String(36)	거래고유번호
body	rsp_code	세부 응답코드	예	String(5)	API 처리결과코드
body	rsp_msg	세부 응답메시지	예	String(1550)	세부 응답메시지