비대면 문서 시작

비대면 타입의 서식을 이용해 문서를 시작합니다.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

문서에 대한 서명 또는 작성 요청을 할 때 사용하는 API입니다.

요청 형식(Content-Type)

비대면 문서 시작 API는 입력 데이터에 따라 다음 두 가지 요청 형식을 지원합니다.

Content-Type사용 목적
application/json일반적인 문서 시작 및 필드 데이터 사전 입력
multipart/form-data문서 시작 시 첨부파일 박스에 파일을 사전 등록

첨부파일 박스에 파일을 등록하려면 multipart/form-data 형식으로 요청해야 합니다.

이때 data 항목에 기존 문서 시작 JSON을 문자열로 전달하고, 파일은 별도의 multipart 항목으로 함께 전송합니다.

기존 application/json 방식은 변경 없이 계속 사용할 수 있습니다.

필수 파라미터 안내

필수로 입력해야 하는 파라미터에 대한 설명입니다.

BODY PARAMS설명
workflow_name해당 계약서 또는 문서의 이름을 정해주시면 됩니다.
template_id숫자로 된 서식의 고유 아이디입니다. 이싸인온 서식 메뉴에서 확인할 수 있습니다.
order작성 단계입니다. 첫번째 단계는 1단계이며, 숫자로 적어주시면 됩니다.
email작성자의 이메일 또는 휴대폰 번호를 입력해주시면 됩니다.
name작성자의 이름을 입력해주세요.

휴대폰 본인 인증을 설정하실 경우, 작성자의 이름이 해당 휴대폰 명의와 같아야 합니다.

이싸인온 Field

이싸인온은 여러가지 데이터를 입력할 수 있는 Field를 제공하고 있습니다.

이싸인온 서식에 만들어 둔 필드에 미리 필요한 정보들을 입력하여 시작할 수 있습니다.

  • 필드 이름은 이싸인온 서식 내에서 확인 및 수정할 수 있습니다.

필드 별 입력 값 (value) 형식

필드에 입력할 값은 value 형식을 참고하여 입력해주세요.

field_list이싸인온 필드Value
Textbox텍스트박스value에 텍스트 값 입력
LabelBox텍스트박스 (읽기 전용)value에 텍스트 값 입력
RadioBox라디오 박스 (단일 선택)value에 "Y" 또는 "N"
CheckBox체크박스 (복수 선택)value에 "Y" 또는 "N"
DatePickerBox날짜/시간박스value에 "YYYY-MM-DD" 형식의 날짜
PictureBox사진박스value에 이미지를 base64로 인코딩한 텍스트 값
DropdownBox드롭다운 박스value에 선택 항목과 일치하는 값
AddFileBox첨부파일 박스attachment_key에 multipart 파일 키 지정

사진박스에 업로드 가능한 이미지 파일 확장자는 jpg, jpeg, png입니다. 다른 확장자 파일을 넣을 경우 문서가 열리지 않을 수 있습니다. 이미지 파일 크기는 1MB를 넘지 않아야 합니다.)


첨부파일 박스 사전 입력 안내

비대면 문서를 시작할 때 서식에 설정된 첨부파일 박스에 PDF 또는 이미지 파일을 미리 등록할 수 있습니다.

파일을 미리 등록하려면 multipart/form-data 형식으로 요청하며, field_list에 첨부파일 박스의 필드명과 파일 키를 지정합니다.

파라미터설명
name서식에 등록된 첨부파일 박스의 필드명 (예: AddFile_0)
attachment_keymultipart 요청에서 첨부파일을 식별하는 키 (예: attachment_1)

attachment_key에 지정한 값과 실제 전송하는 파일의 multipart 키가 일치해야 합니다.

첨부파일 박스에는 해당 작성자의 권한에 따라 파일이 등록됩니다. API 인증 토큰의 이메일과 해당 필드를 담당하는 수신인의 이메일이 일치해야 하며, 작성 단계의 순서와는 관계없이 등록할 수 있습니다.

첨부파일 박스 사전 요청 예제

비대면 문서 시작 시 사업자등록증과 통장사본을 각각의 첨부파일 박스에 미리 등록하는 예제입니다.

요청 형식: multipart/form-data

1. data (Text)

multipart 요청의 data 항목에 아래 JSON을 문자열로 전달합니다.

{
  "template_id": 141,
  "workflow_name": "첨부파일 사전 등록 테스트",
  "recipient_list": [
    {
      "order": 1,
      "name": "담당자",
      "email": "[email protected]"
    },
    {
      "order": 2,
      "name": "서명자",
      "email": "[email protected]"
    }
  ],
  "field_list": [
    {
      "name": "Text_0",
      "value": "일반 텍스트"
    },
    {
      "name": "AddFile_0",
      "attachment_key": "attachment_1"
    },
    {
      "name": "AddFile_1",
      "attachment_key": "attachment_2"
    }
  ]
}

참고: AddFile_0, AddFile_1은 실제 서식에 존재하는 첨부파일 박스의 필드명이어야 합니다. API 인증 토큰의 이메일과 해당 필드를 담당하는 수신인의 이메일이 일치해야 합니다.

2. 첨부파일 (File)

JSON의 attachment_key에 지정한 이름과 동일한 키로 파일을 함께 전송합니다.

Multipart 항목형식전달 값
dataText위 JSON 문자열
attachment_1File사업자등록증.pdf
attachment_2File통장사본.jpg

3. 첨부파일 박스 매칭 결과

서식 필드명attachment_key등록되는 파일
AddFile_0attachment_1사업자등록증.pdf
AddFile_1attachment_2통장사본.jpg
  • name: 서식에 등록된 첨부파일 박스의 필드명
  • attachment_key: multipart 요청에 포함된 파일을 식별하는 키

attachment_key와 실제 전송되는 파일의 multipart 키가 일치하면 해당 첨부파일 박스에 파일이 자동으로 등록됩니다.

첨부파일 박스의 작성 권한이 확인된 경우, 문서 시작 시 파일이 미리 등록되므로 이후 작성자는 해당 파일을 별도로 첨부할 필요가 없습니다.

첨부파일 제한 및 유의사항

첨부파일 박스에 파일을 사전 등록하는 경우, 기존 이싸인온 플레이어의 첨부파일 제한 및 검증 정책이 동일하게 적용됩니다.

지원 파일 형식 및 용량

항목제한 및 처리 기준
지원 파일 형식PDF, JPG, JPEG, PNG
개별 파일 최대 용량30MB
전체 첨부파일 최대 용량30MB (기존 첨부파일 포함)
PDF 파일파일 유효성 및 암호 설정 여부 검증
이미지 파일실제 파일 형식 및 정상적으로 읽을 수 있는 파일인지 검증

참고: 전체 첨부파일 용량은 개별 파일이 아닌 문서에 등록되는 첨부파일의 합계를 기준으로 합니다.

첨부파일 등록 시 검증 조건

다음 조건에 해당하면 API 요청이 거부될 수 있습니다.

  • 서식에 존재하지 않는 필드 또는 첨부파일 박스가 아닌 필드를 지정한 경우
  • 지정한 필드명으로 첨부파일 박스가 하나만 식별되지 않는 경우
  • field_list에서 필드명 또는 attachment_key가 중복된 경우
  • attachment_key와 multipart 파일 키가 일치하지 않는 경우
  • 파일이 누락되었거나 빈 파일인 경우
  • field_list에 지정되지 않은 파일을 추가로 전송한 경우
  • 동일 필드에 attachment_key와 비어 있지 않은 value를 함께 지정한 경우
  • API 토큰의 이메일과 해당 필드의 작성자 이메일이 일치하지 않는 경우
  • 이미 파일이 등록된 첨부파일 박스에 파일을 다시 등록하려는 경우
  • 지원하지 않는 파일 형식이거나 용량 제한을 초과한 경우

참고: 첨부파일 등록 권한은 작성 단계의 순서가 아닌 API 인증 토큰과 해당 필드 작성자의 이메일을 기준으로 확인합니다.


미리보기 URL

is_preview의 값에 따라 URL의 형태가 달라집니다.

is_preview 값URL
true문서가 시작되지 않고, 미리보기 URL 제공
false문서 시작 URL 제공

Response token 활용

Response에서 확인할 수 있는 token 값은 문서를 시작한 사람을 기준으로 발급 됩니다.

해당 token 값을 아래 경로 입력하여 상황에 따라 다르게 활용할 수 있습니다.

📌 https://docs.esignon.net/mail/sign?token={token}

  • 현재 문서의 진행단계의 작성자와 시작한 사람이 일치하는 경우
    • 해당 URL로 서명 가능
  • 일치하지 않는 경우
    • 해당 URL로 진행 중인 문서 확인 가능
📘

EXPORT API

문서 관련 Webhook 기능이 필요한 경우 EXPORT API 가이드를 참고해주세요.

Query Params
string
Defaults to +09:00

UTC offset 값 (±hh:mm 형식)

Body Params
string
required
length ≤ 128

문서명 (128자 제한)

integer
required

시작할 서식의 ID

string
enum
Defaults to ko

문서 전달 이메일 또는 카카오톡 메세지에 표시될 언어 (카카오톡은 ko만 가능)

Allowed:
string
length ≤ 250

서명자에게 전달할 메세지 (250자 제한)

date-time

문서 만료일 (YYYY-MM-DD HH:MM:SS 형식)

boolean
Defaults to false

true일 경우 미리보기 url 제공, false일 경우 문서 시작

recipient_list
array of objects
required

문서 서명자 목록

recipient_list*
field_list
array of objects

필드에 미리 입력할 값의 목록. 지원 필드 타입: RadioBox, CheckBox, LabelBox, TextBox, PictureBox, DatePickerBox, DropdownBox, AddFileBox. DropdownBox는 value에 서식에 등록된 선택 항목과 일치하는 값을 입력합니다. AddFileBox는 attachment_key에 multipart 파일 키를 지정하여 파일을 사전 등록합니다. 첨부파일 사전 등록 시 multipart/form-data 방식으로 요청해야 합니다.

field_list
referer_list
array of objects

참조자 목록

referer_list
export_api_info
object

Export API 사용 시 설정하는 값

Response

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json