조회

1. 연금 지원금 환수 결정 조회nps_edi.b1.lookups.pension_support_recovery_decisions.search

POSThttps://api.xdata.kr/v1/jobsX-Env-Scope: sandbox

샌드박스입니다. 실제 기관을 호출하지 않는 모의 응답이며 일일 한도가 없습니다.

연금 지원금 환수·징수 결정 내역을 검색합니다.

로그인을 먼저 호출해 세션을 만든 뒤, 같은 account_link_id 로 호출합니다. [국민연금공단 EDI 로그인]
implementation_status=support_recovery_decisions_empty.
recovery_decision_year_month 미입력 시 당월 YYYYMM.

Request

변수명	필수	설명
Authorization	Y	API 자격증명입니다. client_id 와 client_secret 을 콜론으로 이어 Base64 로 인코딩해 보냅니다. 형식 : Basic base64("{client_id}:{client_secret}") [참고] 인증
X-Env-Scope	Y	호출 환경입니다. `sandbox`샌드박스 — 모의 응답 `real_test`데모 — 하루 100 사용 토큰 `production`정식 — 유료 플랜 전용 [참고] 환경
Idempotency-Key	Y	재시도 식별 키입니다. 같은 키와 같은 본문으로 다시 호출하면 기존 작업이 그대로 반환됩니다. ASCII 문자만 사용하며 UUID v4 를 권장합니다. 고객 정보는 넣지 않습니다. [참고] 재시도
Content-Type	Y	요청 본문 형식입니다. `application/json`고정값 (기본값)
X-Trace-Id	N	추적 아이디입니다. 지정하지 않으면 서버가 발급합니다.

변수명	타입	길이	필수	설명
provider	string	-	Y	호출할 기관입니다. `nps_edi`이 API 고정값 (기본값) 예시 : nps_edi
action	string	-	Y	호출할 작업입니다. `nps_edi.b1.lookups.pension_support_recovery_decisions.search`이 API 고정값 (기본값) 예시 : nps_edi.b1.lookups.pension_support_recovery_decisions.search
account_link_id	string	36	조건부	등록한 자격증명을 가리키는 아이디입니다. 생략하면 이 계정이 그 기관에 등록한 자격증명 중 대표로 지정한 것이 쓰입니다. 대표가 없으면 등록한 자격증명이 하나뿐일 때만 자동으로 선택되고, 둘 이상이면 직접 지정해야 합니다. 형식 : UUID v4 [참고] 자격증명 등록
params	object	-	Y	작업 파라미터입니다. 아래 params 파라미터 표의 필수 항목을 채워 보냅니다.
encrypted_fields	object	-	N	민감한 params 값을 RSA-OAEP-256 으로 암호화해 담는 객체입니다. 서버가 복호화해 params 에 합칩니다. 같은 이름을 params 와 함께 쓰지 않습니다. [참고] 암호화

순번	변수명	타입	길이	필수	설명
	recovery_decision_year_month	string	6	N	환수 결정 연월 미입력 시 당월 형식 : YYYYMM

bash

curl --request POST \
  --url 'https://api.xdata.kr/v1/jobs' \
  --header 'Authorization: Basic {base64(client_id:client_secret)}' \
  --header 'X-Env-Scope: sandbox' \
  --header 'Idempotency-Key: demo-search-001' \
  --header 'Content-Type: application/json' \
  --data '{
  "provider": "nps_edi",
  "action": "nps_edi.b1.lookups.pension_support_recovery_decisions.search",
  "account_link_id": "9b4c3a2f-0000-4000-8000-000000000000",
  "params": {}
}'

Response

rows·recovery_details를 확인합니다.

순번	변수명	설명
	rows	환수·징수 결정 내역 행 배열
	recovery_details	환수 상세 정보 객체
	workplace	사업장 정보 (사업장관리번호, 사업자번호, 연금번호, 사업장명, 지사, 가입자 수)
	search	이번 조회에 쓰인 조회 조건
	summary	환수 결정 요약 (결정 연월과 금액)

json

// result.data
{
  "rows": [
    {
      "row_index": 0,
      "row_key": "..."
    }
  ],
  "recovery_details": [],
  "workplace": {},
  "search": {},
  "summary": {}
}

2. 사업장 보험료 고지 조회(룩업)nps_edi.b1.lookups.workplace_premium_notices.search

POSThttps://api.xdata.kr/v1/jobsX-Env-Scope: sandbox

샌드박스입니다. 실제 기관을 호출하지 않는 모의 응답이며 일일 한도가 없습니다.

사업장 보험료 룩업 화면(UHJP0001M0)의 요약(summary)과 행(rows)을 조회합니다. 고지 검색(pension_notices.search)과는 다른 화면입니다.

로그인을 먼저 호출합니다. 별도 선택 단계는 필요하지 않습니다. [국민연금공단 EDI 로그인]
rows가 비면 implementation_status=workplace_premium_overpayment_empty, error_code=null.
params 는 읽지 않습니다. 빈 객체로 보냅니다.

Request

변수명	필수	설명
Authorization	Y	API 자격증명입니다. client_id 와 client_secret 을 콜론으로 이어 Base64 로 인코딩해 보냅니다. 형식 : Basic base64("{client_id}:{client_secret}") [참고] 인증
X-Env-Scope	Y	호출 환경입니다. `sandbox`샌드박스 — 모의 응답 `real_test`데모 — 하루 100 사용 토큰 `production`정식 — 유료 플랜 전용 [참고] 환경
Idempotency-Key	Y	재시도 식별 키입니다. 같은 키와 같은 본문으로 다시 호출하면 기존 작업이 그대로 반환됩니다. ASCII 문자만 사용하며 UUID v4 를 권장합니다. 고객 정보는 넣지 않습니다. [참고] 재시도
Content-Type	Y	요청 본문 형식입니다. `application/json`고정값 (기본값)
X-Trace-Id	N	추적 아이디입니다. 지정하지 않으면 서버가 발급합니다.

변수명	타입	길이	필수	설명
provider	string	-	Y	호출할 기관입니다. `nps_edi`이 API 고정값 (기본값) 예시 : nps_edi
action	string	-	Y	호출할 작업입니다. `nps_edi.b1.lookups.workplace_premium_notices.search`이 API 고정값 (기본값) 예시 : nps_edi.b1.lookups.workplace_premium_notices.search
account_link_id	string	36	조건부	등록한 자격증명을 가리키는 아이디입니다. 생략하면 이 계정이 그 기관에 등록한 자격증명 중 대표로 지정한 것이 쓰입니다. 대표가 없으면 등록한 자격증명이 하나뿐일 때만 자동으로 선택되고, 둘 이상이면 직접 지정해야 합니다. 형식 : UUID v4 [참고] 자격증명 등록
params	object	-	N	작업 파라미터입니다. 이 API 는 빈 객체로 호출할 수 있습니다.
encrypted_fields	object	-	N	민감한 params 값을 RSA-OAEP-256 으로 암호화해 담는 객체입니다. 서버가 복호화해 params 에 합칩니다. 같은 이름을 params 와 함께 쓰지 않습니다. [참고] 암호화

추가 파라미터가 없습니다. params 는 {} 로 보냅니다.

bash

curl --request POST \
  --url 'https://api.xdata.kr/v1/jobs' \
  --header 'Authorization: Basic {base64(client_id:client_secret)}' \
  --header 'X-Env-Scope: sandbox' \
  --header 'Idempotency-Key: demo-search-001' \
  --header 'Content-Type: application/json' \
  --data '{
  "provider": "nps_edi",
  "action": "nps_edi.b1.lookups.workplace_premium_notices.search",
  "account_link_id": "9b4c3a2f-0000-4000-8000-000000000000",
  "params": {}
}'

Response

summary·rows를 확인합니다. summary 에는 message · total_payment_amount · row_count · payer_no 가 담깁니다.

순번	변수명	설명
	summary	요약 객체 (message · total_payment_amount · row_count · payer_no)
	rows	조회 행 배열
	summary_rows	요약 원본 행 배열
	workplace	사업장 정보 객체
	search	이번 조회에 쓰인 조회 조건

json

// result.data
{
  "summary": {},
  "rows": [
    {
      "row_index": 0,
      "row_key": "..."
    }
  ],
  "summary_rows": [],
  "workplace": {},
  "search": {}
}

3. 사업장 보험료 지원 룩업 상세nps_edi.b1.lookups.workplace_premium_support.details

POSThttps://api.xdata.kr/v1/jobsX-Env-Scope: sandbox

샌드박스입니다. 실제 기관을 호출하지 않는 모의 응답이며 일일 한도가 없습니다.

사업장 보험료 지원금 룩업(UHJP0004M0) — 가입자 기간 지원과 월별 결정 지원을 조회합니다.

로그인을 먼저 호출합니다. 고지 선택 단계는 필요하지 않습니다. [국민연금공단 EDI 로그인]
implementation_status=workplace_premium_support_empty, error_code=null.
연월을 지정하지 않으면 당월로 조회합니다. params 는 빈 객체로 보내도 호출됩니다.

Request

변수명	필수	설명
Authorization	Y	API 자격증명입니다. client_id 와 client_secret 을 콜론으로 이어 Base64 로 인코딩해 보냅니다. 형식 : Basic base64("{client_id}:{client_secret}") [참고] 인증
X-Env-Scope	Y	호출 환경입니다. `sandbox`샌드박스 — 모의 응답 `real_test`데모 — 하루 100 사용 토큰 `production`정식 — 유료 플랜 전용 [참고] 환경
Idempotency-Key	Y	재시도 식별 키입니다. 같은 키와 같은 본문으로 다시 호출하면 기존 작업이 그대로 반환됩니다. ASCII 문자만 사용하며 UUID v4 를 권장합니다. 고객 정보는 넣지 않습니다. [참고] 재시도
Content-Type	Y	요청 본문 형식입니다. `application/json`고정값 (기본값)
X-Trace-Id	N	추적 아이디입니다. 지정하지 않으면 서버가 발급합니다.

변수명	타입	길이	필수	설명
provider	string	-	Y	호출할 기관입니다. `nps_edi`이 API 고정값 (기본값) 예시 : nps_edi
action	string	-	Y	호출할 작업입니다. `nps_edi.b1.lookups.workplace_premium_support.details`이 API 고정값 (기본값) 예시 : nps_edi.b1.lookups.workplace_premium_support.details
account_link_id	string	36	조건부	등록한 자격증명을 가리키는 아이디입니다. 생략하면 이 계정이 그 기관에 등록한 자격증명 중 대표로 지정한 것이 쓰입니다. 대표가 없으면 등록한 자격증명이 하나뿐일 때만 자동으로 선택되고, 둘 이상이면 직접 지정해야 합니다. 형식 : UUID v4 [참고] 자격증명 등록
params	object	-	Y	작업 파라미터입니다. 아래 params 파라미터 표의 필수 항목을 채워 보냅니다.
encrypted_fields	object	-	N	민감한 params 값을 RSA-OAEP-256 으로 암호화해 담는 객체입니다. 서버가 복호화해 params 에 합칩니다. 같은 이름을 params 와 함께 쓰지 않습니다. [참고] 암호화

변수명	타입	길이	필수	설명
start_year_month	string	6	N	가입자 기간 조회 시작 연월 미입력 시 당월 형식 : YYYYMM
end_year_month	string	6	N	가입자 기간 조회 종료 연월 미입력 시 당월 형식 : YYYYMM
decision_year_month	string	6	N	월별 결정 지원 조회 연월 미입력 시 end_year_month 형식 : YYYYMM

bash

curl --request POST \
  --url 'https://api.xdata.kr/v1/jobs' \
  --header 'Authorization: Basic {base64(client_id:client_secret)}' \
  --header 'X-Env-Scope: sandbox' \
  --header 'Idempotency-Key: demo-details-001' \
  --header 'Content-Type: application/json' \
  --data '{
  "provider": "nps_edi",
  "action": "nps_edi.b1.lookups.workplace_premium_support.details",
  "account_link_id": "9b4c3a2f-0000-4000-8000-000000000000",
  "params": {}
}'

Response

member_support_details·monthly_support_details를 확인합니다.

순번	변수명	설명
	member_support_details	가입자 기간 지원 내역 배열
	monthly_support_details	월별 결정 지원 내역 배열
	workplace	사업장 정보 (사업장관리번호, 사업자번호, 연금번호, 사업장명, 지사, 가입자 수)
	search	이번 조회에 쓰인 조회 조건
	summary	지원 내역 요약 (가입자 행 수, 월별 행 수, 지원금 합계)
	rows	지원 내역 행 (가입자별과 월별)

json

// result.data
{
  "member_support_details": [],
  "monthly_support_details": [],
  "workplace": {},
  "search": {},
  "summary": {},
  "rows": {}
}

4. 사업장 가입자 현황 조회nps_edi.b1.lookups.workplace_subscribers.status

POSThttps://api.xdata.kr/v1/jobsX-Env-Scope: sandbox

샌드박스입니다. 실제 기관을 호출하지 않는 모의 응답이며 일일 한도가 없습니다.

사업장 가입자 현황 화면을 조회합니다. 현재 live transaction이 연결되지 않은 stub입니다.

로그인을 먼저 호출해 세션을 만든 뒤, 같은 account_link_id 로 호출합니다. [국민연금공단 EDI 로그인]
rows는 항상 빈 배열. result.data.error_code=SITE_SCREEN_HAS_NO_LIVE_TRANSACTION.
start_date·end_date 미입력 시 90일 기본. member_name으로 이름 필터.

Request

변수명	필수	설명
Authorization	Y	API 자격증명입니다. client_id 와 client_secret 을 콜론으로 이어 Base64 로 인코딩해 보냅니다. 형식 : Basic base64("{client_id}:{client_secret}") [참고] 인증
X-Env-Scope	Y	호출 환경입니다. `sandbox`샌드박스 — 모의 응답 `real_test`데모 — 하루 100 사용 토큰 `production`정식 — 유료 플랜 전용 [참고] 환경
Idempotency-Key	Y	재시도 식별 키입니다. 같은 키와 같은 본문으로 다시 호출하면 기존 작업이 그대로 반환됩니다. ASCII 문자만 사용하며 UUID v4 를 권장합니다. 고객 정보는 넣지 않습니다. [참고] 재시도
Content-Type	Y	요청 본문 형식입니다. `application/json`고정값 (기본값)
X-Trace-Id	N	추적 아이디입니다. 지정하지 않으면 서버가 발급합니다.

변수명	타입	길이	필수	설명
provider	string	-	Y	호출할 기관입니다. `nps_edi`이 API 고정값 (기본값) 예시 : nps_edi
action	string	-	Y	호출할 작업입니다. `nps_edi.b1.lookups.workplace_subscribers.status`이 API 고정값 (기본값) 예시 : nps_edi.b1.lookups.workplace_subscribers.status
account_link_id	string	36	조건부	등록한 자격증명을 가리키는 아이디입니다. 생략하면 이 계정이 그 기관에 등록한 자격증명 중 대표로 지정한 것이 쓰입니다. 대표가 없으면 등록한 자격증명이 하나뿐일 때만 자동으로 선택되고, 둘 이상이면 직접 지정해야 합니다. 형식 : UUID v4 [참고] 자격증명 등록
params	object	-	Y	작업 파라미터입니다. 아래 params 파라미터 표의 필수 항목을 채워 보냅니다.
encrypted_fields	object	-	N	민감한 params 값을 RSA-OAEP-256 으로 암호화해 담는 객체입니다. 서버가 복호화해 params 에 합칩니다. 같은 이름을 params 와 함께 쓰지 않습니다. [참고] 암호화

변수명	타입	필수	설명
member_name	string	N	가입자명 부분 일치 필터
page_no	number	N	페이지 번호. 기본 1
page_per_count	number	N	페이지당 행 수. 기본 10

bash

curl --request POST \
  --url 'https://api.xdata.kr/v1/jobs' \
  --header 'Authorization: Basic {base64(client_id:client_secret)}' \
  --header 'X-Env-Scope: sandbox' \
  --header 'Idempotency-Key: demo-status-001' \
  --header 'Content-Type: application/json' \
  --data '{
  "provider": "nps_edi",
  "action": "nps_edi.b1.lookups.workplace_subscribers.status",
  "account_link_id": "9b4c3a2f-0000-4000-8000-000000000000",
  "params": {}
}'

Response

순번	변수명	설명
	rows	가입자 현황 행 배열 (현재 항상 빈 배열)
	workplace	사업장 정보 (사업장관리번호, 사업자번호, 연금번호, 사업장명, 지사, 가입자 수)
	search	이번 조회에 쓰인 조회 조건
	summary	가입자 요약 (가입자 수와 행 수)
	subscribers	가입자 행
	page	페이지 정보

json

// result.data
{
  "rows": [
    {
      "row_index": 0,
      "row_key": "..."
    }
  ],
  "workplace": {},
  "search": {},
  "summary": {},
  "subscribers": [],
  "page": {}
}