masstack

V1
API Overview Resources Schemas

Sign Configuration

Sign Configuration

Parameters

Name In Type Required Description
org_id path string true Organization name

Request example

1
2
3
4


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

Responses

Code Meaning Description Schema
200 OK Sign configuration of given tenant. SignConfiguration
400 Bad Request Request input is not valid None
401 Unauthorized Unauthorized. AuthN and AuthZ validations have fail or certificate password is not correct None
500 Internal Server Error Not expected error None
default Default Error response ErrorsResponse

Parameters

Name In Type Required Description
org_id path string true Organization name
body body object true Data about sign configuration

Request body - Content-Type: multipart/form-data

Custom schema example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

landing_url: www.masmovil.com
expiration_duration: P7D
channels:
  - SMS
  - EMAIL
  - WHATSAPP
content: string
sign_certificate_password: Passw0rd
notification_email: example@email.com
Name Type Required Description
landing_url string true Sign process URL
expiration_duration string true Validity duration time (ISO-8601 format) of any sign process for the tenant.
channels array true Channels to send notifications. Possible values: SMS, EMAIL, or WHATSAPP.
content string true The PKCS#12 (.p12) certificate file
sign_certificate_password string true Password for the PKCS#12 certificate
notification_email string true Email where the notifications about certificate expiration will be sent

Request example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11


curl -X POST https://documents.masstack.com/v1/orgs/{org_id}/sign_process/configurations \
  -H "Content-Type: multipart/form-data" \
  -H "Accept: application/json" \
  -F "landing_url=www.masmovil.com" \
  -F "expiration_duration=P7D" \
  -F "channels=SMS,EMAIL,WHATSAPP" \
  -F "content=undefined" \
  -F "sign_certificate_password=Passw0rd" \
  -F "notification_email=example@email.com" \

Responses

Code Meaning Description Schema
204 No Content New sign configuration is created. None
400 Bad Request Request input is not valid None
401 Unauthorized Unauthorized. AuthN and AuthZ validations have fail or certificate password is not correct None
500 Internal Server Error Not expected error None
default Default Error response ErrorsResponse

Parameters

Name In Type Required Description
org_id path string true Organization name
body body ConfigurationPatchRequest true Data about sign configuration 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

{
  "landing_url": "www.masmovil.com",
  "expiration_duration": "P7D",
  "channels": [
    "SMS",
    "EMAIL",
    "WHATSAPP"
  ],
  "content": "string",
  "sign_certificate_password": "Passw0rd",
  "notification_email": "example@email.com"
}
Name Type Required Description
landing_url LandingUrl false Sign process URL
expiration_duration ExpirationDuration false Validity duration time (ISO-8601 format) of any sign process for the tenant.
channels NotificationChannels false Channels to send notifications. Possible values: SMS, EMAIL, or WHATSAPP.
content SignCertificateContent false The PKCS#12 (.p12) certificate file
sign_certificate_password SignCertificatePassword false Password for the PKCS#12 certificate
notification_email NotificationEmail false Email where the notifications about certificate expiration will be sent

Request example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17


curl -X PATCH https://documents.masstack.com/v1/orgs/{org_id}/sign_process/configurations \
  -H "Content-Type: multipart/mixed" \
  -H "Accept: application/json" \
 --data-raw "{
  'landing_url': 'www.masmovil.com',
  'expiration_duration': 'P7D',
  'channels': [
    'SMS',
    'EMAIL',
    'WHATSAPP'
  ],
  'content': 'string',
  'sign_certificate_password': 'Passw0rd',
  'notification_email': 'example@email.com'
}"

Responses

Code Meaning Description Schema
204 No Content Sign configuration is created. None
400 Bad Request Request input is not valid None
401 Unauthorized Unauthorized. AuthN and AuthZ validations have fail or certificate password is not correct None
500 Internal Server Error Not expected error None
default Default Error response ErrorsResponse

Endpoints

Documents

    Forms

      Sections

        Templates

          Templates Configuration

            Digital Sign Process

              Biometric Signature

                Simple Signature

                  Identification Agent

                    Sign Configuration

                      Identification OTP

                        Identification Agent Admin

                          Identification OTP Admin

                            Contracts

                              Scoring

                                Securize