전자계약 목록 개수 조회

등록되어 있는 전자계약 문서 목록의 개수를 조회합니다.

URL

/api/v2/document/count

Request

테이블정보입력필요
Name	Type	Description
title	String	문서 제목
start_date	String	생성 날짜 검색 시작일 * yyyyMMdd
end_date	String	생성 날짜 검색 종료일 * yyyyMMdd
search_code	String	검색 코드
status	String	문서 상태 코드

Response

테이블정보입력필요

Name

Type

Required

Description

result

Object

Required

결과 데이터

테이블정보입력필요
count	Integer	Required	문서 목록 개수

code

String

Required

성공, 실패 코드

message

String

Required

성공, 실패 메세지

Request

Response

전자계약 목록 조회

등록되어 있는 전자계약 문서 목록을 조회합니다.

URL

/api/v2/document

Request

테이블정보입력필요
Name	Type	Description
page	Integer	페이지 수
per_page	Integer	페이지 당 개수
title	String	문서 제목
start_date	String	생성 날짜 검색 시작일 * yyyyMMdd
end_date	String	생성 날짜 검색 종료일 * yyyyMMdd
signer_name	String	서명자 명
status	String	문서 상태 코드
search_code	String	검색 코드

Response

테이블정보입력필요

Name

Type

Required

Description

result

Object

Required

결과 데이터

테이블정보입력필요

page

Integer

페이지 수

per_page

Integer

페이지 당 개수

documents

Array

Required

문서 배열

테이블정보입력필요
id	String	문서 ID
title	String	제목
status_description	String	문서 이력 상태 설명
status	String	문서 상태 코드
creator_id	String	생성자 ID
creator_name	String	생성자 이름
create_datetime	String	생성 일시
complete_datetime	String	문서 완료 일시
search_code	String	검색 코드

code

String

Required

성공, 실패 코드

message

String

Required

성공, 실패 메세지

Request

Response

전자계약 정보 조회

지정한 특정 전자계약 문서의 상세 정보를 조회합니다.

URL

/api/v2/document/{id}

Request

테이블정보입력필요
Name	Type	Required	Description
id	String	Required	문서 ID

Response

테이블정보입력필요

Name

Type

Required

Description

result

Object

Required

결과 데이터

테이블정보입력필요

String

Required

문서 ID

title

String

Required

제목

status_description

String

Required

문서 이력 상태 설명

status

String

Required

문서 상태 코드

expired_date

String

Required

만료일

view_url

String

Required

문서 보기 URL(일반계약일 경우)

download_url

String

Required

문서 다운로드 URL(일반계약일 경우)

creator_id

String

Required

생성자 ID

creator_name

String

Required

생성자 이름

create_datetime

String

Required

생성 일시

complete_datetime

String

Required

문서 완료 일시

search_code

String

Required

검색 코드

attach_files

Array

Required

전자문서 첨부파일

테이블정보입력필요
name	String		전자문서 첨부파일 명

options

Object

Required

옵션 정보

테이블정보입력필요
meet	Boolean		대면서명 여부
signer_order	Boolean		순차서명 여부

signer

Array

Required

서명 대상자 배열

테이블정보입력필요
index	Integer		대상자 순번
type	String		대상자 구분 : SIGNATORY(서명자), REVIEWER(검토자), OFFICIAL_BASE(공문대상자)
sign_method	String		서명방법 : SIMPLE(간편서명), CERTIFICATE(공동인증서서명)
name	String		대상자 이름
contact	String		대상자 연락처(이메일/휴대폰)
view_url	String		서명대사장의 서명가능 URL
download_url	String		대상자의 다운로드 URL(일반계약이 아닌경우)
items	Array	Required	입력항목 리스트

테이블정보입력필요
type	String	입력항목 타입 : STAMP, TEXT, CHECKBOX, SELECTBOX
alias	String	항목명
value	String	항목값
key	String	API Key
required	Boolean	필수여부
page	Integer	입력항목 페이지

테이블정보입력필요
attach_files	Array	Required	첨부파일 요청

테이블정보입력필요
name	String	요청 첨부파일 이름
description	String	요청 첨부파일 설명
attached	Boolean	첨부여부

테이블정보입력필요
auth	Object		문서 열람 인증 설정

테이블정보입력필요
password	String	비밀번호
hp	String	휴대폰인증용 실명(연락처가 휴대폰일 때 적용)
simple	String	간편인증용 실명(연락처가 휴대폰일 때 적용)
biz_no	String	법인 공동인증서 인증용 사업자번호

테이블정보입력필요
memo	String		남길말

cc_list

Array

Required

참조자 리스트

테이블정보입력필요
contact	String		참조자 연락처 정보(이메일)

history

Array

Required

문서 이력 배열

테이블정보입력필요
index	Integer	문서 이력 순번
name	String	문서 이력 대상자 이름
contact	String	문서 이력 대상자 연락처(이메일/휴대폰)
status_description	String	문서 이력 상태 설명
history_datetime	String	문서 이력 일시

code

String

Required

성공, 실패 코드

message

String

Required

성공, 실패 메세지

Request

Response

GET api/v2/document/{id} Content-Type: application/json Authorization: Bearer "Access Token"

{ "result": { "id": "문서 ID", "title": "계약서", "status_description": "완료", "status": "ESC006", "expired_date": "20260102", "view_url": "https://doc.signok.com/linkUrl?abcDEF123456", "download_url": "https://doc.signok.com/api/v2/document/abcdefghijklmnopqrstuvwxyz123456/download", "create_id": "webmaster@signok.com", "creator_name": "(주)한국정보인증", "create_datetime": "2026-01-01 12:00:00", "complete_datetime": "2026-01-01 12:10:00", "search_code": null, "attach_files": [], "options": { "meet": false, "signer_order": true }, "signer": [ { "index": 1, "type": "SIGNATORY", "sign_method": "SIMPLE", "name": "대상자", "contact": "webmaster@signok.com", "view_url": "https://doc.signok.com/linkUrl?ABCdef123456", "items": [ { "type": "STAMP", "alias": "서명 항목", "key": "signature", "required": true, "page": 1 }, { "type": "CHECKBOX", "alias": "체크박스", "required": true, "page": 1 }, { "type": "TEXT", "alias": "텍스트박스", "value": "텍스트", "required": false, "page": 1 }, { "type": "SELECTBOX", "alias": "셀렉트박스", "value": "선택항목 1", "required": true, "page": 1 } ], "attach_files": [], "auth": {} } ], "cc_list": [], "history": [ { "index": 1, "name": "대상자", "contact": "webmaster@signok.com", "status_description": "계약서 최초확인", "history_datetime": "2026-01-01 12:05:00" }, { "index": 2, "name": "대상자", "contact": "webmaster@signok.com", "status_description": "서명완료", "history_datetime": "2026-01-01 12:10:00" } ] }, "code": "200", "message": "success" }