Digital Sign Process

Create new digital sign process

Creates a new digital sign process according with its input data. The digital sign process unique identifier is returned.

POST /orgs/{org_id}/sign_process

Parameters

Name	In	Type	Required	Description
org_id	path	string	true	Organization name
body	body	CreateDigitalSignProcessRequest	true	Data about signers, documents to be signed and associated identification processes.

Request body - instance of CreateDigitalSignProcessRequest

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46


{
  "signers": [
    {
      "alias": "signer_1",
      "name": "James",
      "last_name": "Smith",
      "identity_document": {
        "document_number": "12345678A",
        "document_type": "NIF"
      },
      "email": "example@email.com",
      "msisdn": {
        "phone_number": 6123456789,
        "country_code": "34"
      },
      "language": "ES",
      "identification": {
        "two_factor_type": "EMAIL"
      }
    }
  ],
  "sign": {
    "type": "BIOMETRIC",
    "documents": [
      {
        "id": "0a394423-6f6d-4295-8ce7-c0bd70881836",
        "owner": "2357893",
        "sign_fields": [
          {
            "signer": "signer_1",
            "fields": [
              "SIGNATURE_CUSTOMER"
            ]
          }
        ]
      }
    ],
    "preview_documents": [
      "827d7367-8ff4-4748-970e-009680a87813"
    ]
  },
  "identification": {
    "type": "AGENT"
  },
  "expires_in": "P7D"
}

Name	Type	Required	Description
signers	[SignerData]	true	none
sign	DigitalSignRequest	true	none
identification	DigitalIdentificationRequest	true	none
expires_in	string	false	Minimum 15 minutes. Default to 30 days. Max 30 days. Validity duration time (ISO-8601 format) from now.

Request example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51



curl -X POST https://documents.masstack.com/v1/orgs/{org_id}/sign_process \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
 --data-raw "{
  'signers': [
    {
      'alias': 'signer_1',
      'name': 'James',
      'last_name': 'Smith',
      'identity_document': {
        'document_number': '12345678A',
        'document_type': 'NIF'
      },
      'email': 'example@email.com',
      'msisdn': {
        'phone_number': 6123456789,
        'country_code': '34'
      },
      'language': 'ES',
      'identification': {
        'two_factor_type': 'EMAIL'
      }
    }
  ],
  'sign': {
    'type': 'BIOMETRIC',
    'documents': [
      {
        'id': '0a394423-6f6d-4295-8ce7-c0bd70881836',
        'owner': '2357893',
        'sign_fields': [
          {
            'signer': 'signer_1',
            'fields': [
              'SIGNATURE_CUSTOMER'
            ]
          }
        ]
      }
    ],
    'preview_documents': [
      '827d7367-8ff4-4748-970e-009680a87813'
    ]
  },
  'identification': {
    'type': 'AGENT'
  },
  'expires_in': 'P7D'
}" 

Responses

Code	Meaning	Description	Schema
201	Created	New digital sign process is created. Expected response for a valid request.	CreateDigitalSignProcessResponse
400	Bad Request	Request input is not valid	None
401	Unauthorized	Unauthorized. AuthN and AuthZ validations have fail	None
500	Internal Server Error	Not expected error	None
default	Default	Error response	ErrorsResponse

Get digital sign process information

GET /orgs/{org_id}/sign_process/{sign_process_id}

Parameters

Name	In	Type	Required	Description
org_id	path	string	true	Organization name
sign_process_id	path	string	true	uuid that identifies a digital sign process

Request example

1
2
3
4



curl -X GET https://documents.masstack.com/v1/orgs/{org_id}/sign_process/{sign_process_id} \
  -H "Accept: application/json"

Responses

Code	Meaning	Description	Schema
200	OK	Expected response for a valid request.	GetDigitalSignProcessResponse
400	Bad Request	Request input is not valid	None
401	Unauthorized	Unauthorized. AuthN and AuthZ validations have fail	None
500	Internal Server Error	Not expected error	None
default	Default	Error response	ErrorsResponse

Cancel digital sign process

POST /orgs/{org_id}/sign_process/{sign_process_id}/cancel

Parameters

Name	In	Type	Required	Description
org_id	path	string	true	Organization name
sign_process_id	path	string	true	uuid that identifies a digital sign process
body	body	CancelDigitalSignProcessRequest	true	Necessary data to execute action

Request body - instance of CancelDigitalSignProcessRequest

1
2
3


{
  "reason": "string"
}

Name	Type	Required	Description
reason	string	true	reason for cancellation of the digital signature

Request example

1
2
3
4
5
6
7
8



curl -X POST https://documents.masstack.com/v1/orgs/{org_id}/sign_process/{sign_process_id}/cancel \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
 --data-raw "{
  'reason': 'string'
}" 

Responses

Code	Meaning	Description	Schema
204	No Content	Action executed correctly	None
400	Bad Request	Request input is not valid	None
401	Unauthorized	Unauthorized. AuthN and AuthZ validations have fail	None
409	Conflict	process is not in a cancelable state	None
500	Internal Server Error	Not expected error	None
default	Default	Error response	ErrorsResponse