개발자 문서
API 레퍼런스

사업장

1. 사업장 기본정보 조회nhis_edi.business.basic_info

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

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

로그인 세션의 사업장 기본정보(business·insurance_symbols)를 target_context에서 조회합니다.

  • 로그인을 먼저 호출하고 업무 화면 진입까지 마친 뒤 호출합니다. [국민건강보험공단 EDI 로그인]
  • result.data.error_code=BUSINESS_BASIC_INFO_EMPTY.
  • params 는 빈 객체로 보내도 호출됩니다.
Request
순번변수명필수설명
AuthorizationYAPI 자격증명입니다. client_id 와 client_secret 을 콜론으로 이어 Base64 로 인코딩해 보냅니다.

형식 : Basic base64("{client_id}:{client_secret}")

[참고] 인증

X-Env-ScopeY호출 환경입니다.
  • sandbox샌드박스 — 모의 응답
  • real_test데모 — 하루 100 사용 토큰
  • production정식 — 유료 플랜 전용

[참고] 환경

Idempotency-KeyY재시도 식별 키입니다. 같은 키와 같은 본문으로 다시 호출하면 기존 작업이 그대로 반환됩니다. ASCII 문자만 사용하며 UUID v4 를 권장합니다. 고객 정보는 넣지 않습니다.

[참고] 재시도

Content-TypeY요청 본문 형식입니다.
  • application/json고정값 (기본값)
X-Trace-IdN추적 아이디입니다. 지정하지 않으면 서버가 발급합니다.
순번변수명타입길이필수설명
providerstring-Y호출할 기관입니다.
  • nhis_edi이 API 고정값 (기본값)

예시 : nhis_edi

actionstring-Y호출할 작업입니다.
  • nhis_edi.business.basic_info이 API 고정값 (기본값)

예시 : nhis_edi.business.basic_info

account_link_idstring36조건부등록한 자격증명을 가리키는 아이디입니다. 생략하면 이 계정이 그 기관에 등록한 자격증명 중 대표로 지정한 것이 쓰입니다. 대표가 없으면 등록한 자격증명이 하나뿐일 때만 자동으로 선택되고, 둘 이상이면 직접 지정해야 합니다.

형식 : UUID v4

[참고] 자격증명 등록

paramsobject-N작업 파라미터입니다. 이 API 는 빈 객체로 호출할 수 있습니다.
encrypted_fieldsobject-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-basic_info-001' \
  --header 'Content-Type: application/json' \
  --data '{
  "provider": "nhis_edi",
  "action": "nhis_edi.business.basic_info",
  "account_link_id": "9b4c3a2f-0000-4000-8000-000000000000",
  "params": {}
}'
Response
  • business·insurance_symbols 필드를 확인합니다.
순번변수명설명
business사업장 기본정보 객체
insurance_symbols보험 기호 목록 배열
business_datasets시스템 dataset을 제외한 업무 dataset
download_contract다운로드 기능 계약
filters실제 적용된 조회 조건
received_count받은문서 결과 수
row_count결과 행 수
rows업무 결과 행 목록
sent_count보낸문서 결과 수
source_url원천 NHIS EDI URL
status_codeHTTP 또는 업무 상태 코드
summary합계·건수 요약
json
// result.data
{
  "phase": "detail",
  "success": true,
  "business": {
    "unb_no": "12345678901",
    "firm_sym": "12345678",
    "efirm_sym": "[REDACTED]",
    "firm_name": "예시 주식회사",
    "goji_chasu": "1",
    "finance_code": "00",
    "unit_firm_sym": "000",
    "firm_management_no": "12345678901",
    "representative_name": "홍길동",
    "representative_jumin_no": "0000000000000",
    "business_registration_no": "1234567890"
  },
  "screen_id": "WE::WETC_110.xfdl",
  "error_code": null,
  "route_kind": "live_session_context",
  "feature_name": "nhis_edi_business_basic_info",
  "workflow_step": "business_basic_info_loaded",
  "source_evidence": {
    "screenshot": "20260605_090946_lookup_main_basic_info.png",
    "context_datasets": [
      "ds_Init",
      "ds_Si4nFirmInfo",
      "ds_upCond",
      "ds_noticeChk"
    ],
    "playwright_probe": "nhis_edi_lookup_surfaces_probe_20260605_090946.json"
  },
  "insurance_symbols": {
    "health": "12345678901",
    "pension": "12345678901",
    "employment": "12345678901",
    "industrial_accident": "12345678901"
  },
  "implementation_status": null
}