전자계약 정보 조회
개요
싸인오케이 홈페이지에서 설정한 문서의 상세 정보를 조회합니다.
URL
/api/v2/document/{id}
요청 데이터
| 항목 | 타입 | 위치 | 설명 |
|---|---|---|---|
| id | String | query | 문서 ID |
응답 데이터
| 항목 | 타입 | 위치 | 설명 |
|---|---|---|---|
| result | Object | body | 결과 데이터 |
| id | String | body | 문서 아이디 |
| title | String | body | 제목 |
| status_description | String | body | 문서 이력 상태 설명 |
| status | String | body | 문서 상태 코드 |
| expired_date | String | body | 만료일 |
| view_url | String | body | 문서 보기 URL |
| download_url | String | body | 문서 다운로드 URL (문서 완료시 제공) |
| creator_id | String | body | 생성자 ID |
| creator_name | String | body | 생성자 이름 |
| create_datetime | String | body | 생성 일시 |
| complete_datetime | String | body | 문서 완료 일시 |
| search_code | String | body | 검색 코드 |
| attach_files | Array | body | 전자문서 첨부파일 |
| name | String | body | 전자문서 첨부파일명 |
| options | Object | body | - |
| meet | Boolean | body | 대면서명 여부(Default false) |
| signer_order | Boolean | body | 순차서명 여부(Default false) |
| signer | Array | body | 서명 대상자 배열 |
| index | Integer | body | 대상자 순번 |
| type | String | body | 대상자 구분 – SIGNATORY(서명자), REVIEWER(검토자) |
| sign_method | String | body | 서명방법 – SIMPLE(간편서명), CERTIFICATE(공동인증서서명) |
| name | String | body | 대상자 이름 |
| contact | String | body | 대상자 연락처(이메일/휴대폰) |
| view_url | String | body | 서명대사장의 서명가능 URL |
| items | Array | body | 입력항목 리스트 |
| type | String | body | 입력항목 타입 - STAMP, TEXT, CHECKBOX, SELECTBOX |
| alias | String | body | 항목명 |
| value | String | body | 항목값 |
| key | String | body | API Key |
| required | Boolean | body | 필수여부 |
| page | Integer | body | 입력항목 페이지 |
| attach_files | Array | body | 첨부파일 요청 |
| name | String | body | 요청 첨부파일 이름 |
| description | String | body | 요청 첨부파일 설명 |
| attached | Boolean | body | 첨부여부 |
| auth | Object | body | 문서 열람 인증 설정 |
| password | String | body | 비밀번호 |
| hp | String | body | 휴대폰인증용 실명 (연락처가 휴대폰일 때 적용) |
| simple | String | body | 간편인증용 실명 (연락처가 휴대폰일 때 적용) |
| biz_no | String | body | 법인 공동인증서 인증용 사업자번호 |
| memo | String | body | 남길말 |
| cc_list | Array | body | 참조자 리스트 |
| contact | String | body | 참조자 연락처 정보(이메일) |
| history | Array | body | 문서 이력 배열 |
| index | Integer | body | 문서 이력 순번 |
| name | String | body | 문서 이력 대상자 이름 |
| contact | String | body | 문서 이력 대상자 연락처(이메일/휴대폰) |
| status_description | String | body | 문서 이력 상태 설명 |
| history_datetime | String | body | 문서 이력 일시 |
| code | String | body | 성공, 실패 코드 |
| message | String | body | 성공, 실패 메시지 |
응답 데이터 예시
{
"result": {
"id": "734538d4fd4f4b3abb6",
"title": "title",
"status_description": "진행",
"status": "ESC001",
"view_url": "https://doc.signok.com/linkUrl?ABCDEF",
"download_url": "https://doc.signok.com/api/v2/document/734538d4fd4f4b3abb6/download",
"creator_id": "test@signgate.com",
"creator_name": "creator_name",
"create_datetime": "2023-06-05 13:45:21",
"complete_datetime": "2023-06-06 13:45:21",
"search_code": "searchcode",
"attach_files": [],
"options": {
"meet": true,
"signer_order": false
},
"signer": [
{
"index": 1,
"type": "SIGNATORY",
"sign_method": "SIMPLE",
"name": "name",
"contact": "01012345678",
"memo": "memo",
"view_url": "https://doc.signok.com/linkUrl?DN20XHYYSJP5",
"items": [
{
"type": "TEXT",
"alias": "ALIAS",
"required": true,
"page": 1
},
{
"type": "STAMP",
"alias": "ALIAS",
"key": "org_stamp",
"required": true,
"page": 1
}
],
"attach_files": [],
"auth": {
"password": "1234"
}
},
{
"index": 0,
"type": "REFEREE",
"contact": "contact@signgate.com",
"view_url": "https://doc.signok.com/linkUrl?4SMX5WR2NX",
"items": [],
"attach_files": [],
"auth": {}
}
],
"cc_list": [
{
"contact": "cc@signgate.com"
}
],
"history": [
{
"index": 1,
"name": "name",
"contact": "01056781234",
"status_description": "서명대기중",
"history_datetime": "2023-06-05 13:45:21"
},
{
"index": 2,
"name": "name",
"contact": "01023456789",
"status_description": "대면서명인증요청",
"history_datetime": "2023-06-05 13:45:21"
}
]
},
"code": "200",
"message": "success"
}