DocsReferencesChangelog
Docs

문서 이력 조회

문서의 이력은 "문서 이력 조회 API" 를 통해 조회할 수 있습니다.

각 문서 이력의 기본적인 구조는 아래와 같습니다.

{ 
  // 메세지 (추상적으로 표현한 예시입니다. 실 메시지는 action마다 다릅니다)
  message: `
    ${generator.name}(${generator.contact})님이 
    ${target.name}(${target.contact})님에게
    ${additionalInfo} ${action} 하였습니다.
  `,

  // 언제
  timestamp: "2020-01-01T00:00:00.000Z",

  // 무엇을
  action: 'ACTION_NAME',

  // 누가
  generator: {
    // 기본 정보
    type: 'PARTICIPANT || REQUESTER || SYSTEM',
    name: '박길동',
    contact: '[email protected]',

    // 환경 정보
    environment: {
      userIp: '255.255.255.0',
      userAgent: 'Mozilla/5.0 (Windows; U; Windows NT 5.1; de-CH)...',
    },
  },

  // 누구에게
  target: {
    // 기본 정보
    type: 'PARTICIPANT',
    name: '박참여',
    contact: '[email protected]'
  },

  // 어떻게
  details: {
    // action이 VERIFICATION_FAILURE, VERIFICATION_EXCEEDED, VERIFICATION_COMPLETED 일 때
    authType: 'PASSWORD || MOBILE',
    // action이 VERIFICATION_FAILURE 일 때
    failureCount: 5,
  },
}

이력 예시

이력의 액션 명(ACTION_NAME) 별 이력 예시는 아래와 같습니다.

  • START_SIGNING_REQUEST - 요청자가 서명 요청 시작
  • SIGNING_REQUEST - 시스템의 서명 요청 전송
  • FIRST_READING_DOCUMENT_IN_SIGNING_TURN - 참여자의 첫 문서 조회
  • READING_DOCUMENT_IN_SIGNING_TURN - 참여자의 문서 조회
  • VERIFICATION_FAILURE - 추가 인증 실패
  • VERIFICATION_EXCEEDED - 추가 인증 5회 실패
  • VERIFICATION_COMPLETED - 인증 성공
  • SIGNING_COMPLETED - 서명 입력
  • SIGNING_COMPLETED_ALL - 모든 서명 입력 완료
  • REJECT_SIGNING - 서명 거절
  • CANCEL_SIGNING - 서명 취소
  • CANCEL_SIGNING_REQUEST - 서명 요청 취소
  • REMIND_SIGNING - 서명 알림 재전송
  • CHANGE_SIGNING_EXPIRY_DATE - 서명 유효 기간 수정
  • CORRECT_SIGNING- 서명 수정
  • 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 - 열람 만료일 변경

요청자가 서명 요청 시작

START_SIGNING_REQUEST

{
  message: '김요청([email protected])님이 서명 요청을 시작하였습니다.',
  timestamp: "2020-01-01T00:00:00.000Z",
  action: 'START_SIGNING_REQUEST',
  generator: {
    type: 'REQUESTER',
    name: '김요청',
    contact: '[email protected]',
    environment: {
      userIp: '255.255.255.0',
      userAgent: 'Mozilla/5.0 (Windows; U; Windows NT 5.1; de-CH)...'
    }
  },
  target: null,
  details: null
}

시스템의 서명 요청 전송

SIGNING_REQUEST

{
  message: '박참여([email protected])님에게 서명할 문서를 전송하였습니다.',
  timestamp: "2020-01-01T00:00:00.000Z",
  action: 'SIGNING_REQUEST',
  generator: {
    type: 'SYSTEM',
    name: null,
    contact: null,
    environment: null
  },
  target: {
    type: 'PARTICIPANT',
    name: '박참여',
    contact: '[email protected]'
  },
  details: null
}

참여자의 첫 문서 조회

FIRST_READING_DOCUMENT_IN_SIGNING_TURN

{
  message: '박참여([email protected])님이 문서의 내용을 확인하였습니다.',
  timestamp: "2020-01-01T00:00:00.000Z",
  type: 'FIRST_READING_DOCUMENT_IN_SIGNING_TURN',
  generator: {
    type: 'PARTICIPANT',
    name: '박참여',
    contact: '[email protected]',
    environment: {
      userIp: '255.255.255.0',
      userAgent: 'Mozilla/5.0 (Windows; U; Windows NT 5.1; de-CH)...'
    }
  },
  target: null,
  details: null
}

참여자의 문서 조회

READING_DOCUMENT_IN_SIGNING_TURN

{
  message: '박참여([email protected])님이 문서의 내용을 확인하였습니다.',
  timestamp: "2020-01-01T00:00:00.000Z",
  type: 'READING_DOCUMENT_IN_SIGNING_TURN',
  generator: {
    type: 'PARTICIPANT',
    name: '박참여',
    contact: '[email protected]',
    environment: {
      userIp: '255.255.255.0',
      userAgent: 'Mozilla/5.0 (Windows; U; Windows NT 5.1; de-CH)...'
    }
  },
  target: null,
  details: null
}

참여자의 인증 실패

VERIFICATION_FAILURE

{
  message: '박참여([email protected])님이 접근 암호 인증을 2회 실패하였습니다.',
  timestamp: "2020-01-01T00:00:00.000Z",
  action: 'VERIFICATION_FAILURE',
  generator: {
    type: 'PARTICIPANT',
    name: '박참여',
    contact: '[email protected]',
    environment: {
      userIp: '255.255.255.0',
      userAgent: 'Mozilla/5.0 (Windows; U; Windows NT 5.1; de-CH)...'
    }
  },
  target: null,
  details: {
    authType: 'PASSWORD',
    failureCount: 2
  }
}

참여자의 인증 최대 실패 횟수 초과

VERIFICATION_EXCEEDED

{
  message: '박참여([email protected])님이 접근 암호 인증의 최대 실패 횟수를 초과하였습니다.',
  timestamp: "2020-01-01T00:00:00.000Z",
  action: 'VERIFICATION_EXCEEDED',
  generator: {
    type: 'PARTICIPANT',
    name: '박참여',
    contact: '[email protected]',
    environment: {
      userIp: '255.255.255.0',
      userAgent: 'Mozilla/5.0 (Windows; U; Windows NT 5.1; de-CH)...'
    }
  },
  target: null,
  details: {
    authType: 'PASSWORD',
    failureCount: null
  }
}

참여자의 인증 성공

VERIFICATION_COMPLETED

{
  message: '박참여([email protected])님이 접근 암호 인증을 완료하였습니다.',
  timestamp: "2020-01-01T00:00:00.000Z",
  action: 'VERIFICATION_COMPLETED',
  generator: {
    type: 'PARTICIPANT',
    name: '박참여',
    contact: '[email protected]',
    environment: {
      userIp: '255.255.255.0',
      userAgent: 'Mozilla/5.0 (Windows; U; Windows NT 5.1; de-CH)...'
    }
  },
  target: null,
  details: {
    authType: 'PASSWORD',
    failureCount: null
  }
}

참여자의 서명 입력

SIGNING_COMPLETED

{
  message: '박참여([email protected])님이 문서에 서명하였습니다.',
  timestamp: "2020-01-01T00:00:00.000Z",
  action: 'SIGNING_COMPLETED',
  generator: {
    type: 'PARTICIPANT',
    name: '박참여',
    contact: '[email protected]',
    environment: {
      userIp: '255.255.255.0',
      userAgent: 'Mozilla/5.0 (Windows; U; Windows NT 5.1; de-CH)...'
    }
  },
  target: null,
  details: null
}

시스템이 모든 서명 완료 확인

SIGNING_COMPLETED_ALL

{
  message: '문서의 모든 서명이 완료되었으며, 모든 서명 참여자에게 완료된 문서와 감사 추적 인증서를 전송하였습니다.',
  timestamp: "2020-01-01T00:00:00.000Z",
  action: 'SIGNING_COMPLETED_ALL',
  generator: {
    type: 'SYSTEM',
    name: null,
    contact: null,
    environment: null
  },
  target: null,
  details: null
}

참여자의 서명 거절

REJECT_SIGNING

{
  message: '박참여([email protected])님이 서명을 거절하였습니다.',
  timestamp: "2020-01-01T00:00:00.000Z",
  action: 'REJECT_SIGNING',
  generator: {
    type: 'PARTICIPANT',
    name: '박참여',
    contact: '[email protected]',
    environment: {
      userIp: '255.255.255.0',
      userAgent: 'Mozilla/5.0 (Windows; U; Windows NT 5.1; de-CH)...'
    },
  },
  target: null,
  details: null
}

참여자의 서명 취소

CANCEL_SIGNING

{
  content: '박참여([email protected])님이 서명을 취소하였습니다.',
  timestamp: "2020-01-01T00:00:00.000Z",
  action: 'CANCEL_SIGNING',
  generator: {
    type: 'PARTICIPANT',
    name: '박참여',
    contact: '[email protected]',
    environment: {
      userIp: '255.255.255.0',
      userAgent: 'Mozilla/5.0 (Windows; U; Windows NT 5.1; de-CH)...'
    },
  },
  target: null,
  details: null
}

요청자의 서명 요청 취소

CANCEL_SIGNING_REQUEST

{
  message: '김요청([email protected])님이 서명 요청을 취소하였습니다.',
  timestamp: "2020-01-01T00:00:00.000Z",
  action: 'CANCEL_SIGNING_REQUEST',
  generator: {
    type: 'REQUESTER',
    name: '김요청',
    contact: '[email protected]',
    environment: {
      userIp: '255.255.255.0',
      userAgent: 'Mozilla/5.0 (Windows; U; Windows NT 5.1; de-CH)...'
    }
  },
  target: null,
  details: null
}

요청자의 서명 요청 알림 재전송

REMIND_SIGNING

{
  message: '김요청([email protected])님이 박참여([email protected])님에게 서명할 문서를 전송하였습니다.',
  timestamp: "2020-01-01T00:00:00.000Z",
  action: 'REMIND_SIGNING',
  generator: {
    type: 'REQUESTER',
    name: '김요청',
    contact: '[email protected]',
    environment: {
      userIp: '255.255.255.0',
      userAgent: 'Mozilla/5.0 (Windows; U; Windows NT 5.1; de-CH)...'
    }
  },
  target: {
    type: 'PARTICIPANT',
    name: '박참여',
    contact: '[email protected]'
  },
  details: null
}

요청자의 서명 유효 기간 수정

CHANGE_SIGNING_EXPIRY_DATE

{
  message: '김요청([email protected])님이 박참여([email protected])님의 서명 유효기간 만료일을 변경하였습니다.',
  timestamp: "2020-01-01T00:00:00.000Z",
  action: 'CHANGE_SIGNING_EXPIRY_DATE',
  generator: {
    type: 'REQUESTER',
    name: '김요청',
    contact: '[email protected]',
    environment: {
      userIp: '255.255.255.0',
      userAgent: 'Mozilla/5.0 (Windows; U; Windows NT 5.1; de-CH)...'
    }
  },
  target: {
    type: 'PARTICIPANT',
    name: '박참여',
    contact: '[email protected]'
  },
  details: null
}

요청자가 열람 요청 시작

VIEW_ONLY_REQUEST

{
  message: '김요청([email protected])님이 열람할 문서를 전송했습니다.',
  timestamp: "2024-09-25T00:00:00.000Z",
  action: 'VIEW_ONLY_REQUEST',
  generator: {
    type: 'SYSTEM',
    name:null
    contact: null
    environment: null
    }
  },
  target: {
    type: 'PARTICIPANT',
    name: '박참여',
    contact: '[email protected]'
  },
  details: null
}

참여자가 문서 처음 열람

FIRST_READING_VIEW_ONLY_IN_OWN_TURN 

{
  message: '박열람([email protected])님이 문서 열람을 시작 했습니다.',
  timestamp: "2024-09-25T00:00:00.000Z",
  action: 'FIRST_READING_VIEW_ONLY_IN_OWN_TURN',
  generator: {
    type: 'PARTICIPANT',
    name: '박열람',
    contact: '[email protected]',
    environment: {
      userIp: '255.255.255.0',
      userAgent: 'Mozilla/5.0 (Windows; U; Windows NT 5.1; de-CH)...'
    }
  },
  target: null,
  details: null
}

참여자의 열람완료

VIEW_ONLY_COMPLETED

{
  message: '박열람([email protected])님이 문서 열람을 완료하였습니다.',
  timestamp: "2024-09-25T00:00:00.000Z",
  action: 'VIEW_ONLY_COMPLETED',
  generator: {
    type: 'PARTICIPANT',
    name: '박열람',
    contact: '[email protected]',
    environment: {
      userIp: '255.255.255.0',
      userAgent: 'Mozilla/5.0 (Windows; U; Windows NT 5.1; de-CH)...'
    }
  },
  target: null,
  details: null
}

시스템이 모든 열람 완료 확인

VIEW_ONLY_COMPLETED_ALL

{
  message: '요청자와 참조자에게 완료 알림과 문서가 전송되었습니다.',
  timestamp: "2024-09-25T00:00:00.000Z",
  action: 'VIEW_ONLY_COMPLETED_ALL',
  generator: {
    type: 'SYSTEM',
    name: null,
    contact: null,
    environment: null
  },
  target: null,
  details: null
}

Updated 29 days ago