{"openapi":"3.0.1","info":{"title":"얼마싸인 Open API","description":"얼마싸인 Open API"},"servers":[{"url":"https://olmasign.com"}],"security":[{"bearerAuth":[]}],"tags":[{"name":"API설명","description":"\r\n# API 사용\r\n얼마싸인 API 이용을 원하시면 아래 링크를 통해 문의해주세요. \r\n얼마싸인 [**고객문의 >**](https://olmasign.com/wm/signbill/product/customer.do)\r\n\r\n## API KEY 발급\r\nolmasign.com 서비스에 로그인 후 상단 메뉴\r\n`API` -> `OPEN API` -> `사전 준비` -> `3.인증 ID 및 KEY 전송`\r\n이메일 전송을 클릭하면 발급 받을 수 있습니다.\r\n\r\n---\r\n\r\n## 액세스 토큰\r\nAPI KEY 발급에서 설명드린대로 API ID, KEY 발급 후 `액세스 토큰 요청 API`를 호출하여 토큰을 발급받을 수 있습니다.\r\n\r\n📤 **REQUEST**\r\n\r\n```cmd\r\ncurl -X \"GET\" \\\r\n \"https://olmasign.com/openapi/v1/token\" \\\r\n -H \"x-api-id: fAfbp7ka2O\" \\\r\n -H \"x-api-key: CpQKhFvZNlFMhYRc1UG1lA==\"\r\n```\r\n\r\n> ⚠️ **액세스 토큰 만료시간** \r\n> 발급받은 액세스 토큰의 만료일은 `30일`이며, 만료되면 다시 발급받아야 합니다.\r\n\r\n📤 **RESPONSE**\r\n\r\n응답 content type은 `application/json` 입니다. \r\n`accessToken` 키의 값이 액세스 토큰입니다.\r\n\r\n```json\r\n{\r\n \"accessToken\": \"eyJ0eXAiOiJKV1QiLCJiOiJIUzUxMiJ9.eyJhcGlVcjp7InNxVXNlciI6MTQ3OTksImlkVXNlciI6ImpkaSIsImNkQ29tcGFueSI6IjEwMDAifSwicm9sZSI6IlJPTEVfT1BFTkFQSSIsImlhdCI6MTc0NzkwMTU1OSwiZXhwIjoxNzUwNTc5OTU5fQ.2Rqi1HExjNj9NFdLCDJy2oT9RIWemeeKDoK1bbhwHQg26WQUEbXn8rHi9v_QCxyn1YRpE1doI_1xlihbw\",\r\n \"expiresAt\": \"2025-06-22T08:12:39.000+00:00\"\r\n}\r\n```\r\n\r\n---\r\n## API 요청\r\n\r\n발급받은 액세스 토큰을 사용해서 API를 호출합니다.\r\n\r\n전자계약 API 연동 제품별 구분이 필요한 경우, header에 `product_name` 추가해서 요청 바랍니다.\r\n전자계약 발송 History이력에 추가됩니다. `(default: olmasign)`\r\n\r\n📤 **REQUEST (회사 정보 조회)**\r\n\r\n```cmd\r\ncurl -X \"GET\" \\\r\n \"https://olmasign.com/openapi/v1/companys\" \\\r\n -H \"product_name: olmasign\"\r\n -H \"Authorization: Bearer eyJ0eXAiOiJKV1QiLCJiOiJIUzUxMiJ9.eyJhcGlVcjp7InNxVXNlciI6MTQ3OTksImlkVXNlciI6ImpkaSIsImNkQ29tcGFueSI6IjEwMDAifSwicm9sZSI6IlJPTEVfT1BFTkFQSSIsImlhdCI6MTc0NzkwMTU1OSwiZXhwIjoxNzUwNTc5OTU5fQ.2Rqi1HExjNj9NFdLCDJy2oT9RIWemeeKDoK1bbhwHQg26WQUEbXn8rHi9v_QCxyn1YRpE1doI_1xlihbw\"\r\n```\r\n\r\n---\r\n# HTTPS 프로토콜을 확인해주세요\r\n\r\n웹훅 전송 URL, 임베디드 redirect URL 등록시 \r\nURL은 반드시 HTTPS 프로토콜(SSL/TLS 기반) 을 사용해야 하며, HTTP는 지원되지 않습니다. \r\nSSL 인증서가 없거나 유효하지 않은 경우 웹훅 전송, 임베디드 redirect URL 이 정상적으로 동작하지 않을수 있습니다.\r\n\r\n- 테스트를 위해선 `ngrok` 같은 터널링 서비스를 사용하시면 됩니다.\r\n\r\n---\r\n\r\n# 에러코드 안내\r\n\r\n- 일부 에러 메시지 내용은 커스텀 되어 보여질수 있습니다.\r\n### 📥 일반 에러 응답 예시\r\n\r\n
\r\n{\r\n  \"errorCode\": \"{CODE}\",\r\n  \"message\": \"{ERROR_CODE}\",\r\n  \"description\" : \"{DESCRIPTION}\"\r\n}\r\n
\r\n\r\n### 📥 Validated 에러 응답 예시\r\n
\r\n{\r\n  \"errorCode\": 501,\r\n  \"message\": \"BAD_REQUEST\",\r\n  \"description\": \"Request body is invalid\",\r\n  \"errors\": [\r\n    {\r\n      \"field\": \"{FIELD}\",\r\n      \"rejectedValue\": \"{REJECT_VALUE}\",\r\n      \"defaultMessage\": \"{DEFAULT_MESSAGE}\"\r\n    }\r\n  ]\r\n}\r\n
\r\n\r\n\r\n\r\n## 일반 에러\r\n| 코드 | HTTP 상태 | 에러 코드 | 메시지 |\r\n|-----|-----------------------------|-------------------------------|---------------------------------------|\r\n| 401 | UNAUTHORIZED (401) | UNAUTHORIZED | Unauthorized |\r\n| 403 | FORBIDDEN (403) | FORBIDDEN | Forbidden |\r\n| 404 | NOT_FOUND (404) | API_NOT_FOUND | API를 찾을수 없습니다. |\r\n| 405 | METHOD_NOT_ALLOWED (405) | METHOD_NOT_ALLOWED | Method Not Allowed |\r\n| 409 | CONFLICT (409) | CONFLICT | Conflict |\r\n| 500 | INTERNAL_SERVER_ERROR (500) | INTERNAL_SERVER_ERROR | 내부 서버 오류 |\r\n| 501 | BAD_REQUEST (400) | BAD_REQUEST | Request body is invalid |\r\n| 502 | BAD_REQUEST (400) | BAD_PARAMETER_REQUEST | Request Parameter is invalid |\r\n| 503 | BAD_REQUEST (400) | BAD_JSON_REQUEST | Request Json is invalid |\r\n| 504 | BAD_REQUEST (400) | BAD_MEDIATYPE_REQUEST | Request MediaType is invalid |\r\n| 505 | BAD_REQUEST (400) | BAD_PATHVARIABLE_REQUEST | Request PathVariable is invalid |\r\n| 510 | CONFLICT (409) | EXISTS_NAME | 이미 존재하는 이름입니다. |\r\n| 511 | INTERNAL_SERVER_ERROR (500) | UNDEFINED_ERROR | 정의되지 않은 내부 서버 오류 |\r\n| 512 | NOT_FOUND (404) | NO_FOLDER | 폴더가 존재하지 않습니다. |\r\n| 513 | BAD_REQUEST (400) | NO_DATA_INVALID | 요청한 데이터를 다시 확인 바랍니다. |\r\n| 514 | BAD_REQUEST (400) | NO_UID_INVALID | 요청한 고유키를 다시 확인 바랍니다. |\r\n| 515 | CONFLICT (409) | NO_EXCEL_DOWN | 엑셀 다운로드 실패 하였습니다. |\r\n| 516 | BAD_REQUEST (400) | BAD_REQUEST_EXTENSION | 잘못된 확장자 입니다. |\r\n| 517 | CONFLICT (409) | NO_EXCEL_UPLOAD | 올바른 엑셀을 등록해 주세요. |\r\n| 518 | BAD_REQUEST (400) | CHECK_QUERY_PARAM | CHECK_QUERY_PARAM. |\r\n| 519 | NOT_FOUND (404) | NOT_FOUND_PRODUCT | 제품 정보를 불러오는데 실패했습니다. |\r\n| 520 | PAYMENT_REQUIRED (402) | INSUFFICIENT_DEDUCTION_AMOUNT | 잔여 포인트&건수가 부족합니다. 충전 후 사용 바랍니다. |\r\n| 521 | CONFLICT (409) | FAIL_DEDUCTION | 포인트를 차감하는데 실패했습니다. |\r\n| 522 | CONFLICT (409) | FAIL_DEDUCTION_POINT | 차감하는데 실패했습니다. |\r\n| 523 | CONFLICT (409) | FAIL_DEDUCTION_COUNT | 건 수를 차감하는데 실패했습니다. |\r\n| 524 | PAYMENT_REQUIRED (402) | NOT_PREMIUM_RATEPLAN | PREMIUM 요금제만 사용이 가능합니다. 요금제를 확인 바랍니다. |\r\n| 525 | BAD_REQUEST (400) | DATA_DUPLICATE | 요청한 중복 데이터를 다시 확인 바랍니다. |\r\n| 524 | PAYMENT_REQUIRED (402) | NOT_API_RATEPLAN | API 요금제만 사용이 가능합니다. 요금제를 확인 바랍니다. |\r\n| 525 | CONFLICT (409) | NOT_CONNECT_BACKOFFICE | 제품 정보를 연결하는데 실패했습니다. |\r\n| 526 | CONFLICT (409) | UNUSABLE_PDF | 사용할 수 없는 PDF 입니다. |\r\n---\r\n## 회사 에러\r\n| 코드 | HTTP 상태 | 에러 코드 | 메시지 |\r\n|------|-----------------|------------------------------------|----------------------------------------------------------------|\r\n| 1000 | NOT_FOUND (404) | COMPANY_NOT_FOUND | 회사 정보를 찾을 수 없습니다. |\r\n| 1001 | NOT_FOUND (404) | TEAM_NOT_FOUND | 팀 정보를 찾을 수 없습니다. |\r\n| 1002 | NOT_FOUND (404) | COMPANY_CUSTOM_EMAIL_NOT_FOUND | 이메일 맞춤설정을 찾을 수 없습니다. |\r\n| 1003 | CONFLICT (409) | COMPANY_CUSTOM_EMAIL_NOT_FOUND | 이메일 맞춤설정 로고 업로드가 불가능 합니다. |\r\n| 1004 | CONFLICT (409) | CUSTOM_EMAIL_LOGO_UPLOAD_SIZE_FAIL | 이메일 맞춤설정 로고 파일은 최대 가로 210px, 세로 70px 까지만 업로드 가능합니다. |\r\n| 1005 | CONFLICT (409) | CUSTOM_EMAIL_LINK_FAIL | 이메일 맞춤설정 로고 링크는 'https://' 혹은 'http://' 를 제외한 올바른 형식으로 입력해주세요. |\r\n| 1006 | CONFLICT (409) | CUSTOM_EMAIL_HEX_CODE_FAIL | 이메일 맞춤설정 hex 코드는 '#000000' 형태로 입력해주세요. |\r\n---\r\n\r\n## 사용자 에러\r\n\r\n| 코드 | HTTP 상태 | 에러 코드 | 메시지 |\r\n|------|--------------------|-------------------|---------------------|\r\n| 1100 | NOT_FOUND (404) | USER_NOT_FOUND | 사용자 정보를 찾을 수 없습니다. |\r\n| 1101 | CONFLICT (409) | NO_DELETE_MASTER | 최초 가입자는 삭제할 수 없습니다. |\r\n| 1102 | NOT_FOUND (404) | COMPANY_NOT_FOUND | 그룹 정보를 찾을 수 없습니다. |\r\n| 1103 | NOT_FOUND (404) | ADDRESS_NOT_FOUND | 주소록 정보를 찾을 수 없습니다. |\r\n| 1104 | UNAUTHORIZED (401) | INVALID_ID_KEY | 잘못된 ID, KEY 입니다. |\r\n---\r\n## 계약 에러\r\n\r\n| 코드 | HTTP 상태 | 에러 코드 | 메시지 |\r\n|------|-------------------|-----------------------------------|----------------------------|\r\n| 1200 | NOT_FOUND (404) | CONTRACT_NOT_FOUND | 문서가 존재하지 않습니다. |\r\n| 1201 | CONFLICT (409) | CONTRACT_NOT_CANCEL | 계약을 취소할 수 없습니다. |\r\n| 1202 | CONFLICT (409) | CONTRACT_NOT_PROCESSING | 계약 진행 상태가 아닙니다. |\r\n| 1203 | CONFLICT (409) | APPROVAL_NO_WAITE | 결제 대기자가 없습니다. |\r\n| 1204 | BAD_REQUEST (400) | BAD_EXTERNAL_UPLOAD_REQUEST | 개별 업로드시 파일과 문서정보는 1:1. |\r\n| 1205 | BAD_REQUEST (400) | BAD_EXTERNAL_UPLOAD_MERGE_REQUEST | 병합시 파일과 문서정보는 N:1. |\r\n| 1206 | CONFLICT (409) | CONTRACT_ATTACH_UPLOAD_FAIL | 첨부파일 업로드가 불가능 합니다. |\r\n| 1207 | BAD_REQUEST (400) | NECESSARY_SIGNER | 서명자는 필수 입니다. |\r\n| 1208 | CONFLICT (409) | NO_SIGN_LIMIT | 서명 유효기간을 설정할 수 없습니다. |\r\n| 1209 | NOT_FOUND (404) | CONTRACT_CONTRACTOR_NOT_FOUND | 계약에 포함된 해당 수신자를 찾을 수 없습니다. |\r\n| 1210 | CONFLICT (409) | FAIL_REQUEST_SIGN | 계약 서명 요청에 실패하였습니다. |\r\n| 1211 | NOT_FOUND (404) | USER_AND_FOLDER_NOT_FOUND | 사용자 또는 내 폴더함이 없습니다. |\r\n| 1212 | CONFLICT (409) | CONTRACT_PROCESSING | 계약 진행 상태 입니다. |\r\n| 1213 | BAD_REQUEST (400) | SEND_CONTRACT_ALLOW_CONFIRM | 문서확인 상태의 문서만 전송 할수 있습니다 |\r\n---\r\n## 템플릿 에러\r\n\r\n| 코드 | HTTP 상태 | 에러 코드 | 메시지 |\r\n|------|-----------------|-------------------------------|---------------------------------|\r\n| 1300 | NOT_FOUND (404) | TEMPLATE_NOT_FOUND | 템플릿이 존재하지 않습니다. |\r\n| 1301 | NOT_FOUND (404) | TEMPLATE_CONTRACTOR_NOT_FOUND | 템플릿에 포함된 해당 수신자를 찾을 수 없습니다. |\r\n| 1302 | NOT_FOUND (404) | TEMPLATE_ATTACH_NOT_FOUND | 템플릿에 포함된 해당 첨부파일을 찾을 수 없습니다. |\r\n| 1303 | NOT_FOUND (404) | TEMPLATE_FILE_REQ_NOT_FOUND | 템플릿에 포함된 해당 첨부파일 요청을 찾을 수 없습니다. |\r\n| 1310 | CONFLICT (409) | TEMPLATE_ATTACH_UPLOAD_FAIL | 첨부파일 업로드가 불가능 합니다. |\r\n---\r\n\r\n## 대량전송 에러\r\n\r\n| 코드 | HTTP 상태 | 에러 코드 | 메시지 |\r\n|------|-----------------|----------------------------|-------------------------------|\r\n| 1400 | NOT_FOUND (404) | BULK_CONTRACT_NOT_FOUND | 대량전송 문서가 존재하지 않습니다. |\r\n| 1401 | CONFLICT (409) | BULK_NOT_TRANSFER_STATE | 대량 전송이 완료되었거나 시작할 수 없는 상태입니다. |\r\n| 1402 | CONFLICT (409) | FAIL_REQUEST_BULK_SIGN | 대량계약 서명 요청에 실패하였습니다. |\r\n| 1403 | CONFLICT (409) | BULK_CONTRACTS_NOT_DELETED | 진행중인 계약건이 있어 삭제가 불가능합니다. |\r\n| 1404 | CONFLICT (409) | BULK_EXCEL_NOT_UPLOAD | 준비중, 전송 대기 상태만 업로드 가능합니다. |\r\n---\r\n\r\n## SSL / TLS 검증 에러\r\n\r\n| 코드 | HTTP 상태 | 에러 코드 | 메시지 |\r\n|------|----------------|---------------------|---------------------------|\r\n| 1700 | CONFLICT (409) | INVALID_CERTIFICATE | 유효하지 않은 인증서 입니다. |\r\n| 1701 | CONFLICT (409) | NOT_YET_CERTIFICATE | 인증서의 유효기간이 아직 시작되지 않았습니다. |\r\n| 1702 | CONFLICT (409) | EXPIRED_CERTIFICATE | 만료된 인증서 입니다. |\r\n| 1703 | CONFLICT (409) | INVALID_URL | 잘못된 프로토콜 또는 잘못된 URL 입니다. |\r\n---\r\n# 웹훅 기능 설명\r\n\r\n웹훅은 특정 이벤트 발생 시 실시간으로 외부 시스템에 HTTP `POST` 요청을 보내는 자동화된 알림 기능입니다. \r\n사용자는 웹훅 URL(엔드포인트)을 사전에 등록해두고, 지정된 이벤트 발생 시 해당 URL로 이벤트 관련 데이터를 전달받을 수 있습니다.\r\n\r\n---\r\n\r\n### 여러 하위 회사를 관리하는 본사 계정 구조에서 웹훅 이벤트 동작 방식\r\n1. 하위 회사의 API 토큰을 기준으로 이벤트를 조회합니다.\r\n2. 해당 토큰으로 조회된 이벤트가 없을 경우, 상위(부모) 회사로 이벤트를 재조회합니다.\r\n---\r\n\r\n## 요청 커스텀 헤더\r\n\r\n웹훅 전송 시, 클라이언트 시스템에서 요구하는 인증 또는 식별 정보를 포함할 수 있도록, \r\n커스텀 HTTP 헤더를 설정할 수 있습니다. \r\n설정된 헤더는 웹훅 요청 시 함께 전송되며, \r\n클라이언트 시스템에서 이를 기반으로 요청의 유효성을 검증할 수 있습니다.\r\n\r\n### 웹훅 등록 예시\r\n\r\n
\r\n{\r\n  \"uri\": \"https://client.example.com/webhook\", \r\n  \"headers\": [ \r\n      {\r\n        \"key\" : \"Authorization\", \r\n        \"value\" : \"Bearer ******\"\r\n      }, \r\n      {\r\n        \"key\" : \"X-API-Key\", \r\n        \"value\" : \"client-key-xyz\"\r\n      }, \r\n      {\r\n        \"key\" : \"X-Custom-Header\", \r\n        \"value\" : \"custom-value\"\r\n      } \r\n  ],\r\n  \"eventType\" : \"SIGNED_CONTRACT\",\r\n  \"name\" : \"{NAME}\",\r\n  \"activationStatus\" : \"ACTIVE\"\r\n}\r\n
\r\n\r\n## 웹훅 이벤트 목록\r\n\r\n| 이벤트 타입 | 설명 |\r\n|----------------------------|------------------------------|\r\n| `BEFORE_SENDING_CONTRACT` | 계약 전송 이전 |\r\n| `AFTER_SENDING_CONTRACT` | 계약 전송 이후 |\r\n| `SIGNED_CONTRACT` | 서명자 서명 완료 이후 |\r\n| `SIGNED_ALL_CONTRACT` | 모든 서명 완료 이후 |\r\n| `REJECTED_SIGN` | 서명 거절 이후 |\r\n| `CANCELED_CONTRACT` | 계약 취소 이후 |\r\n| `APPROVE_CONTRACT` | 결재자 승인 완료 이후 |\r\n| `APPROVE_ALL_CONTRACT` | 모든 결재자 승인 완료 이후 |\r\n| `COMPANION_CONTRACT` | 결재 반려 이후 |\r\n| `BEFORE_SENDING_BULK` | 대량 전송 이전 |\r\n| `AFTER_SENDING_BULK` | 대량 전송 이후 |\r\n\r\n---\r\n## 공통 요청 정보\r\n\r\n- `eventType` → 웹훅 이벤트\r\n- `master` → 최초 가입자 정보\r\n- `documentId` → 문서 ID (UUID)\r\n- `triggerBy` → 이벤트를 발동시킨 사용자 정보\r\n\r\n### 📤 요청 예시\r\n\r\n
\r\n{\r\n  \"eventType\": \"SIGNED_ALL_CONTRACT\",\r\n  \"master\": {\r\n    \"email\": \"{EMAIL}\",\r\n    \"cell\": \"{CELL}\",\r\n    \"id\": \"{ID}\"\r\n  },\r\n  \"documentId\": \"3c3e3b1d-e5d9-48b8-923b-d9514f7608f1\",\r\n  \"triggerBy\": {\r\n    \"name\": \"{NAME}\",\r\n    \"email\": \"{EMAIL}\",\r\n    \"cell\": \"{CELL}\",\r\n  }\r\n}\r\n
\r\n\r\n---\r\n\r\n## BEFORE_SENDING_CONTRACT (계약 전송 이전)\r\n\r\n**설명** \r\n계약 전송 직전에 호출되는 이벤트로, 계약 건수 차감 전에 실행됩니다. \r\n웹훅 수신 서버의 응답에 따라 계약 전송 여부가 결정됩니다.\r\n\r\n이벤트는 얼마싸인 화면에서만 작동하며 \r\n전자계약 전송하는 API(`템플릿으로 계약 생성`, `검토 확인 계약서 전송`)를 사용할 경우 동작하지 않습니다.\r\n\r\n**동작 방식**\r\n- `isValid: true` → 계약 전송 허용 (건수 차감 O)\r\n- `isValid: false` → 계약 전송 차단 (건수 차감 X)\r\n- `message`: `isValid: false`일 경우 사용자에게 표시할 메시지\r\n\r\n### 📤 요청 예시\r\n\r\n
\r\n{\r\n  \"eventType\": \"BEFORE_SENDING_CONTRACT\",\r\n  \"master\": {\r\n    \"email\": \"{EMAIL}\",\r\n    \"cell\": \"{CELL}\",\r\n    \"id\": \"{ID}\"\r\n  },\r\n  \"documentId\": \"3c3e3b1d-e5d9-48b8-923b-d9514f7608f1\",\r\n  \"triggerBy\": {\r\n    \"name\": \"{NAME}\",\r\n    \"email\": \"{EMAIL}\",\r\n    \"cell\": \"{CELL}\",\r\n  }\r\n}\r\n
\r\n\r\n### 📥 응답 예시\r\n\r\n
\r\n{\r\n  \"isValid\": true,\r\n  \"message\": \"\"\r\n}\r\n
\r\n\r\n
\r\n{\r\n  \"isValid\": false,\r\n  \"message\": \"포인트가 부족하여 계약을 전송할 수 없습니다.\"\r\n}\r\n
\r\n\r\n---\r\n\r\n## BEFORE_SENDING_BULK (대량 전송 이전)\r\n\r\n**설명** \r\n대량 계약 전송 전에 호출되며, 전체 문서 건수 정보가 함께 전달됩니다.\r\n\r\n**동작 방식**\r\n- `isValid`: 전송 가능 여부\r\n- `message`: 실패 시 사용자 안내 메시지\r\n- `documentCount`: 전송될 문서 수\r\n- `documentIds`: 전송 대상 문서 ID 리스트\r\n\r\n### 📤 요청 예시\r\n\r\n
\r\n{\r\n  \"eventType\": \"BEFORE_SENDING_BULK\",\r\n  \"master\": {\r\n    \"email\": \"{EMAIL}\",\r\n    \"cell\": \"{CELL}\",\r\n    \"id\": \"{ID}\"\r\n  },\r\n  \"documentCount\": {DOCUMENT_COUNT},\r\n  \"documentIds\": [\r\n      \"3c3e3b1d-e5d9-48b8-923b-d9514f7608f1\", \r\n      \"3c3e3b1d-e5d9-48b8-923b-d9514f7608f2\"],\r\n  \"triggerBy\": {\r\n    \"name\": \"{NAME}\",\r\n    \"email\": \"{EMAIL}\",\r\n    \"cell\": \"{CELL}\",\r\n  }\r\n}\r\n
\r\n\r\n### 📥 응답 예시\r\n\r\n
\r\n{\r\n  \"isValid\": true,\r\n  \"message\": \"\"\r\n}\r\n
\r\n\r\n---\r\n\r\n## AFTER_SENDING_BULK (대량 전송 이후)\r\n**설명** \r\n대량 계약 전송 이후에 호출되며, 전체 문서 건수, 전송 성공 건수, 전송 실패 건수가 함께 전달됩니다.\r\n\r\n**동작 방식**\r\n- `documentCount`: 전송될 문서 건수\r\n- `documentIds`: 전송 대상 문서 ID 리스트\r\n- `successCount` : 전송 성공 문서 건수\r\n- `failCount` : 전송 실패 문서 건수\r\n### 📤 요청 예시\r\n\r\n
\r\n{\r\n  \"eventType\": \"AFTER_SENDING_BULK\",\r\n  \"master\": {\r\n    \"email\": \"{EMAIL}\",\r\n    \"cell\": \"{CELL}\",\r\n    \"id\": \"{ID}\"\r\n  },\r\n  \"documentCount\": {DOCUMENT_COUNT},\r\n  \"successCount\": {SUCCESS_COUNT},\r\n  \"failCount\": {FAIL_COUNT},\r\n  \"documentIds\": [\"3c3e3b1d-e5d9-48b8-923b-d9514f7608f1\", \"3c3e3b1d-e5d9-48b8-923b-d9514f7608f2\"],\r\n  \"triggerBy\": {\r\n    \"name\": \"{NAME}\",\r\n    \"email\": \"{EMAIL}\",\r\n    \"cell\": \"{CELL}\",\r\n  }\r\n}\r\n
\r\n\r\n---\r\n\r\n## 기타 이벤트 요청 예시\r\n\r\n- `AFTER_SENDING_CONTRACT`\r\n- `SIGNED_CONTRACT`\r\n- `SIGNED_ALL_CONTRACT`\r\n- `REJECTED_SIGN`\r\n- `CANCELED_CONTRACT`\r\n- `APPROVE_CONTRACT`\r\n- `APPROVE_ALL_CONTRACT`\r\n- `COMPANION_CONTRACT`\r\n\r\n### 📤 요청 예시\r\n\r\n
\r\n{\r\n  \"eventType\": \"SIGNED_ALL_CONTRACT\",\r\n  \"master\": {\r\n    \"email\": \"{EMAIL}\",\r\n    \"cell\": \"{CELL}\",\r\n    \"id\": \"{ID}\"\r\n  },\r\n  \"documentId\": \"3c3e3b1d-e5d9-48b8-923b-d9514f7608f1\",\r\n  \"triggerBy\": {\r\n    \"name\": \"{NAME}\",\r\n    \"email\": \"{EMAIL}\",\r\n    \"cell\": \"{CELL}\",\r\n  }\r\n}\r\n
\r\n\r\n## 웹훅 성공, 실패, 재시도 정책\r\n\r\n웹훅 이벤트가 외부 시스템으로 전송될 때, 수신 서버의 응답 상태에 따라 성공 여부가 판단됩니다.\r\n\r\n---\r\n\r\n### 📦 성공 응답\r\n\r\n- **2xx** 응답 코드일 경우: \r\n → 웹훅 전송이 **정상적으로 완료**된 것으로 간주됩니다.\r\n\r\n---\r\n\r\n### ❌ 실패 응답\r\n\r\n- **2xx가 아닌 모든 응답 코드** \r\n → 실패로 간주되며, 재시도 조건에 해당하지 않으면 재요청되지 않습니다.\r\n\r\n---\r\n\r\n### 🔁 재시도 정책\r\n\r\n웹훅 요청이 실패했을 때, 아래 조건에 따라 자동 재시도가 이루어집니다.\r\n\r\n| 항목 | 설정 값 |\r\n|----------------|---------------------------|\r\n| **재시도 조건** | `Connection timeout` 발생 시에만 |\r\n| **재시도 횟수** | 최대 5회 |\r\n| **재시도 간격** | 3초 간격 |\r\n| **연결 타임아웃** | 3초 |\r\n| **응답 타임아웃** | 7초 |\r\n\r\n> ⚠️ 4xx, 5xx 응답과 같이 서버가 응답을 반환한 경우에는 **재시도되지 않습니다.** \r\n> 재시도는 오직 **연결이 불가능한 경우(Connection timeout)** 에만 수행됩니다.\r\n\r\n---\r\n# 임베디드 기능 설명\r\n임베디드(Embedded) 기능은 쉽게 말하면 얼마싸인 기능을 다른 웹사이트나 프로그램 안에 직접 넣을 수 있게 해주는 것입니다.\r\n\r\n즉, 사용자가 얼마싸인 홈페이지에 별도로 방문하지 않고, 당신의 서비스 안에서 바로 계약을 진행하거나 문서에 서명할 수 있게 해줍니다.\r\n\r\n---\r\n\r\n\r\n## Redirect URL 기능\r\n\r\n`redirectUrl`은 **임베디드 작업 완료 후 사용자를 지정된 웹 페이지로 자동 이동(리다이렉트)** 시키는 기능입니다. \r\n예를 들어, 계약서 작성이 완료되었거나 템플릿 생성이 끝났을 때, 사전에 등록한 URL로 사용자를 이동시킬 수 있습니다.\r\n\r\n### ✅ 주요 특징\r\n\r\n- 특정 이벤트 발생 시 자동으로 지정 URL로 이동\r\n- URL 쿼리 파라미터로 이벤트 정보와 문서 ID 제공\r\n- 필요 시 사용자 정의 데이터도 함께 전달 가능\r\n\r\n---\r\n\r\n## redirect 이벤트 예시\r\n\r\n아래는 다양한 임베디드 상황에서 발생할 수 있는 리디렉션 이벤트들과 그 URL 예시입니다:\r\n\r\n| 이벤트 설명 | Redirect URL 예시 |\r\n|---------------------------------------|-------------------|\r\n| 계약서 문서 확인 완료 | `https://your-domain.com/redirect?documentId=UUID&eventType=contract_preview` |\r\n| 계약서 문서 수정 완료 | `https://your-domain.com/redirect?documentId=UUID&eventType=contract_edit` |\r\n| 템플릿 문서 수정 완료 | `https://your-domain.com/redirect?documentId=UUID&eventType=template_edit` |\r\n| 계약서 서명 요청 시작 | `https://your-domain.com/redirect?documentId=UUID&eventType=contract_start` |\r\n| 대량전송 템플릿 문서 확인 완료 | `https://your-domain.com/redirect?documentId=UUID&eventType=bulk_template_confrim` |\r\n\r\n> ℹ`documentId`와 `eventType`은 쿼리 파라미터로 자동 포함되어 전달되며, 이를 통해 문서 후처리나 사용자 안내가 가능합니다.\r\n\r\n---\r\n\r\n## 활용 팁\r\n\r\n- `redirectUrl`에 커스텀 파라미터(예: 사용자 ID, 세션 정보 등)를 추가하면 후처리에 유용합니다.\r\n- 프론트엔드에서 이벤트 발생 후 URL 분석을 통해 로직 분기 처리가 가능합니다.\r\n- 모바일 환경에서도 동일한 방식으로 작동하므로 모바일 최적화된 리디렉트 페이지를 준비해두면 좋습니다.\r\n\r\n---\r\n"},{"name":"인증","description":"인증 토큰 API"},{"name":"사용자","description":"사용자 API"},{"name":"회사","description":"회사 API"},{"name":"템플릿","description":"템플릿 API"},{"name":"계약","description":"계약 API"},{"name":"대량전송","description":"대량전송 API"},{"name":"임베디드","description":"응답 linkUrl은 접속 가능한 URL이 전달됩니다.해당 URL은 2시간동안 접속 가능합니다."},{"name":"웹훅","description":"웹훅 API"}],"paths":{"/openapi/v1/token":{"get":{"tags":["인증"],"summary":"액세스 토큰 요청","description":"액세스 토큰을 요청합니다.","operationId":"createOpenAPIToken","parameters":[{"name":"x-api-id","in":"header","required":true,"schema":{"type":"string"}},{"name":"x-api-key","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/token"}}}},"400":{"description":"Bad Request"}},"security":[]}},"/openapi/v1/bulk/templates":{"get":{"tags":["대량전송"],"summary":"대량전송 템플릿 조회","description":"대량전송 가능한 수신자1인 템플릿을 조회합니다","operationId":"getTemplates","parameters":[{"name":"memberId","in":"query","description":"사용자 ID","required":false,"schema":{"type":"string","description":"사용자 ID","nullable":true}},{"name":"title","in":"query","description":"템플릿 제목","required":false,"schema":{"type":"string","description":"템플릿 제목","nullable":true}},{"name":"folderId","in":"query","description":"폴더 ID (My 템플릿 : 1)","required":false,"schema":{"title":"Use With memberId","type":"string","description":"폴더 ID (My 템플릿 : 1)","nullable":true}},{"name":"signerCount","in":"query","description":"서명자 수","required":false,"schema":{"type":"integer","description":"서명자 수","nullable":true}},{"name":"startDate","in":"query","description":"시작 일자 (yyyy-MM-dd)","required":false,"schema":{"type":"string","description":"시작 일자 (yyyy-MM-dd)","format":"date","nullable":true,"example":"2020-01-01"},"example":"2020-01-01"},{"name":"endDate","in":"query","description":"종료 일자 (yyyy-MM-dd)","required":false,"schema":{"type":"string","description":"종료 일자 (yyyy-MM-dd)","format":"date","nullable":true}},{"name":"page","in":"query","description":"조회 할 페이지 번호","required":false,"schema":{"minimum":1,"type":"integer","description":"조회 할 페이지 번호","format":"int32","default":1}},{"name":"rows","in":"query","description":"페이지에서 가져올 문서 개수","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer","description":"페이지에서 가져올 문서 개수","default":10}}],"responses":{"404":{"description":"Not Found"},"400":{"description":"Bad Request"},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResTemplatePageDTO_Default"}}}}}}},"/openapi/v1/bulk/contracts/{bulkContractId}":{"get":{"tags":["대량전송"],"summary":"대량전송 상세 조회","description":"대량전송 계약서를 상세 조회 합니다.","operationId":"getBulkContractDetail","parameters":[{"name":"bulkContractId","in":"path","description":"대량전송 ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"대량 전송 서명자 페이지 번호","required":false,"schema":{"maximum":2147483647,"minimum":1,"type":"integer","description":"대량 전송 서명자 페이지 번호","format":"int32","default":1}},{"name":"rows","in":"query","description":"대량 전송 서명자 개수","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer","description":"대량 전송 서명자 개수","default":10}}],"responses":{"404":{"description":"Not Found"},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResBulkContractDetailDTO"}}}},"400":{"description":"Bad Request"}}},"post":{"tags":["대량전송"],"summary":"검토 완료 대량전송 전송시작","description":"검토 완료된 대량전송을 시작합니다.","operationId":"sendBulkContract","parameters":[{"name":"bulkContractId","in":"path","description":"대량전송 ID","required":true,"schema":{"type":"string","description":"대량전송 ID","format":"uuid"}}],"responses":{"404":{"description":"Not Found"},"400":{"description":"Bad Request"},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResBulkContractTransferDTO"}}}}}}},"/openapi/v1/bulk/contracts":{"get":{"tags":["대량전송"],"summary":"대량전송 조회","description":"대량전송 리스트를 조회합니다.","operationId":"getBulkContracts","parameters":[{"name":"title","in":"query","description":"대량전송 제목","required":false,"schema":{"type":"string","description":"대량전송 제목","nullable":true}},{"name":"memberId","in":"query","description":"사용자 ID","required":false,"schema":{"type":"string","description":"사용자 ID","nullable":true}},{"name":"startDate","in":"query","description":"시작 일자 (yyyy-MM-dd)","required":false,"schema":{"type":"string","description":"시작 일자 (yyyy-MM-dd)","format":"date","nullable":true,"example":"2020-01-01"},"example":"2020-01-01"},{"name":"endDate","in":"query","description":"종료 일자 (yyyy-MM-dd)","required":false,"schema":{"type":"string","description":"종료 일자 (yyyy-MM-dd)","format":"date","nullable":true}},{"name":"page","in":"query","description":"조회 할 페이지 번호","required":false,"schema":{"minimum":1,"type":"integer","description":"조회 할 페이지 번호","format":"int32","default":1}},{"name":"rows","in":"query","description":"페이지에서 가져올 문서 개수","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer","description":"페이지에서 가져올 문서 개수","default":10}}],"responses":{"404":{"description":"Not Found"},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResBulkContractPageDTO"}}}},"400":{"description":"Bad Request"}}}},"/openapi/v1/bulk/contracts/{bulkContractId}/excel":{"get":{"tags":["대량전송"],"summary":"대량전송 엑셀 다운로드","description":"대량전송 샘플 엑셀 파일을 다운로드 합니다.","operationId":"bulkContractExcelSampleDown","parameters":[{"name":"bulkContractId","in":"path","description":"대량전송 ID","required":true,"schema":{"type":"string","description":"대량전송 ID","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/downloads_Default"}}}},"404":{"description":"Not Found"},"400":{"description":"Bad Request"}}},"post":{"tags":["대량전송"],"summary":"대량전송 엑셀 업로드","description":"대량전송 엑셀을 업로드 합니다.","operationId":"bulkContractExcelupload","parameters":[{"name":"bulkContractId","in":"path","description":"대량전송 ID","required":true,"schema":{"type":"string","description":"대량전송 ID","format":"uuid"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["file"],"type":"object","properties":{"file":{"type":"string","format":"binary"}}}}},"required":true},"responses":{"201":{"description":"Created"},"404":{"description":"Not Found"},"400":{"description":"Bad Request"}}}},"/openapi/v1/bulk/contracts/{bulkContractId}/limit":{"patch":{"tags":["대량전송"],"summary":"대량전송 서명 유효기간 설정","description":"유효기간을 일괄 적용합니다. (기본 15일, 전송완료 상태 불가)","operationId":"setBulkContractSignLimit","parameters":[{"name":"bulkContractId","in":"path","description":"대량전송 ID","required":true,"schema":{"type":"string","description":"대량전송 ID","format":"uuid"}},{"name":"limit","in":"query","description":"서명 유효기간 (yyyy-MM-dd)","required":true,"schema":{"type":"string","description":"서명 유효기간 (yyyy-MM-dd)","format":"date"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResBulkContractDTO"}}}},"404":{"description":"Not Found"},"400":{"description":"Bad Request"}}}},"/openapi/v1/companys/teams":{"get":{"tags":["회사"],"summary":"팀 폴더 조회","description":"회사에 등록된 팀 정보를 조회 합니다.","operationId":"getTeams","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiTeamFolder_Detail"}}}},"404":{"description":"팀 정보를 찾을 수 없습니다."}}},"post":{"tags":["회사"],"summary":"팀 폴더 생성","description":"팀 폴더 하위 팀으로 생성됩니다.","operationId":"createTeams","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiReqCreateTeamDTO_Default"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiTeamFolder_Default"}}}},"404":{"description":"Not Found"},"400":{"description":"Bad Request"}}},"patch":{"tags":["회사"],"summary":"팀 폴더명 변경","description":"팀 폴더 명을 변경합니다.","operationId":"renameTeam","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiReqRenameTeamDTO_Default"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiTeamFolder_Default"}}}},"404":{"description":"Not Found"},"400":{"description":"Bad Request"}}}},"/openapi/v1/companys/teams/{teamId}/users":{"get":{"tags":["회사"],"summary":"팀 사용자 조회","description":"회사 팀에 등록된 사용자를 조회 합니다.","operationId":"getUsersFromTeam","parameters":[{"name":"teamId","in":"path","description":"팀 ID 입력","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"responses":{"404":{"description":"Not Found"},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResTeamDTO"}}}},"400":{"description":"Bad Request"}}}},"/openapi/v1/companys":{"get":{"tags":["회사"],"summary":"회사 정보 조회","description":"회사 정보를 조회합니다.","operationId":"getCompany","responses":{"404":{"description":"Not Found"},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResCompanyDTO"}}}}}}},"/openapi/v1/companys/teams/{teamId}":{"delete":{"tags":["회사"],"summary":"팀 폴더 삭제","description":"팀 폴더를 삭제합니다.","operationId":"deleteTeams","parameters":[{"name":"teamId","in":"path","description":"팀 ID 입력","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"responses":{"204":{"description":"OK","content":{"application/json":{}}},"404":{"description":"Not Found"},"400":{"description":"Bad Request"}}}},"/openapi/v1/companys/teams/members":{"post":{"tags":["회사"],"summary":"팀 사용자 초대","description":"이메일로 팀원을 초대합니다.","operationId":"inviteTeamMember","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ApiReqTeamMemberDTO"}}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResTeamMemberDTO"}}}},"404":{"description":"Not Found"},"400":{"description":"Bad Request"}}},"delete":{"tags":["회사"],"summary":"팀원 삭제","description":"팀원의 고유키로 삭제합니다.","operationId":"deleteTeamMembers","parameters":[{"name":"uid","in":"query","description":"고유 식별자","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"OK"},"404":{"description":"Not Found"},"400":{"description":"Bad Request"}}}},"/openapi/v1/companys/point":{"get":{"tags":["회사"],"summary":"잔여 포인트(건수) 조회","description":"잔여 포인트(건수)를 조회합니다.","operationId":"getPoint","responses":{"404":{"description":"Not Found"},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResPointDTO"}}}}}}},"/openapi/v1/companys/teams/{teamId}/{memberId}":{"patch":{"tags":["회사"],"summary":"팀원 이동","description":"팀원을 다른 팀으로 이동합니다.","operationId":"moveMemberTeam","parameters":[{"name":"teamId","in":"path","description":"폴더 아이디","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"memberId","in":"path","description":"사용자 ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResTeamMemberDTO"}}}},"404":{"description":"Not Found"},"400":{"description":"Bad Request"}}}},"/openapi/v1/companys/custom/email":{"get":{"tags":["회사"],"summary":"이메일 맞춤설정 조회","description":"이메일 맞춤설정을 조회합니다.","operationId":"getCustomEmail","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResCustomEmailDTO"}}}},"404":{"description":"Not Found"}}},"put":{"tags":["회사"],"summary":"이메일 맞춤설정 변경","description":"이메일 맞춤설정을 변경합니다.","operationId":"updateCustomEmail","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiReqCustomEmailDTO"}}},"required":true},"responses":{"204":{"description":"OK","content":{"application/json":{}}},"404":{"description":"Not Found"}}}},"/openapi/v1/companys/custom/email/logo":{"put":{"tags":["회사"],"summary":"이메일 맞춤설정 로고 변경","description":"이메일 맞춤설정 로고를 변경합니다.","operationId":"updateCustomEmailLogo","requestBody":{"content":{"multipart/form-data":{"schema":{"required":["logo"],"type":"object","properties":{"logo":{"type":"string","description":"Contents-Type: 'multipart/form-data' 형태로 요청해주세요.
허용 가능 확장자 : png, jpg, jpeg
허용 가능 사이즈 : 최대 2MB (가로 최대 210px, 세로 최대 70px)","format":"binary"}}}}},"required":true},"responses":{"204":{"description":"OK","content":{"application/json":{}}},"404":{"description":"Not Found"}}}},"/openapi/v1/contracts/{contractId}/cancel":{"post":{"tags":["계약"],"summary":"계약 요청 취소","description":"요청한 계약을 취소 합니다.","operationId":"cancelContract","parameters":[{"name":"contractId","in":"path","description":"계약 ID","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"404":{"description":"Not Found"},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResContractCancel"}}}},"400":{"description":"Bad Request"}}}},"/openapi/v1/contracts":{"get":{"tags":["계약"],"summary":"전체 계약 조회","description":"개인 계약서 리스트를 조회 합니다.
- 폴더ID 조회할 경우 memberId는 필수 입니다.","operationId":"getUserContracts","parameters":[{"name":"memberId","in":"query","description":"사용자 ID","required":false,"schema":{"type":"string","description":"사용자 ID"}},{"name":"title","in":"query","description":"계약서 제목","required":false,"schema":{"type":"string","description":"계약서 제목","nullable":true}},{"name":"folderId","in":"query","description":"폴더 ID (보낸 계약 : 1, 받은 계약 : 2, 임시 저장 : 3, 노무/근로계약 : 7, 동의서 : 8)","required":false,"schema":{"type":"string","description":"폴더 ID (보낸 계약 : 1, 받은 계약 : 2, 임시 저장 : 3, 노무/근로계약 : 7, 동의서 : 8)","nullable":true}},{"name":"startDate","in":"query","description":"시작 일자 (yyyy-MM-dd)","required":false,"schema":{"type":"string","description":"시작 일자 (yyyy-MM-dd)","format":"date","nullable":true,"example":"2020-01-01"},"example":"2020-01-01"},{"name":"endDate","in":"query","description":"종료 일자 (yyyy-MM-dd)","required":false,"schema":{"type":"string","description":"종료 일자 (yyyy-MM-dd)","format":"date","nullable":true}},{"name":"page","in":"query","description":"조회 할 페이지 번호","required":false,"schema":{"minimum":1,"type":"integer","description":"조회 할 페이지 번호","format":"int32","default":1}},{"name":"rows","in":"query","description":"페이지에서 가져올 문서 개수","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer","description":"페이지에서 가져올 문서 개수","default":10}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResContractPageDTO_Default"}}}},"404":{"description":"Not Found"},"400":{"description":"Bad Request"}}}},"/openapi/v1/contracts/folders/{memberId}":{"get":{"tags":["계약"],"summary":"폴더함 조회","description":"멤버 폴더함을 조회합니다.","operationId":"getContractFolders","parameters":[{"name":"memberId","in":"path","description":"사용자 ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiDocFolder_Detail"}}}},"404":{"description":"Not Found"},"400":{"description":"Bad Request"}}},"post":{"tags":["계약"],"summary":"폴더함 생성","description":"멤버 폴더함을 생성합니다.","operationId":"createContractFolder","parameters":[{"name":"memberId","in":"path","description":"사용자 ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiReqCreateFolderDTO_Default"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiDocFolder_Default"}}}},"404":{"description":"Not Found"},"400":{"description":"Bad Request"}}},"patch":{"tags":["계약"],"summary":"폴더명 변경","description":"멤버 폴더함 폴더명을 변경 합니다.","operationId":"renameCotractFolder","parameters":[{"name":"memberId","in":"path","description":"사용자 ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiReqRenameFolderDTO_Default"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiDocFolder_Default"}}}},"404":{"description":"Not Found"},"400":{"description":"Bad Request"}}}},"/openapi/v1/contracts/{contractId}/resend":{"post":{"tags":["계약"],"summary":"계약 재전송","description":"현재 서명해야할 참여자에게 계약 알림을 재전송합니다.
순서없이 서명하기일 경우 서명대기 참여자에게 모두 발송 됩니다.","operationId":"resendContract","parameters":[{"name":"contractId","in":"path","description":"계약 ID","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"404":{"description":"Not Found"},"200":{"description":"알림 전송한 데이터만 출력됩니다.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResContractDTO"}}}},"400":{"description":"Bad Request"}}}},"/openapi/v1/contracts/{contractId}/history":{"get":{"tags":["계약"],"summary":"계약 이력 조회","description":"계약 이력 조회합니다.","operationId":"getContractHistory","parameters":[{"name":"contractId","in":"path","description":"계약서 ID","required":true,"schema":{"type":"string","description":"계약서 ID","format":"uuid"}}],"responses":{"404":{"description":"Not Found"},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResContractHistoryDTO"}}}},"400":{"description":"Bad Request"}}}},"/openapi/v1/contracts/{contractId}/detail":{"get":{"tags":["계약"],"summary":"계약 상세 조회","description":"계약 상세 조회합니다.","operationId":"getContractDetail","parameters":[{"name":"contractId","in":"path","description":"계약서 ID","required":true,"schema":{"type":"string","description":"계약서 ID","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResContractDetailDTO_Detail"}}}},"404":{"description":"Not Found"},"400":{"description":"Bad Request"}}}},"/openapi/v1/contracts/folders/{memberId}/{folderId}":{"delete":{"tags":["계약"],"summary":"폴더함 삭제","description":"멤버 폴더함을 삭제합니다. 폴더를 삭제할 경우 폴더 안에 계약서는 휴지통으로 이동합니다.","operationId":"deleteContractFolder","parameters":[{"name":"memberId","in":"path","description":"사용자 ID","required":true,"schema":{"type":"string"}},{"name":"folderId","in":"path","description":"폴더 ID","required":true,"schema":{"minimum":20,"type":"integer","format":"int32"}}],"responses":{"204":{"description":"OK"},"404":{"description":"Not Found"},"400":{"description":"Bad Request"}}}},"/openapi/v1/contracts/external":{"get":{"tags":["계약"],"summary":"외부 문서함 조회","description":"외부 문서함을 조회합니다.","operationId":"getExternalDocuments","parameters":[{"name":"title","in":"query","description":"문서명","required":false,"schema":{"type":"string","description":"문서명"}},{"name":"externalDocumentId","in":"query","description":"외부문서 ID","required":false,"schema":{"type":"string","description":"외부문서 ID"}},{"name":"memberId","in":"query","description":"사용자 조회에서 얻은 memberId","required":false,"schema":{"type":"string","description":"사용자 조회에서 얻은 memberId"}},{"name":"startDate","in":"query","description":"계약일(시작)","required":false,"schema":{"type":"string","description":"계약일(시작)","format":"date","example":"2020-01-01"},"example":"2020-01-01"},{"name":"endDate","in":"query","description":"계약일(종료)","required":false,"schema":{"type":"string","description":"계약일(종료)","format":"date","example":"2020-01-01"},"example":"2020-01-01"},{"name":"startLimitDate","in":"query","description":"계약 만료일(시작)","required":false,"schema":{"type":"string","description":"계약 만료일(시작)","format":"date","example":"2024-06-25"},"example":"2024-06-25"},{"name":"endLimitDate","in":"query","description":"계약 만료일(종료)","required":false,"schema":{"type":"string","description":"계약 만료일(종료)","format":"date","example":"2024-06-25"},"example":"2024-06-25"},{"name":"page","in":"query","description":"조회 할 페이지 번호","required":false,"schema":{"minimum":1,"type":"integer","description":"조회 할 페이지 번호","format":"int32","default":1}},{"name":"rows","in":"query","description":"페이지에서 가져올 문서 개수","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer","description":"페이지에서 가져올 문서 개수","default":10}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResExternalDocumentPageDTO"}}}},"404":{"description":"Not Found"},"400":{"description":"Bad Request"}}},"post":{"tags":["계약"],"summary":"외부 문서함 업로드","description":"외부 문서함을 업로드합니다.","operationId":"uploadExternalDocument","requestBody":{"content":{"multipart/form-data":{"schema":{"required":["file","upload"],"type":"object","properties":{"file":{"type":"array","items":{"type":"string","format":"binary"}},"upload":{"$ref":"#/components/schemas/upload"}}}}}},"responses":{"404":{"description":"Not Found"},"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ExternalDocument"}}}}},"400":{"description":"Bad Request"}}}},"/openapi/v1/contracts/completed/download":{"get":{"tags":["계약"],"summary":"계약 사본 파일 다운로드","description":"완료된 계약 파일을 다운로드 합니다.","operationId":"downloadCompletedContract","parameters":[{"name":"contractId","in":"query","description":"조회한 계약 ID List","required":true,"schema":{"maxItems":10,"minItems":0,"type":"array","items":{"type":"string","format":"uuid"}}}],"responses":{"404":{"description":"Not Found"},"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/downloads_Contract"}}}}},"400":{"description":"Bad Request"}}}},"/openapi/v1/contracts/resend/complete":{"post":{"tags":["계약"],"summary":"완료된 계약 알림 재전송","description":"계약내 서명자를 선택해 완료된 계약 알림을 재전송 합니다.","operationId":"resendCompleteContract","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiReqResendCompleteContractDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResContractResendDTO"}}}},"404":{"description":"Not Found"},"400":{"description":"Bad Request"}}}},"/openapi/v1/contracts/{contractId}/reviewed":{"post":{"tags":["계약"],"summary":"검토 확인 계약서 전송","description":"검토 확인된 계약서를 전송 합니다.","operationId":"sendReviewedContract","parameters":[{"name":"contractId","in":"path","description":"계약 ID","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"folderId","in":"query","description":"계약 폴더 ID","required":false,"content":{"application/x-www-form-urlencoded":{}}}],"responses":{"404":{"description":"Not Found"},"200":{"description":"전송이 완료 되었습니다.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResContractResendDTO"}}}},"400":{"description":"Bad Request"}}}},"/openapi/v1/contracts/external/download":{"get":{"tags":["계약"],"summary":"외부 문서 다운로드","description":"외부 문서 다운로드 합니다.","operationId":"downloadExternalDocument","parameters":[{"name":"contractId","in":"query","description":"조회한 외부문서의 ID List","required":true,"schema":{"maxItems":10,"minItems":0,"type":"array","items":{"type":"string","format":"uuid"}}}],"responses":{"404":{"description":"Not Found"},"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/downloads_Default"}}}}},"400":{"description":"Bad Request"}}}},"/openapi/v1/contracts/{contractId}/preview":{"get":{"tags":["임베디드"],"summary":"임베디드 계약서 문서 확인","description":"에디터 화면으로 생성된 문서를 확인 합니다.","operationId":"getContractPreview","parameters":[{"name":"contractId","in":"path","required":true,"schema":{"type":"string"}},{"name":"memberId","in":"query","required":true,"schema":{"type":"string"}},{"name":"redirectUrl","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"404":{"description":"Not Found"},"200":{"description":"요청 URL 정보","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResLinkUrl"}}}},"400":{"description":"Bad Request"}}}},"/openapi/v1/templates/{templateId}/edit":{"get":{"tags":["임베디드"],"summary":"임베디드 템플릿 문서 수정","description":"에디터 화면으로 템플릿을 수정할 수 있습니다. ","operationId":"templateEdit","parameters":[{"name":"templateId","in":"path","required":true,"schema":{"type":"string"}},{"name":"memberId","in":"query","required":true,"schema":{"type":"string"}},{"name":"redirectUrl","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"404":{"description":"Not Found"},"200":{"description":"요청 URL 정보","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResLinkUrl"}}}},"400":{"description":"Bad Request"}}}},"/openapi/v1/contracts/{contractId}/edit":{"get":{"tags":["임베디드"],"summary":"임베디드 계약서 문서 수정","description":"에디터 화면으로 계약서를 수정할 수 있습니다.
(계약서 진행 상태는 수정이 불가능합니다.)","operationId":"contractEdit","parameters":[{"name":"contractId","in":"path","required":true,"schema":{"type":"string"}},{"name":"memberId","in":"query","required":true,"schema":{"type":"string"}},{"name":"redirectUrl","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"404":{"description":"Not Found"},"200":{"description":"요청 URL 정보","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResLinkUrl"}}}},"400":{"description":"Bad Request"}}}},"/openapi/v1/login":{"post":{"tags":["임베디드"],"summary":"임베디드 사용자 로그인","description":"얼마싸인 로그인이 가능 합니다.
응답 linkUrl은 접속 가능한 URL이 전달됩니다.해당 URL은 1분동안 접속 가능합니다.","operationId":"embeddedLogin","parameters":[{"name":"memberId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"404":{"description":"Not Found"},"200":{"description":"요청 URL 정보","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResLinkUrl"}}}},"400":{"description":"Bad Request"}}}},"/openapi/v1/templates":{"get":{"tags":["템플릿"],"summary":"전체 템플릿 조회","description":"개인 템플릿 리스트를 조회 합니다.
- 폴더ID 조회할 경우 memberId는 필수 입니다.","operationId":"getUserTemplates","parameters":[{"name":"memberId","in":"query","description":"사용자 ID","required":false,"schema":{"type":"string","description":"사용자 ID","nullable":true}},{"name":"title","in":"query","description":"템플릿 제목","required":false,"schema":{"type":"string","description":"템플릿 제목","nullable":true}},{"name":"folderId","in":"query","description":"폴더 ID (My 템플릿 : 1)","required":false,"schema":{"title":"Use With memberId","type":"string","description":"폴더 ID (My 템플릿 : 1)","nullable":true}},{"name":"signerCount","in":"query","description":"서명자 수","required":false,"schema":{"type":"integer","description":"서명자 수","nullable":true}},{"name":"startDate","in":"query","description":"시작 일자 (yyyy-MM-dd)","required":false,"schema":{"type":"string","description":"시작 일자 (yyyy-MM-dd)","format":"date","nullable":true,"example":"2020-01-01"},"example":"2020-01-01"},{"name":"endDate","in":"query","description":"종료 일자 (yyyy-MM-dd)","required":false,"schema":{"type":"string","description":"종료 일자 (yyyy-MM-dd)","format":"date","nullable":true}},{"name":"page","in":"query","description":"조회 할 페이지 번호","required":false,"schema":{"minimum":1,"type":"integer","description":"조회 할 페이지 번호","format":"int32","default":1}},{"name":"rows","in":"query","description":"페이지에서 가져올 문서 개수","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer","description":"페이지에서 가져올 문서 개수","default":10}}],"responses":{"404":{"description":"Not Found"},"400":{"description":"Bad Request"},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResTemplatePageDTO_Default"}}}}}},"post":{"tags":["임베디드"],"summary":"임베디드 템플릿 생성","description":"양식을 업로드해서 에디터 화면 템플릿을 생성합니다.","operationId":"createTemplate","parameters":[{"name":"memberId","in":"query","required":true,"schema":{"type":"string"}},{"name":"title","in":"query","required":false,"schema":{"type":"string"}},{"name":"folderId","in":"query","description":"default : 1(My 템플릿)","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"redirectUrl","in":"query","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["file"],"type":"object","properties":{"file":{"type":"string","description":"Contents-Type: 'multipart/form-data' 형태로 요청해주세요.","format":"binary"}}}}},"required":true},"responses":{"404":{"description":"Not Found"},"200":{"description":"요청 URL 정보","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResLinkUrl"}}}},"400":{"description":"Bad Request"}}},"delete":{"tags":["템플릿"],"summary":"템플릿 삭제","description":"템플릿을 삭제합니다.","operationId":"deleteTemplate","parameters":[{"name":"templateId","in":"query","description":"템플릿 ID","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"204":{"description":"OK","content":{"application/json":{}}},"404":{"description":"Not Found"},"400":{"description":"Bad Request"}}}},"/openapi/v1/templates/contracts":{"post":{"tags":["임베디드"],"summary":"임베디드 템플릿으로 전자계약 생성","description":"템플릿으로 전자계약을 생성하여 에디터 화면으로 편집 후 계약서를 발송할 수 있습니다. ","operationId":"createTemplateToContract","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiReqEmbeddedContractSettingDTO_Request"}}},"required":true},"responses":{"404":{"description":"Not Found"},"200":{"description":"요청 URL 정보","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResLinkUrl_Request"}}}},"400":{"description":"Bad Request"}}}},"/openapi/v1/bulk/templates/{bulkContractId}":{"get":{"tags":["임베디드"],"summary":"임베디드 대량전송 템플릿 문서 확인","description":"에디터 화면으로 대량전송 템플릿 문서를 확인 합니다.","operationId":"geBulkTemplateEmbeddedUrl","parameters":[{"name":"bulkContractId","in":"path","required":true,"schema":{"type":"string"}},{"name":"memberId","in":"query","required":true,"schema":{"type":"string"}},{"name":"redirectUrl","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"404":{"description":"Not Found"},"200":{"description":"요청 URL 정보","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResLinkUrl"}}}},"400":{"description":"Bad Request"}}}},"/openapi/v1/templates/folders/{memberId}":{"get":{"tags":["템플릿"],"summary":"폴더함 조회","description":"My 템플릿 폴더함을 조회합니다.
(My 템플릿 폴더 ID = 1)","operationId":"getTemplateFolders","parameters":[{"name":"memberId","in":"path","description":"사용자 ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiDocFolder_Detail"}}}},"404":{"description":"Not Found"},"400":{"description":"Bad Request"}}},"post":{"tags":["템플릿"],"summary":"폴더함 생성","description":"My 템플릿 폴더를 생성합니다.","operationId":"createTemplateFolder","parameters":[{"name":"memberId","in":"path","description":"사용자 ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiReqCreateFolderDTO_Default"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiDocFolder_Default"}}}},"404":{"description":"Not Found"},"400":{"description":"Bad Request"}}},"patch":{"tags":["템플릿"],"summary":"폴더명 변경","description":"My 템플릿 폴더명을 변경합니다","operationId":"renameTemplateFolder","parameters":[{"name":"memberId","in":"path","description":"사용자 ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiReqRenameFolderDTO_Default"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiDocFolder_Default"}}}},"404":{"description":"Not Found"},"400":{"description":"Bad Request"}}}},"/openapi/v1/templates/top/{templateId}/folders/{memberId}":{"post":{"tags":["템플릿"],"summary":"템플릿 복사(상위 회사 템플릿 복사)","description":"회원가입 API를 사용해, 등록된 업체의 상위 회사 템플릿을 해당 업체 멤버의 폴더함으로
복사합니다. (해당 업체 토큰 사용)","operationId":"copyUpperTemplate","parameters":[{"name":"templateId","in":"path","description":"상위 회사 템플릿 ID","required":true,"schema":{"type":"string","description":"상위 회사 템플릿 ID","format":"uuid"}},{"name":"memberId","in":"path","description":"해당 업체 사용자 ID","required":true,"schema":{"type":"string"}},{"name":"title","in":"query","description":"템플릿 이름","required":false,"schema":{"type":"string"}},{"name":"folderId","in":"query","description":"해당 업체 사용자 폴더 ID","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"404":{"description":"Not Found"},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResTemplateDTO_Default"}}}},"400":{"description":"Bad Request"}}}},"/openapi/v1/templates/{templateId}/preview":{"get":{"tags":["템플릿"],"summary":"템플릿 미리보기","description":"템플릿을Html로 미리보기를 지원합니다.","operationId":"getTemplatePreview","parameters":[{"name":"templateId","in":"path","description":"템플릿 ID","required":true,"schema":{"type":"string","description":"템플릿 ID","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResTemplatePreviewDTO"}}}},"404":{"description":"존재하지 않는 템플릿 입니다."},"400":{"description":"Bad Request"}}}},"/openapi/v1/templates/{templateId}":{"get":{"tags":["템플릿"],"summary":"템플릿 상세 조회","description":"템플릿 정보를 상세 조회 합니다.","operationId":"getTemplate","parameters":[{"name":"templateId","in":"path","description":"템플릿 ID","required":true,"schema":{"type":"string","description":"템플릿 ID"}}],"responses":{"404":{"description":"Not Found"},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResTemplateDTO"}}}},"400":{"description":"Bad Request"}}}},"/openapi/v1/templates/{templateId}/folders/{memberId}/{folderId}":{"patch":{"tags":["템플릿"],"summary":"템플릿 이동","description":"템플릿을 다른 폴더함으로 이동 합니다.","operationId":"moveTemplate","parameters":[{"name":"templateId","in":"path","description":"템플릿 ID","required":true,"schema":{"type":"string","description":"템플릿 ID","format":"uuid"}},{"name":"memberId","in":"path","description":"사용자 ID","required":true,"schema":{"type":"string"}},{"name":"folderId","in":"path","description":"폴더 ID","required":true,"schema":{"minimum":20,"type":"integer","format":"int32"}}],"responses":{"404":{"description":"Not Found"},"200":{"description":"템플릿 이동 성공","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResTemplateDTO_Default"}}}},"400":{"description":"Bad Request"}}}},"/openapi/v1/templates/{templateId}/folders/{memberId}":{"post":{"tags":["템플릿"],"summary":"템플릿 복사","description":"템플릿을 멤버의 폴더함으로 복사합니다.","operationId":"copyTemplate","parameters":[{"name":"templateId","in":"path","description":"템플릿 ID","required":true,"schema":{"type":"string","description":"템플릿 ID","format":"uuid"}},{"name":"memberId","in":"path","description":"사용자 ID","required":true,"schema":{"type":"string"}},{"name":"title","in":"query","description":"템플릿 이름","required":false,"schema":{"type":"string"}},{"name":"folderId","in":"query","description":"폴더 ID","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"404":{"description":"Not Found"},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResTemplateDTO_Default"}}}},"400":{"description":"Bad Request"}}}},"/openapi/v1/templates/contract":{"post":{"tags":["템플릿"],"summary":"템플릿으로 계약 생성","description":"템플릿으로 계약 생성 합니다.
- 계약 요청자 정보는 memberId(얼마싸인 가입된 회원 정보)
또는 requester(요청자 정보 입력) 중 하나를 반드시 입력해야 합니다.
두 항목이 모두 입력된 경우, memberId를 우선 적용 됩니다.

- 미리 서명자 존재시 요청자 기본정보(이름,휴대폰번호,이메일)
미리 서명 적용한 서명자에게 적용됩니다.","operationId":"createContractWithTemplate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiReqUserSettingDTO_Request"}}},"required":true},"responses":{"404":{"description":"Not Found"},"200":{"description":"계약 생성 완료","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResTemplateToContractDTO_Request"}}}},"400":{"description":"Bad Request"}}}},"/openapi/v1/templates/{templateId}/attaches":{"post":{"tags":["템플릿"],"summary":"첨부파일 업로드","description":"템플릿에 첨부파일을 업로드합니다.","operationId":"uploadTemplateAttaches","parameters":[{"name":"templateId","in":"path","description":"템플릿 ID","required":true,"schema":{"type":"string","description":"템플릿 ID"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["file"],"type":"object","properties":{"file":{"type":"array","description":"Contents-Type: 'multipart/form-data' 형태로 요청해주세요.","items":{"type":"string","format":"binary"}}}}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Attach"}}}},"404":{"description":"Not Found"},"400":{"description":"Bad Request"}}},"delete":{"tags":["템플릿"],"summary":"첨부파일 삭제","description":"첨부파일을 삭제합니다.","operationId":"deleteTemplateAttaches","parameters":[{"name":"templateId","in":"path","description":"템플릿 ID","required":true,"schema":{"type":"string","description":"템플릿 ID"}},{"name":"attachId","in":"query","description":"첨부파일 고유 ID","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"204":{"description":"OK","content":{"application/json":{}}},"404":{"description":"Not Found"},"400":{"description":"Bad Request"}}}},"/openapi/v1/templates/folders/{memberId}/{folderId}":{"delete":{"tags":["템플릿"],"summary":"폴더함 삭제","description":"My 템플릿 폴더를 삭제합니다.","operationId":"deleteTemplateFolder","parameters":[{"name":"memberId","in":"path","description":"사용자 ID","required":true,"schema":{"type":"string"}},{"name":"folderId","in":"path","description":"폴더 ID","required":true,"schema":{"minimum":20,"type":"integer","format":"int32"}}],"responses":{"204":{"description":"OK"},"404":{"description":"Not Found"},"400":{"description":"Bad Request"}}}},"/openapi/v1/templates/{templateId}/files-req":{"post":{"tags":["템플릿"],"summary":"서명자 첨부파일 요청 추가","description":"템플릿 서명자의 첨부파일 요청을 추가합니다.","operationId":"createTemplateFilesReq","parameters":[{"name":"templateId","in":"path","description":"템플릿 ID","required":true,"schema":{"type":"string","description":"템플릿 ID"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/contractorFileReq"}}},"required":true},"responses":{"404":{"description":"Not Found"},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileReq"}}}},"400":{"description":"Bad Request"}}},"delete":{"tags":["템플릿"],"summary":"서명자 첨부파일 요청 삭제","description":"서명자 첨부파일 요청을 삭제합니다.","operationId":"deleteTemplateFilesReq","parameters":[{"name":"templateId","in":"path","description":"템플릿 ID","required":true,"schema":{"type":"string","description":"템플릿 ID"}},{"name":"fileReqIndex","in":"query","description":"첨부파일 요청 고유 번호","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"depth","in":"query","description":"수신자 depth","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"204":{"description":"OK","content":{"application/json":{}}},"404":{"description":"Not Found"},"400":{"description":"Bad Request"}}}},"/openapi/v1/users":{"get":{"tags":["사용자"],"summary":"사용자 조회","description":"사용자 정보를 조회합니다.","operationId":"getUserInfo","parameters":[{"name":"memberId","in":"query","description":"사용자 ID","required":false,"schema":{"type":"string"}},{"name":"email","in":"query","description":"사용자 이메일","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserList"}}}},"404":{"description":"Not Found"},"400":{"description":"Bad Request"}}}},"/openapi/v1/users/addresses":{"post":{"tags":["사용자"],"summary":"주소록 사용자 추가","description":"주소록 그룹에 사용자를 추가합니다.","operationId":"addAddress","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiReqAddressListDTO"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{}}},"404":{"description":"Not Found"},"400":{"description":"Bad Request"}}},"delete":{"tags":["사용자"],"summary":"주소록 사용자 삭제","description":"주소록 그룹에 포함된 사용자를 삭제합니다.","operationId":"deleteAddress","parameters":[{"name":"addressId","in":"query","description":"주소록 ID","required":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"memberId","in":"query","description":"사용자 ID","required":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"OK","content":{"application/json":{}}},"404":{"description":"Not Found"},"400":{"description":"Bad Request"}}},"patch":{"tags":["사용자"],"summary":"주소록 사용자 이동","description":"주소록 그룹으로 사용자를 이동합니다.","operationId":"moveAddress","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiReqAddressGroupDTO"}}},"required":true},"responses":{"404":{"description":"Not Found"},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResAddressGroupDTO"}}}},"400":{"description":"Bad Request"}}}},"/openapi/v1/users/addresses/groups":{"get":{"tags":["사용자"],"summary":"주소록 그룹 조회","description":"사용자의 주소록 그룹 조회합니다.","operationId":"getAddressGroups","parameters":[{"name":"memberId","in":"query","description":"사용자 ID","required":false,"schema":{"type":"string"}}],"responses":{"404":{"description":"Not Found"},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResAddressGroupDTO"}}}},"400":{"description":"Bad Request"}}},"post":{"tags":["사용자"],"summary":"주소록 그룹 생성","description":"주소록 그룹을 생성합니다.","operationId":"createAddressGroup","parameters":[{"name":"groupName","in":"query","description":"그룹명","required":true,"schema":{"type":"string"}},{"name":"memberId","in":"query","description":"사용자 ID","required":false,"schema":{"type":"string"}}],"responses":{"404":{"description":"Not Found"},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupId"}}}},"400":{"description":"Bad Request"}}},"delete":{"tags":["사용자"],"summary":"주소록 그룹 삭제","description":"주소록 그룹을 삭제합니다.","operationId":"deleteAddressGroup","parameters":[{"name":"groupId","in":"query","description":"그룹 ID","required":true,"schema":{"type":"string"}},{"name":"memberId","in":"query","description":"사용자 ID","required":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"OK","content":{"application/json":{}}},"404":{"description":"Not Found"},"400":{"description":"Bad Request"}}}},"/openapi/v1/webhooks":{"get":{"tags":["웹훅"],"summary":"전체 웹훅 조회","description":"전체 웹훅 목록을 조회 합니다.","operationId":"selectWebhookPageByCdCompany","parameters":[{"name":"page","in":"query","description":"조회 할 페이지 번호","required":false,"schema":{"minimum":1,"type":"integer","description":"조회 할 페이지 번호","format":"int32","default":1}},{"name":"rows","in":"query","description":"페이지에서 가져올 문서 개수","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer","description":"페이지에서 가져올 문서 개수","default":10}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResWebhookPageDTO_Default"}}}},"404":{"description":"Not Found"},"400":{"description":"Bad Request"}}},"post":{"tags":["웹훅"],"summary":"웹훅 등록","description":"웹훅을 등록 합니다.","operationId":"saveWebhook","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiReqSaveWebhookDTO"}}},"required":true},"responses":{"404":{"description":"Not Found"},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResSaveWebhookDTO"}}}},"400":{"description":"Bad Request"}}}},"/openapi/v1/webhooks/{webhookId}":{"patch":{"tags":["웹훅"],"summary":"웹훅 수정","description":"웹훅을 수정 합니다.","operationId":"updateWebhook","parameters":[{"name":"webhookId","in":"path","description":"웹훅 ID","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiReqUpdateWebhookDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResUpdateWebhookDTO"}}}},"404":{"description":"Not Found"},"400":{"description":"Bad Request"}}}},"/openapi/v1/webhooks/{webhookId}/detail":{"get":{"tags":["웹훅"],"summary":"웹훅 상세 조회","description":"웹훅을 상세 조회 합니다.","operationId":"selectWebhookDetail","parameters":[{"name":"webhookId","in":"path","description":"웹훅 ID","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"404":{"description":"Not Found"},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResWebhookDTO_Detail"}}}},"400":{"description":"Bad Request"}}}}},"components":{"schemas":{"ApiReqCustomEmailDTO":{"type":"object","properties":{"link":{"type":"string","description":"로고 링크
- https:// 혹은 http:// 를 제외하고 입력해 주세요.","example":"www.iquest.co.kr"},"backgroundColor":{"type":"string","description":"버튼 배경 색상
- HEX 코드로 입력해주세요.","example":"#000000"},"fontColor":{"type":"string","description":"버튼 글자 색상
- HEX 코드로 입력해주세요.","example":"#000000"},"callerName":{"type":"string","description":"발신자명","example":"얼마싸인"},"brandMessageTop":{"type":"string","description":"브랜딩메시지-상단","example":"디지털 계약 & 증빙관리"},"brandMessageBottom":{"type":"string","description":"브랜딩메시지-하단","example":"전자계약과 거래증빙관리의 결합 서비스"}}},"ApiReqSaveWebhookDTO":{"title":"webhook","required":["activationStatus","eventType","name","uri"],"type":"object","properties":{"name":{"type":"string","description":"웹훅 명칭"},"uri":{"type":"string","description":"웹훅 이벤트를 전달받을 POST URI"},"eventType":{"type":"string","description":"웹훅에 지정할 이벤트 타입
BEFORE_SENDING_CONTRACT : 계약 전송 이전
AFTER_SENDING_CONTRACT : 계약 전송 이후
SIGNED_CONTRACT : 서명자 서명 이후
SIGN_ALL_CONTRACT : 서명자 모두 서명 이후
REJECTED_SIGN : 서명 거절 이후
CANCELLED_CONTRACT : 계약 취소 이후
BEFORE_SENDING_BULK : 대량 전송 이전
AFTER_SENDING_BULK : 대량 전송 이전
APPROVE_CONTRACT : 결재자 결재 이후
APPROVE_ALL_CONTRACT : 결재자 모두 결재 이후
COMPANION_CONTRACT : 결재자 반려 이후","enum":["BEFORE_SENDING_CONTRACT","AFTER_SENDING_CONTRACT","SIGNED_CONTRACT","SIGNED_ALL_CONTRACT","REJECTED_SIGN","CANCELLED_CONTRACT","BEFORE_SENDING_BULK","AFTER_SENDING_BULK","APPROVE_CONTRACT","APPROVE_ALL_CONTRACT","COMPANION_CONTRACT"]},"activationStatus":{"type":"string","description":"이벤트 활성화 여부
활성화 : ACTIVE
비활성화 : INACTIVE","default":"ACTIVE","enum":["ACTIVE","INACTIVE"]},"headers":{"title":"headers","type":"array","description":"웹훅 헤더 설정 정보","items":{"$ref":"#/components/schemas/ApiWebhookHeaderDTO"}}},"description":"웹훅을 저장 합니다"},"ApiWebhookHeaderDTO":{"title":"header","type":"object","properties":{"key":{"type":"string","description":"헤더 key"},"value":{"type":"string","description":"헤더 value"}},"description":"웹훅 헤더 설정 정보"},"ApiResSaveWebhookDTO":{"required":["webhookId"],"type":"object","properties":{"webhookId":{"type":"string","description":"웹훅 ID"}}},"ApiReqAddressDTO":{"title":"Address","required":["email","groupId","name","phone"],"type":"object","properties":{"groupId":{"type":"string","description":"그룹 ID"},"name":{"type":"string","description":"이름"},"email":{"type":"string","description":"이메일"},"phone":{"type":"string","description":"전화번호"},"memberId":{"type":"string","description":"사용자 ID"}},"description":"주소록 DTO"},"ApiReqAddressListDTO":{"required":["addressList"],"type":"object","properties":{"addressList":{"title":"addressList","type":"array","description":"주소록","items":{"$ref":"#/components/schemas/ApiReqAddressDTO"}}}},"GroupId":{"required":["groupName"],"type":"object","properties":{"groupName":{"type":"string","description":"그룹명"},"groupId":{"type":"string","description":"그룹 ID"},"memberId":{"type":"string","description":"사용자 ID"}}},"ApiResLinkUrl":{"type":"object","properties":{"documentId":{"type":"string","description":"문서 ID"},"expired":{"type":"string","description":"만료 날자","format":"date-time"},"linkUrl":{"type":"string","description":"임베디드 링크"}}},"ApiResTemplateDTO_Default":{"title":"template","required":["createdAt","folderName","memberId","templateId","title","updatedAt"],"type":"object","properties":{"templateId":{"type":"string","description":"템플릿 ID"},"title":{"type":"string","description":"템플릿명"},"favorites":{"type":"boolean","description":"템플릿 즐겨찾기 여부","nullable":true},"folderName":{"type":"string","description":"템플릿 폴더 이름"},"memberId":{"type":"string","description":"사용자 ID(템플릿 소유자 ID)"},"createdAt":{"type":"string","description":"템플릿 생성 시간","format":"date-time"},"updatedAt":{"type":"string","description":"템플릿 마지막 업데이트 시간","format":"date-time"}},"description":"템플릿 DTO"},"contractorFileReq":{"required":["depth","type"],"type":"object","properties":{"depth":{"maximum":10,"minimum":1,"type":"integer","description":"첨부파일 요청을 추가할 수신자 depth","format":"int32"},"type":{"type":"string","description":"첨부파일 종류"},"message":{"type":"string","description":"전달 사항","nullable":true},"necessary":{"type":"boolean","description":"필수 여부","default":false}},"description":"서명자 첨부파일 요청 DTO"},"ApiResTemplateFileReqDTO":{"title":"requesterAttachments","required":["type"],"type":"object","properties":{"depth":{"type":"integer","description":"수신자 depth","format":"int32"},"fileReqIndex":{"type":"integer","description":"첨부파일 요청 고유 번호","format":"int32"},"type":{"type":"string","description":"첨부파일 종류"},"message":{"type":"string","description":"전달 사항","nullable":true},"necessary":{"type":"string","description":"필수 여부","nullable":true}},"description":"첨부파일 요청 DTO"},"FileReq":{"required":["memberId","templateId"],"type":"object","properties":{"templateId":{"type":"string","description":"템플릿 ID"},"requesterAttaches":{"type":"array","description":"첨부파일 요청 정보","items":{"$ref":"#/components/schemas/ApiResTemplateFileReqDTO"}},"memberId":{"type":"string","description":"사용자 ID(템플릿 소유자 ID)"}}},"ApiResTemplateAttachDTO":{"title":"templateAttaches","required":["extension","name"],"type":"object","properties":{"name":{"type":"string","description":"파일명"},"extension":{"type":"string","description":"파일 확장자"},"size":{"type":"string","description":"파일 크기","nullable":true},"attachId":{"type":"string","description":"첨부파일 고유 ID","nullable":true}},"description":"첨부파일 DTO"},"Attach":{"required":["memberId","templateId"],"type":"object","properties":{"templateId":{"type":"string","description":"템플릿 ID"},"templateAttaches":{"type":"array","description":"첨부파일 정보","items":{"$ref":"#/components/schemas/ApiResTemplateAttachDTO"}},"memberId":{"type":"string","description":"사용자 ID(템플릿 소유자 ID)"}}},"ApiReqCreateFolderDTO_Default":{"required":["parentId","text"],"type":"object","properties":{"parentId":{"minimum":20,"type":"integer","description":"부모 폴더 ID","format":"int32","example":21},"text":{"type":"string","description":"폴더 이름","format":"string","example":"내 폴더명"}}},"ApiDocFolder_Default":{"type":"object","properties":{"parentId":{"type":"string","description":"부모 폴더 ID(# : 최상위 폴더)"},"folderId":{"type":"integer","description":"자식 폴더 ID","format":"int32"},"text":{"type":"string","description":"폴더 이름"},"depth":{"type":"integer","description":"폴더 레벨","format":"int32"}},"format":"Array of objects"},"ApiReferenceDTO_Request":{"title":"reference","required":["name","noticeType"],"type":"object","properties":{"noticeType":{"type":"string","description":"서명 알림 수단","enum":["EMAIL","KAKAO","ALL"]},"message":{"type":"string","description":"메시지"},"name":{"type":"string","description":"참조자 이름"},"phone":{"type":"string","description":"참조자 핸드폰 번호","example":"01012345678"},"email":{"type":"string","description":"참조자 이메일"}},"description":"참조자 리스트"},"ApiReqApprovalDTO_Request":{"title":"approval","required":["approvers","depth"],"type":"object","properties":{"simplifyYn":{"type":"boolean","description":"결재 간소화 여부","default":false},"message":{"type":"string","description":"결재 메세지"},"approvers":{"title":"approvers","type":"array","description":"결재자 정보","items":{"$ref":"#/components/schemas/Approver_Request"}},"depth":{"minimum":1,"type":"integer","description":"결재 depth","format":"int64"}},"description":"결재 정보"},"ApiReqAuthMfaDTO_Request":{"title":"authMfa","type":"object","properties":{"email":{"type":"string","description":"메일 본인 인증 메일 주소"},"smsPhoneNumber":{"type":"string","description":"SMS 인증 명의자 휴대폰 번호","example":"01012345678"},"password":{"$ref":"#/components/schemas/Password_Request"},"cert":{"$ref":"#/components/schemas/Cert_Request"},"phone":{"$ref":"#/components/schemas/Phone_Request"},"empty":{"type":"boolean"}},"description":"본인 인증 DTO"},"ApiReqEmbeddedContractSettingDTO_Request":{"type":"object","properties":{"userSetting":{"$ref":"#/components/schemas/ApiReqEmbeddedUserSettingDTO_Request"},"redirectUrl":{"type":"string"}}},"ApiReqEmbeddedSignerDTO_Request":{"title":"signer","type":"object","properties":{"noticeType":{"type":"string","description":"서명 알림 수단","enum":["EMAIL","KAKAO","ALL"]},"message":{"type":"string","description":"메시지"},"authMfa":{"$ref":"#/components/schemas/ApiReqAuthMfaDTO_Request"},"depth":{"type":"integer","description":"계약자 depth ( 1부터 시작 )","format":"int32"},"name":{"type":"string","description":"서명자 이름"},"phone":{"type":"string","description":"서명자 핸드폰 번호","example":"01012345678"},"email":{"type":"string","description":"서명자 이메일"},"role":{"type":"string","description":"서명자 역할"},"expirationAt":{"type":"string","description":"서명 만료일(yyyy-MM-dd)
default : 현재 날짜 + 15일","format":"date"}},"description":"서명자 리스트"},"ApiReqEmbeddedUserSettingDTO_Request":{"title":"userSetting","required":["templateId","title"],"type":"object","properties":{"templateId":{"type":"string","description":"템플릿 ID"},"title":{"type":"string","description":"계약서 제목"},"signers":{"maxItems":10,"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/ApiReqEmbeddedSignerDTO_Request"}},"requester":{"$ref":"#/components/schemas/ApiReqRequesterDTO_Request"},"orderYn":{"type":"boolean","description":"순차 서명","default":false},"confirmYn":{"type":"boolean","description":"내 계약 확인","default":false},"folderId":{"minimum":20,"type":"integer","description":"계약 폴더 ID
(서명 요청후 해당 폴더 ID 에 보관 됩니다. default : 보낸 계약)","format":"int32","default":1},"approvals":{"title":"approvals","type":"array","description":"결재 정보","items":{"$ref":"#/components/schemas/ApiReqApprovalDTO_Request"}},"references":{"title":"references","type":"array","description":"참조자 리스트","items":{"$ref":"#/components/schemas/ApiReferenceDTO_Request"}},"requesterField":{"$ref":"#/components/schemas/RequesterField_Request"},"afterSendYn":{"type":"boolean"},"memberId":{"title":"memberId","type":"string","description":"요청자 ID(사용자 조회에서 얻은 member ID)"},"passwordLock":{"type":"string","description":"완료 계약서 PDF 다운 잠금 패스워드"}}},"ApiReqRequesterDTO_Request":{"title":"requester","required":["email","name"],"type":"object","properties":{"name":{"type":"string","description":"요청자 이름"},"phone":{"type":"string","description":"요청자 핸드폰 번호","example":"01012345678"},"email":{"type":"string","description":"요청자 이메일"}},"description":"요청자 정보"},"Approver_Request":{"title":"approvers","required":["depth","email","memberId","name"],"type":"object","properties":{"memberId":{"type":"string","description":"사용자 조회에서 얻은 member ID"},"depth":{"minimum":1,"type":"integer","description":"결재자 depth","format":"int32"},"name":{"type":"string","description":"결재자 이름"},"phone":{"type":"string","description":"결재자 핸드폰 번호","example":"01012345678"},"email":{"type":"string","description":"결재자 이메일"}},"description":"결재자 정보"},"Cert_Request":{"type":"object","properties":{"businessName":{"type":"string","description":"법인 명"},"businessNumber":{"type":"string","description":"사업자 등록 번호"}},"description":"법인 공동인증"},"CheckboxField_Request":{"title":"checkboxFields","type":"object","properties":{"uid":{"type":"string","description":"컴포넌트 고유 ID"},"value":{"type":"boolean","description":"체크 여부"}},"description":"체크박스"},"DateField_Request":{"title":"dateFields","type":"object","properties":{"uid":{"type":"string","description":"컴포넌트 고유 ID"},"value":{"type":"string","description":"내용","nullable":true}},"description":"날짜"},"NumberField_Request":{"title":"numberFields","type":"object","properties":{"uid":{"type":"string","description":"컴포넌트 고유 ID"},"value":{"type":"string","description":"내용","nullable":true}},"description":"숫자"},"Password_Request":{"type":"object","properties":{"password":{"maxLength":20,"minLength":4,"type":"string","description":"패스워드"},"passwordHint":{"type":"string","description":"패스워드 힌트"}},"description":"패스워드 인증"},"Phone_Request":{"type":"object","properties":{"phone":{"type":"string","description":"본인 인증 명의자 휴대폰 번호","example":"01012345678"},"name":{"type":"string","description":"본인 인증 명의자 이름"}},"description":"PASS 인증"},"RequesterField_Request":{"title":"requesterField","type":"object","properties":{"textFields":{"title":"textFields","type":"array","description":"텍스트","items":{"$ref":"#/components/schemas/TextField_Request"}},"dateFields":{"title":"dateFields","type":"array","description":"날짜","items":{"$ref":"#/components/schemas/DateField_Request"}},"checkboxFields":{"title":"checkboxFields","type":"array","description":"체크박스","items":{"$ref":"#/components/schemas/CheckboxField_Request"}},"numberFields":{"title":"numberFields","type":"array","description":"숫자","items":{"$ref":"#/components/schemas/NumberField_Request"}}},"description":"요청자 내용 추가 입력 매핑값"},"TextField_Request":{"title":"textFields","type":"object","properties":{"uid":{"type":"string","description":"컴포넌트 고유 ID"},"value":{"type":"string","description":"내용","nullable":true}},"description":"텍스트"},"ApiResLinkUrl_Request":{"type":"object","properties":{"documentId":{"type":"string","description":"문서 ID"},"expired":{"type":"string","description":"만료 날자","format":"date-time"},"linkUrl":{"type":"string","description":"임베디드 링크"}}},"ApiReqSignerDTO_Request":{"title":"signer","required":["depth","name","noticeType"],"type":"object","properties":{"noticeType":{"type":"string","description":"서명 알림 수단
EMAIL 요청 email 필드값 필수
KAKAO 요청 phone 필드값 필수
ALL 요청 email,phone 필드값 필수","enum":["EMAIL","KAKAO","ALL"]},"message":{"type":"string","description":"메시지"},"authMfa":{"$ref":"#/components/schemas/ApiReqAuthMfaDTO_Request"},"depth":{"minimum":1,"type":"integer","description":"계약자 depth ( 1부터 시작 )","format":"int32"},"name":{"type":"string","description":"서명자 이름"},"phone":{"type":"string","description":"서명자 핸드폰 번호","example":"01012345678"},"email":{"type":"string","description":"서명자 이메일"},"role":{"type":"string","description":"서명자 역할"},"expirationAt":{"type":"string","description":"서명 만료일(yyyy-MM-dd)
default : 현재 날짜 + 15일","format":"date"}},"description":"서명자 리스트"},"ApiReqUserSettingDTO_Request":{"title":"participants","required":["signers","templateId","title"],"type":"object","properties":{"requester":{"$ref":"#/components/schemas/ApiReqRequesterDTO_Request"},"orderYn":{"type":"boolean","description":"순차 서명","default":false},"confirmYn":{"type":"boolean","description":"내 계약 확인","default":false},"folderId":{"minimum":20,"type":"integer","description":"계약 폴더 ID
(서명 요청후 해당 폴더 ID 에 보관 됩니다. default : 보낸 계약)","format":"int32","default":1},"signers":{"maxItems":10,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/ApiReqSignerDTO_Request"}},"approvals":{"title":"approvals","type":"array","description":"결재 정보","items":{"$ref":"#/components/schemas/ApiReqApprovalDTO_Request"}},"references":{"title":"references","type":"array","description":"참조자 리스트","items":{"$ref":"#/components/schemas/ApiReferenceDTO_Request"}},"requesterField":{"$ref":"#/components/schemas/RequesterField_Request"},"afterSendYn":{"type":"boolean","description":"계약 생성 후 전송 여부","default":false},"templateId":{"type":"string","description":"템플릿 ID"},"title":{"type":"string","description":"계약서 제목"},"memberId":{"title":"memberId","type":"string","description":"요청자 ID(사용자 조회에서 얻은 member ID)"},"passwordLock":{"type":"string","description":"완료 계약서 PDF 다운 잠금 패스워드"}}},"ApiResTemplateToContractDTO_Request":{"type":"object","properties":{"contractId":{"type":"string","description":"계약서 ID"},"title":{"type":"string","description":"문서명"}},"description":"템플릿으로 생성된 계약서 정보"},"ApiResAuthMfaDTO":{"type":"object","properties":{"email":{"type":"string","description":"메일 본인 인증 주소"},"sms":{"type":"string","description":"SMS 본인 인증 번호"},"password":{"$ref":"#/components/schemas/Password"},"cert":{"$ref":"#/components/schemas/Cert"},"phone":{"$ref":"#/components/schemas/Phone"}},"description":"다중 본인 인증"},"ApiResContractResendDTO":{"type":"object","properties":{"contractId":{"type":"string","description":"계약 ID"},"senderId":{"type":"string","description":"발신자 ID"},"senderName":{"type":"string","description":"발신자 명"},"participants":{"$ref":"#/components/schemas/ReceivedParticipants"}},"description":"발송자 및 수신자 정보"},"Cert":{"type":"object","properties":{"businessName":{"type":"string","description":"법인 명"},"businessNumber":{"type":"string","description":"사업자 등록 번호"}},"description":"법인 공동 인증"},"CheckboxField":{"title":"checkboxFields","type":"object","properties":{"uid":{"type":"string","description":"컴포넌트 고유 ID"},"id":{"type":"integer","description":"입력란 순번","format":"int32"},"x":{"type":"string","description":"x좌표"},"y":{"type":"string","description":"y좌표"},"scaleX":{"type":"string","description":"x축 확대값"},"scaleY":{"type":"string","description":"y축 확대값"},"page":{"type":"string","description":"페이지 번호"},"width":{"type":"string","description":"너비"},"height":{"type":"string","description":"높이"},"necessary":{"type":"string","description":"필수 여부","nullable":true},"inputFieldValue":{"type":"string","description":"입력 필드값"},"value":{"type":"boolean","description":"체크 여부"},"selectableCountType":{"type":"string","description":"체크 선택 가능 타입"},"minCount":{"type":"string","description":"최소 선택 가능 수","nullable":true},"maxCount":{"type":"string","description":"최대 선택 가능 수","nullable":true},"group":{"type":"string","description":"그룹","nullable":true}},"description":"체크박스"},"ContractApprovers":{"title":"approvers","type":"object","properties":{"participantsId":{"type":"string","description":"계약 내 유저 고유 ID"},"name":{"type":"string","description":"수신자 이름"},"email":{"type":"string","description":"수신자 이메일"},"phone":{"type":"string","description":"수신자 핸드폰"},"message":{"type":"string","description":"메시지"},"noticeType":{"type":"string","description":"알림 수단","enum":["EMAIL","KAKAO","ALL"]},"folderId":{"type":"integer","description":"계약서 보관함 번호","format":"int32"},"status":{"type":"string","description":"수신자 상태"},"participantsType":{"type":"string","description":"수신자 타입(REQ : 요청자, RECV : 서명자, RFR : 참조자, APV : 결재자)","enum":["REQ","RECV","RFR","APV"]},"depth":{"type":"integer","description":"수신자 depth","format":"int32"}},"description":"결재자 정보"},"ContractReference":{"title":"references","type":"object","properties":{"participantsId":{"type":"string","description":"계약 내 유저 고유 ID"},"name":{"type":"string","description":"수신자 이름"},"email":{"type":"string","description":"수신자 이메일"},"phone":{"type":"string","description":"수신자 핸드폰"},"message":{"type":"string","description":"메시지"},"noticeType":{"type":"string","description":"알림 수단","enum":["EMAIL","KAKAO","ALL"]},"folderId":{"type":"integer","description":"계약서 보관함 번호","format":"int32"},"participantsType":{"type":"string","description":"수신자 타입(REQ : 요청자, RECV : 서명자, RFR : 참조자, APV : 결재자)","enum":["REQ","RECV","RFR","APV"]}},"description":"참조자 정보"},"ContractSigner":{"title":"signers","type":"object","properties":{"participantsId":{"type":"string","description":"계약 내 유저 고유 ID"},"name":{"type":"string","description":"수신자 이름"},"email":{"type":"string","description":"수신자 이메일"},"phone":{"type":"string","description":"수신자 핸드폰"},"message":{"type":"string","description":"메시지"},"noticeType":{"type":"string","description":"알림 수단","enum":["EMAIL","KAKAO","ALL"]},"folderId":{"type":"integer","description":"계약서 보관함 번호","format":"int32"},"status":{"type":"string","description":"수신자 상태"},"signYn":{"type":"boolean","description":"수신자 서명 유무"},"aheadSignYn":{"type":"boolean","description":"미리 서명 여부"},"authMfa":{"$ref":"#/components/schemas/ApiResAuthMfaDTO"},"role":{"type":"string","description":"서명자 역할"},"contractorField":{"$ref":"#/components/schemas/ContractorField"},"participantsType":{"type":"string","description":"수신자 타입(REQ : 요청자, RECV : 서명자, RFR : 참조자, APV : 결재자)","enum":["REQ","RECV","RFR","APV"]},"depth":{"type":"integer","description":"수신자 depth","format":"int32"},"expirationAt":{"type":"string","description":"만료 시간"},"signedAt":{"type":"string","description":"서명 시간"}},"description":"서명자 정보"},"ContractorField":{"title":"signerField","type":"object","properties":{"textFields":{"title":"textFields","type":"array","description":"텍스트","items":{"$ref":"#/components/schemas/TextField"}},"dateFields":{"title":"dateFields","type":"array","description":"날짜","items":{"$ref":"#/components/schemas/DateField"}},"checkboxFields":{"title":"checkboxFields","type":"array","description":"체크박스","items":{"$ref":"#/components/schemas/CheckboxField"}},"imageFields":{"title":"imageFields","type":"array","description":"이미지","items":{"$ref":"#/components/schemas/ImageField"}},"numberFields":{"title":"numberFields","type":"array","description":"숫자","items":{"$ref":"#/components/schemas/NumberField"}},"signFields":{"title":"signFields","type":"array","description":"사인","items":{"$ref":"#/components/schemas/SignField"}},"stampFields":{"title":"stampFields","type":"array","description":"도장","items":{"$ref":"#/components/schemas/StampField"}},"radioFields":{"title":"radioFields","type":"array","description":"라디오버튼","items":{"$ref":"#/components/schemas/RadioField"}}},"description":"서명자 입력란"},"DateField":{"title":"dateFields","type":"object","properties":{"uid":{"type":"string","description":"컴포넌트 고유 ID"},"id":{"type":"integer","description":"입력란 순번","format":"int32"},"x":{"type":"string","description":"x좌표"},"y":{"type":"string","description":"y좌표"},"scaleX":{"type":"string","description":"x축 확대값"},"scaleY":{"type":"string","description":"y축 확대값"},"page":{"type":"string","description":"페이지 번호"},"width":{"type":"string","description":"너비"},"height":{"type":"string","description":"높이"},"necessary":{"type":"string","description":"필수 여부","nullable":true},"inputFieldValue":{"type":"string","description":"입력 필드값"},"value":{"type":"string","description":"내용","nullable":true},"inputType":{"type":"string","description":"날짜 기입 방식"},"dateShowFormat":{"type":"string","description":"텍스트 표시 형식"},"size":{"type":"string","description":"텍스트 크기"},"font":{"type":"string","description":"텍스트 글자체"},"fill":{"type":"string","description":"텍스트 색상"}},"description":"날짜"},"ImageField":{"title":"imageFields","type":"object","properties":{"uid":{"type":"string","description":"컴포넌트 고유 ID"},"id":{"type":"integer","description":"입력란 순번","format":"int32"},"x":{"type":"string","description":"x좌표"},"y":{"type":"string","description":"y좌표"},"scaleX":{"type":"string","description":"x축 확대값"},"scaleY":{"type":"string","description":"y축 확대값"},"page":{"type":"string","description":"페이지 번호"},"width":{"type":"string","description":"너비"},"height":{"type":"string","description":"높이"},"necessary":{"type":"string","description":"필수 여부","nullable":true},"inputFieldValue":{"type":"string","description":"입력 필드값"},"src":{"type":"string","description":"이미지 src","nullable":true}},"description":"이미지"},"NumberField":{"title":"numberFields","type":"object","properties":{"uid":{"type":"string","description":"컴포넌트 고유 ID"},"id":{"type":"integer","description":"입력란 순번","format":"int32"},"x":{"type":"string","description":"x좌표"},"y":{"type":"string","description":"y좌표"},"scaleX":{"type":"string","description":"x축 확대값"},"scaleY":{"type":"string","description":"y축 확대값"},"page":{"type":"string","description":"페이지 번호"},"width":{"type":"string","description":"너비"},"height":{"type":"string","description":"높이"},"necessary":{"type":"string","description":"필수 여부","nullable":true},"inputFieldValue":{"type":"string","description":"입력 필드값"},"value":{"type":"string","description":"내용","nullable":true},"thousandUnitDelimiter":{"type":"string","description":"천단위 구분 기호 사용 여부","nullable":true},"size":{"type":"string","description":"텍스트 크기"},"font":{"type":"string","description":"텍스트 글자체"},"fill":{"type":"string","description":"텍스트 색상"},"align":{"type":"string","description":"텍스트 정렬"}},"description":"숫자"},"Password":{"type":"object","properties":{"password":{"type":"string","description":"암호"},"passwordHint":{"type":"string","description":"암호 힌트"}},"description":"접근 암호 인증"},"Phone":{"type":"object","properties":{"phone":{"type":"string","description":"본인 인증 명의자 휴대폰 번호"},"name":{"type":"string","description":"본인 인증 명의자 이름"}},"description":"PASS 인증"},"RadioField":{"title":"radioFields","type":"object","properties":{"uid":{"type":"string","description":"컴포넌트 고유 ID"},"id":{"type":"integer","description":"입력란 순번","format":"int32"},"x":{"type":"string","description":"x좌표"},"y":{"type":"string","description":"y좌표"},"scaleX":{"type":"string","description":"x축 확대값"},"scaleY":{"type":"string","description":"y축 확대값"},"page":{"type":"string","description":"페이지 번호"},"width":{"type":"string","description":"너비"},"height":{"type":"string","description":"높이"},"necessary":{"type":"string","description":"필수 여부","nullable":true},"inputFieldValue":{"type":"string","description":"입력 필드값"},"value":{"type":"integer","description":"체크 여부","format":"int32"},"group":{"type":"string","description":"그룹","nullable":true}},"description":"라디오버튼"},"ReceivedParticipants":{"title":"participants","type":"object","properties":{"signers":{"title":"signers","type":"array","description":"서명자 정보","items":{"$ref":"#/components/schemas/ContractSigner"}},"approvers":{"title":"approvers","type":"array","description":"결재자 정보","items":{"$ref":"#/components/schemas/ContractApprovers"}},"references":{"title":"references","type":"array","description":"참조자 정보","items":{"$ref":"#/components/schemas/ContractReference"}}},"description":"발송된 참여자 정보 (서명자, 결재자, 참조자)"},"SignField":{"title":"signFields","type":"object","properties":{"uid":{"type":"string","description":"컴포넌트 고유 ID"},"id":{"type":"integer","description":"입력란 순번","format":"int32"},"x":{"type":"string","description":"x좌표"},"y":{"type":"string","description":"y좌표"},"scaleX":{"type":"string","description":"x축 확대값"},"scaleY":{"type":"string","description":"y축 확대값"},"page":{"type":"string","description":"페이지 번호"},"width":{"type":"string","description":"너비"},"height":{"type":"string","description":"높이"},"necessary":{"type":"string","description":"필수 여부","nullable":true},"inputFieldValue":{"type":"string","description":"입력 필드값"},"message":{"type":"string","description":"메시지","nullable":true}},"description":"사인"},"StampField":{"title":"stampFields","type":"object","properties":{"uid":{"type":"string","description":"컴포넌트 고유 ID"},"id":{"type":"integer","description":"입력란 순번","format":"int32"},"x":{"type":"string","description":"x좌표"},"y":{"type":"string","description":"y좌표"},"scaleX":{"type":"string","description":"x축 확대값"},"scaleY":{"type":"string","description":"y축 확대값"},"page":{"type":"string","description":"페이지 번호"},"width":{"type":"string","description":"너비"},"height":{"type":"string","description":"높이"},"necessary":{"type":"string","description":"필수 여부","nullable":true},"inputFieldValue":{"type":"string","description":"입력 필드값"},"message":{"type":"string","description":"메시지","nullable":true}},"description":"도장"},"TextField":{"title":"textFields","type":"object","properties":{"uid":{"type":"string","description":"컴포넌트 고유 ID"},"id":{"type":"integer","description":"입력란 순번","format":"int32"},"x":{"type":"string","description":"x좌표"},"y":{"type":"string","description":"y좌표"},"scaleX":{"type":"string","description":"x축 확대값"},"scaleY":{"type":"string","description":"y축 확대값"},"page":{"type":"string","description":"페이지 번호"},"width":{"type":"string","description":"너비"},"height":{"type":"string","description":"높이"},"necessary":{"type":"string","description":"필수 여부","nullable":true},"inputFieldValue":{"type":"string","description":"입력 필드값"},"value":{"type":"string","description":"내용","nullable":true},"size":{"type":"string","description":"텍스트 크기"},"font":{"type":"string","description":"텍스트 글자체"},"fill":{"type":"string","description":"텍스트 색상"},"align":{"type":"string","description":"텍스트 정렬"}},"description":"텍스트"},"ApiResApprovalDTO":{"title":"approvals","type":"object","properties":{"depth":{"type":"integer","description":"결재 순번","format":"int64"},"status":{"type":"string","description":"결재 처리 상태"},"simplifyYn":{"type":"boolean","description":"결재 간소화 여부"},"message":{"type":"string","description":"메세지"},"approvers":{"title":"approvers","type":"array","description":"결재자 정보","items":{"$ref":"#/components/schemas/ContractApprovers"}}},"description":"결재 정보"},"ApiResContractDTO":{"title":"contract","type":"object","properties":{"contractId":{"type":"string","description":"계약서 ID"},"title":{"type":"string","description":"문서명"},"requesterName":{"type":"string","description":"서명 요청자 이름"},"email":{"type":"string","description":"서명 요청자 이메일"},"templateId":{"type":"string","description":"템플릿 ID"},"approvals":{"title":"approvals","type":"array","description":"결재 정보","items":{"$ref":"#/components/schemas/ApiResApprovalDTO"}},"status":{"type":"string","description":"계약서 상태"},"orderYn":{"type":"boolean","description":"계약서 순차 발송 여부"},"completeYn":{"type":"boolean","description":"계약서 완료 여부"},"participants":{"$ref":"#/components/schemas/ApiResParticipantDTO"},"cancelYn":{"type":"boolean","description":"계약서 취소 여부"},"cancelReason":{"type":"string","description":"계약서 취소 이유"},"createAt":{"type":"string","description":"계약서 생성 시간"},"updateAt":{"type":"string","description":"계약서 업데이트 시간"},"completedAt":{"type":"string","description":"계약서 완료 시간"},"cancelAt":{"type":"string","description":"계약서 취소 시간"},"passwordLock":{"type":"string","description":"완료 계약서 PDF 다운 잠금 패스워드"}},"description":"계약서 DTO"},"ApiResParticipantDTO":{"title":"participants","type":"object","properties":{"requester":{"$ref":"#/components/schemas/ContractRequester"},"signers":{"title":"signers","type":"array","description":"서명자 정보","items":{"$ref":"#/components/schemas/ContractSigner"}},"approvers":{"title":"approvers","type":"array","description":"결재자 정보","items":{"$ref":"#/components/schemas/ContractApprovers"}},"references":{"title":"references","type":"array","description":"참조자 정보","items":{"$ref":"#/components/schemas/ContractReference"}}},"description":"참여자 (요청자, 서명자, 결재자, 참조자)"},"ContractRequester":{"title":"requester","type":"object","properties":{"participantsId":{"type":"string","description":"계약 내 유저 고유 ID"},"name":{"type":"string","description":"수신자 이름"},"email":{"type":"string","description":"수신자 이메일"},"phone":{"type":"string","description":"수신자 핸드폰"},"message":{"type":"string","description":"메시지"},"noticeType":{"type":"string","description":"알림 수단","enum":["EMAIL","KAKAO","ALL"]},"folderId":{"type":"integer","description":"계약서 보관함 번호","format":"int32"},"status":{"type":"string","description":"수신자 상태"},"requesterField":{"$ref":"#/components/schemas/RequesterField"},"participantsType":{"type":"string","description":"수신자 타입(REQ : 요청자, RECV : 서명자, RFR : 참조자, APV : 결재자)","enum":["REQ","RECV","RFR","APV"]},"depth":{"type":"integer","description":"수신자 depth","format":"int32"}},"description":"요청자 정보"},"RequesterField":{"title":"requesterField","type":"object","properties":{"textFields":{"title":"textFields","type":"array","description":"텍스트","items":{"$ref":"#/components/schemas/TextField"}},"dateFields":{"title":"dateFields","type":"array","description":"날짜","items":{"$ref":"#/components/schemas/DateField"}},"checkboxFields":{"title":"checkboxFields","type":"array","description":"체크박스","items":{"$ref":"#/components/schemas/CheckboxField"}},"imageFields":{"title":"imageFields","type":"array","description":"이미지","items":{"$ref":"#/components/schemas/ImageField"}},"numberFields":{"title":"numberFields","type":"array","description":"숫자","items":{"$ref":"#/components/schemas/NumberField"}}},"description":"요청자 내용 추가 입력"},"ApiResContractCancel":{"title":"contractCancel","type":"object","properties":{"contractId":{"type":"string","description":"계약 ID","format":"uuid"},"title":{"type":"string","description":"계약명","example":"계약명"},"canceledAt":{"type":"string","description":"요청 취소시간","format":"date-time"}},"description":"계약 취소 DTO"},"ApiReqResendCompleteContractDTO":{"required":["contractId","senderId","signerIds"],"type":"object","properties":{"contractId":{"type":"string","description":"계약 ID"},"senderId":{"type":"string","description":"계약 상세 보기 조회한 참여자 ID(발신자)"},"signerIds":{"type":"array","description":"계약 상세 보기 조회한 서명자 고유 ID(수신자)","items":{"type":"string","description":"계약 상세 보기 조회한 서명자 고유 ID(수신자)"}}}},"Info":{"required":["limitDate","participantNames","startDate","title"],"type":"object","properties":{"title":{"type":"string","description":"문서 명"},"startDate":{"type":"string","description":"계약 시작일","format":"date","example":"2020-01-01"},"limitDate":{"type":"string","description":"계약 만료일","format":"date","example":"2020-01-01"},"participantNames":{"type":"array","description":"참여자 목록(이름)","items":{"type":"string","description":"참여자 목록(이름)"}}},"description":"문서 정보
- 병합시 파일과 문서정보는 N:1
- 개별 업로드시 파일과 문서정보는 1:1"},"upload":{"required":["info","isMerge","memberId"],"type":"object","properties":{"isMerge":{"type":"boolean","description":"병합 여부"},"info":{"type":"array","description":"문서 정보
- 병합시 파일과 문서정보는 N:1
- 개별 업로드시 파일과 문서정보는 1:1","items":{"$ref":"#/components/schemas/Info"}},"memberId":{"type":"string","description":"사용자 ID"}},"description":"외부 문서 업로드"},"ExternalDocument":{"type":"object","properties":{"contractId":{"type":"string","description":"계약서 ID"},"title":{"type":"string","description":"문서명"},"participants":{"type":"array","description":"수신자 목록","items":{"type":"string","description":"수신자 목록"}},"contractAt":{"type":"string","description":"계약일","format":"date-time"},"limitAt":{"type":"string","description":"계약 만료일","format":"date-time"},"createAt":{"type":"string","description":"계약 생성일","format":"date-time"},"updateAt":{"type":"string","description":"계약 수정일","format":"date-time"}},"description":"페이지 목록"},"ApiReqCreateTeamDTO_Default":{"required":["parentId","text"],"type":"object","properties":{"parentId":{"minimum":0,"type":"integer","description":"상위 팀 ID","format":"int32","example":1},"text":{"type":"string","description":"팀 이름","example":"테스트 팀"}}},"ApiTeamFolder_Default":{"type":"object","properties":{"parentId":{"type":"string","description":"상위 팀 ID(# : 최상위 팀)"},"teamId":{"type":"integer","description":"팀 ID","format":"int32"},"text":{"type":"string","description":"팀 이름"},"depth":{"type":"integer","description":"팀 레벨","format":"int32"}},"format":"Array of objects"},"ApiReqTeamMemberDTO":{"required":["email"],"type":"object","properties":{"name":{"maxLength":50,"minLength":2,"type":"string","description":"이름","example":"홍길동"},"memberId":{"type":"string","description":"사용자 ID (사용자 ID를 입력하면 초대받은 사용자는 ID를 수정할 수 없습니다.)"},"email":{"type":"string","description":"이메일","example":"hong@gmail.com"},"phone":{"type":"string","description":"전화번호","example":"01011112222"},"teamId":{"minimum":0,"type":"integer","description":"팀 ID","format":"int32","example":1}}},"ApiResTeamMemberDTO":{"title":"members","type":"object","properties":{"status":{"type":"string","description":"멤버 초대 상태","example":"초대 완료"},"uid":{"type":"string","description":"고유 식별자","format":"uuid"},"name":{"type":"string","description":"이름","example":"홍길동"},"memberId":{"type":"string","description":"사용자 ID","example":"hong"},"email":{"type":"string","description":"이메일","example":"hong@gmail.com"},"phone":{"type":"string","description":"전화번호","example":"010-0000-0000"},"teamId":{"type":"integer","description":"팀 ID","format":"int32","example":1}},"description":"팀 사용자"},"ApiResBulkContractTransferDTO":{"type":"object","properties":{"success_count":{"type":"integer","description":"성공 횟수","format":"int32"},"fail_count":{"type":"integer","description":"실패 횟수","format":"int32"},"fails":{"type":"array","items":{"$ref":"#/components/schemas/Fail"}}}},"Fail":{"type":"object","properties":{"contractId":{"type":"string","description":"계약서 ID"},"title":{"type":"string","description":"문서명"},"signerName":{"type":"string","description":"수신자 이름"},"status":{"type":"string","description":"계약서 상태"}}},"ApiReqUpdateWebhookDTO":{"title":"webhook","type":"object","properties":{"name":{"type":"string","description":"웹훅 명칭"},"uri":{"type":"string","description":"웹훅 이벤트를 전달받을 POST URI"},"eventType":{"type":"string","description":"웹훅에 지정할 이벤트 타입
BEFORE_SENDING_CONTRACT : 계약 전송 이전
AFTER_SENDING_CONTRACT : 계약 전송 이후
SIGNED_CONTRACT : 서명자 서명 이후
SIGN_ALL_CONTRACT : 서명자 모두 서명 이후
REJECTED_SIGN : 서명 거절 이후
CANCELLED_CONTRACT : 계약 취소 이후
BEFORE_SENDING_BULK : 대량 전송 이전
AFTER_SENDING_BULK : 대량 전송 이전
APPROVE_CONTRACT : 결재자 결재 이후
APPROVE_ALL_CONTRACT : 결재자 모두 결재 이후
COMPANION_CONTRACT : 결재자 반려 이후","enum":["BEFORE_SENDING_CONTRACT","AFTER_SENDING_CONTRACT","SIGNED_CONTRACT","SIGNED_ALL_CONTRACT","REJECTED_SIGN","CANCELLED_CONTRACT","BEFORE_SENDING_BULK","AFTER_SENDING_BULK","APPROVE_CONTRACT","APPROVE_ALL_CONTRACT","COMPANION_CONTRACT"]},"activationStatus":{"type":"string","description":"이벤트 활성화 여부
활성화 : ACTIVE
비활성화 : INACTIVE","enum":["ACTIVE","INACTIVE"]},"headers":{"title":"headers","type":"array","description":"웹훅 헤더 설정 정보
(값이 없을시 빈 값으로 저장 됩니다.)","items":{"$ref":"#/components/schemas/ApiWebhookHeaderDTO"}}}},"ApiResUpdateWebhookDTO":{"required":["webhookId"],"type":"object","properties":{"webhookId":{"type":"string","description":"웹훅 ID"}}},"ApiReqAddressGroupDTO":{"required":["addressIds"],"type":"object","properties":{"groupId":{"type":"string","description":"변경할 기존 그룹 ID"},"groupName":{"type":"string","description":"새로 생성할 그룹 이름"},"addressIds":{"maxItems":100,"minItems":1,"type":"array","description":"주소록 ID","items":{"type":"string","description":"주소록 ID"}},"memberId":{"type":"string","description":"사용자 ID"}}},"ApiResAddressDTO":{"title":"address","required":["addressId","email","name","phone"],"type":"object","properties":{"addressId":{"type":"string","description":"주소록 ID"},"name":{"type":"string","description":"이름"},"email":{"type":"string","description":"이메일"},"phone":{"type":"string","description":"전화번호"}},"description":"사용자 주소록 DTO"},"ApiResAddressGroupDTO":{"title":"addressGroup","required":["groupId","groupName"],"type":"object","properties":{"groupName":{"type":"string","description":"그룹명"},"groupId":{"type":"string","description":"그룹 ID"},"addressList":{"type":"array","description":"소속 주소록","items":{"$ref":"#/components/schemas/ApiResAddressDTO"}}},"description":"사용자 주소록 그룹 DTO"},"ApiReqRenameFolderDTO_Default":{"required":["folderId","text"],"type":"object","properties":{"folderId":{"minimum":20,"type":"integer","description":"폴더 ID","format":"int32","example":21},"text":{"type":"string","description":"폴더명 변경","format":"string","example":"내 폴더명"}}},"ApiReqRenameTeamDTO_Default":{"required":["teamId","text"],"type":"object","properties":{"teamId":{"minimum":0,"type":"integer","description":"팀 ID","format":"int32","example":2},"text":{"type":"string","description":"팀명 변경","example":"테스트 팀"}}},"ApiResBulkContractDTO":{"title":"bulkContract","type":"object","properties":{"bulkContractId":{"type":"string","description":"대량 계약서 ID"},"title":{"type":"string","description":"문서명"},"status":{"type":"string","description":"전송상태"},"sendAt":{"type":"string","description":"전송시간","format":"date-time"}},"description":"대량 계약서 목록"},"ApiResWebhookDTO_Default":{"title":"webhooks","required":["name","uri","webhookId"],"type":"object","properties":{"webhookId":{"type":"string","description":"웹훅 ID"},"name":{"type":"string","description":"웹훅 명칭"},"uri":{"type":"string","description":"이벤트 전달 받을 URI"},"createAt":{"type":"string","description":"웹훅 등록 시간","format":"date-time"},"updateAt":{"type":"string","description":"웹훅 마지막 업데이트 시간","format":"date-time"}},"description":"페이지 목록"},"ApiResWebhookPageDTO_Default":{"type":"object","properties":{"total":{"type":"integer","description":"전체 개수","format":"int64"},"page":{"type":"integer","description":"페이지 번호","format":"int32"},"rows":{"type":"integer","description":"한 페이지 조회 개수","format":"int32"},"contents":{"type":"array","description":"페이지 목록","items":{"$ref":"#/components/schemas/ApiResWebhookDTO_Default"}}}},"ApiResWebhookDTO_Detail":{"title":"webhooks","required":["name","uri","webhookId"],"type":"object","properties":{"webhookId":{"type":"string","description":"웹훅 ID"},"name":{"type":"string","description":"웹훅 명칭"},"uri":{"type":"string","description":"이벤트 전달 받을 URI"},"headers":{"title":"headers","type":"array","description":"설정한 웹훅 헤더","items":{"$ref":"#/components/schemas/ApiWebhookHeaderDTO_Detail"}},"eventType":{"type":"string","description":"구독 중인 이벤트","enum":["BEFORE_SENDING_CONTRACT","AFTER_SENDING_CONTRACT","SIGNED_CONTRACT","SIGNED_ALL_CONTRACT","REJECTED_SIGN","CANCELLED_CONTRACT","BEFORE_SENDING_BULK","AFTER_SENDING_BULK","APPROVE_CONTRACT","APPROVE_ALL_CONTRACT","COMPANION_CONTRACT"]},"activationStatus":{"type":"string","description":"이벤트 활성화 여부
활성화 : ACTIVE
비활성화 : INACTIVE","enum":["ACTIVE","INACTIVE"]},"createAt":{"type":"string","description":"웹훅 등록 시간","format":"date-time"},"updateAt":{"type":"string","description":"웹훅 마지막 업데이트 시간","format":"date-time"}}},"ApiWebhookHeaderDTO_Detail":{"title":"header","type":"object","properties":{"key":{"type":"string","description":"헤더 key"},"value":{"type":"string","description":"헤더 value"}},"description":"웹훅 헤더 설정 정보"},"ApiResUserDTO":{"title":"user","type":"object","properties":{"memberId":{"type":"string","description":"사용자 ID"},"email":{"type":"string","description":"사용자 이메일"},"name":{"type":"string","description":"사용자명"},"status":{"type":"string","description":"멤버 초대 상태","example":"초대 완료"},"phone":{"type":"string","description":"전화번호","example":"010-0000-0000"},"teamId":{"type":"integer","description":"팀 ID","format":"int32","example":1}},"description":"사용자 정보 DTO"},"UserList":{"type":"object","properties":{"users":{"type":"array","description":"사용자 목록","items":{"$ref":"#/components/schemas/ApiResUserDTO"}}}},"token":{"required":["accessToken","expiresAt"],"type":"object","properties":{"accessToken":{"type":"string","description":"액세스 토큰"},"expiresAt":{"type":"string","description":"토큰 만료일(30일)","format":"date-time"}},"description":"액세스 토큰 응답 DTO"},"ApiResTemplatePageDTO_Default":{"type":"object","properties":{"total":{"type":"integer","description":"전체 개수","format":"int64"},"page":{"type":"integer","description":"페이지 번호","format":"int32"},"rows":{"type":"integer","description":"한 페이지 조회 개수","format":"int32"},"contents":{"type":"array","description":"페이지 목록","items":{"$ref":"#/components/schemas/ApiResTemplateDTO_Default"}}}},"ApiResTemplateContractorDTO":{"title":"participants","type":"object","properties":{"requester":{"$ref":"#/components/schemas/TemplateRequester"},"signers":{"title":"signers","type":"array","description":"서명자 정보","items":{"$ref":"#/components/schemas/TemplateSigner"}}},"description":"템플릿 수신자 DTO"},"ApiResTemplateDTO":{"title":"template","required":["createdAt","folderName","memberId","templateId","title","updatedAt"],"type":"object","properties":{"templateId":{"type":"string","description":"템플릿 ID"},"title":{"type":"string","description":"템플릿명"},"participants":{"$ref":"#/components/schemas/ApiResTemplateContractorDTO"},"favorites":{"type":"boolean","description":"템플릿 즐겨찾기 여부","nullable":true},"folderName":{"type":"string","description":"템플릿 폴더 이름"},"memberId":{"type":"string","description":"사용자 ID(템플릿 소유자 ID)"},"templateAttaches":{"type":"array","description":"첨부파일 정보","items":{"$ref":"#/components/schemas/ApiResTemplateAttachDTO"}},"requesterAttaches":{"type":"array","description":"첨부파일 요청 정보","items":{"$ref":"#/components/schemas/ApiResTemplateFileReqDTO"}},"createdAt":{"type":"string","description":"템플릿 생성 시간","format":"date-time"},"updatedAt":{"type":"string","description":"템플릿 마지막 업데이트 시간","format":"date-time"}},"description":"템플릿 DTO"},"TemplateRequester":{"title":"requester","type":"object","properties":{"name":{"type":"string","description":"수신자 이름"},"cell":{"type":"string","description":"수신자 전화번호","nullable":true},"email":{"type":"string","description":"수신자 이메일","nullable":true},"depth":{"type":"integer","description":"수신자 depth","format":"int32"},"requesterField":{"$ref":"#/components/schemas/RequesterField"},"participantsType":{"type":"string","description":"수신자 타입(REQ : 요청자, RECV : 서명자)","enum":["REQ","RECV"]}},"description":"내용 추가자 정보"},"TemplateSigner":{"title":"signers","type":"object","properties":{"name":{"type":"string","description":"수신자 이름"},"cell":{"type":"string","description":"수신자 전화번호","nullable":true},"email":{"type":"string","description":"수신자 이메일","nullable":true},"depth":{"type":"integer","description":"수신자 depth","format":"int32"},"noticeType":{"type":"string","description":"서명자 서명 참여 수단","nullable":true,"enum":["EMAIL","KAKAO","ALL"]},"role":{"type":"string","description":"서명자 역할","nullable":true},"signYn":{"type":"boolean","description":"서명자 사인 여부","nullable":true},"aheadSignYn":{"type":"boolean","description":"서명자 미리서명 여부","nullable":true},"contractorField":{"$ref":"#/components/schemas/ContractorField"},"participantsType":{"type":"string","description":"수신자 타입(REQ : 요청자, RECV : 서명자)","enum":["REQ","RECV"]}},"description":"서명자 정보"},"ApiResTemplatePreviewDTO":{"type":"object","properties":{"templateId":{"type":"string","description":"계약서 ID"},"templateName":{"type":"string","description":"문서명"},"html":{"type":"string","description":"미리보기"},"size":{"$ref":"#/components/schemas/size"}}},"size":{"type":"object","properties":{"width":{"type":"integer","description":"넓이","format":"int32"},"height":{"type":"integer","description":"높이","format":"int32"}},"description":"미리보기 크기"},"ApiDocFolder_Detail":{"type":"object","properties":{"parentId":{"type":"string","description":"부모 폴더 ID(# : 최상위 폴더)"},"folderId":{"type":"integer","description":"자식 폴더 ID","format":"int32"},"text":{"type":"string","description":"폴더 이름"},"depth":{"type":"integer","description":"폴더 레벨","format":"int32"},"childrens":{"type":"object","properties":{"parentId":{"type":"string","description":"부모 폴더 ID(# : 최상위 폴더)"},"folderId":{"type":"integer","description":"자식 폴더 ID","format":"int32"},"text":{"type":"string","description":"폴더 이름"},"depth":{"type":"integer","description":"폴더 레벨","format":"int32"}},"description":"자식 폴더 리스트","format":"Array of objects"}},"format":"Array of objects"},"ApiResContractDTO_Default":{"title":"contract","type":"object","properties":{"contractId":{"type":"string","description":"계약서 ID"},"title":{"type":"string","description":"문서명"},"requesterName":{"type":"string","description":"서명 요청자 이름"},"email":{"type":"string","description":"서명 요청자 이메일"},"templateId":{"type":"string","description":"템플릿 ID"},"status":{"type":"string","description":"계약서 상태"},"orderYn":{"type":"boolean","description":"계약서 순차 발송 여부"},"completeYn":{"type":"boolean","description":"계약서 완료 여부"},"cancelYn":{"type":"boolean","description":"계약서 취소 여부"},"cancelReason":{"type":"string","description":"계약서 취소 이유"},"createAt":{"type":"string","description":"계약서 생성 시간"},"updateAt":{"type":"string","description":"계약서 업데이트 시간"},"completedAt":{"type":"string","description":"계약서 완료 시간"},"cancelAt":{"type":"string","description":"계약서 취소 시간"}},"description":"계약서 DTO"},"ApiResContractPageDTO_Default":{"type":"object","properties":{"total":{"type":"integer","description":"전체 개수","format":"int64"},"page":{"type":"integer","description":"페이지 번호","format":"int32"},"rows":{"type":"integer","description":"한 페이지 조회 개수","format":"int32"},"contents":{"type":"array","description":"페이지 목록","items":{"$ref":"#/components/schemas/ApiResContractDTO_Default"}}}},"ApiResContractHistoryDTO":{"title":"contractHistory","type":"object","properties":{"contractHistories":{"title":"contractHistories","type":"array","description":"계약 이력 목록","items":{"$ref":"#/components/schemas/ContractHistory"}}},"description":"계약 이력 DTO"},"ContractHistory":{"title":"contractHistories","type":"object","properties":{"historyCodeName":{"type":"string","description":"이력 처리 상태 명칭"},"pubIp":{"type":"string","description":"접속 공인 ip"},"name":{"type":"string","description":"참여자 이름"},"createAt":{"type":"string","description":"등록 시간"},"phone":{"type":"string","description":"참여자 전화번호"},"email":{"type":"string","description":"참여자 이메일"}},"description":"계약 이력 목록"},"ApiResApprovalDTO_Detail":{"title":"approvals","type":"object","properties":{"depth":{"type":"integer","description":"결재 순번","format":"int64"},"status":{"type":"string","description":"결재 처리 상태"},"simplifyYn":{"type":"boolean","description":"결재 간소화 여부"},"message":{"type":"string","description":"메세지"},"approvers":{"title":"approvers","type":"array","description":"결재자 정보","items":{"$ref":"#/components/schemas/ContractApprovers_Detail"}}},"description":"결재 정보"},"ApiResAuthMfaDTO_Detail":{"type":"object","properties":{"email":{"type":"string","description":"메일 본인 인증 주소"},"sms":{"type":"string","description":"SMS 본인 인증 번호"},"password":{"$ref":"#/components/schemas/Password_Detail"},"cert":{"$ref":"#/components/schemas/Cert_Detail"},"phone":{"$ref":"#/components/schemas/Phone_Detail"}},"description":"다중 본인 인증"},"ApiResContractDetailDTO_Detail":{"title":"contractDetail","type":"object","properties":{"contractId":{"type":"string","description":"계약서 ID"},"title":{"type":"string","description":"문서명"},"requesterName":{"type":"string","description":"서명 요청자 이름"},"email":{"type":"string","description":"서명 요청자 이메일"},"templateId":{"type":"string","description":"템플릿 ID"},"approvals":{"title":"approvals","type":"array","description":"결재 정보","items":{"$ref":"#/components/schemas/ApiResApprovalDTO_Detail"}},"status":{"type":"string","description":"계약서 상태"},"orderYn":{"type":"boolean","description":"계약서 순차 발송 여부"},"completeYn":{"type":"boolean","description":"계약서 완료 여부"},"participants":{"$ref":"#/components/schemas/ApiResParticipantDTO_Detail"},"attaches":{"title":"attaches","type":"array","description":"첨부 파일 목록","items":{"$ref":"#/components/schemas/ContractAttach_Detail"}},"fileReqs":{"title":"fileReqs","type":"array","description":"첨부파일 요청 목록","items":{"$ref":"#/components/schemas/ContractFileReq_Detail"}},"histories":{"title":"histories","type":"array","description":"계약 이력 목록","items":{"$ref":"#/components/schemas/ContractHistory_Detail"}},"cancelYn":{"type":"boolean","description":"계약서 취소 여부"},"cancelReason":{"type":"string","description":"계약서 취소 이유"},"createAt":{"type":"string","description":"계약서 생성 시간"},"updateAt":{"type":"string","description":"계약서 업데이트 시간"},"completedAt":{"type":"string","description":"계약서 완료 시간"},"cancelAt":{"type":"string","description":"계약서 취소 시간"},"passwordLock":{"type":"string","description":"완료 계약서 PDF 다운 잠금 패스워드"}},"description":"계약 상세 DTO"},"ApiResParticipantDTO_Detail":{"title":"participants","type":"object","properties":{"requester":{"$ref":"#/components/schemas/ContractRequester_Detail"},"signers":{"title":"signers","type":"array","description":"서명자 정보","items":{"$ref":"#/components/schemas/ContractSigner_Detail"}},"approvers":{"title":"approvers","type":"array","description":"결재자 정보","items":{"$ref":"#/components/schemas/ContractApprovers_Detail"}},"references":{"title":"references","type":"array","description":"참조자 정보","items":{"$ref":"#/components/schemas/ContractReference_Detail"}}},"description":"참여자 (요청자, 서명자, 결재자, 참조자)"},"Cert_Detail":{"type":"object","properties":{"businessName":{"type":"string","description":"법인 명"},"businessNumber":{"type":"string","description":"사업자 등록 번호"}},"description":"법인 공동 인증"},"CheckboxField_Detail":{"title":"checkboxFields","type":"object","properties":{"uid":{"type":"string","description":"컴포넌트 고유 ID"},"id":{"type":"integer","description":"입력란 순번","format":"int32"},"x":{"type":"string","description":"x좌표"},"y":{"type":"string","description":"y좌표"},"scaleX":{"type":"string","description":"x축 확대값"},"scaleY":{"type":"string","description":"y축 확대값"},"page":{"type":"string","description":"페이지 번호"},"width":{"type":"string","description":"너비"},"height":{"type":"string","description":"높이"},"necessary":{"type":"string","description":"필수 여부","nullable":true},"value":{"type":"boolean","description":"체크 여부"},"selectableCountType":{"type":"string","description":"체크 선택 가능 타입"},"minCount":{"type":"string","description":"최소 선택 가능 수","nullable":true},"maxCount":{"type":"string","description":"최대 선택 가능 수","nullable":true},"group":{"type":"string","description":"그룹","nullable":true}},"description":"체크박스"},"ContractApprovers_Detail":{"title":"approvers","type":"object","properties":{"participantsId":{"type":"string","description":"계약 내 유저 고유 ID"},"name":{"type":"string","description":"수신자 이름"},"email":{"type":"string","description":"수신자 이메일"},"phone":{"type":"string","description":"수신자 핸드폰"},"message":{"type":"string","description":"메시지"},"noticeType":{"type":"string","description":"알림 수단","enum":["EMAIL","KAKAO","ALL"]},"folderId":{"type":"integer","description":"계약서 보관함 번호","format":"int32"},"status":{"type":"string","description":"수신자 상태"},"participantsType":{"type":"string","description":"수신자 타입(REQ : 요청자, RECV : 서명자, RFR : 참조자, APV : 결재자)","enum":["REQ","RECV","RFR","APV"]},"depth":{"type":"integer","description":"수신자 depth","format":"int32"}},"description":"결재자 정보"},"ContractAttach_Detail":{"title":"attaches","type":"object","properties":{"fileIndex":{"type":"string","description":"파일 INDEX"},"fileName":{"type":"string","description":"파일 명"},"extension":{"type":"string","description":"파일 확장자"},"fileSize":{"type":"string","description":"파일 사이즈"},"contentType":{"type":"string","description":"타입 ex)image/png"},"tyFile":{"type":"string","description":"첨부파일 요청건 구분 (00: 요청자 전송 파일, 10 : 첨부파일 요청건)"},"fileId":{"type":"string","description":"파일 UUID"},"depth":{"type":"integer","description":"첨부파일 요청건 서명참여자 구분 depth(1:을,2:병..N)","format":"int32"}},"description":"첨부 파일 목록"},"ContractFileReq_Detail":{"title":"fileReqs","type":"object","properties":{"depth":{"type":"integer","description":"첨부파일 요청 수신자 depth","format":"int32"},"name":{"type":"string","description":"첨부파일 종류"},"message":{"type":"string","description":"전달 사항","nullable":true},"required":{"type":"string","description":"필수 여부","nullable":true},"fileReqIndex":{"type":"integer","description":"첨부파일 요청 고유 번호","format":"int32"}},"description":"첨부파일 요청 목록"},"ContractHistory_Detail":{"title":"histories","type":"object","properties":{"historyCodeName":{"type":"string","description":"이력 처리 상태 명칭"},"pubIp":{"type":"string","description":"접속 공인 ip"},"name":{"type":"string","description":"참여자 이름"},"createAt":{"type":"string","description":"등록 시간"},"phone":{"type":"string","description":"참여자 전화번호"},"email":{"type":"string","description":"참여자 이메일"}},"description":"계약 이력 목록"},"ContractReference_Detail":{"title":"references","type":"object","properties":{"participantsId":{"type":"string","description":"계약 내 유저 고유 ID"},"name":{"type":"string","description":"수신자 이름"},"email":{"type":"string","description":"수신자 이메일"},"phone":{"type":"string","description":"수신자 핸드폰"},"message":{"type":"string","description":"메시지"},"noticeType":{"type":"string","description":"알림 수단","enum":["EMAIL","KAKAO","ALL"]},"folderId":{"type":"integer","description":"계약서 보관함 번호","format":"int32"},"participantsType":{"type":"string","description":"수신자 타입(REQ : 요청자, RECV : 서명자, RFR : 참조자, APV : 결재자)","enum":["REQ","RECV","RFR","APV"]}},"description":"참조자 정보"},"ContractRequester_Detail":{"title":"requester","type":"object","properties":{"participantsId":{"type":"string","description":"계약 내 유저 고유 ID"},"name":{"type":"string","description":"수신자 이름"},"email":{"type":"string","description":"수신자 이메일"},"phone":{"type":"string","description":"수신자 핸드폰"},"message":{"type":"string","description":"메시지"},"noticeType":{"type":"string","description":"알림 수단","enum":["EMAIL","KAKAO","ALL"]},"folderId":{"type":"integer","description":"계약서 보관함 번호","format":"int32"},"status":{"type":"string","description":"수신자 상태"},"requesterField":{"$ref":"#/components/schemas/RequesterField_Detail"},"participantsType":{"type":"string","description":"수신자 타입(REQ : 요청자, RECV : 서명자, RFR : 참조자, APV : 결재자)","enum":["REQ","RECV","RFR","APV"]},"depth":{"type":"integer","description":"수신자 depth","format":"int32"}},"description":"요청자 정보"},"ContractSigner_Detail":{"title":"signers","type":"object","properties":{"participantsId":{"type":"string","description":"계약 내 유저 고유 ID"},"name":{"type":"string","description":"수신자 이름"},"email":{"type":"string","description":"수신자 이메일"},"phone":{"type":"string","description":"수신자 핸드폰"},"message":{"type":"string","description":"메시지"},"noticeType":{"type":"string","description":"알림 수단","enum":["EMAIL","KAKAO","ALL"]},"folderId":{"type":"integer","description":"계약서 보관함 번호","format":"int32"},"status":{"type":"string","description":"수신자 상태"},"signYn":{"type":"boolean","description":"수신자 서명 유무"},"aheadSignYn":{"type":"boolean","description":"미리 서명 여부"},"authMfa":{"$ref":"#/components/schemas/ApiResAuthMfaDTO_Detail"},"role":{"type":"string","description":"서명자 역할"},"contractorField":{"$ref":"#/components/schemas/ContractorField_Detail"},"participantsType":{"type":"string","description":"수신자 타입(REQ : 요청자, RECV : 서명자, RFR : 참조자, APV : 결재자)","enum":["REQ","RECV","RFR","APV"]},"depth":{"type":"integer","description":"수신자 depth","format":"int32"},"expirationAt":{"type":"string","description":"만료 시간"},"signedAt":{"type":"string","description":"서명 시간"}},"description":"서명자 정보"},"ContractorField_Detail":{"title":"signerField","type":"object","properties":{"textFields":{"title":"textFields","type":"array","description":"텍스트","items":{"$ref":"#/components/schemas/TextField_Detail"}},"dateFields":{"title":"dateFields","type":"array","description":"날짜","items":{"$ref":"#/components/schemas/DateField_Detail"}},"checkboxFields":{"title":"checkboxFields","type":"array","description":"체크박스","items":{"$ref":"#/components/schemas/CheckboxField_Detail"}},"imageFields":{"title":"imageFields","type":"array","description":"이미지","items":{"$ref":"#/components/schemas/ImageField_Detail"}},"numberFields":{"title":"numberFields","type":"array","description":"숫자","items":{"$ref":"#/components/schemas/NumberField_Detail"}},"signFields":{"title":"signFields","type":"array","description":"사인","items":{"$ref":"#/components/schemas/SignField_Detail"}},"stampFields":{"title":"stampFields","type":"array","description":"도장","items":{"$ref":"#/components/schemas/StampField_Detail"}},"radioFields":{"title":"radioFields","type":"array","description":"라디오버튼","items":{"$ref":"#/components/schemas/RadioField_Detail"}}},"description":"서명자 입력란"},"DateField_Detail":{"title":"dateFields","type":"object","properties":{"uid":{"type":"string","description":"컴포넌트 고유 ID"},"id":{"type":"integer","description":"입력란 순번","format":"int32"},"x":{"type":"string","description":"x좌표"},"y":{"type":"string","description":"y좌표"},"scaleX":{"type":"string","description":"x축 확대값"},"scaleY":{"type":"string","description":"y축 확대값"},"page":{"type":"string","description":"페이지 번호"},"width":{"type":"string","description":"너비"},"height":{"type":"string","description":"높이"},"necessary":{"type":"string","description":"필수 여부","nullable":true},"value":{"type":"string","description":"내용","nullable":true},"inputType":{"type":"string","description":"날짜 기입 방식"},"dateShowFormat":{"type":"string","description":"텍스트 표시 형식"},"size":{"type":"string","description":"텍스트 크기"},"font":{"type":"string","description":"텍스트 글자체"},"fill":{"type":"string","description":"텍스트 색상"}},"description":"날짜"},"ImageField_Detail":{"title":"imageFields","type":"object","properties":{"uid":{"type":"string","description":"컴포넌트 고유 ID"},"id":{"type":"integer","description":"입력란 순번","format":"int32"},"x":{"type":"string","description":"x좌표"},"y":{"type":"string","description":"y좌표"},"scaleX":{"type":"string","description":"x축 확대값"},"scaleY":{"type":"string","description":"y축 확대값"},"page":{"type":"string","description":"페이지 번호"},"width":{"type":"string","description":"너비"},"height":{"type":"string","description":"높이"},"necessary":{"type":"string","description":"필수 여부","nullable":true},"src":{"type":"string","description":"이미지 src","nullable":true}},"description":"이미지"},"NumberField_Detail":{"title":"numberFields","type":"object","properties":{"uid":{"type":"string","description":"컴포넌트 고유 ID"},"id":{"type":"integer","description":"입력란 순번","format":"int32"},"x":{"type":"string","description":"x좌표"},"y":{"type":"string","description":"y좌표"},"scaleX":{"type":"string","description":"x축 확대값"},"scaleY":{"type":"string","description":"y축 확대값"},"page":{"type":"string","description":"페이지 번호"},"width":{"type":"string","description":"너비"},"height":{"type":"string","description":"높이"},"necessary":{"type":"string","description":"필수 여부","nullable":true},"value":{"type":"string","description":"내용","nullable":true},"thousandUnitDelimiter":{"type":"string","description":"천단위 구분 기호 사용 여부","nullable":true},"size":{"type":"string","description":"텍스트 크기"},"font":{"type":"string","description":"텍스트 글자체"},"fill":{"type":"string","description":"텍스트 색상"},"align":{"type":"string","description":"텍스트 정렬"}},"description":"숫자"},"Password_Detail":{"type":"object","properties":{"password":{"type":"string","description":"패스워드"},"passwordHint":{"type":"string","description":"패스워드 힌트"}},"description":"패스워드 인증"},"Phone_Detail":{"type":"object","properties":{"phone":{"type":"string","description":"본인 인증 명의자 휴대폰 번호"},"name":{"type":"string","description":"본인 인증 명의자 이름"}},"description":"PASS 인증"},"RadioField_Detail":{"title":"radioFields","type":"object","properties":{"uid":{"type":"string","description":"컴포넌트 고유 ID"},"id":{"type":"integer","description":"입력란 순번","format":"int32"},"x":{"type":"string","description":"x좌표"},"y":{"type":"string","description":"y좌표"},"scaleX":{"type":"string","description":"x축 확대값"},"scaleY":{"type":"string","description":"y축 확대값"},"page":{"type":"string","description":"페이지 번호"},"width":{"type":"string","description":"너비"},"height":{"type":"string","description":"높이"},"necessary":{"type":"string","description":"필수 여부","nullable":true},"value":{"type":"integer","description":"체크 여부","format":"int32"},"group":{"type":"string","description":"그룹","nullable":true}},"description":"라디오버튼"},"RequesterField_Detail":{"title":"requesterField","type":"object","properties":{"textFields":{"title":"textFields","type":"array","description":"텍스트","items":{"$ref":"#/components/schemas/TextField_Detail"}},"dateFields":{"title":"dateFields","type":"array","description":"날짜","items":{"$ref":"#/components/schemas/DateField_Detail"}},"checkboxFields":{"title":"checkboxFields","type":"array","description":"체크박스","items":{"$ref":"#/components/schemas/CheckboxField_Detail"}},"imageFields":{"title":"imageFields","type":"array","description":"이미지","items":{"$ref":"#/components/schemas/ImageField_Detail"}},"numberFields":{"title":"numberFields","type":"array","description":"숫자","items":{"$ref":"#/components/schemas/NumberField_Detail"}}},"description":"요청자 내용 추가 입력"},"SignField_Detail":{"title":"signFields","type":"object","properties":{"uid":{"type":"string","description":"컴포넌트 고유 ID"},"id":{"type":"integer","description":"입력란 순번","format":"int32"},"x":{"type":"string","description":"x좌표"},"y":{"type":"string","description":"y좌표"},"scaleX":{"type":"string","description":"x축 확대값"},"scaleY":{"type":"string","description":"y축 확대값"},"page":{"type":"string","description":"페이지 번호"},"width":{"type":"string","description":"너비"},"height":{"type":"string","description":"높이"},"necessary":{"type":"string","description":"필수 여부","nullable":true},"message":{"type":"string","description":"메시지","nullable":true}},"description":"사인"},"StampField_Detail":{"title":"stampFields","type":"object","properties":{"uid":{"type":"string","description":"컴포넌트 고유 ID"},"id":{"type":"integer","description":"입력란 순번","format":"int32"},"x":{"type":"string","description":"x좌표"},"y":{"type":"string","description":"y좌표"},"scaleX":{"type":"string","description":"x축 확대값"},"scaleY":{"type":"string","description":"y축 확대값"},"page":{"type":"string","description":"페이지 번호"},"width":{"type":"string","description":"너비"},"height":{"type":"string","description":"높이"},"necessary":{"type":"string","description":"필수 여부","nullable":true},"message":{"type":"string","description":"메시지","nullable":true}},"description":"도장"},"TextField_Detail":{"title":"textFields","type":"object","properties":{"uid":{"type":"string","description":"컴포넌트 고유 ID"},"id":{"type":"integer","description":"입력란 순번","format":"int32"},"x":{"type":"string","description":"x좌표"},"y":{"type":"string","description":"y좌표"},"scaleX":{"type":"string","description":"x축 확대값"},"scaleY":{"type":"string","description":"y축 확대값"},"page":{"type":"string","description":"페이지 번호"},"width":{"type":"string","description":"너비"},"height":{"type":"string","description":"높이"},"necessary":{"type":"string","description":"필수 여부","nullable":true},"value":{"type":"string","description":"내용","nullable":true},"size":{"type":"string","description":"텍스트 크기"},"font":{"type":"string","description":"텍스트 글자체"},"fill":{"type":"string","description":"텍스트 색상"},"align":{"type":"string","description":"텍스트 정렬"}},"description":"텍스트"},"ApiResExternalDocumentPageDTO":{"type":"object","properties":{"total":{"type":"integer","description":"전체 개수","format":"int64"},"page":{"type":"integer","description":"페이지 번호","format":"int32"},"rows":{"type":"integer","description":"한 페이지 조회 개수","format":"int32"},"contents":{"type":"array","description":"페이지 목록","items":{"$ref":"#/components/schemas/ExternalDocument"}}}},"downloads_Default":{"type":"object","properties":{"fileName":{"type":"string","description":"파일 명"},"urlEncodedFileName":{"type":"string","description":"URL encoded fileName"},"extension":{"type":"string","description":"파일 확장자"},"fileSize":{"type":"string","description":"파일 사이즈"},"contentType":{"type":"string","description":"타입 ex)application/pdf"},"file":{"type":"array","description":"파일 byte[] 데이터","items":{"type":"string","description":"파일 byte[] 데이터","format":"byte"}},"fileId":{"type":"string","description":"파일 UUID"}},"description":"다운로드 정보"},"downloads_Contract":{"type":"object","properties":{"fileName":{"type":"string","description":"파일 명"},"urlEncodedFileName":{"type":"string","description":"URL encoded fileName"},"extension":{"type":"string","description":"파일 확장자"},"fileSize":{"type":"string","description":"파일 사이즈"},"contentType":{"type":"string","description":"타입 ex)application/pdf"},"file":{"type":"array","description":"파일 byte[] 데이터","items":{"type":"string","description":"파일 byte[] 데이터","format":"byte"}},"fileId":{"type":"string","description":"파일 UUID"},"passwordLock":{"type":"string","description":"pdf 잠금 비밀번호"}},"description":"다운로드 정보"},"ApiResCompanyDTO":{"title":"company","type":"object","properties":{"companyName":{"type":"string","description":"회사명"},"businessNumber":{"type":"string","description":"사업자번호"},"ceoName":{"type":"string","description":"대표자명"},"zipCode":{"type":"string","description":"우편번호"},"addr":{"type":"string","description":"주소"},"addrDetail":{"type":"string","description":"세부 주소"},"phone":{"type":"string","description":"전화번호"},"email":{"type":"string","description":"이메일"},"createAt":{"type":"string","description":"등록날짜","format":"date-time"}},"description":"회사정보 DTO"},"ApiTeamFolder_Detail":{"type":"object","properties":{"parentId":{"type":"string","description":"상위 팀 ID(# : 최상위 팀)"},"teamId":{"type":"integer","description":"팀 ID","format":"int32"},"text":{"type":"string","description":"팀 이름"},"depth":{"type":"integer","description":"팀 레벨","format":"int32"},"childrens":{"type":"object","properties":{"parentId":{"type":"string","description":"상위 팀 ID(# : 최상위 팀)"},"teamId":{"type":"integer","description":"팀 ID","format":"int32"},"text":{"type":"string","description":"팀 이름"},"depth":{"type":"integer","description":"팀 레벨","format":"int32"}},"description":"하위 팀 리스트","format":"Array of objects"}},"format":"Array of objects"},"ApiResTeamDTO":{"title":"team","type":"object","properties":{"text":{"type":"string","description":"팀 명","example":"아이퀘스트"},"parentId":{"type":"string","description":"상위 팀 ID","example":"1"},"treamId":{"type":"integer","description":"팀 ID","format":"int32","example":2},"depth":{"type":"integer","description":"팀 레벨","format":"int32","example":1},"members":{"title":"members","type":"array","description":"팀 사용자","items":{"$ref":"#/components/schemas/ApiResTeamMemberDTO"}}}},"ApiResPointDTO":{"title":"point","type":"object","properties":{"signUser":{"$ref":"#/components/schemas/SignUser"},"olmaUser":{"$ref":"#/components/schemas/OlmaUser"}},"description":"포인트(건수) DTO"},"OlmaUser":{"type":"object","properties":{"point":{"type":"string","description":"잔여 포인트"}},"description":"얼마에요 연계 사용자"},"SignUser":{"type":"object","properties":{"paymentType":{"type":"string","description":"현재 구독형 요금제"},"count":{"type":"string","description":"구독형 잔여 건수"},"useCount":{"type":"string","description":"구독형 사용 건수"},"payCount":{"type":"string","description":"건별 잔여 건수"},"chargeCount":{"type":"string","description":"건별 충전 건수"},"useChargeCount":{"type":"string","description":"건별 사용 건수"},"dpCount":{"type":"string","description":"후불 사용 건수"}},"description":"얼마싸인 단독 사용자"},"ApiResCustomEmailDTO":{"type":"object","properties":{"link":{"type":"string","description":"로고 링크"},"backgroundColor":{"type":"string","description":"버튼 배경 색상"},"fontColor":{"type":"string","description":"버튼 글자 색상"},"callerName":{"type":"string","description":"발신자명"},"brandMessageTop":{"type":"string","description":"브랜딩메시지-상단"},"brandMessageBottom":{"type":"string","description":"브랜딩메시지-하단"}}},"ApiResBulkContractPageDTO":{"type":"object","properties":{"total":{"type":"integer","description":"전체 개수","format":"int64"},"page":{"type":"integer","description":"페이지 번호","format":"int32"},"rows":{"type":"integer","description":"한 페이지 조회 개수","format":"int32"},"contents":{"type":"array","description":"페이지 목록","items":{"$ref":"#/components/schemas/ApiResBulkContractDTO"}}}},"ApiResBulkContractDetailDTO":{"type":"object","properties":{"bulkContractId":{"type":"string","description":"대량 계약서 ID"},"title":{"type":"string","description":"문서명"},"status":{"type":"string","description":"전송상태"},"sendAt":{"type":"string","description":"전송시간","format":"date-time"},"fixedParticipants":{"title":"fixedParticipants","type":"array","description":"고정 참여자","items":{"$ref":"#/components/schemas/ApiResBulkFixedParticipantDTO"}},"participants":{"$ref":"#/components/schemas/ApiResBulkParticipantPageDTO"}}},"ApiResBulkFixedParticipantDTO":{"title":"fixedParticipant","type":"object","properties":{"name":{"type":"string","description":"수신자 이름"},"email":{"type":"string","description":"수신자 이메일"},"phone":{"type":"string","description":"수신자 전화번호"},"depth":{"type":"integer","description":"수신자 depth","format":"int32"},"role":{"type":"string","description":"수신자 역할"}},"description":"고정 참여자"},"ApiResBulkParticipantDTO":{"title":"participant","type":"object","properties":{"name":{"type":"string","description":"수신자 이름"},"email":{"type":"string","description":"수신자 이메일"},"phone":{"type":"string","description":"수신자 전화번호"},"depth":{"type":"integer","description":"수신자 depth","format":"int32"},"contractId":{"type":"string","description":"계약서 ID"},"title":{"type":"string","description":"문서명"},"auth":{"$ref":"#/components/schemas/ApiResContractorMfaDTO"},"component":{"type":"object","additionalProperties":{"type":"object","description":"입력된 컴포넌트 정보"},"description":"입력된 컴포넌트 정보"},"reqComponent":{"type":"array","writeOnly":true,"items":{"$ref":"#/components/schemas/IqbContractValue"}}},"description":"서명자 정보"},"ApiResBulkParticipantPageDTO":{"title":"participants","type":"object","properties":{"total":{"type":"integer","description":"전체 개수","format":"int64"},"page":{"type":"integer","description":"페이지 번호","format":"int32"},"rows":{"type":"integer","description":"한 페이지 조회 개수","format":"int32"},"contents":{"type":"array","description":"페이지 목록","items":{"$ref":"#/components/schemas/ApiResBulkParticipantDTO"}}},"description":"서명자"},"ApiResContractorMfaDTO":{"type":"object","properties":{"sms":{"type":"string","description":"SMS 인증"},"email":{"type":"string","description":"이메일 인증"},"password":{"$ref":"#/components/schemas/Password"},"pass":{"$ref":"#/components/schemas/Pass"},"corporateCert":{"$ref":"#/components/schemas/CorporateCert"}},"description":"2차 인증 정보"},"CorporateCert":{"type":"object","properties":{"certName":{"type":"string","description":"법인명"},"certNo":{"type":"string","description":"사업자번호"}},"description":"법인 공동 인증서 인증"},"IqbContractValue":{"type":"object","properties":{"sqContractValue":{"type":"integer","format":"int64"},"sqContract":{"type":"integer","format":"int64"},"sqContractor":{"type":"integer","format":"int64"},"sqTemplateInto":{"type":"integer","format":"int64"},"tyContractor":{"type":"string"},"svgId":{"type":"string"},"noDepth":{"type":"integer","format":"int32"},"noId":{"type":"integer","format":"int32"},"tyFormat":{"type":"string"},"noSize":{"type":"string"},"noX":{"type":"string"},"noY":{"type":"string"},"noWidth":{"type":"string"},"noHeight":{"type":"string"},"checked":{"type":"integer","format":"int32"},"txtText":{"type":"string"},"ltextImgUrlSigned":{"type":"string"},"dtInsert":{"type":"string","format":"date-time"},"markType":{"type":"string"},"markId":{"type":"string"},"cmpNm":{"type":"string"},"noPage":{"type":"string"},"noGenKey":{"type":"string"},"noLeft":{"type":"string"},"noTop":{"type":"string"},"noScaleX":{"type":"string"},"noScaleY":{"type":"string"},"noFontSize":{"type":"string"},"fill":{"type":"string"},"markNote":{"type":"string"},"fontFamily":{"type":"string"},"necessary":{"type":"string"},"cboxListData":{"type":"string"},"backgroundColor":{"type":"string"},"text":{"type":"string"},"textAlign":{"type":"string"},"fullFileNm":{"type":"string"},"fileNm":{"type":"string"},"fileExtension":{"type":"string"},"fileSize":{"type":"string"},"image":{"type":"string"},"gc":{"type":"string"},"chYn":{"type":"string"},"depth":{"type":"string"},"noNoId":{"type":"integer","format":"int32"},"fontWeight":{"type":"string"},"fillgC":{"type":"string"},"comboboxSlc":{"type":"string"},"compSelect":{"type":"string"},"radioBoxSlc":{"type":"string"},"radioSelect":{"type":"string"},"radioWrap":{"type":"string"},"rdbSingleSel":{"type":"string"},"readonly":{"type":"string"},"editable":{"type":"string"},"selectable":{"type":"string"},"checkedValue":{"type":"string"},"excelTitle":{"type":"string"},"thousandUnitDelimiter":{"type":"string"},"signMessage":{"type":"string"},"itemsCount":{"type":"string"},"itemsGroup":{"type":"string"},"selectableCheckboxMinCount":{"type":"string"},"selectableCheckboxMaxCount":{"type":"string"},"dropdownTitle":{"type":"string"},"dropdownOptions":{"type":"string"},"selectableCountType":{"type":"string"},"dateInputType":{"type":"string"},"dateShowFormat":{"type":"string"}}},"Pass":{"type":"object","properties":{"phoneName":{"type":"string","description":"휴대폰 명의"},"phone":{"type":"string","description":"휴대폰 번호"}},"description":"PASS 인증"}},"securitySchemes":{"bearerAuth":{"type":"http","scheme":"Bearer","bearerFormat":"JWT"}}}}