--- updatedAt: 2026-04-22T09:48:12.000Z agentTools: projectIndex: https://developers.modusign.co.kr/llms.txt --- # 문서 이력 조회 # OpenAPI definition ```json { "openapi": "3.0.0", "paths": { "/documents/{documentId}/histories": { "get": { "operationId": "DocumentController_getAllDocumentHistories", "parameters": [ { "name": "documentId", "required": true, "in": "path", "description": "문서 ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAllDocumentHistoriesResponseDto" } } } } }, "security": [ { "Basic": [] }, { "Bearer": [] } ], "summary": "문서 이력 조회", "tags": [ "USER API" ] } } }, "info": { "title": "MODUSIGN API", "description": "", "version": "1.0.0", "contact": {} }, "servers": [ { "url": "https://api.modusign.co.kr", "description": "production" } ], "components": { "securitySchemes": { "Bearer": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" }, "Basic": { "type": "http", "scheme": "basic" } }, "schemas": { "Environment": { "type": "object", "properties": { "userIp": { "type": "string", "description": "발생자의 IP 주소", "nullable": true, "example": "255.255.255.0" }, "userAgent": { "type": "string", "description": "발생자 브라우저의 user-agent", "example": "Mozilla/5.0 (Windows; U; Windows NT 5.1; de-CH)..." } }, "required": [ "userIp", "userAgent" ] }, "Generator": { "type": "object", "properties": { "type": { "type": "string", "description": "발생자의 종류\n* `REQUESTER` - 요청자\n* `ADMIN` - 관리자\n* `PARTICIPANT` - 참여자\n* `SYSTEM` - 시스템", "nullable": true, "enum": [ "SYSTEM", "PARTICIPANT", "REQUESTER", "ADMIN" ] }, "name": { "type": "string", "description": "발생자의 이름", "nullable": true }, "contact": { "type": "string", "description": "발생자의 연락처 (이메일 또는 전화번호)", "nullable": true }, "environment": { "description": "발생자의 환경", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/Environment" } ] } }, "required": [ "type", "name", "contact", "environment" ] }, "Target": { "type": "object", "properties": { "type": { "type": "string", "description": "이력의 대상자 종류", "enum": [ "PARTICIPANT" ] }, "name": { "type": "string", "description": "대상자의 이름" }, "contact": { "type": "string", "description": "대상자의 연락처 (이메일 또는 전화번호)" } }, "required": [ "type", "name", "contact" ] }, "Detail": { "type": "object", "properties": { "authType": { "type": "string", "description": "인증 수단 (action이 `VERIFICATION_FAILURE`, `VERIFICATION_EXCEEDED`, `VERIFICATION_COMPLETED` 일 때)", "enum": [ "PASSWORD", "MOBILE", "D_CERT" ] }, "failureCount": { "type": "number", "nullable": true, "description": "누적 실패한 횟수 (action이 `VERIFICATION_FAILURE` 일 때)" } }, "required": [ "authType", "failureCount" ] }, "HistoryDto": { "type": "object", "properties": { "message": { "type": "string", "description": "이력을 문장으로 요약한 메세지" }, "timestamp": { "format": "date-time", "type": "string", "description": "이력이 발생한 시간" }, "action": { "type": "string", "description": "이력의 액션:\n* `START_SIGNING_REQUEST` - 서명 요청 시작\n* `SIGNING_REQUEST` - 서명 요청 됨\n* `FIRST_READING_DOCUMENT_IN_SIGNING_TURN` - 서명 차례에 첫 문서 조회\n* `READING_DOCUMENT_IN_SIGNING_TURN` - 서명 차례에 문서 조회\n* `VERIFICATION_FAILURE` - 추가 인증 실패\n* `VERIFICATION_EXCEEDED` - 추가 인증 5회 실패\n* `VERIFICATION_COMPLETED` - 인증 성공\n* `SIGNING_COMPLETED` - 서명 입력\n* `SIGNING_COMPLETED_ALL` - 모든 서명 입력 완료\n* `REJECT_SIGNING` - 서명 거절\n* `CANCEL_SIGNING` - 서명 취소\n* `CANCEL_SIGNING_REQUEST` - 서명 요청 취소\n* `REMIND_SIGNING` - 서명 알림 재전송\n* `CHANGE_SIGNING_EXPIRY_DATE` - 서명 유효 기간 수정\n* `CORRECT_SIGNING` - 서명 수정\n* `SIGNING_REQUEST_TO_HOST` - 호스트에게 서명 요청\n* `START_SESSION` - 대면 서명 세션 시작\n* `START_VIEW_ONLY_REQUEST` - 열람 요청 시작\n* `VIEW_ONLY_REQUEST` - 열람 요청\n* `VIEW_ONLY_COMPLETED` - 열람 완료\n* `VIEW_ONLY_COMPLETED_ALL` - 모든 열람 완료\n* `CANCEL_VIEW_ONLY_REQUEST` - 열람 요청 취소\n* `FIRST_READING_VIEW_ONLY_IN_OWN_TURN` - 열람 요청자가 문서 처음 열람\n* `READING_VIEW_ONLY_IN_OWN_TURN` - 열람 요청자가 문서 열람\n* `REMIND_VIEW_ONLY` - 열람 재요청\n* `CHANGE_VIEWING_EXPIRY_DATE` - 열람 만료일 변경\n* `MODIFICATION_STARTED` - 수정 시작\n* `MODIFICATION_COMPLETED` - 수정 완료\n* `MODIFICATION_CANCELED` - 수정 되돌리기\n* `SIGNER_INFO_CHANGED` - 서명자 정보 변경\n* `SIGNER_ADDED` - 서명자 추가\n* `SIGNER_REMOVED` - 서명자 삭제\n* `SIGNERS_CHANGED` - 서명자 변경 (통합)\n* `DOCUMENT_SETTINGS_CHANGED` - 문서 설정 변경 (통합)\n* `SIGNER_ATTACHMENT_CHANGED` - 서명자 첨부 변경\n* `SIGNER_ORDER_CHANGED` - 서명 순서 변경\n* `FIELD_MODIFIED` - 입력란 변경\n* `REQUESTER_FIELD_MODIFIED` - 요청자 편집 필드 변경\n* `FIELD_GROUP_CHANGED` - 필드 그룹 변경\n* `TITLE_CHANGED` - 제목 변경\n* `ATTACHMENT_CHANGED` - 첨부 변경\n* `VERIFICATION_CHANGED` - 인증수단 변경\n* `DOCUMENT_FILE_CHANGED` - 원본 파일 변경\n* `CARBON_COPY_CHANGED` - 참조인 변경\n* `PDF_PASSWORD_CHANGED` - PDF 비밀번호 변경\n* `SIGNING_PERIOD_CHANGED` - 서명 기한 변경\n* `CHANGE_PARTICIPANT_DELEGATION_PERIOD` - 참여자 대리 기간 변경\n* `INTERRUPT_PARTICIPANT_DELEGATION` - 참여자 대리 중단", "enum": [ "START_SIGNING_REQUEST", "SIGNING_REQUEST", "SIGNING_REQUEST_TO_HOST", "FIRST_READING_DOCUMENT_IN_SIGNING_TURN", "READING_DOCUMENT_IN_SIGNING_TURN", "VERIFICATION_FAILURE", "VERIFICATION_EXCEEDED", "VERIFICATION_COMPLETED", "SIGNING_COMPLETED", "SIGNING_COMPLETED_ALL", "REJECT_SIGNING", "CANCEL_SIGNING", "CANCEL_SIGNING_REQUEST", "REMIND_SIGNING", "CHANGE_SIGNING_EXPIRY_DATE", "CORRECT_SIGNING", "START_SESSION", "START_VIEW_ONLY_REQUEST", "VIEW_ONLY_REQUEST", "VIEW_ONLY_COMPLETED", "VIEW_ONLY_COMPLETED_ALL", "CANCEL_VIEW_ONLY_REQUEST", "FIRST_READING_VIEW_ONLY_IN_OWN_TURN", "READING_VIEW_ONLY_IN_OWN_TURN", "REMIND_VIEW_ONLY", "CHANGE_VIEWING_EXPIRY_DATE", "BULK_SIGNING_COMPLETED", "MODIFICATION_STARTED", "MODIFICATION_COMPLETED", "MODIFICATION_CANCELED", "SIGNER_INFO_CHANGED", "SIGNER_ADDED", "SIGNER_REMOVED", "SIGNERS_CHANGED", "DOCUMENT_SETTINGS_CHANGED", "SIGNER_ATTACHMENT_CHANGED", "SIGNER_ORDER_CHANGED", "FIELD_MODIFIED", "REQUESTER_FIELD_MODIFIED", "FIELD_GROUP_CHANGED", "TITLE_CHANGED", "ATTACHMENT_CHANGED", "VERIFICATION_CHANGED", "DOCUMENT_FILE_CHANGED", "CARBON_COPY_CHANGED", "PDF_PASSWORD_CHANGED", "SIGNING_PERIOD_CHANGED", "CHANGE_PARTICIPANT_DELEGATION_PERIOD", "INTERRUPT_PARTICIPANT_DELEGATION" ] }, "generator": { "description": "이력의 발생자", "allOf": [ { "$ref": "#/components/schemas/Generator" } ] }, "target": { "description": "이력의 대상자", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/Target" } ] }, "details": { "description": "이력의 자세한 정보", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/Detail" } ] } }, "required": [ "message", "timestamp", "action", "generator", "target", "details" ] }, "GetAllDocumentHistoriesResponseDto": { "type": "object", "properties": { "histories": { "description": "문서 이력", "type": "array", "items": { "$ref": "#/components/schemas/HistoryDto" } } }, "required": [ "histories" ] } } } } ```