진료 및 투약정보
POST
https://api.candiy.io/v1/nhis/treatment_record
건강보험공단 진료 및 투약정보를 조회합니다.
해당 상품은 보안숫자 추가인증 요청이 진행되는 상품이며, 보안숫자 추가인증 처리는 딥러닝을 통해 학습된 AI엔진이 캡처 이미지를 인식하여 자동 진행합니다.
(단, 3회 실패 시 보안 숫자 수동 입력이 필요합니다.)
입력부(input)
| Key | Name | Type | Description |
|---|---|---|---|
| id *required | 요청 식별 아이디(SSO(동일계정) 구분값) | String | 사용자 계정을 식별할 수 있는 유일 값 세팅 (ex. 아이디 + UUID) |
| loginTypeLevel *required | 간편인증 로그인 구분 | String | 1: 카카오톡, 3: 삼성패스, 4: 국민은행(국민인증서), |
| legalName *required | 사용자 본명 | String | 사용자 본명 |
| birthdate *required | 사용자 생년월일 | String | 생년월일(YYYYMMDD) |
| phoneNo *required | 사용자 명의 전화번호(핸드폰) | String | 숫자없이 번호만 입력 |
| telecom *required | 통신사 | String | 0: SKT(SKT알뜰폰), 1: KT(KT알뜰폰), 2: LG U+(LG U+알뜰폰) |
| startDate | 조회 시작 연도 | String | yyyy-mm-dd 형식의 날짜 (default: 1년 전) |
| endDate | 조회 종료 연도 | String | yyyy-mm-dd 형식의 날짜 (default: 오늘 날짜) |
Example
입력부 특이사항
- 최근 1년 정보를 제공합니다. 조회 시작/종료 일자 입력 시 기간내 정보만 제공합니다.
- id는 일정 시간(로그인 세션)동안 사용자 계정을 식별할 수 있는 유일 값을 지정해야 합니다. (예시: 아이디 + UUID)
추가인증 출력부(Output)
해당 상품은 추가인증이 필요합니다. 상태코드에 따라 추가인증 요청 상태를 확인할 수 있습니다.
| Key | Name | Type | Description |
|---|---|---|---|
| status | 상태코드 | String | 상태를 나타내는 상태코드 (success, error) |
|
data
|
응답 값 | Object | 실제 응답 데이터가 들어가는 응답값 |
Example
추가인증 입력부(Input)
| Key | Name | Type | Description |
|---|---|---|---|
| isContinue *required | 간편인증 | String | 0: cancel , 1: ok |
|
multiFactorInfo
*required
|
추가 인증 정보 | Object | 1차 요청 응답 값 |
Example
추가인증 처리 방식
- [기본 요청]
- 요청 : 입력부(Input) : [기본 파라미터]
- 응답 : 추가인증 출력부(Output)
- [간편인증 추가인증]
- 요청 : [기본 파라미터] + [간편인증 요청 파라미터]
- 추가인증 입력부(Input) : isContinue 입력
- 응답 : 출력부(Output)
추가인증 특이 사항
- 간편 인증 타임 아웃 4분 30초입니다.
- 간편 인증 시 인증을 완료하지 않은 경우 "Bad Request: 본인인증 절차가 완료되지 않았습니다. 먼저 본인인증을 완료해주세요." 오류가 발생합니다.
출력부(Output)
| Key | Name | Type | Description |
|---|---|---|---|
| status | 상태코드 | String | 상태를 나타내는 상태코드 (success, error) |
|
data
|
응답 값 | List | 실제 응답 데이터가 들어가는 응답값 |
