v1

latestOpenAPI 3.0.02026-07-2457351270.1 KB
USER API

템플릿으로 서명 요청

미리 만들어둔 템플릿으로 서명요청을 보냅니다.
템플릿에 문서 이름, 서명자 정보, 추가 인증, 추가내용 입력 값을 추가로 적용해 서명요청을 할 수 있습니다.

post/documents/request-with-template

Request body

templateIdstring required

모두싸인에 미리 만들어 둔 템플릿의 ID

brandIdstring

브랜드 ID

Example request

{
  "templateId": "TEMPLATE_ID",
  "document": {
    "title": "2020_근로계약서_홍길동",
    "fileOpenPassword": "password1234",
    "participantMappings": [
      {
        "role": "근로자",
        "name": "김모두",
        "signingMethod": {
          "type": " ",
          "value": "modu.kim@modusign.co.kr / 01012345678"
        },
        "signingDuration": 20160,
        "requesterMessage": "서명해 주세요.",
        "verification": {
          "password": {
            "value": "password1234"
          },
          "mobileIdentification": {
            "name": "김모두",
            "phoneNumber": "01012345678"
          },
          "dCert": {
            "name": "주식회사 모두싸인",
            "bizNumber": "1231212345"
          }
        },
        "attachmentRequests": [
          {
            "dataLabel": "첨부파일 1"
          }
        ]
      }
    ],
    "requesterInputMappings": [
      {
        "dataLabel": "기타사항",
        "value": "기타사항입니다."
      }
    ],
    "requesterAttachmentMappings": [
      {
        "dataLabel": "첨부파일_1",
        "file": {
          "name": "첨부파일_1"
        }
      }
    ],
    "carbonCopies": [
      {
        "contact": "01000000000 or example@modusign.co.kr",
        "locale": "ko"
      }
    ],
    "auditTrail": {
      "locales": [
        [
          "ko",
          "en"
        ]
      ]
    }
  }
}

Response

idstring required

문서 ID

titlestring required

문서 제목

status'ON_GOING' | 'MODIFYING' | 'APPROVAL_PENDING' | 'DRAFT' | 'ON_PROCESSING' | 'PROCESSING_FAILED' | 'ABORTED' | 'COMPLETED' | 'SCHEDULED' required

문서 상태:

  • DRAFT - 작성 중* SCHEDULED - 전송 예약 중
  • ON_GOING - 서명/열람 진행 중
  • MODIFYING - 수정 중
  • APPROVAL_PENDING - 결재 대기 중
  • ON_PROCESSING - 문서 처리 중
  • PROCESSING_FAILED - 문서 처리 실패
  • ABORTED - 서명/열람 중단됨
  • COMPLETED - 모든 서명/열람 완료
currentSigningOrderinteger required

현재 참여 차례

accessibleByParticipantboolean required

문서 중단 시 요청자 외의 참여자들의 문서 파일 접근 가능 여부

updatedAtstring date required

마지막 업데이트 시간

createdAtstring date required

문서 생성 시간

startedAtstring date nullable required

참여 요청 시간

brandIdstring

브랜드 ID