Skip to content

Commit d758062

Browse files
Add API endpoints for signer IPs and form data
Added new API endpoints to retrieve signer IPs and form data for documents. Updated schemas and descriptions for better clarity.
1 parent cf698be commit d758062

1 file changed

Lines changed: 171 additions & 1 deletion

File tree

docs/docs/API-docs/v1.1/opensign.yaml

Lines changed: 171 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1668,7 +1668,7 @@ paths:
16681668
"readonly": false,
16691669
"default": 0,
16701670
"formula": "",
1671-
"decimalplaces": 2
1671+
"decimalplaces": 2,
16721672
}
16731673
```
16741674
@@ -2070,6 +2070,104 @@ paths:
20702070
$ref: '#/components/schemas/invalidtoken'
20712071
security:
20722072
- x-api-token: []
2073+
2074+
/signerips/{document_id}:
2075+
get:
2076+
tags:
2077+
- Documents
2078+
summary: Get Signer IPs
2079+
description: |
2080+
The Get Signer IPs API enables you to retrieve IPs of signers who signed the document.
2081+
2082+
Note: This API is only available for Teams and Enterprise plans.
2083+
operationId: getsignerips
2084+
parameters:
2085+
- name: document_id
2086+
in: path
2087+
description: objectId of Document
2088+
required: true
2089+
style: simple
2090+
explode: false
2091+
schema:
2092+
type: string
2093+
format: string
2094+
example: aB2cc2hpbh
2095+
responses:
2096+
"200":
2097+
description: successful operation
2098+
content:
2099+
application/json:
2100+
schema:
2101+
$ref: '#/components/schemas/signerIpsResponse'
2102+
"400":
2103+
description: "Something went wrong, please try again later!"
2104+
content:
2105+
application/json:
2106+
schema:
2107+
$ref: '#/components/schemas/inline_response_400_1'
2108+
"404":
2109+
description: Document not found!
2110+
content:
2111+
application/json:
2112+
schema:
2113+
$ref: '#/components/schemas/inline_response_404_3'
2114+
"405":
2115+
description: Invalid API Token!
2116+
content:
2117+
application/json:
2118+
schema:
2119+
$ref: '#/components/schemas/invalidtoken'
2120+
security:
2121+
- x-api-token: []
2122+
2123+
/formdata/{document_id}:
2124+
get:
2125+
tags:
2126+
- Documents
2127+
summary: Get Formdata
2128+
description: |
2129+
The Get Formdata API enables you to retrieve widget data filled by signers who signed the document.
2130+
2131+
Note: This API is only available for Teams and Enterprise plans.
2132+
operationId: getformdata
2133+
parameters:
2134+
- name: document_id
2135+
in: path
2136+
description: objectId of Document
2137+
required: true
2138+
style: simple
2139+
explode: false
2140+
schema:
2141+
type: string
2142+
format: string
2143+
example: aB2cc2hpbh
2144+
responses:
2145+
"200":
2146+
description: successful operation
2147+
content:
2148+
application/json:
2149+
schema:
2150+
$ref: '#/components/schemas/formdataResponse'
2151+
"400":
2152+
description: "Something went wrong, please try again later!"
2153+
content:
2154+
application/json:
2155+
schema:
2156+
$ref: '#/components/schemas/inline_response_400_1'
2157+
"404":
2158+
description: Document not found!
2159+
content:
2160+
application/json:
2161+
schema:
2162+
$ref: '#/components/schemas/inline_response_404_3'
2163+
"405":
2164+
description: Invalid API Token!
2165+
content:
2166+
application/json:
2167+
schema:
2168+
$ref: '#/components/schemas/invalidtoken'
2169+
security:
2170+
- x-api-token: []
20732171
/drafttemplate:
20742172
post:
20752173
tags:
@@ -4470,6 +4568,78 @@ components:
44704568
example: 0
44714569
xml:
44724570
name: documentwithstatus
4571+
signerIpsResponse:
4572+
type: object
4573+
properties:
4574+
objectId:
4575+
type: string
4576+
format: string
4577+
example: FGik23bhUJ
4578+
signer_ips:
4579+
type: array
4580+
items:
4581+
$ref: '#/components/schemas/signer_ips'
4582+
xml:
4583+
name: signerIpsResponse
4584+
signer_ips:
4585+
type: object
4586+
properties:
4587+
email:
4588+
type: string
4589+
example: joebee@example.com
4590+
phone:
4591+
type: string
4592+
example: "193.186.4.187"
4593+
xml:
4594+
name: signerIpsResponse
4595+
4596+
formdataResponse:
4597+
type: object
4598+
properties:
4599+
objectId:
4600+
type: string
4601+
format: string
4602+
example: FGik23bhUJ
4603+
title:
4604+
type: string
4605+
format: string
4606+
example: sample doc
4607+
sent_date:
4608+
type: string
4609+
format: string
4610+
example: "26/11/2025"
4611+
status:
4612+
type: string
4613+
format: string
4614+
example: "completed"
4615+
form_data:
4616+
type: array
4617+
items:
4618+
$ref: '#/components/schemas/form_data'
4619+
xml:
4620+
name: formdataResponse
4621+
form_data:
4622+
type: object
4623+
properties:
4624+
name:
4625+
type: string
4626+
example: "job bee"
4627+
email:
4628+
type: string
4629+
example: "jobbee@exampl.com"
4630+
widgets:
4631+
type: array
4632+
items:
4633+
type: object
4634+
properties:
4635+
name:
4636+
type: string
4637+
example: "job title"
4638+
response:
4639+
type: string
4640+
example: "ceo"
4641+
xml:
4642+
name: form_data
44734643
document:
44744644
type: object
44754645
properties:

0 commit comments

Comments
 (0)