Skip to main content
API docs by Redocly

dmss-process-and-auditing-service (1.2.7)

Download OpenAPI specification:Download

TrustLynx: info@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
compleatedAt
string <date-time>
totalSigners
integer <int32>
totalSigned
integer <int32>
Array of objects (ProcessStepSigner)
object (SigningProcessStep)

Responses

Request samples

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
          }
        ]
      }
    ],
  • "processInitiatorEmail": "string",
  • "documentId": "string",
  • "documentName": "string",
  • "initiator": "string",
  • "comment": "string",
  • "canceled": true,
  • "status": "PENDING",
  • "documentType": "string",
  • "ownerGroup": "string",
  • "compleatedAt": "2019-08-24T14:15:22Z",
  • "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
      }
    ],
  • "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
        }
      ]
    }
}

find

Request Body schema: application/json
required
documentId
string
personalCode
string

Responses

Request samples

Content type
application/json
{
  • "documentId": "string",
  • "personalCode": "string"
}

getAll

query Parameters
required
object (Pageable)
createdDateBefore
string <date>
createdDateAfter
string <date>
processStatus
string
nameSearch
string
emailSearch
string
personalCode
string
ownerGroup
string

Responses

create

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
compleatedAt
string <date-time>
totalSigners
integer <int32>
totalSigned
integer <int32>
Array of objects (ProcessStepSigner)
object (SigningProcessStep)

Responses

Request samples

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
          }
        ]
      }
    ],
  • "processInitiatorEmail": "string",
  • "documentId": "string",
  • "documentName": "string",
  • "initiator": "string",
  • "comment": "string",
  • "canceled": true,
  • "status": "PENDING",
  • "documentType": "string",
  • "ownerGroup": "string",
  • "compleatedAt": "2019-08-24T14:15:22Z",
  • "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
      }
    ],
  • "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
        }
      ]
    }
}

cancel

path Parameters
processId
required
string

Responses

getByStepSignerID

path Parameters
stepsignerId
required
string

Responses

authorize

path Parameters
signerId
required
string
personCode
required
string
country
required
string

Responses

getByDocument

path Parameters
documentId
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

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
      }
    ]
}

process-step-signer-controller

update_2

path Parameters
processSignerId
required
string
Request Body schema: application/json
required
id
string
signerName
string
signerCountry
string
signerPersonalCode
string
signerEmail
string
signerRole
string
Enum: "VIEWER" "SIGNER" "APPROVER"
signerComment
string
commentForSigner
string
signingStatus
string
Enum: "WAITING_FOR_PROCESS" "PROCESS_STARTED" "SIGNED" "CANCELED" "DECLINED" "APPROVED"
signerNotification
boolean

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "signerName": "string",
  • "signerCountry": "string",
  • "signerPersonalCode": "string",
  • "signerEmail": "string",
  • "signerRole": "VIEWER",
  • "signerComment": "string",
  • "commentForSigner": "string",
  • "signingStatus": "WAITING_FOR_PROCESS",
  • "signerNotification": true
}

getAll_1

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
page
integer <int32>

Responses

getMyDocuments

path Parameters
personCode
required
string
country
required
string

Responses

auditing-controller

create_1

Request Body schema: application/json
required
id
string
createdAt
string <date-time>
eventType
string
Enum: "VIEW" "CREATE" "SIGNATURE" "DECLINE" "APPROVE"
eventOrigin
string
creator
string
documentId
string
signerId
string
customerPersonalCode
string
note
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "eventType": "VIEW",
  • "eventOrigin": "string",
  • "creator": "string",
  • "documentId": "string",
  • "signerId": "string",
  • "customerPersonalCode": "string",
  • "note": "string"
}