{"info":{"_postman_id":"80d98780-10d2-423f-84cb-d06fa6d12a04","name":"Consist.DoxiAPI v4.6.0","description":"

Getting started

\n\n

You needs to get a token and pass the Bearer Token in each API call.

For getting the token please use GetToken
method

Base Doxi API URL is: https://doxi-sign.com/api

Swagger: https://doxi-sign.com/api/swagger

OpenAPI: https://doxi-sign.com/api/swagger/v4/swagger.json

For every call you need to add the HTTP Header name X-Tenant with the company tenant name. For example if your Doxi URL is:
https://doxi-sign.com/#/mycompany
Then the company tenant is mycompany

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Getting started","slug":"getting-started"}],"owner":"21971446","collectionId":"80d98780-10d2-423f-84cb-d06fa6d12a04","publishedId":"2s93RNxaAa","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2023-03-24T19:16:26.000Z"},"item":[{"name":"ex","item":[{"name":"webhook","item":[{"name":"test","item":[{"name":"/ex/webhook/test","id":"6e665c75-4208-4ee4-9009-6baea04ecf00","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"webhookUri\": \"\",\n \"isActive\": \"\",\n \"webhookEvents\": [\n {\n \"webhookEventType\": null,\n \"signFlowEventFilter\": {\n \"customFieldsKeys\": [\n \"\",\n \"\"\n ],\n \"sourceTemplateId\": \"\",\n \"signatureFlowStatus\": 0\n },\n \"signerEventFilter\": {\n \"customFieldsKeys\": [\n \"\",\n \"\"\n ],\n \"sourceTemplateId\": \"\",\n \"signStatus\": 3\n },\n \"openFlowEventFilter\": {\n \"customFieldsKeys\": [\n \"\",\n \"\"\n ],\n \"sourceTemplateId\": \"\"\n },\n \"kitEventFilter\": {\n \"kitStatus\": 0\n },\n \"userEventFilter\": {\n \"userType\": 2,\n \"company\": \"\"\n }\n },\n {\n \"webhookEventType\": null,\n \"signFlowEventFilter\": {\n \"customFieldsKeys\": [\n \"\",\n \"\"\n ],\n \"sourceTemplateId\": \"\",\n \"signatureFlowStatus\": 5\n },\n \"signerEventFilter\": {\n \"customFieldsKeys\": [\n \"\",\n \"\"\n ],\n \"sourceTemplateId\": \"\",\n \"signStatus\": 7\n },\n \"openFlowEventFilter\": {\n \"customFieldsKeys\": [\n \"\",\n \"\"\n ],\n \"sourceTemplateId\": \"\"\n },\n \"kitEventFilter\": {\n \"kitStatus\": 1\n },\n \"userEventFilter\": {\n \"userType\": 1,\n \"company\": \"\"\n }\n }\n ],\n \"headers\": {\n \"deserunt5d\": \"\",\n \"adipisicing_d9\": \"\",\n \"esse7\": \"\",\n \"laborum7c\": \"\"\n },\n \"isEncryptData\": \"\",\n \"webhookConsumer\": {\n \"company\": \"\",\n \"description\": \"\",\n \"contactInfo\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//ex/webhook/test","description":"

Use to test the webhook subscription (like Trigger test on Zappier)

JSON object description:

webhookSubscriptionWebhookSubscription:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

filed	type	description
WebhookUri	String	Subscription webhook endpoint
IsActive	Boolean	Is subscription active
WebhookEvents	IEnumerable<WebhookEvent>	Publish the event with filter is matching
Headers	IDictionary<String,String>	Gets a set of additional HTTP headers. That headers will be sent with the webhook.
IsEncryptData	Boolean	If to make the data encrypted
WebhookConsumer	WebhookConsumer	Webhook consumer details

WebhookConsumer:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

filed	type	description
Company	String	The company of the consumer
Description	String	The description of the consumer
ContactInfo	String	The contact info of the consumer

WebhookEvent:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

filed	type	description
WebhookEventType	WebhookEventType
SignFlowEventFilter	SignFlowEventFilter	Flow event filter parameters:Only then WebhookEventType=SignFlowStatusChanged.
SignerEventFilter	SignerEventFilter	Signer event filter parameters :Only then WebhookEventType=SignerStatusChanged.
OpenFlowEventFilter	OpenFlowEventFilter	Open flow event filter:Only then WebhookEventType=OpenFlowFirstTime.
KitEventFilter	KitEventFilter	Kit event filter parameters :Only then WebhookEventType=KitStatusChanged.
UserEventFilter	UserEventFilter	User event filter parameters :Only then WebhookEventType=UsersChanged.

UserEventFilter:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

filed	type	description
UserType	Nullable<UserType>	User's type
Company	String	User's company

UserType:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

value	description
0	Administrator
1	Creator
2	Signer

KitEventFilter:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

filed	type	description
KitStatus	Nullable<KitStatusType>	Status of the kit

KitStatusType:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

value	description
0	Open
1	Completed

OpenFlowEventFilter:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

filed	type	description
CustomFieldsKeys	String[]	Additional data keys
SourceTemplateId	String	The template id the flow was created from

SignerEventFilter:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

filed	type	description
SignStatus	Nullable<SignStatus>	Status of the signer
CustomFieldsKeys	String[]	Additional data keys
SourceTemplateId	String	The template id the flow was created from

SignStatus:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

value	description
0	NotSend
1	WaitingForApproval
2	Approved
3	Declined
4	Stopped
5	FailedToSent
6	Suspended
7	Expired

SignFlowEventFilter:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

filed	type	description
SignatureFlowStatus	Nullable<SignatureFlowStatus>	Status of the flow
CustomFieldsKeys	String[]	Additional data keys
SourceTemplateId	String	The template id the flow was created from

SignatureFlowStatus:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

value	description
0	Open
1	Approved
2	Declined
3	Stopped
4	Suspended
5	Expired

WebhookEventType:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

value	description
0	FlowStatusChangedEvent
1	SignerStatusChangedEvent
2	FlowOpenedEvent
3	KitStatusChangedEvent
4	AddUserEvent

","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"80d98780-10d2-423f-84cb-d06fa6d12a04","id":"80d98780-10d2-423f-84cb-d06fa6d12a04","name":"Consist.DoxiAPI v4.6.0","type":"collection"}},"urlObject":{"path":["ex","webhook","test"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"34b32052-ab41-48b8-a7fa-ff8d66c65bfd","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"webhookUri\": \"\",\n \"isActive\": \"\",\n \"webhookEvents\": [\n {\n \"webhookEventType\": null,\n \"signFlowEventFilter\": {\n \"customFieldsKeys\": [\n \"\",\n \"\"\n ],\n \"sourceTemplateId\": \"\",\n \"signatureFlowStatus\": 0\n },\n \"signerEventFilter\": {\n \"customFieldsKeys\": [\n \"\",\n \"\"\n ],\n \"sourceTemplateId\": \"\",\n \"signStatus\": 3\n },\n \"openFlowEventFilter\": {\n \"customFieldsKeys\": [\n \"\",\n \"\"\n ],\n \"sourceTemplateId\": \"\"\n },\n \"kitEventFilter\": {\n \"kitStatus\": 0\n },\n \"userEventFilter\": {\n \"userType\": 2,\n \"company\": \"\"\n }\n },\n {\n \"webhookEventType\": null,\n \"signFlowEventFilter\": {\n \"customFieldsKeys\": [\n \"\",\n \"\"\n ],\n \"sourceTemplateId\": \"\",\n \"signatureFlowStatus\": 5\n },\n \"signerEventFilter\": {\n \"customFieldsKeys\": [\n \"\",\n \"\"\n ],\n \"sourceTemplateId\": \"\",\n \"signStatus\": 7\n },\n \"openFlowEventFilter\": {\n \"customFieldsKeys\": [\n \"\",\n \"\"\n ],\n \"sourceTemplateId\": \"\"\n },\n \"kitEventFilter\": {\n \"kitStatus\": 1\n },\n \"userEventFilter\": {\n \"userType\": 1,\n \"company\": \"\"\n }\n }\n ],\n \"headers\": {\n \"deserunt5d\": \"\",\n \"adipisicing_d9\": \"\",\n \"esse7\": \"\",\n \"laborum7c\": \"\"\n },\n \"isEncryptData\": \"\",\n \"webhookConsumer\": {\n \"company\": \"\",\n \"description\": \"\",\n \"contactInfo\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//ex/webhook/test"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"webhookEvent\": \"\",\n \"attempt\": \"\",\n \"data\": {\n \"nullable\": true\n },\n \"creationTimeUtc\": \"\"\n}"}],"_postman_id":"6e665c75-4208-4ee4-9009-6baea04ecf00"}],"id":"c42a6f2f-8452-47c4-99ac-a4db464130c1","_postman_id":"c42a6f2f-8452-47c4-99ac-a4db464130c1","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"80d98780-10d2-423f-84cb-d06fa6d12a04","id":"80d98780-10d2-423f-84cb-d06fa6d12a04","name":"Consist.DoxiAPI v4.6.0","type":"collection"}}},{"name":"/ex/webhook","id":"bdd65db2-f823-4570-a1bc-9f04dd42f112","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"webhookUri\": \"\",\n \"isActive\": \"\",\n \"webhookEvents\": [\n {\n \"webhookEventType\": null,\n \"signFlowEventFilter\": {\n \"customFieldsKeys\": [\n \"\",\n \"\"\n ],\n \"sourceTemplateId\": \"\",\n \"signatureFlowStatus\": 0\n },\n \"signerEventFilter\": {\n \"customFieldsKeys\": [\n \"\",\n \"\"\n ],\n \"sourceTemplateId\": \"\",\n \"signStatus\": 3\n },\n \"openFlowEventFilter\": {\n \"customFieldsKeys\": [\n \"\",\n \"\"\n ],\n \"sourceTemplateId\": \"\"\n },\n \"kitEventFilter\": {\n \"kitStatus\": 0\n },\n \"userEventFilter\": {\n \"userType\": 2,\n \"company\": \"\"\n }\n },\n {\n \"webhookEventType\": null,\n \"signFlowEventFilter\": {\n \"customFieldsKeys\": [\n \"\",\n \"\"\n ],\n \"sourceTemplateId\": \"\",\n \"signatureFlowStatus\": 5\n },\n \"signerEventFilter\": {\n \"customFieldsKeys\": [\n \"\",\n \"\"\n ],\n \"sourceTemplateId\": \"\",\n \"signStatus\": 7\n },\n \"openFlowEventFilter\": {\n \"customFieldsKeys\": [\n \"\",\n \"\"\n ],\n \"sourceTemplateId\": \"\"\n },\n \"kitEventFilter\": {\n \"kitStatus\": 1\n },\n \"userEventFilter\": {\n \"userType\": 1,\n \"company\": \"\"\n }\n }\n ],\n \"headers\": {\n \"deserunt5d\": \"\",\n \"adipisicing_d9\": \"\",\n \"esse7\": \"\",\n \"laborum7c\": \"\"\n },\n \"isEncryptData\": \"\",\n \"webhookConsumer\": {\n \"company\": \"\",\n \"description\": \"\",\n \"contactInfo\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//ex/webhook","description":"

Add new webhook subscription

JSON object description:

webhookSubscriptionWebhookSubscription:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

filed	type	description
WebhookUri	String	Subscription webhook endpoint
IsActive	Boolean	Is subscription active
WebhookEvents	IEnumerable<WebhookEvent>	Publish the event with filter is matching
Headers	IDictionary<String,String>	Gets a set of additional HTTP headers. That headers will be sent with the webhook.
IsEncryptData	Boolean	If to make the data encrypted
WebhookConsumer	WebhookConsumer	Webhook consumer details

WebhookConsumer:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

filed	type	description
Company	String	The company of the consumer
Description	String	The description of the consumer
ContactInfo	String	The contact info of the consumer

WebhookEvent:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

filed	type	description
WebhookEventType	WebhookEventType
SignFlowEventFilter	SignFlowEventFilter	Flow event filter parameters:Only then WebhookEventType=SignFlowStatusChanged.
SignerEventFilter	SignerEventFilter	Signer event filter parameters :Only then WebhookEventType=SignerStatusChanged.
OpenFlowEventFilter	OpenFlowEventFilter	Open flow event filter:Only then WebhookEventType=OpenFlowFirstTime.
KitEventFilter	KitEventFilter	Kit event filter parameters :Only then WebhookEventType=KitStatusChanged.
UserEventFilter	UserEventFilter	User event filter parameters :Only then WebhookEventType=UsersChanged.

UserEventFilter:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

filed	type	description
UserType	Nullable<UserType>	User's type
Company	String	User's company

UserType:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

value	description
0	Administrator
1	Creator
2	Signer

KitEventFilter:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

filed	type	description
KitStatus	Nullable<KitStatusType>	Status of the kit

KitStatusType:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

value	description
0	Open
1	Completed

OpenFlowEventFilter:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

filed	type	description
CustomFieldsKeys	String[]	Additional data keys
SourceTemplateId	String	The template id the flow was created from

SignerEventFilter:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

filed	type	description
SignStatus	Nullable<SignStatus>	Status of the signer
CustomFieldsKeys	String[]	Additional data keys
SourceTemplateId	String	The template id the flow was created from

SignStatus:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

value	description
0	NotSend
1	WaitingForApproval
2	Approved
3	Declined
4	Stopped
5	FailedToSent
6	Suspended
7	Expired

SignFlowEventFilter:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

filed	type	description
SignatureFlowStatus	Nullable<SignatureFlowStatus>	Status of the flow
CustomFieldsKeys	String[]	Additional data keys
SourceTemplateId	String	The template id the flow was created from

SignatureFlowStatus:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

value	description
0	Open
1	Approved
2	Declined
3	Stopped
4	Suspended
5	Expired

WebhookEventType:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

value	description
0	FlowStatusChangedEvent
1	SignerStatusChangedEvent
2	FlowOpenedEvent
3	KitStatusChangedEvent
4	AddUserEvent

Add Flow to meeting

vrMeetingId(String):

signflowId(String):

Update Virtual Room meeting

vrMeetingId(String):

updateVRMeetingRequestUpdateVRMeetingRequest:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

filed	type	description
SignFlowsIds	IEnumerable<String>	Doxi flows to sign in the meeting (array of flow IDs)

Search for Virtual Room meeting

JSON object description:

getVRMeetingsRequestGetVRMeetingsRequest:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

filed	type	description
SignFlowId	String
Host	ParticipantKey<ParticipantKeyType>
Participant	ParticipantKey<ParticipantKeyType>

ParticipantKey`1:

Allow to locate Doxi user by:UserEmail=1UserPhone=2

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

filed	type	description
* Key	String	User search value
Type	ParticipantKeyType	Search type:UserEmail=1,UserPhone=2

ParticipantKeyType:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

value	description
0	UserId
1	UserEmail
2	UserPhone
3	UserName
4	GroupId

","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"80d98780-10d2-423f-84cb-d06fa6d12a04","id":"80d98780-10d2-423f-84cb-d06fa6d12a04","name":"Consist.DoxiAPI v4.6.0","type":"collection"}},"urlObject":{"path":["ex","vrmeeting","search"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"df43ce80-0af6-4713-bddd-41e78da0879e","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"signFlowId\": \"\",\n \"host\": {\n \"key\": \"\",\n \"type\": null\n },\n \"participant\": {\n \"key\": \"\",\n \"type\": null\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//ex/vrmeeting/search"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"vrMeetings\": [\n {\n \"id\": \"\",\n \"sessionId\": \"\",\n \"meetingDescription\": \"\",\n \"meetingDateTime\": \"\",\n \"signFlowsIds\": [\n \"\",\n \"\"\n ],\n \"participants\": [\n {\n \"id\": \"\",\n \"type\": null,\n \"isHost\": \"\",\n \"status\": null,\n \"email\": \"\",\n \"phone\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": null,\n \"isHost\": \"\",\n \"status\": null,\n \"email\": \"\",\n \"phone\": \"\"\n }\n ],\n \"guests\": [\n {\n \"id\": \"\",\n \"type\": null,\n \"isHost\": \"\",\n \"status\": null,\n \"email\": \"\",\n \"phone\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": null,\n \"isHost\": \"\",\n \"status\": null,\n \"email\": \"\",\n \"phone\": \"\"\n }\n ],\n \"createdAt\": \"\",\n \"creator\": {\n \"key\": \"\",\n \"type\": null\n }\n },\n {\n \"id\": \"\",\n \"sessionId\": \"\",\n \"meetingDescription\": \"\",\n \"meetingDateTime\": \"\",\n \"signFlowsIds\": [\n \"\",\n \"\"\n ],\n \"participants\": [\n {\n \"id\": \"\",\n \"type\": null,\n \"isHost\": \"\",\n \"status\": null,\n \"email\": \"\",\n \"phone\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": null,\n \"isHost\": \"\",\n \"status\": null,\n \"email\": \"\",\n \"phone\": \"\"\n }\n ],\n \"guests\": [\n {\n \"id\": \"\",\n \"type\": null,\n \"isHost\": \"\",\n \"status\": null,\n \"email\": \"\",\n \"phone\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": null,\n \"isHost\": \"\",\n \"status\": null,\n \"email\": \"\",\n \"phone\": \"\"\n }\n ],\n \"createdAt\": \"\",\n \"creator\": {\n \"key\": \"\",\n \"type\": null\n }\n }\n ]\n}"}],"_postman_id":"6c231fa5-94d8-4d8f-883c-e6c3a9c8ce85"}],"id":"e0b9b63c-3778-4c93-a76f-fe68be3096d5","_postman_id":"e0b9b63c-3778-4c93-a76f-fe68be3096d5","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"80d98780-10d2-423f-84cb-d06fa6d12a04","id":"80d98780-10d2-423f-84cb-d06fa6d12a04","name":"Consist.DoxiAPI v4.6.0","type":"collection"}}},{"name":"/ex/vrmeeting","id":"73f54d71-85c1-4947-96cf-04256c4cd521","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"meetingDescription\": \"\",\n \"meetingDateTime\": \"\",\n \"signFlowsIds\": [\n \"\",\n \"\"\n ],\n \"roomHostUser\": {\n \"key\": \"\",\n \"type\": null\n },\n \"participants\": [\n {\n \"key\": \"\",\n \"type\": null\n },\n {\n \"key\": \"\",\n \"type\": null\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//ex/vrmeeting","description":"

Add new Virtual Room meeting

JSON object description:

createVRRoomRequestCreateVRMeetingRequest:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

filed	type	description
MeetingDescription	String	Name on the virtual room meeting
MeetingDateTime	DateTime	Date and time of the meeting
SignFlowsIds	IEnumerable<String>	Doxi flows to sign in the meeting (array of flow IDs)
RoomHostUser	ParticipantKey<ParticipantKeyType>	Room host user
Participants	IEnumerable<ParticipantKey<ParticipantKeyType>>	Room Participants

ParticipantKey`1:

Allow to locate Doxi user by:UserEmail=1UserPhone=2

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

filed	type	description
* Key	String	User search value
Type	ParticipantKeyType	Search type:UserEmail=1,UserPhone=2

ParticipantKeyType:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

value	description
0	UserId
1	UserEmail
2	UserPhone
3	UserName
4	GroupId

Get all templates by username

Get all users groups by user key parameter

Get all template elements and PDF document

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"80d98780-10d2-423f-84cb-d06fa6d12a04","id":"80d98780-10d2-423f-84cb-d06fa6d12a04","name":"Consist.DoxiAPI v4.6.0","type":"collection"}},"urlObject":{"path":["ex","template",":templateId"],"host":["/"],"query":[],"variable":[{"type":"any","value":"97372d9c-b6d5-4342-bb48-ef97344c1c68","key":"templateId"}]}},"response":[{"id":"abcc0d0f-3f40-4d9e-88a6-58f705cac522","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"text/plain"}],"url":{"raw":"//ex/template/:templateId","host":["/"],"path":["ex","template",":templateId"],"variable":[{"key":"templateId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"templateName\": \"\",\n \"flowElements\": [\n {\n \"elementType\": null,\n \"pageNumber\": \"\",\n \"position\": {\n \"height\": \"\",\n \"left\": \"\",\n \"top\": \"\",\n \"width\": \"\"\n },\n \"elementSubType\": null,\n \"textValue\": \"\",\n \"textSize\": \"\",\n \"textFont\": \"\",\n \"elementLabel\": \"\",\n \"elementHelp\": \"\",\n \"valueName\": \"\",\n \"horizontalAlignment\": 1,\n \"isRequired\": \"\",\n \"validations\": [\n {\n \"regex\": \"\",\n \"errorCode\": null\n },\n {\n \"regex\": \"\",\n \"errorCode\": null\n }\n ],\n \"dateTimeValidation\": {\n \"dateTimeFormat\": \"\",\n \"isCurrentDateTime\": \"\",\n \"minimumDate\": \"\",\n \"maximumDate\": \"\"\n },\n \"dropDownList\": [\n {\n \"values\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"values\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ],\n \"additionalInfo\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ],\n \"duplicateElementInfo\": {\n \"isAllPagesFromCurrent\": \"\",\n \"pageRange\": \"\"\n },\n \"displayValueInFlowDecription\": \"\",\n \"zIndex\": \"\",\n \"userIndex\": \"\"\n },\n {\n \"elementType\": null,\n \"pageNumber\": \"\",\n \"position\": {\n \"height\": \"\",\n \"left\": \"\",\n \"top\": \"\",\n \"width\": \"\"\n },\n \"elementSubType\": null,\n \"textValue\": \"\",\n \"textSize\": \"\",\n \"textFont\": \"\",\n \"elementLabel\": \"\",\n \"elementHelp\": \"\",\n \"valueName\": \"\",\n \"horizontalAlignment\": 1,\n \"isRequired\": \"\",\n \"validations\": [\n {\n \"regex\": \"\",\n \"errorCode\": null\n },\n {\n \"regex\": \"\",\n \"errorCode\": null\n }\n ],\n \"dateTimeValidation\": {\n \"dateTimeFormat\": \"\",\n \"isCurrentDateTime\": \"\",\n \"minimumDate\": \"\",\n \"maximumDate\": \"\"\n },\n \"dropDownList\": [\n {\n \"values\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"values\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ],\n \"additionalInfo\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ],\n \"duplicateElementInfo\": {\n \"isAllPagesFromCurrent\": \"\",\n \"pageRange\": \"\"\n },\n \"displayValueInFlowDecription\": \"\",\n \"zIndex\": \"\",\n \"userIndex\": \"\"\n }\n ],\n \"sendMethodType\": 0,\n \"templateType\": 2,\n \"captchaDisabled\": \"\",\n \"preliminaryText\": \"\",\n \"signFlowDescriptionMessage\": \"\",\n \"isAutomaticRemainder\": \"\",\n \"dayesForAutomaticRemainder\": \"\",\n \"isSendApprovalMailToAllSigners\": \"\",\n \"recipients\": [\n {\n \"key\": \"\",\n \"type\": null\n },\n {\n \"key\": \"\",\n \"type\": null\n }\n ],\n \"disableSBS\": \"\",\n \"flowTwoFactorEnabled\": \"\",\n \"flowExpirationDate\": \"\",\n \"documentFileName\": \"\",\n \"senderKey\": {\n \"key\": \"\",\n \"type\": null\n },\n \"users\": [\n {\n \"userIndex\": \"\",\n \"title\": \"\",\n \"fixedSignerKey\": {\n \"key\": \"\",\n \"type\": null\n },\n \"signerType\": 0,\n \"isDisableAttachment\": \"\",\n \"isSuspended\": \"\",\n \"isNoDecline\": \"\",\n \"minimumSignatures\": \"\",\n \"forceApprovalOnSignature\": \"\"\n },\n {\n \"userIndex\": \"\",\n \"title\": \"\",\n \"fixedSignerKey\": {\n \"key\": \"\",\n \"type\": null\n },\n \"signerType\": 2,\n \"isDisableAttachment\": \"\",\n \"isSuspended\": \"\",\n \"isNoDecline\": \"\",\n \"minimumSignatures\": \"\",\n \"forceApprovalOnSignature\": \"\"\n }\n ],\n \"base64DocumentFile\": \"\",\n \"anonymousTemplateLink\": \"\"\n}"}],"_postman_id":"d2e319dc-f41c-4247-b1c1-1e2988c71f8d"},{"name":"/ex/template/:templateId","id":"a93f0e33-b7e6-4d00-96fb-c7f0e2fd3714","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"templateName\": \"\",\n \"flowElements\": [\n {\n \"elementType\": null,\n \"pageNumber\": \"\",\n \"position\": {\n \"height\": \"\",\n \"left\": \"\",\n \"top\": \"\",\n \"width\": \"\"\n },\n \"elementSubType\": null,\n \"textValue\": \"\",\n \"textSize\": \"\",\n \"textFont\": \"\",\n \"elementLabel\": \"\",\n \"elementHelp\": \"\",\n \"valueName\": \"\",\n \"horizontalAlignment\": 0,\n \"isRequired\": \"\",\n \"validations\": [\n {\n \"regex\": \"\",\n \"errorCode\": null\n },\n {\n \"regex\": \"\",\n \"errorCode\": null\n }\n ],\n \"dateTimeValidation\": {\n \"dateTimeFormat\": \"\",\n \"isCurrentDateTime\": \"\",\n \"minimumDate\": \"\",\n \"maximumDate\": \"\"\n },\n \"dropDownList\": [\n {\n \"values\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"values\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ],\n \"additionalInfo\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ],\n \"duplicateElementInfo\": {\n \"isAllPagesFromCurrent\": \"\",\n \"pageRange\": \"\"\n },\n \"displayValueInFlowDecription\": \"\",\n \"zIndex\": \"\",\n \"userIndex\": \"\"\n },\n {\n \"elementType\": null,\n \"pageNumber\": \"\",\n \"position\": {\n \"height\": \"\",\n \"left\": \"\",\n \"top\": \"\",\n \"width\": \"\"\n },\n \"elementSubType\": null,\n \"textValue\": \"\",\n \"textSize\": \"\",\n \"textFont\": \"\",\n \"elementLabel\": \"\",\n \"elementHelp\": \"\",\n \"valueName\": \"\",\n \"horizontalAlignment\": 0,\n \"isRequired\": \"\",\n \"validations\": [\n {\n \"regex\": \"\",\n \"errorCode\": null\n },\n {\n \"regex\": \"\",\n \"errorCode\": null\n }\n ],\n \"dateTimeValidation\": {\n \"dateTimeFormat\": \"\",\n \"isCurrentDateTime\": \"\",\n \"minimumDate\": \"\",\n \"maximumDate\": \"\"\n },\n \"dropDownList\": [\n {\n \"values\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"values\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ],\n \"additionalInfo\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ],\n \"duplicateElementInfo\": {\n \"isAllPagesFromCurrent\": \"\",\n \"pageRange\": \"\"\n },\n \"displayValueInFlowDecription\": \"\",\n \"zIndex\": \"\",\n \"userIndex\": \"\"\n }\n ],\n \"users\": [\n {\n \"userIndex\": \"\",\n \"title\": \"\",\n \"fixedSignerKey\": {\n \"key\": \"\",\n \"type\": null\n },\n \"signerType\": 1,\n \"isDisableAttachment\": \"\",\n \"isSuspended\": \"\",\n \"isNoDecline\": \"\",\n \"minimumSignatures\": \"\",\n \"forceApprovalOnSignature\": \"\"\n },\n {\n \"userIndex\": \"\",\n \"title\": \"

filed	type	description
* TemplateName	String	The name of the template
FlowElements	ExTemplatFlowElement[]	All the elements of the template
Users	ExTemplateUser[]	The users of the template
SendMethodType	SendMethodType	Distribution method of the template
TemplateType	Nullable<TemplateType>	The type of the template : Standard=0,AnonymousEnable=1,AnonymousDisable=2
CaptchaDisabled	Boolean	Disable/Enable captcha (only in anonymous template)
PreliminaryText	String	Preliminary text of the flow - that will be created from this template (display only in side by side mode)
SignFlowDescriptionMessage	String	Description of the document in the email
IsAutomaticRemainder	Boolean	Enable/Disable send automatic remainder
DayesForAutomaticRemainder	Int32	Number of the days for getting automatic remainder
IsSendApprovalMailToAllSigners	Boolean	Enable/Disable send email to all signers (when the flow approved)
Recipients	ParticipantKey<ParticipantKeyType>[]	All the CC users of the flow (that will be created from this template)
DisableSBS	Boolean	Disable/Enable dispaly side by side mode in the flow (that will be created from this template)
FlowTwoFactorEnabled	Nullable<Boolean>	Enable/Disable Two Factor on the flow (that will created from this template)
FlowExpirationDate	Nullable<DateTime>	Expiration date of the flow (that will created from this template)

value	description
0	Standard
1	AnonymousEnable
2	AnonymousDisable

filed	type	description
UserIndex	Int32	The order of signer in the template
Title	String	The title of the singer
FixedSignerKey	ParticipantKey<ParticipantKeyType>	The id of the fixed signer
SignerType	Nullable<SignerType>	The type of the user
IsDisableAttachment	Nullable<Boolean>	Disabled/Enabled add attachments to the flow (that will be created from the template)
IsSuspended	Boolean	Set status flow to suspended (that will be created from the template)
IsNoDecline	Boolean	Disable/Endable Decline the flow (that will be created from the template)
MinimumSignatures	Nullable<Int32>
ForceApprovalOnSignature	Boolean

value	description
0	Changeable
1	Static
2	Anonymous

filed	type	description
UserIndex	Int32	The order of the user in the template
* ElementType	ElementType	Type of element
ElementSubType	ElementSubType	Type of subject element
* PageNumber	Int32	The page number of the element
* Position	ElementPosition	Position of the element on the page
TextValue	String(200)	The text of the element
TextSize	Int32	The size of the text element
TextFont	String	The font of the text element
ElementLabel	String	The label of the element
ElementHelp	String	Information about the element (helps to know more about the element)
ValueName	String	The value name of element (only on radio-button/checkbox elemets)
HorizontalAlignment	Nullable<ExHorizontalAlignment>	Alignment the text of the element: Right=0,Center=1,Left=2
IsRequired	Nullable<Boolean>	Set required to element
Validations	ExValidation[]	Set validation to element
DateTimeValidation	ExDateTimeValidation	Set Date validation to element (only on Date element)
DropDownList	ExDropDownField[]	Values of drop list element
AdditionalInfo	KeyValuePair<String,String>[]	Add additional data to the element
DuplicateElementInfo	DuplicateElementInfo	Set element as duplicate (make the element to parent)
DisplayValueInFlowDecription	Boolean	Display/Not dispaly the value of element in the flow decription
IsDisableAttachment	Boolean
ZIndex	Nullable<Int32>	The order of the element on the page

filed	type	description
IsAllPagesFromCurrent	Boolean	Duplicate element at all pages
PageRange	String	Duplicate element on a specific page (for example : 1,5,8 - the element will duplicated on these pages)

filed	type	description
DateTimeFormat	String	Format of the date
IsCurrentDateTime	Boolean	Set the date to the current signing date
MinimumDate	Nullable<DateTime>	Minimum value of date
MaximumDate	Nullable<DateTime>	Maximum value of date

filed	type	description
Regex	String	The Regex on the value
ErrorCode	ElementValidationError	Errors of regex

value	description
4	Email
5	IdNumber
6	PhoneNumber
7	LicensePlate
8	PostalCode
10	MandatoryElements
11	smallChar
12	BigChar
13	SmallDate
14	BigDate
15	CreditCard
16	CwCredit
17	SmallNumber
18	BigNumber
19	RequiredElements

filed	type	description
* Top	Single	Position of the element related to top of the page (in points)
* Left	Single	Position of the element related to left of the page (in points)
* Width	Single	Width of the element (in points)
* Height	Single	Height of the element (in points)

value	description
0	Custom
1	FullName
2	FirstName
3	LastName
4	Email
5	IdentityNumber
6	PhoneNumber
7	License
8	PostalCode
9	EditorText
10	Initials

value	description
0	Sign
1	Text
2	Date
3	Erase
4	Highlight
5	Blackout
9	EditorText
10	Checkbox
11	Numeric
12	Radio
13	Dropdown
14	Attachment

filed	type	description
* Description	String	The description/name of the flow
* SenderKey	ParticipantKey<ParticipantKeyType>	Id of the Sender
CustomFields	KeyValuePair<String,String>[]	Add additional data in the flow
Users	ExUser[]	The changable users of the flow
Recipients	ExUser[]	All the CC users of the flow
IsNoSend	Boolean	Disable/Enable receive emails of the flow
ReadOnlyFields	ReadOnlyField[]	Elements with readonly value (the signer can't change the value)
PackageId	String	Id of the package (the flow will be assigned to package)
PackageName	String	Name of the package
SenderNotificationMailsToSend	NotificationMails[]	Types of emails notification (for the sender and CC)
IsAutomaticRemainder	Nullable<Boolean>	Enable/Disable send automatic remainder
DayesForAutomaticRemainder	Nullable<Int32>	Number of the days for getting automatic remainder
IsSendApprovalMailToAllSigners	Nullable<Boolean>	Enabled/Diabaled send email to all signers (when the flow approved)
PreliminaryText	String	Preliminary text of the flow (display only in side by side mode)
SignFlowDescriptionMessage	String	Description of the document in the email
DisableSBS	Nullable<Boolean>	Disable/Enable dispaly side by side mode in the flow
FlowTwoFactorEnabled	Nullable<Boolean>	Enable/Disable Two Factor on the flow
SignersIndexToRemove	Int32[]	The index of the signer to remove from the flow (The first index is one)
FlowExpirationDate	Nullable<DateTime>	Expiration date of the flow

filed	type	description
* ElementLabel	String	Label of element
Value	String	Value of element
TextSize	Int32	Size ot element text
TextFont	String	Font of element text

filed	type	description
* UserKey	ParticipantKey<ParticipantKeyType>	Id of user
Email	String(80)	Email of user
FirstName	String(30)	First name of user
LastName	String(30)	Last name of user
SmsPhoneNumber	String(80)	Phone Number of user (if empty, the user will not receive sms)
UserPassword	String	Password for opening the sign link
Company	String(80)	Company name of user
Title	String(80)	Title of user
UserPasswordDescription	LanguageKey[]	Display when the user open the linkfor example: \"Please enter your social security number\"LanguageKey is the message with all supported languages
IsDisableAttachment	Nullable<Boolean>	Disable/Enable add attachments to the flow
IsSuspended	Boolean	Set status flow to suspended
IsNoDecline	Boolean	Disable/Endable Decline the flow
NotificationMailsToSend	NotificationMails[]	Types of email notifications
Participant	Participant
MinimumSignatures	Nullable<Int32>	When the user have optional signature element - Dox validate the minimum signatures in the document
ForceApprovalOnSignature	Boolean

value	description
0	QueuedFlow
1	ParallelFlow

filed	type	description
Id	String	Id of parcicipant
Type	ParticipantType	Type of participant : User=0,Group=1

value	description
0	All
1	None
2	SignFlow
3	FlowApproved
4	FlowDeclined
5	FlowStart
6	ReminderToSignFlow
7	FlowStoppedToSender
8	FlowStoppedToSigner
9	KitCompleted
10	SignKit
11	ReminderToSignKit
12	KitCreated
13	FlowExpired

filed	type	description
Language	String	language : 'en-US','he-IL'
Value	String	Value of text

filed	type	description
* DocumentFileName	String	The name of the file
* SenderKey	ParticipantKey<ParticipantKeyType>	The Id of the sender
* Base64DocumentFile	String	The file as base 64
* TemplateName	String	The name of the template
FlowElements	ExTemplatFlowElement[]	All the elements of the template
Users	ExTemplateUser[]	The users of the template
SendMethodType	SendMethodType	Distribution method of the template
TemplateType	Nullable<TemplateType>	The type of the template : Standard=0,AnonymousEnable=1,AnonymousDisable=2
CaptchaDisabled	Boolean	Disable/Enable captcha (only in anonymous template)
PreliminaryText	String	Preliminary text of the flow - that will be created from this template (display only in side by side mode)
SignFlowDescriptionMessage	String	Description of the document in the email
IsAutomaticRemainder	Boolean	Enable/Disable send automatic remainder
DayesForAutomaticRemainder	Int32	Number of the days for getting automatic remainder
IsSendApprovalMailToAllSigners	Boolean	Enable/Disable send email to all signers (when the flow approved)
Recipients	ParticipantKey<ParticipantKeyType>[]	All the CC users of the flow (that will be created from this template)
DisableSBS	Boolean	Disable/Enable dispaly side by side mode in the flow (that will be created from this template)
FlowTwoFactorEnabled	Nullable<Boolean>	Enable/Disable Two Factor on the flow (that will created from this template)
FlowExpirationDate	Nullable<DateTime>	Expiration date of the flow (that will created from this template)

filed	type	description
* KitDescription	String	The name of the kit
* SenderKey	ParticipantKey<ParticipantKeyType>	Id of the Sender
* Signer	ExUser	Signer who is required to sign the flows included in the kit
SendingMethods	SendMethodTypes[]	Options to send the sign request to the signer (in case of null, the signer won't receive a request to sign)
IsUseCompanyNameInMessage	Boolean	Sending the request to sign by name of the company instead of the sender name
SignFlowDescriptionMessage	String	Additional information in the request to sign message
PreliminaryText	String	Additional information in the screen of all kit's flows
SignerNotificationMailsToSend	NotificationMails[]	Types of emails notification for the sender and CC
SenderNotificationMailsToSend	NotificationMails[]	Types of emails notification for the signer
Flows	String[]	Flows assigned to the kit

filed	type	description
File	IFormFile	file stream to add to flow
* UserAddedTheFile	ParticipantKey<ParticipantKeyType>

filed	type	description
* FlowAction	FlowExternalAction	FlowAction: StopFlow=0 ResendDeclinedFlow=1 SendReminder=2 ArchiveFlow=3
UserKey	ParticipantKey<ParticipantKeyType>	Required for action: StopFlow, ResendDeclinedFlow, ArchiveFlow
IsRecover	Nullable<Boolean>	Required for action ArchiveFlow
SignerKey	ParticipantKey<ParticipantKeyType>

value	description
0	StopFlow
1	ResendDeclinedFlow
2	SendReminder
3	ArchiveFlow
4	ReleaseFlow

filed	type	description
* SignerKey	ParticipantKey<ParticipantKeyType>
DeclineComments	String(4000)
signAction	SignAction
SignImageBase64	String
BrowserDetails	String
IPAddress	String
FlowElements	FlowElementData[]
AttachedFiles	IEnumerable<String>

filed	type	description
* ElementId	String Validation:'^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$'
TextData	String(4000)

Getting started

Login:

JSON object description:

webhookSubscriptionWebhookSubscription:

WebhookConsumer:

WebhookEvent:

UserEventFilter:

UserType:

KitEventFilter:

KitStatusType:

OpenFlowEventFilter:

SignerEventFilter:

SignStatus:

SignFlowEventFilter:

SignatureFlowStatus:

WebhookEventType:

JSON object description:

webhookSubscriptionWebhookSubscription:

WebhookConsumer:

WebhookEvent:

UserEventFilter:

UserType:

KitEventFilter:

KitStatusType:

OpenFlowEventFilter:

SignerEventFilter:

SignStatus:

SignFlowEventFilter:

SignatureFlowStatus:

WebhookEventType:

vrMeetingId(String):

signflowId(String):

vrMeetingId(String):

updateVRMeetingRequestUpdateVRMeetingRequest:

JSON object description:

getVRMeetingsRequestGetVRMeetingsRequest:

ParticipantKey`1:

Allow to locate Doxi user by:UserEmail=1UserPhone=2

ParticipantKeyType:

JSON object description:

createVRRoomRequestCreateVRMeetingRequest:

ParticipantKey`1:

Allow to locate Doxi user by:UserEmail=1UserPhone=2

ParticipantKeyType:

templateId(String):

exUpdateTemplateRequestExUpdateTemplateRequest:

TemplateType:

Types of templates

SendMethodType:

Distribution method of the flow

ExTemplateUser:

SignerType:

Types of signers

ParticipantKey`1:

Allow to locate Doxi user by:UserEmail=1UserPhone=2

ParticipantKeyType:

ExTemplatFlowElement:

DuplicateElementInfo:

ExDropDownField:

ExDropDownItem:

ExDateTimeValidation:

ExValidation:

ElementValidationError:

ExHorizontalAlignment:

ElementPosition:

ElementSubType:

Sub type of element

ElementType:

Types of Elements

templateId(String):

createFlowFromTemplateRequestCreateFlowFromTemplateRequest:

ReadOnlyField:

ExUser:

Participant:

ParticipantType:

NotificationMails[]:

LanguageKey:

ParticipantKey`1:

Allow to locate Doxi user by:UserEmail=1UserPhone=2

ParticipantKeyType:

filed	type	description
CustomFields	IEnumerable<KeyValuePair<String,String>>	Search flows be CustomFields property Key+Value
SignatureFlowStatus	Nullable<SignatureFlowStatus>	Search flow by Flow status
Signer	ParticipantKey<ParticipantKeyType>	Searche by the flow signer
Sender	ParticipantKey<ParticipantKeyType>	Search by the user that create the flow (sender)
FromDate	Nullable<DateTime>	Search by flow create date - from
ToDate	Nullable<DateTime>	Search by flow create date - to
Description	String	Search by flow description name

filed	type	description
CurrentSignerKey	ParticipantKey<ParticipantKeyType>
NewtSigner	ExUser
signFlowsId	String[]

filed	type	description
* File	IFormFile
* CreateFlowJsonRequest	ExCreateFlowRequestBase

filed	type	description
* DocumentFileName	String	The name of the document
* SenderKey	ParticipantKey<ParticipantKeyType>	Id of the Sender
* Description	String(100)	The description/name of the flow
* FlowElements	ExFlowElement[]	All the elements of the flow
SendMethodType	SendMethodType	Distribution method of the flow
Recipients	ExUser[]	All the CC users of the flow
IsSendApprovalMailToAllSigners	Boolean	Enabled/Diabaled send email to all signers (when the flow approved)
IsAutomaticRemainder	Boolean	Enabled/Disabled send automatic remainder
DayesForAutomaticRemainder	Int32	Number of the days for getting automatic remainder
SignFlowDescriptionMessage	String	Description of the document in the email
CustomFields	KeyValuePair<String,String>[]	Add additional data in the flow
* Users	ExUser[]	The changable users of the flow
PackageId	String	Id of the package (the flow will be in package)
PackageName	String	Name of the package
DisableSBS	Boolean	Disabled/Enabled dispaly side by side mode in the flow
PreliminaryText	String	Preliminary text of the flow (display only in side by side mode)
FlowTwoFactorEnabled	Nullable<Boolean>	Enabled/Disabled Two Factor on the flow
SenderNotificationMailsToSend	NotificationMails[]	Types of emails notification (for the sender and CC)
FlowExpirationDate	Nullable<DateTime>	Expiration date of the flow
SourceTemplateId	String

filed	type	description
SignerKey	ParticipantKey<ParticipantKeyType>	The Id of the signer
SignerIndex	Nullable<Int32>	The order of signer in the flow
* ElementType	ElementType	Type of element
ElementSubType	ElementSubType	Type of subject element
* PageNumber	Int32	The page number of the element
* Position	ElementPosition	Position of the element on the page
TextValue	String(200)	The text of the element
TextSize	Int32	The size of the text element
TextFont	String	The font of the text element
ElementLabel	String	The label of the element
ElementHelp	String	Information about the element (helps to know more about the element)
ValueName	String	The value name of element (only on radio-button/checkbox elemets)
HorizontalAlignment	Nullable<ExHorizontalAlignment>	Alignment the text of the element: Right=0,Center=1,Left=2
IsRequired	Nullable<Boolean>	Set required to element
Validations	ExValidation[]	Set validation to element
DateTimeValidation	ExDateTimeValidation	Set Date validation to element (only on Date element)
DropDownList	ExDropDownField[]	Values of drop list element
AdditionalInfo	KeyValuePair<String,String>[]	Add additional data to the element
DuplicateElementInfo	DuplicateElementInfo	Set element as duplicate (make the element to parent)
DisplayValueInFlowDecription	Boolean	Display/Not dispaly the value of element in the flow decription
IsDisableAttachment	Boolean
ZIndex	Nullable<Int32>	The order of the element on the page