process-and-auditing-service (24.3.22)

Download OpenAPI specification:Download

TrustLynx: sales@trustlynx.com URL: https://trustlynx.com

process-controller

get

path Parameters

processId

required

string

Responses

update

path Parameters

processId

required

string

Request Body schema: application/json
required

id	string
createdAt	string <date-time>
	Array of objects (SigningProcessStep)
processInitiatorEmail	string
documentId	string
documentName	string
initiator	string
comment	string
canceled	boolean
status	string Enum: "PENDING" "STARTED" "COMPLETED" "CANCELED" "DECLINED"
documentType	string
ownerGroup	string
completedAt	string <date-time>
initiatorName	string
totalSigners	integer <int32>
totalSigned	integer <int32>
	Array of objects (ProcessStepSigner)
	object (SigningProcessStep)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"signingProcessSteps": [{"id": "string",
"processOrder": 0,
"stepStatus": "WAITING_FOR_PREVIOUS",
"dueDate": "2019-08-24T14:15:22Z",
"processStepSigners": [{"id": "string",
"signerName": "string",
"signerCountry": "string",
"signerPersonalCode": "string",
"signerEmail": "string",
"signerRole": "VIEWER",
"signerComment": "string",
"commentForSigner": "string",
"signingStatus": "WAITING_FOR_PROCESS",
"signerNotification": true,
"signerLanguage": "string",
"anonymous": true
}
]
}
],
"processInitiatorEmail": "string",
"documentId": "string",
"documentName": "string",
"initiator": "string",
"comment": "string",
"canceled": true,
"status": "PENDING",
"documentType": "string",
"ownerGroup": "string",
"completedAt": "2019-08-24T14:15:22Z",
"initiatorName": "string",
"totalSigners": 0,
"totalSigned": 0,
"signers": [{"id": "string",
"signerName": "string",
"signerCountry": "string",
"signerPersonalCode": "string",
"signerEmail": "string",
"signerRole": "VIEWER",
"signerComment": "string",
"commentForSigner": "string",
"signingStatus": "WAITING_FOR_PROCESS",
"signerNotification": true,
"signerLanguage": "string",
"anonymous": true
}
],
"currentInProgressStep": {"id": "string",
"processOrder": 0,
"stepStatus": "WAITING_FOR_PREVIOUS",
"dueDate": "2019-08-24T14:15:22Z",
"processStepSigners": [{"id": "string",
"signerName": "string",
"signerCountry": "string",
"signerPersonalCode": "string",
"signerEmail": "string",
"signerRole": "VIEWER",
"signerComment": "string",
"commentForSigner": "string",
"signingStatus": "WAITING_FOR_PROCESS",
"signerNotification": true,
"signerLanguage": "string",
"anonymous": true
}
]
}
}

find

Request Body schema: application/json
required

documentId	string
personalCode	string

Responses

Request samples

Payload

Content type

application/json

{"documentId": "string",
"personalCode": "string"
}

getAll_2

query Parameters

required	object (Pageable)
createdDateBefore	string <date>
createdDateAfter	string <date>
processStatus	string
nameSearch	string
emailSearch	string
personalCode	string
ownerGroup	string
docType	string
isAdmin	boolean

Responses

create_1

Request Body schema: application/json
required

id	string
createdAt	string <date-time>
	Array of objects (SigningProcessStep)
processInitiatorEmail	string
documentId	string
documentName	string
initiator	string
comment	string
canceled	boolean
status	string Enum: "PENDING" "STARTED" "COMPLETED" "CANCELED" "DECLINED"
documentType	string
ownerGroup	string
completedAt	string <date-time>
initiatorName	string
totalSigners	integer <int32>
totalSigned	integer <int32>
	Array of objects (ProcessStepSigner)
	object (SigningProcessStep)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"signingProcessSteps": [{"id": "string",
"processOrder": 0,
"stepStatus": "WAITING_FOR_PREVIOUS",
"dueDate": "2019-08-24T14:15:22Z",
"processStepSigners": [{"id": "string",
"signerName": "string",
"signerCountry": "string",
"signerPersonalCode": "string",
"signerEmail": "string",
"signerRole": "VIEWER",
"signerComment": "string",
"commentForSigner": "string",
"signingStatus": "WAITING_FOR_PROCESS",
"signerNotification": true,
"signerLanguage": "string",
"anonymous": true
}
]
}
],
"processInitiatorEmail": "string",
"documentId": "string",
"documentName": "string",
"initiator": "string",
"comment": "string",
"canceled": true,
"status": "PENDING",
"documentType": "string",
"ownerGroup": "string",
"completedAt": "2019-08-24T14:15:22Z",
"initiatorName": "string",
"totalSigners": 0,
"totalSigned": 0,
"signers": [{"id": "string",
"signerName": "string",
"signerCountry": "string",
"signerPersonalCode": "string",
"signerEmail": "string",
"signerRole": "VIEWER",
"signerComment": "string",
"commentForSigner": "string",
"signingStatus": "WAITING_FOR_PROCESS",
"signerNotification": true,
"signerLanguage": "string",
"anonymous": true
}
],
"currentInProgressStep": {"id": "string",
"processOrder": 0,
"stepStatus": "WAITING_FOR_PREVIOUS",
"dueDate": "2019-08-24T14:15:22Z",
"processStepSigners": [{"id": "string",
"signerName": "string",
"signerCountry": "string",
"signerPersonalCode": "string",
"signerEmail": "string",
"signerRole": "VIEWER",
"signerComment": "string",
"commentForSigner": "string",
"signingStatus": "WAITING_FOR_PROCESS",
"signerNotification": true,
"signerLanguage": "string",
"anonymous": true
}
]
}
}

cancel

path Parameters

processId

required

string

Responses

cancel_1

path Parameters

processId required	string
disableMessages required	boolean

Responses

getByStepSignerID

path Parameters

stepsignerId

required

string

Responses

authorize

path Parameters

signerId required	string
personCode required	string
country required	string

Responses

authorize_1

path Parameters

signerId required	string
personCode required	string
country required	string

Responses

getByDocument

path Parameters

documentId

required

string

Responses

getAll_1

query Parameters

required	object (Pageable)
createdDateBefore	string <date>
createdDateAfter	string <date>
processStatus	string
nameSearch	string
emailSearch	string
personalCode	string
ownerGroup	string
docType	string
isAdmin	boolean

Responses

delete_1

path Parameters

processId

required

string

Responses

process-step-controller

update_1

path Parameters

processStepId

required

string

Request Body schema: application/json
required

id	string
processOrder	integer <int32>
stepStatus	string Enum: "WAITING_FOR_PREVIOUS" "STARTED" "CANCELED" "COMPLETED"
dueDate	string <date-time>
	Array of objects (ProcessStepSigner)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"processOrder": 0,
"stepStatus": "WAITING_FOR_PREVIOUS",
"dueDate": "2019-08-24T14:15:22Z",
"processStepSigners": [{"id": "string",
"signerName": "string",
"signerCountry": "string",
"signerPersonalCode": "string",
"signerEmail": "string",
"signerRole": "VIEWER",
"signerComment": "string",
"commentForSigner": "string",
"signingStatus": "WAITING_FOR_PROCESS",
"signerNotification": true,
"signerLanguage": "string",
"anonymous": true
}
]
}

document-profile-controller

get_1

path Parameters

id

required

string

Responses

update_2

path Parameters

id

required

string

Request Body schema: application/json
required

name	string
documentType	string
ownerGroup	string
	Array of objects (DocumentAttribute)
seal	string
isSealRequired	boolean
profileorder	integer <int32>

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"documentType": "string",
"ownerGroup": "string",
"attributes": [{"id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"type": "string",
"name": "string",
"required": true
}
],
"seal": "string",
"isSealRequired": true,
"profileorder": 0
}

delete_2

path Parameters

id

required

string

Responses

getAll_3

query Parameters

group

string

Responses

create_2

Request Body schema: application/json
required

name	string
documentType	string
ownerGroup	string
	Array of objects (DocumentAttribute)
seal	string
isSealRequired	boolean
profileorder	integer <int32>

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"documentType": "string",
"ownerGroup": "string",
"attributes": [{"id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"type": "string",
"name": "string",
"required": true
}
],
"seal": "string",
"isSealRequired": true,
"profileorder": 0
}

getByName

query Parameters

name

required

string

Responses

document-attribute-controller

get_2

path Parameters

id

required

string

Responses

update_3

path Parameters

id

required

string

Request Body schema: application/json
required

id	string
createdAt	string <date-time>
type	string
name	string
required	boolean

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"type": "string",
"name": "string",
"required": true
}

delete_3

path Parameters

id

required

string

Responses

getAll_4

Responses

create_3

Request Body schema: application/json
required

id	string
createdAt	string <date-time>
type	string
name	string
required	boolean

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"type": "string",
"name": "string",
"required": true
}

contacts-controller

getAll_6

query Parameters

owner required	string
group required	string
required	object (Pageable)
name	string
email	string
personalCode	string
scope	Array of strings Items Enum: "PERSONAL" "GROUP" "GLOBAL" "ALL"

Responses

update_4

query Parameters

user required	string
group required	string

Request Body schema: application/json
required

id	string
createdAt	string <date-time>
name	string
country	string
personalCode	string
phone	string
email	string
role	string Enum: "VIEWER" "SIGNER" "APPROVER" "INITIATOR" "ADMINISTRATOR"
defaultAnonymous	boolean
owner	string
scope	string Enum: "PERSONAL" "GROUP" "GLOBAL" "ALL"
group	string
language	string

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"name": "string",
"country": "string",
"personalCode": "string",
"phone": "string",
"email": "string",
"role": "VIEWER",
"defaultAnonymous": true,
"owner": "string",
"scope": "PERSONAL",
"group": "string",
"language": "string"
}

create_5

Request Body schema: application/json
required

id	string
createdAt	string <date-time>
name	string
country	string
personalCode	string
phone	string
email	string
role	string Enum: "VIEWER" "SIGNER" "APPROVER" "INITIATOR" "ADMINISTRATOR"
defaultAnonymous	boolean
owner	string
scope	string Enum: "PERSONAL" "GROUP" "GLOBAL" "ALL"
group	string
language	string

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"name": "string",
"country": "string",
"personalCode": "string",
"phone": "string",
"email": "string",
"role": "VIEWER",
"defaultAnonymous": true,
"owner": "string",
"scope": "PERSONAL",
"group": "string",
"language": "string"
}

getAll_5

query Parameters

owner required	string
group required	string
required	object (Pageable)
name	string
email	string
personalCode	string
scope	Array of strings Items Enum: "PERSONAL" "GROUP" "GLOBAL" "ALL"

Responses

create_4

Request Body schema: application/json
required

id	string
createdAt	string <date-time>
name	string
country	string
personalCode	string
phone	string
email	string
role	string Enum: "VIEWER" "SIGNER" "APPROVER" "INITIATOR" "ADMINISTRATOR"
defaultAnonymous	boolean
owner	string
scope	string Enum: "PERSONAL" "GROUP" "GLOBAL" "ALL"
group	string
language	string

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"name": "string",
"country": "string",
"personalCode": "string",
"phone": "string",
"email": "string",
"role": "VIEWER",
"defaultAnonymous": true,
"owner": "string",
"scope": "PERSONAL",
"group": "string",
"language": "string"
}

delete_4

path Parameters

contactId

required

string

query Parameters

user required	string
group required	string

Responses

templates-controller

getMany_1

query Parameters

owner required	string
group required	string
required	object (Pageable)
name	string
scope	Array of strings Items Enum: "PERSONAL" "GROUP" "GLOBAL" "ALL"

Responses

create

Request Body schema: application/json
required

id	string
createdAt	string <date-time>
name	string
data	string
owner	string
scope	string Enum: "PERSONAL" "GROUP" "GLOBAL" "ALL"
group	string

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"name": "string",
"data": "string",
"owner": "string",
"scope": "PERSONAL",
"group": "string"
}

getMany

query Parameters

owner required	string
group required	string
required	object (Pageable)
name	string
scope	Array of strings Items Enum: "PERSONAL" "GROUP" "GLOBAL" "ALL"

Responses

delete

path Parameters

templateId

required

string

query Parameters

user required	string
group required	string

Responses

message-controller

sendReminders

Responses

sendTestEmail

path Parameters

eventType

required

string

Enum: "PROCESS_STARTED" "PROCESS_CANCELED" "PROCESS_COMPLETED" "PROCESS_UPDATED" "PROCESS_DELETED" "PROCESS_OPENED" "PROCESS_GETALL" "PROCESS_GETONE" "DOCUMENT_CREATE" "DOCUMENT_INFO" "DOCUMENT_DOWNLOAD" "DOCUMENT_DELETE" "DOCUMENT_CREATE_OR_UPDATE" "DOCUMENT_ADDVERSION" "DOCUMENT_UPDATE" "SIGNATURE" "DECLINE" "APPROVE" "TASK_STARTED" "SIGNER_DECLINED" "APPROVER_DECLINED" "SIGNER_SIGNED" "APPROVER_APPROVED" "REMINDER" "FAILURE" "AUDIT_LOGIN_START" "AUDIT_LOGIN_COMPLETED" "AUDIT_LOGIN_FAULT" "AUDIT_EMAIL_REMINDER" "AUTH_COMPLETED" "AUTH_START"

query Parameters

role

required

string

Enum: "VIEWER" "SIGNER" "APPROVER" "INITIATOR" "ADMINISTRATOR"

Request Body schema: application/json
required

id	string
createdAt	string <date-time>
	Array of objects (SigningProcessStep)
processInitiatorEmail	string
documentId	string
documentName	string
initiator	string
comment	string
canceled	boolean
status	string Enum: "PENDING" "STARTED" "COMPLETED" "CANCELED" "DECLINED"
documentType	string
ownerGroup	string
completedAt	string <date-time>
initiatorName	string
totalSigners	integer <int32>
totalSigned	integer <int32>
	Array of objects (ProcessStepSigner)
	object (SigningProcessStep)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"signingProcessSteps": [{"id": "string",
"processOrder": 0,
"stepStatus": "WAITING_FOR_PREVIOUS",
"dueDate": "2019-08-24T14:15:22Z",
"processStepSigners": [{"id": "string",
"signerName": "string",
"signerCountry": "string",
"signerPersonalCode": "string",
"signerEmail": "string",
"signerRole": "VIEWER",
"signerComment": "string",
"commentForSigner": "string",
"signingStatus": "WAITING_FOR_PROCESS",
"signerNotification": true,
"signerLanguage": "string",
"anonymous": true
}
]
}
],
"processInitiatorEmail": "string",
"documentId": "string",
"documentName": "string",
"initiator": "string",
"comment": "string",
"canceled": true,
"status": "PENDING",
"documentType": "string",
"ownerGroup": "string",
"completedAt": "2019-08-24T14:15:22Z",
"initiatorName": "string",
"totalSigners": 0,
"totalSigned": 0,
"signers": [{"id": "string",
"signerName": "string",
"signerCountry": "string",
"signerPersonalCode": "string",
"signerEmail": "string",
"signerRole": "VIEWER",
"signerComment": "string",
"commentForSigner": "string",
"signingStatus": "WAITING_FOR_PROCESS",
"signerNotification": true,
"signerLanguage": "string",
"anonymous": true
}
],
"currentInProgressStep": {"id": "string",
"processOrder": 0,
"stepStatus": "WAITING_FOR_PREVIOUS",
"dueDate": "2019-08-24T14:15:22Z",
"processStepSigners": [{"id": "string",
"signerName": "string",
"signerCountry": "string",
"signerPersonalCode": "string",
"signerEmail": "string",
"signerRole": "VIEWER",
"signerComment": "string",
"commentForSigner": "string",
"signingStatus": "WAITING_FOR_PROCESS",
"signerNotification": true,
"signerLanguage": "string",
"anonymous": true
}
]
}
}

auditing-controller

create_6

Request Body schema: application/json
required

id	string
createdAt	string <date-time>
eventType	string Enum: "PROCESS_STARTED" "PROCESS_CANCELED" "PROCESS_COMPLETED" "PROCESS_UPDATED" "PROCESS_DELETED" "PROCESS_OPENED" "PROCESS_GETALL" "PROCESS_GETONE" "DOCUMENT_CREATE" "DOCUMENT_INFO" "DOCUMENT_DOWNLOAD" "DOCUMENT_DELETE" "DOCUMENT_CREATE_OR_UPDATE" "DOCUMENT_ADDVERSION" "DOCUMENT_UPDATE" "SIGNATURE" "DECLINE" "APPROVE" "TASK_STARTED" "SIGNER_DECLINED" "APPROVER_DECLINED" "SIGNER_SIGNED" "APPROVER_APPROVED" "REMINDER" "FAILURE" "AUDIT_LOGIN_START" "AUDIT_LOGIN_COMPLETED" "AUDIT_LOGIN_FAULT" "AUDIT_EMAIL_REMINDER" "AUTH_COMPLETED" "AUTH_START"
eventOrigin	string
creator	string
documentId	string
signerId	string
customerPersonalCode	string
note	string
processId	string
ipAddress	string
containerId	string
method	string
clientAppName	string

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"eventType": "PROCESS_STARTED",
"eventOrigin": "string",
"creator": "string",
"documentId": "string",
"signerId": "string",
"customerPersonalCode": "string",
"note": "string",
"processId": "string",
"ipAddress": "string",
"containerId": "string",
"method": "string",
"clientAppName": "string"
}

process-step-signer-controller

getAll

query Parameters

personalCode required	string
country required	string
signerId required	string
createdDateBefore	string <date>
createdDateAfter	string <date>
processStatus	string
nameSearch	string
size	integer <int32>
sort	string
nonExpired	boolean
page	integer <int32>

Responses

sendSignerEmeail

path Parameters

processSignerId

required

string

Responses

getMySteps

path Parameters

personCode required	string
country required	string

Responses

getMyDocuments

path Parameters

personCode required	string
country required	string

process-and-auditing-service (24.3.22)

process-controller

get

path Parameters

Responses

update

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

find

Request Body schema: application/jsonrequired

Responses

Request samples

getAll_2

query Parameters

Responses

create_1

Request Body schema: application/jsonrequired

Responses

Request samples

cancel

path Parameters

Responses

cancel_1

path Parameters

Responses

getByStepSignerID

path Parameters

Responses

authorize

path Parameters

Responses

authorize_1

path Parameters

Responses

getByDocument

path Parameters

Responses

getAll_1

query Parameters

Responses

delete_1

path Parameters

Responses

process-step-controller

update_1

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

document-profile-controller

get_1

path Parameters

Responses

update_2

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

delete_2

path Parameters

Responses

getAll_3

query Parameters

Responses

create_2

Request Body schema: application/jsonrequired

Responses

Request samples

getByName

query Parameters

Responses

document-attribute-controller

get_2

path Parameters

Responses

update_3

path Parameters

Request Body schema: application/jsonrequired

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required