WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-08-21 15:12:34 +02:00
Code Issues Packages Projects Releases Wiki Activity

Add API endpoints for signer IPs and form data

Browse Source 
Added new API endpoints to retrieve signer IPs and form data for documents. Updated schemas and descriptions for better clarity.
This commit is contained in:
prafull-opensignlabs
2025-11-26 22:08:25 +05:30
committed by GitHub
parent cf698be79e
commit d758062c07
1 changed files with 171 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/docs/API-docs/v1.1/opensign.yaml
+171 -1
View File
@@ -1668,7 +1668,7 @@ paths:
"readonly": false,
"default": 0,
"formula": "",
"decimalplaces": 2
"decimalplaces": 2,
}
```
@@ -2070,6 +2070,104 @@ paths:
$ref: '#/components/schemas/invalidtoken'
security:
- x-api-token: []
/signerips/{document_id}:
get:
tags:
- Documents
summary: Get Signer IPs
description: |
The Get Signer IPs API enables you to retrieve IPs of signers who signed the document.
Note: This API is only available for Teams and Enterprise plans.
operationId: getsignerips
parameters:
- name: document_id
in: path
description: objectId of Document
required: true
style: simple
explode: false
schema:
type: string
format: string
example: aB2cc2hpbh
responses:
"200":
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/signerIpsResponse'
"400":
description: "Something went wrong, please try again later!"
content:
application/json:
schema:
$ref: '#/components/schemas/inline_response_400_1'
"404":
description: Document not found!
content:
application/json:
schema:
$ref: '#/components/schemas/inline_response_404_3'
"405":
description: Invalid API Token!
content:
application/json:
schema:
$ref: '#/components/schemas/invalidtoken'
security:
- x-api-token: []
/formdata/{document_id}:
get:
tags:
- Documents
summary: Get Formdata
description: |
The Get Formdata API enables you to retrieve widget data filled by signers who signed the document.
Note: This API is only available for Teams and Enterprise plans.
operationId: getformdata
parameters:
- name: document_id
in: path
description: objectId of Document
required: true
style: simple
explode: false
schema:
type: string
format: string
example: aB2cc2hpbh
responses:
"200":
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/formdataResponse'
"400":
description: "Something went wrong, please try again later!"
content:
application/json:
schema:
$ref: '#/components/schemas/inline_response_400_1'
"404":
description: Document not found!
content:
application/json:
schema:
$ref: '#/components/schemas/inline_response_404_3'
"405":
description: Invalid API Token!
content:
application/json:
schema:
$ref: '#/components/schemas/invalidtoken'
security:
- x-api-token: []
/drafttemplate:
post:
tags:
@@ -4470,6 +4568,78 @@ components:
example: 0
xml:
name: documentwithstatus
signerIpsResponse:
type: object
properties:
objectId:
type: string
format: string
example: FGik23bhUJ
signer_ips:
type: array
items:
$ref: '#/components/schemas/signer_ips'
xml:
name: signerIpsResponse
signer_ips:
type: object
properties:
email:
type: string
example: joebee@example.com
phone:
type: string
example: "193.186.4.187"
xml:
name: signerIpsResponse
formdataResponse:
type: object
properties:
objectId:
type: string
format: string
example: FGik23bhUJ
title:
type: string
format: string
example: sample doc
sent_date:
type: string
format: string
example: "26/11/2025"
status:
type: string
format: string
example: "completed"
form_data:
type: array
items:
$ref: '#/components/schemas/form_data'
xml:
name: formdataResponse
form_data:
type: object
properties:
name:
type: string
example: "job bee"
email:
type: string
example: "jobbee@exampl.com"
widgets:
type: array
items:
type: object
properties:
name:
type: string
example: "job title"
response:
type: string
example: "ceo"
xml:
name: form_data
document:
type: object
properties: