API Overview Resources Schemas

Schemas

ErrorsResponse

 1
 2
 3
 4
 5
 6
 7
 8
 9
10


{
  "errors": [
    {
      "code": "MDOC-XXX",
      "title": "ERROR_TYPE",
      "ref": "https://developers.masstack.com/en/docs/apis_documents_doc_swagger/1/schemas/#schemaerror",
      "details": "Detailed description of the error"
    }
  ]
}

Name	Type	Required	Description
errors	Errors	false	List of errors

Errors

1
2
3
4
5
6
7
8


[
  {
    "code": "MDOC-XXX",
    "title": "ERROR_TYPE",
    "ref": "https://developers.masstack.com/en/docs/apis_documents_doc_swagger/1/schemas/#schemaerror",
    "details": "Detailed description of the error"
  }
]

Name	Type	Required	Description
anonymous	[Error]	false	List of errors

Error

1
2
3
4
5
6


{
  "code": "MDOC-XXX",
  "title": "ERROR_TYPE",
  "ref": "https://developers.masstack.com/en/docs/apis_documents_doc_swagger/1/schemas/#schemaerror",
  "details": "Detailed description of the error"
}

Name	Type	Required	Description
code	string	true	Error codes: * MDOC_000 * MDOC_001 * MDOC_002 * MDOC_003 * MDOC_004 * MDOC_005 * MDOC_006
title	string	true	Error titles: * `PARAMETER_ERROR` * `INTERNAL_SERVER_ERROR` * `INVALID_INPUT` * `UNAUTHORIZED` * `RESOURCE_NOT_FOUND` * `RESOURCE_IS_NO_LONGER_AVAILABLE` * `CONFLICT` * `UNPROCESSABLE_ENTITY`
ref	string	true	Url of the error details in Developer portal
details	string	true	Message and details of the error

DocExtension

1

"pdf"

Name	Type	Required	Description
anonymous	string	false	Format of the document to be stored. It must match the format of the binary Allowed values: pdf, jpeg, jpg, png

DocTag

1

"DRAFT"

Name	Type	Required	Description
anonymous	string	false	Free values (user-defined) to tag document. These values are normalized following the next rules: - All tags will be converted to lowercase - All whitespaces will be removed - Empty or blank tags are not allowed - Tags matching reserved words (null, undefined or nan) are not allowed

PostDocumentResponse

1
2
3


{
  "documentId": "d290f1ee-6c54-4b01-90e6-d701748f0851"
}

Name	Type	Required	Description
documentId	string(uuid)	true	Document unique identifier

CreatePublicUrlRequest

1
2
3
4


{
  "expiresIn": "PT24H",
  "downloadDisposition": "inline"
}

Name	Type	Required	Description
expiresIn	string	false	Default to 24 hours. Max 24 hours. Validity duration time (ISO-8601 format) of the public url from now.
downloadDisposition	string	false	Controls the disposition of the content (if the PDF is rendered inline or downloaded). Allowed values “attachment” or “inline”.

Property	Values
downloadDisposition	one of [attachment, inline]

CreatePublicUrlResponse

1
2
3
4
5
6


{
  "expirationDate": "2023-01-27T03:44:52.000Z",
  "publicUrl": "https://storage.googleapis.com/mas-documents-prod/cbd2e693-d71a-4cee-8313-1972acc0394d",
  "mediaType": "application/pdf",
  "name": "my_doc_name"
}

Name	Type	Required	Description
expirationDate	string	true	Timestamp (ISO-8601 format) at which public url becomes inaccesible.
publicUrl	string	true	Signed url fully accessible without authentication or authorization.
mediaType	string	false	Binary media type of the downloadable document
name	string	true	Name of the downloadable document

ChangeOwnerRequest

1
2
3


{
  "newOwner": "sUbScRiPtiOn_12123112a"
}

Name	Type	Required	Description
newOwner	string	false	The identifier of the new owner of the document

ChangeOwnerResponse

1
2
3


{
  "owner": "subscription_12123112a"
}

Name	Type	Required	Description
owner	string	true	The normalized identifier of the new owner of the document

TagsList

1
2
3
4
5


[
  "Draft",
  "Top_Secret",
  "v1.0"
]

Name	Type	Required	Description
anonymous	[DocTag]	false	Free values (user-defined) to tag document. These values are normalized following the next rules: - All tags will be converted to lowercase - All whitespaces will be removed - Empty or blank tags are not allowed - Tags matching reserved words (null, undefined or nan) are not allowed

GetDocumentMetadataResponse

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13


{
  "documentId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "name": "personal_contract",
  "tags": [
    "Draft",
    "Top_Secret",
    "v1.0"
  ],
  "extension": "pdf",
  "archiveHash": "938c2cc0dcc05f2b68c4287040cfcf71",
  "size": 400000000,
  "isPublic": true
}

Name	Type	Required	Description
documentId	string(uuid)	true	Document unique identifier
name	string	true	Name of the document (without spaces). The document is renamed with this value.
tags	TagsList	true	Free values (user-defined) to tag document. These values are normalized following the next rules: - All tags will be converted to lowercase - All whitespaces will be removed - Empty or blank tags are not allowed - Tags matching reserved words (null, undefined or nan) are not allowed
extension	DocExtension	true	Format of the document to be stored. It must match the format of the binary Allowed values: pdf, jpeg, jpg, png
archiveHash	string	true	Document hash digest
size	integer	true	The size of the document in bytes.
isPublic	boolean	true	Indicates if document is public (without owner) or private (with owner defined)

DeleteDocumentResponse

1
2
3
4


{
  "deletedDocumentId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "deleteTS": "2023-04-20T11:43:13Z"
}

Name	Type	Required	Description
deletedDocumentId	string(uuid)	true	deleted document unique identifier
deleteTS	string(date-time)	true	instant when document was deleted by first time

Extension

1

"pdf"

Name	Type	Required	Description
anonymous	string	false	Format of the form to be stored. It must match the format of the binary Allowed values: pdf

Languages

1
2
3
4
5
6
7
8


[
  "ES",
  "EU",
  "EN",
  "DE",
  "GL",
  "CA"
]

Name	Type	Required	Description
anonymous	[Language]	false	list of available languages for the template

Language

1

"ES"

Name	Type	Required	Description
anonymous	string	false	Templates languages allowed Allowed values: ES, EN, EU, GL, CA, DE, UNDEFINED

ConfigurationChangelog

1

"TEXT"

Name	Type	Required	Description
anonymous	string	false	Description of the template change in this version

Fields

1
2
3


[
  "NAME"
]

Name	Type	Required	Description
anonymous	[Field]	false	list all fields available to fill in all the sections that belongs to the template

Field

1

"NAME"

Name	Type	Required	Description
anonymous	string	false	It’s field’s name in a form

FormFields

1
2
3
4
5
6


[
  {
    "key": "NAME",
    "type": "FILLABLE"
  }
]

Name	Type	Required	Description
anonymous	[FormField]	false	list all fields types

FormField

1
2
3
4


{
  "key": "NAME",
  "type": "FILLABLE"
}

Name	Type	Required	Description
type	string	true	Name of the field
key	string	true	Type of the field

Name	Type	Required	Description
anonymous	[Tag]	false	Five free values (user-defined) to tag form. These values are normalized following the next rules: - All tags will be converted to uppercase - All whitespaces will be removed - Empty or blank tags are not allowed - Tags matching reserved words (null, undefined or nan) are not allowed

Tag

1

"DRAFT"

Name	Type	Required	Description
anonymous	string	false	Free values (user-defined) to tag document. These values are normalized following the next rules: - All tags will be converted to lowercase - All whitespaces will be removed - Empty or blank tags are not allowed - Tags matching reserved words (null, undefined or nan) are not allowed

Forms

1
2
3
4
5
6


[
  {
    "language": "ES",
    "formExternalId": "contract_gdpr_en"
  }
]

Name	Type	Required	Description
anonymous	[Form]	false	defines which form is defined to each language

Form

1
2
3
4


{
  "language": "ES",
  "formExternalId": "contract_gdpr_en"
}

Name	Type	Required	Description
language	Language	true	Templates languages allowed Allowed values: ES, EN, EU, GL, CA, DE, UNDEFINED
formExternalId	string	true	Form name (normalized)

Conditions

1
2
3
4


[
  "GDPR:YES",
  "PREVIEW:ALLOW"
]

Name	Type	Required	Description
anonymous	[Condition]	false	list of conditions which trigger specific sections of the template to be filled

Condition

1

"GDPR:YES"

Name	Type	Required	Description
anonymous	string	false	Tuple FLAG:VALUE (flag and expected value) that will evaluated to know if this section have to be filled

Rules

1
2
3
4
5
6


[
  {
    "sectionExternalId": "contract_gdpr",
    "condition": "GDPR:YES"
  }
]

Name	Type	Required	Description
anonymous	[Rule]	false	defines conditions rules that have to be matched in fill flags values, to allow this section to be filled

Rule

1
2
3
4


{
  "sectionExternalId": "contract_gdpr",
  "condition": "GDPR:YES"
}

Name	Type	Required	Description
sectionExternalId	string	true	Section external Id (section name normalized)
condition	Condition	true	Tuple FLAG:VALUE (flag and expected value) that will evaluated to know if this section have to be filled

FillMode

1

"default"

Name	Type	Required	Description
anonymous	string	false	Allowed values: ‘default’, ‘raw’ Describes character’s filter process to execute when fill a form/template: - ‘default’ (also when no value or unrecognized value): all non alfa-numeric characters are escaped and replaced by ‘?' - ‘raw’: like ‘default’ but ‘tabulation’ and ‘end of line’ characters are allowed

Flatten

1

true

Name	Type	Required	Description
anonymous	boolean	false	Describes if the filled template will be flattened or not.

FormFieldResponses

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


[
  {
    "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "externalId": "contract_gdpr_es",
    "fields": [
      {
        "key": "NAME",
        "type": "FILLABLE"
      }
    ],
    "tags": [
      "DRAFT"
    ],
    "creationDate": "2022-08-21T17:32:28Z"
  }
]

Name	Type	Required	Description
anonymous	[FormFieldResponse]	false	none

FormFieldResponse

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


{
  "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "externalId": "contract_gdpr_es",
  "fields": [
    {
      "key": "NAME",
      "type": "FILLABLE"
    }
  ],
  "tags": [
    "DRAFT"
  ],
  "creationDate": "2022-08-21T17:32:28Z"
}

Name	Type	Required	Description
id	string(uuid)	true	form unique identifier
externalId	string	true	form name normalized
fields	FormFields	true	list all fields types
tags	Tags	false	Five free values (user-defined) to tag form. These values are normalized following the next rules: - All tags will be converted to uppercase - All whitespaces will be removed - Empty or blank tags are not allowed - Tags matching reserved words (null, undefined or nan) are not allowed
creationDate	string(date-time)	true	date of creation of the form

CreateSectionRequest

1
2
3
4
5
6
7
8
9


{
  "sectionName": "contract_gdpr",
  "forms": [
    {
      "language": "ES",
      "formExternalId": "contract_gdpr_en"
    }
  ]
}

Name	Type	Required	Description
sectionName	string	true	name of section of forms (will be normalized on section external Id)
forms	Forms	true	defines which form is defined to each language

SectionMetadatas

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


[
  {
    "externalId": "anexo_gdpr",
    "forms": [
      {
        "language": "ES",
        "formExternalId": "contract_gdpr_en"
      }
    ],
    "fields": [
      {
        "key": "NAME",
        "type": "FILLABLE"
      }
    ],
    "creationDate": "2022-08-21T17:32:28Z"
  }
]

Name	Type	Required	Description
anonymous	[SectionMetadata]	false	List of sections metadata

SectionMetadata

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


{
  "externalId": "anexo_gdpr",
  "forms": [
    {
      "language": "ES",
      "formExternalId": "contract_gdpr_en"
    }
  ],
  "fields": [
    {
      "key": "NAME",
      "type": "FILLABLE"
    }
  ],
  "creationDate": "2022-08-21T17:32:28Z"
}

Name	Type	Required	Description
externalId	string	true	normalized name of section (external id)
forms	Forms	true	defines which form is defined to each language
fields	FormFields	true	list all fields types
creationDate	string(date-time)	true	none

CreateTemplateRequest

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


{
  "templateName": "convergentes",
  "defaultLanguage": "ES",
  "orderedSectionNames": [
    "introduction",
    "personal_data",
    "anexo_gdpr"
  ],
  "rules": [
    {
      "sectionExternalId": "contract_gdpr",
      "condition": "GDPR:YES"
    }
  ]
}

Name	Type	Required	Description
templateName	string	true	name of template of sections (will be normalized on template external Id)
defaultLanguage	Language	true	Templates languages allowed Allowed values: ES, EN, EU, GL, CA, DE, UNDEFINED
orderedSectionNames	OrderedSectionNames	true	list sections external Ids that belongs to the template IN THE ORDER in which they should be concatenated when filled
rules	Rules	false	defines conditions rules that have to be matched in fill flags values, to allow this section to be filled

UpgradeTemplateRequest

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


{
  "defaultLanguage": "ES",
  "orderedSectionNames": [
    "introduction",
    "personal_data",
    "anexo_gdpr"
  ],
  "rules": [
    {
      "sectionExternalId": "contract_gdpr",
      "condition": "GDPR:YES"
    }
  ],
  "changelog": "Added new GDPR descriptive text and formatting changes to the contract."
}

Name	Type	Required	Description
defaultLanguage	Language	true	Templates languages allowed Allowed values: ES, EN, EU, GL, CA, DE, UNDEFINED
orderedSectionNames	OrderedSectionNames	true	list sections external Ids that belongs to the template IN THE ORDER in which they should be concatenated when filled
rules	Rules	false	defines conditions rules that have to be matched in fill flags values, to allow this section to be filled
changelog	string	false	none

UpdateTemplateRequest

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


{
  "defaultLanguage": "ES",
  "orderedSectionNames": [
    "introduction",
    "personal_data",
    "anexo_gdpr"
  ],
  "rules": [
    {
      "sectionExternalId": "contract_gdpr",
      "condition": "GDPR:YES"
    }
  ],
  "changelog": "Template change reason description."
}

Name	Type	Required	Description
defaultLanguage	Language	false	Templates languages allowed Allowed values: ES, EN, EU, GL, CA, DE, UNDEFINED
orderedSectionNames	OrderedSectionNames	false	list sections external Ids that belongs to the template IN THE ORDER in which they should be concatenated when filled
rules	Rules	false	defines conditions rules that have to be matched in fill flags values, to allow this section to be filled
changelog	string	false	none

UpdateTemplateResponse

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23


{
  "externalId": "contrato_convergente",
  "languages": [
    "ES",
    "EU",
    "EN",
    "DE",
    "GL",
    "CA"
  ],
  "defaultLanguage": "ES",
  "fields": [
    {
      "key": "NAME",
      "type": "FILLABLE"
    }
  ],
  "conditions": [
    "GDPR:YES",
    "PREVIEW:ALLOW"
  ],
  "version": "1"
}

Name	Type	Required	Description
externalId	string	true	normalized name of template (external id)
languages	Languages	true	list of available languages for the template
defaultLanguage	Language	true	Templates languages allowed Allowed values: ES, EN, EU, GL, CA, DE, UNDEFINED
fields	FormFields	true	list all fields types
conditions	Conditions	false	list of conditions which trigger specific sections of the template to be filled
version	string	true	Higher version of the template

FieldsValues

1
2
3
4
5
6


[
  {
    "name": "string",
    "value": "string"
  }
]

Name	Type	Required	Description
anonymous	[FillFieldsValues]	false	form variables whose values will be printed in the filled form

FillFieldsValues

1
2
3
4


{
  "name": "string",
  "value": "string"
}

Name	Type	Required	Description
name	string	true	Form field name
value	string	true	Form field value

FillTemplateRequest

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


{
  "language": "ES",
  "flagsConditions": [
    "GDPR:YES",
    "PREVIEW:ALLOW"
  ],
  "fieldsValues": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "fillMode": "default"
}

Name	Type	Required	Description
language	Language	true	Templates languages allowed Allowed values: ES, EN, EU, GL, CA, DE, UNDEFINED
flagsConditions	Conditions	false	list of conditions which trigger specific sections of the template to be filled
fieldsValues	FieldsValues	true	form variables whose values will be printed in the filled form
fillMode	FillMode	false	Allowed values: ‘default’, ‘raw’ Describes character’s filter process to execute when fill a form/template: - ‘default’ (also when no value or unrecognized value): all non alfa-numeric characters are escaped and replaced by ‘?' - ‘raw’: like ‘default’ but ‘tabulation’ and ‘end of line’ characters are allowed

Page

1

0

Name	Type	Required	Description
anonymous	integer	false	Forms page to be shown

PageSize

1

50

Name	Type	Required	Description
anonymous	integer	false	Number of forms that will be shown by page

AllFormsResponse

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


{
  "totalResults": "100",
  "currentPage": 0,
  "forms": [
    {
      "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
      "externalId": "contract_gdpr_es",
      "fields": [
        {
          "key": "NAME",
          "type": "FILLABLE"
        }
      ],
      "tags": [
        "DRAFT"
      ],
      "creationDate": "2022-08-21T17:32:28Z"
    }
  ]
}

Name	Type	Required	Description
totalResults	integer	true	Number of total forms to get
currentPage	integer	true	Current page
forms	FormFieldResponses	true	none

AllSectionsResponse

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22


{
  "totalResults": "100",
  "currentPage": 0,
  "sections": [
    {
      "externalId": "anexo_gdpr",
      "forms": [
        {
          "language": "ES",
          "formExternalId": "contract_gdpr_en"
        }
      ],
      "fields": [
        {
          "key": "NAME",
          "type": "FILLABLE"
        }
      ],
      "creationDate": "2022-08-21T17:32:28Z"
    }
  ]
}

Name	Type	Required	Description
totalResults	integer	true	Number of total sections to get
currentPage	integer	true	Current page
sections	SectionMetadatas	true	List of sections metadata

AllTemplatesResponse

 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


{
  "totalResults": "100",
  "currentPage": 0,
  "templates": [
    {
      "externalId": "contrato_convergente",
      "version": "1.0",
      "defaultLanguage": "ES",
      "languages": [
        "ES",
        "EU",
        "EN",
        "DE",
        "GL",
        "CA"
      ],
      "orderedSectionNames": [
        "introduction",
        "personal_data",
        "anexo_gdpr"
      ],
      "fields": [
        {
          "key": "NAME",
          "type": "FILLABLE"
        }
      ],
      "rules": [
        {
          "sectionExternalId": "contract_gdpr",
          "condition": "GDPR:YES"
        }
      ],
      "creationDate": "2022-08-21T17:32:28Z"
    }
  ]
}

Name	Type	Required	Description
totalResults	integer	true	Number of total templates to get
currentPage	integer	true	Current page
templates	TemplateMetadataList	true	List of templates metadatas

TemplateMetadataResponse

 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


{
  "templates": [
    {
      "externalId": "contrato_convergente",
      "version": "1.0",
      "defaultLanguage": "ES",
      "languages": [
        "ES",
        "EU",
        "EN",
        "DE",
        "GL",
        "CA"
      ],
      "orderedSectionNames": [
        "introduction",
        "personal_data",
        "anexo_gdpr"
      ],
      "fields": [
        {
          "key": "NAME",
          "type": "FILLABLE"
        }
      ],
      "rules": [
        {
          "sectionExternalId": "contract_gdpr",
          "condition": "GDPR:YES"
        }
      ],
      "creationDate": "2022-08-21T17:32:28Z"
    }
  ]
}

Name	Type	Required	Description
templates	TemplateMetadataList	false	List of templates metadatas

TemplateMetadataList

 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


[
  {
    "externalId": "contrato_convergente",
    "version": "1.0",
    "defaultLanguage": "ES",
    "languages": [
      "ES",
      "EU",
      "EN",
      "DE",
      "GL",
      "CA"
    ],
    "orderedSectionNames": [
      "introduction",
      "personal_data",
      "anexo_gdpr"
    ],
    "fields": [
      {
        "key": "NAME",
        "type": "FILLABLE"
      }
    ],
    "rules": [
      {
        "sectionExternalId": "contract_gdpr",
        "condition": "GDPR:YES"
      }
    ],
    "creationDate": "2022-08-21T17:32:28Z"
  }
]

Name	Type	Required	Description
anonymous	[TemplateMetadata]	false	List of templates metadatas

TemplateMetadata

 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


{
  "externalId": "contrato_convergente",
  "version": "1.0",
  "defaultLanguage": "ES",
  "languages": [
    "ES",
    "EU",
    "EN",
    "DE",
    "GL",
    "CA"
  ],
  "orderedSectionNames": [
    "introduction",
    "personal_data",
    "anexo_gdpr"
  ],
  "fields": [
    {
      "key": "NAME",
      "type": "FILLABLE"
    }
  ],
  "rules": [
    {
      "sectionExternalId": "contract_gdpr",
      "condition": "GDPR:YES"
    }
  ],
  "creationDate": "2022-08-21T17:32:28Z"
}

Name	Type	Required	Description
externalId	string	true	normalized name of template (external id)
version	string	true	Higher version of the template
defaultLanguage	Language	true	Templates languages allowed Allowed values: ES, EN, EU, GL, CA, DE, UNDEFINED
languages	Languages	true	list of available languages for the template
orderedSectionNames	OrderedSectionNames	true	list sections external Ids that belongs to the template IN THE ORDER in which they should be concatenated when filled
fields	FormFields	true	list all fields types
rules	Rules	false	defines conditions rules that have to be matched in fill flags values, to allow this section to be filled
creationDate	string(date-time)	true	date when template was created

TemplateDocTag

1

"DRAFT"

Name	Type	Required	Description
anonymous	string	false	Free values (user-defined) to tag document. These values are normalized following the next rules: - All tags will be converted to lowercase - All whitespaces will be removed - Empty or blank tags are not allowed - Tags matching reserved words (null, undefined or nan) are not allowed

FillTemplateDocumentsResponse

1
2
3
4
5
6
7
8
9


{
  "documentId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "renamedKeys": [
    {
      "currentName": "SUBSCRIPTION_ID_212",
      "originalName": "SUBSCRIPTION_ID"
    }
  ]
}

Name	Type	Required	Description
documentId	string(uuid)	true	Document unique identifier
renamedKeys	RenamedTemplateKeys	true	List of template keys which name has changed from original template

RenamedTemplateKeys

1
2
3
4
5
6


[
  {
    "currentName": "SUBSCRIPTION_ID_212",
    "originalName": "SUBSCRIPTION_ID"
  }
]

Name	Type	Required	Description
anonymous	[RenamedTemplateKey]	false	List of template keys which name has changed from original template

RenamedTemplateKey

1
2
3
4


{
  "currentName": "SUBSCRIPTION_ID_212",
  "originalName": "SUBSCRIPTION_ID"
}

Name	Type	Required	Description
currentName	string	true	Current template key name
originalName	string	true	Original template key name

FillTemplateDocumentsRequest

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


{
  "language": "ES",
  "flagsConditions": [
    "GDPR:YES",
    "PREVIEW:ALLOW"
  ],
  "fieldsValues": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "name": "personal_contract",
  "tags": [
    "DRAFT"
  ],
  "fillMode": "default",
  "flatten": true
}

Name	Type	Required	Description
language	Language	true	Templates languages allowed Allowed values: ES, EN, EU, GL, CA, DE, UNDEFINED
flagsConditions	Conditions	false	list of conditions which trigger specific sections of the template to be filled
fieldsValues	FieldsValues	true	form variables whose values will be printed in the filled form
name	string	false	Name of the document (without spaces). The document is renamed with this value.
tags	Tags	false	Five free values (user-defined) to tag form. These values are normalized following the next rules: - All tags will be converted to uppercase - All whitespaces will be removed - Empty or blank tags are not allowed - Tags matching reserved words (null, undefined or nan) are not allowed
fillMode	FillMode	false	Allowed values: ‘default’, ‘raw’ Describes character’s filter process to execute when fill a form/template: - ‘default’ (also when no value or unrecognized value): all non alfa-numeric characters are escaped and replaced by ‘?' - ‘raw’: like ‘default’ but ‘tabulation’ and ‘end of line’ characters are allowed
flatten	Flatten	false	Describes if the filled template will be flattened or not.

FillFormRequest

1
2
3
4
5
6
7
8
9


{
  "fieldsValues": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "fillMode": "default"
}

Name	Type	Required	Description
fieldsValues	FieldsValues	true	form variables whose values will be printed in the filled form
fillMode	FillMode	false	Allowed values: ‘default’, ‘raw’ Describes character’s filter process to execute when fill a form/template: - ‘default’ (also when no value or unrecognized value): all non alfa-numeric characters are escaped and replaced by ‘?' - ‘raw’: like ‘default’ but ‘tabulation’ and ‘end of line’ characters are allowed

ChangelogHistory

1
2
3
4
5
6
7
8


[
  {
    "fromVersion": "1.0",
    "toVersion": "1.1",
    "onDate": "2022-08-21T17:32:28Z",
    "changelog": "Added new GDPR descriptive text and formatting changes to the contract."
  }
]

Name	Type	Required	Description
anonymous	[TemplateChangelog]	false	list of all template’s version changes with its changelog and date

TemplateChangelog

1
2
3
4
5
6


{
  "fromVersion": "1.0",
  "toVersion": "1.1",
  "onDate": "2022-08-21T17:32:28Z",
  "changelog": "Added new GDPR descriptive text and formatting changes to the contract."
}

Name	Type	Required	Description
fromVersion	string	true	Initial version before template change
toVersion	string	true	Final version after template change
onDate	string(date-time)	true	date when template was changed
changelog	string	true	change log defined by user when template changes

TemplateChangelogHistoryResponse

 1
 2
 3
 4
 5
 6
 7
 8
 9
10


{
  "changelogHistory": [
    {
      "fromVersion": "1.0",
      "toVersion": "1.1",
      "onDate": "2022-08-21T17:32:28Z",
      "changelog": "Added new GDPR descriptive text and formatting changes to the contract."
    }
  ]
}

Name	Type	Required	Description
changelogHistory	ChangelogHistory	true	list of all template’s version changes with its changelog and date

GetAllTenantConfigurationsResponse

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11


{
  "totalResults": "100",
  "currentPage": 0,
  "configurations": [
    {
      "version": 1,
      "changelog": "TEXT",
      "creationDate": "2022-08-21T17:32:28Z"
    }
  ]
}

Name	Type	Required	Description
totalResults	integer	true	Number of total forms to get
currentPage	integer	true	Current page
configurations	Configurations	true	List of forms metadata

GetTenantConfigurationResponse

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


{
  "defaultLanguage": "ES",
  "fieldValues": [
    {
      "name": "CONFIG_TENANT.SOCIAL_REASON",
      "type": "TEXT",
      "value": [
        {
          "language": "ES",
          "content": "Avenida de Bruselas 38, Alcobendas, Madrid"
        }
      ]
    }
  ]
}

Name	Type	Required	Description
defaultLanguage	Language	true	Templates languages allowed Allowed values: ES, EN, EU, GL, CA, DE, UNDEFINED
fieldValues	ConfigurationFieldValues	true	Configuration fields with default values by language

CreateOrUpdateTemplateConfigurationRequest

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


{
  "changelog": "TEXT",
  "defaultLanguage": "ES",
  "fieldValues": [
    {
      "name": "CONFIG_TENANT.SOCIAL_REASON",
      "type": "TEXT",
      "value": [
        {
          "language": "ES",
          "content": "Avenida de Bruselas 38, Alcobendas, Madrid"
        }
      ]
    }
  ]
}

Name	Type	Required	Description
changelog	ConfigurationChangelog	false	Description of the template change in this version
defaultLanguage	Language	true	Templates languages allowed Allowed values: ES, EN, EU, GL, CA, DE, UNDEFINED
fieldValues	ConfigurationFieldValues	true	Configuration fields with default values by language

Configurations

1
2
3
4
5
6
7


[
  {
    "version": 1,
    "changelog": "TEXT",
    "creationDate": "2022-08-21T17:32:28Z"
  }
]

Name	Type	Required	Description
anonymous	[ConfigurationMetadata]	false	List of forms metadata

ConfigurationMetadata

1
2
3
4
5


{
  "version": 1,
  "changelog": "TEXT",
  "creationDate": "2022-08-21T17:32:28Z"
}

Name	Type	Required	Description
version	integer	true	Defines template configuration version (initial version is ‘1’)
changelog	ConfigurationChangelog	true	Description of the template change in this version
creationDate	string(date-time)	true	date when template was created

ConfigurationFieldValues

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12


[
  {
    "name": "CONFIG_TENANT.SOCIAL_REASON",
    "type": "TEXT",
    "value": [
      {
        "language": "ES",
        "content": "Avenida de Bruselas 38, Alcobendas, Madrid"
      }
    ]
  }
]

Name	Type	Required	Description
anonymous	[ConfigurationFieldValue]	false	Configuration fields with default values by language

ConfigurationFieldValue

 1
 2
 3
 4
 5
 6
 7
 8
 9
10


{
  "name": "CONFIG_TENANT.SOCIAL_REASON",
  "type": "TEXT",
  "value": [
    {
      "language": "ES",
      "content": "Avenida de Bruselas 38, Alcobendas, Madrid"
    }
  ]
}

Name	Type	Required	Description
name	string	true	Configuration field name. Must start with prefix: CONFIG_TENANT.
type	string	true	Configuration field type. Allowed values: IMAGE and TEXT
value	ConfigurationFieldValueByLanguages	true	Configuration field value by language

OrderedSectionNames

1
2
3
4
5


[
  "introduction",
  "personal_data",
  "anexo_gdpr"
]

None

ConfigurationFieldValueByLanguages

1
2
3
4
5
6


[
  {
    "language": "ES",
    "content": "Avenida de Bruselas 38, Alcobendas, Madrid"
  }
]

Name	Type	Required	Description
anonymous	[ConfigurationFieldValueByLanguage]	false	Configuration field value by language

ConfigurationFieldValueByLanguage

1
2
3
4


{
  "language": "ES",
  "content": "Avenida de Bruselas 38, Alcobendas, Madrid"
}

Name	Type	Required	Description
language	Language	true	Templates languages allowed Allowed values: ES, EN, EU, GL, CA, DE, UNDEFINED
content	string	true	Configuration field value. It is dependent from field ‘type’: - ‘IMAGE’: then value must be a valid documentId (UUID) - ‘TEXT’: then value must be a text (string)

CreateOrUpdateTemplateConfigurationResponse

1
2
3


{
  "version": 1
}

Name	Type	Required	Description
version	integer	true	Defines template configuration version (initial version is ‘1’)

ConfigurationDocumentExtension

1

"pdf"

Name	Type	Required	Description
anonymous	string	false	Format of the document to be stored. It must match the format of the binary Allowed values: jpeg, jpg, png

CreateConfigurationDocumentResponse

1
2
3


{
  "id": "d290f1ee-6c54-4b01-90e6-d701748f0851"
}

Name	Type	Required	Description
id	string(uuid)	true	Templates document unique identifier

ConfigurationDocument

1
2
3
4
5
6


{
  "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "name": "new_logo_mm",
  "extension": "png",
  "creationDate": "2022-08-21T17:32:28Z"
}

Name	Type	Required	Description
id	string(uuid)	true	Templates document unique identifier.
name	string	true	Name of the document.
extension	string	true	Format of the document.
creationDate	string(date-time)	true	Creation date of the document.

ConfigurationDocuments

1
2
3
4
5
6
7
8


[
  {
    "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "name": "new_logo_mm",
    "extension": "png",
    "creationDate": "2022-08-21T17:32:28Z"
  }
]

Name	Type	Required	Description
anonymous	[ConfigurationDocument]	false	List of configuration documents

GetAllConfigurationDocumentsResponse

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12


{
  "totalResults": "100",
  "currentPage": 0,
  "items": [
    {
      "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
      "name": "new_logo_mm",
      "extension": "png",
      "creationDate": "2022-08-21T17:32:28Z"
    }
  ]
}

Name	Type	Required	Description
totalResults	integer	true	Number of total forms to get
currentPage	integer	true	Current page
items	ConfigurationDocuments	true	List of configuration documents

CreateDigitalSignProcessResponse

1
2
3


{
  "id": "7902cd2d-80f4-4766-a3e9-a1760e0df9bd"
}

Name	Type	Required	Description
id	string	true	uuid that identifies a digital sign process, referenced on the endpoints as sign_process_id

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.

CancelDigitalSignProcessRequest

1
2
3


{
  "reason": "string"
}

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

BiometricSignRequest

1
2
3
4


{
  "biometric_data": "string",
  "signature_image": "string"
}

Name	Type	Required	Description
biometric_data	string	true	biometric data extracted from the signatory’s handwritten signature. (Max allowed length 300kb)
signature_image	string	true	base64 encoded image of the signature. (Max allowed length 500kb)

GetDigitalSignProcessResponse

 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


{
  "signatures": [
    {
      "alias": "signer_1",
      "name": "James",
      "last_name": "Williams Smith",
      "language": "ES",
      "document_number": "12345678A",
      "sign": {
        "id": "0b9bbe95-f080-4317-b371-1f9ae0b9bf4f",
        "status": "CLOSED",
        "modification_date": "2023-04-21T17:32:28Z"
      },
      "identification": {
        "id": "b3041b0c-95fe-459c-8df3-bdea4a83233a",
        "type": "AGENT"
      }
    }
  ],
  "status": "CREATED",
  "sign_type": "BIOMETRIC",
  "modification_date": "2023-04-20T11:43:13Z",
  "creation_date": "2023-04-20T11:43:13Z",
  "certificate_id": "23f65996-95e6-4fac-b4c2-f8d93f162cc9"
}

Name	Type	Required	Description
signatures	[Signatures]	true	none
status	DigitalSignProcessStatus	true	Digital sign processes management. A digital sign process can be on one of the following statuses: - CREATED: New process has been created. - SIGNED: Process has been successfully finished. All signs have to be on SUCCEEDED status. See Signature signs. - FAILED: Process has failed. Signature is in an error state. See signature statuses. - CANCELLED: Process has been cancelled. A process cannot be cancelled if it is already in SIGNED, EXPIRED or FAILED status. - EXPIRED: Process has exceeded the maximum time waiting for signature - CERTIFIED: Signatures and identifications have been certified in a PDF document. Certificate_id has been associated with the process.
sign_type	DigitalSignType	true	Sign processes type: - SIMPLE: Simple Sign - BIOMETRIC: Biometric Sign
modification_date	string(date-time)	true	none
creation_date	string(date-time)	true	none
certificate_id	string	false	Document id of the sign process certificate

GetSignResponse

 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


{
  "signer": {
    "alias": "signer_1",
    "name": "James",
    "last_name": "Smith",
    "document_number": "25478547L",
    "language": "ES"
  },
  "preview_documents": [
    {
      "name": "Document_Name",
      "url": "https://storage.googleapis.com/mas-documents-prod/cbd2e693-d71a-4cee-8313-1972acc0394d"
    }
  ],
  "signable_documents": [
    {
      "name": "Document_Name",
      "url": "https://storage.googleapis.com/mas-documents-prod/cbd2e693-d71a-4cee-8313-1972acc0394d"
    }
  ],
  "signed_documents": [
    {
      "name": "Document_Name",
      "url": "https://storage.googleapis.com/mas-documents-prod/cbd2e693-d71a-4cee-8313-1972acc0394d"
    }
  ],
  "status": "CREATED",
  "identification": {
    "id": "b3041b0c-95fe-459c-8df3-bdea4a83233a",
    "type": "AGENT"
  },
  "modification_date": "2023-04-21T17:32:28Z",
  "creation_date": "2023-04-21T17:32:28Z"
}

Name	Type	Required	Description
signer	SignerPartial	true	none
preview_documents	DownloadableDocuments	false	Temporary signed URL fully accessible without authentication or authorisation, plus the document name, for the signed documents.
signable_documents	DownloadableDocuments	true	Temporary signed URL fully accessible without authentication or authorisation, plus the document name, for the signed documents.
signed_documents	DownloadableDocuments	false	Temporary signed URL fully accessible without authentication or authorisation, plus the document name, for the signed documents.
status	DigitalSignProcessStatus	true	Digital sign processes management. A digital sign process can be on one of the following statuses: - CREATED: New process has been created. - SIGNED: Process has been successfully finished. All signs have to be on SUCCEEDED status. See Signature signs. - FAILED: Process has failed. Signature is in an error state. See signature statuses. - CANCELLED: Process has been cancelled. A process cannot be cancelled if it is already in SIGNED, EXPIRED or FAILED status. - EXPIRED: Process has exceeded the maximum time waiting for signature - CERTIFIED: Signatures and identifications have been certified in a PDF document. Certificate_id has been associated with the process.
identification	SignIdentificationInfo	false	none
modification_date	string(date-time)	true	none
creation_date	string(date-time)	true	none

Signatures

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


{
  "alias": "signer_1",
  "name": "James",
  "last_name": "Williams Smith",
  "language": "ES",
  "document_number": "12345678A",
  "sign": {
    "id": "0b9bbe95-f080-4317-b371-1f9ae0b9bf4f",
    "status": "CLOSED",
    "modification_date": "2023-04-21T17:32:28Z"
  },
  "identification": {
    "id": "b3041b0c-95fe-459c-8df3-bdea4a83233a",
    "type": "AGENT"
  }
}

Name	Type	Required	Description
alias	string	true	alias has to be a unique value within the signing process and cannot overlap with other signers
name	string	true	none
last_name	string	true	none
language	language	true	Languages available to configure operation Not all values are available to all organizations. If language text it is not defined, a default language text will be provided (by default `ES`). Locale defined lists: * `ES` - Spanish language * `EN` - English language * `EU` - Basque language * `GL` - Galician language * `CA` - Catalan language * ‘UNDEFINED’ - Use default language
document_number	string	true	signer personal number that customers agent will use to identification
sign	SignatureInfo	true	none
identification	SignIdentificationInfo	false	none

SignerPartial

1
2
3
4
5
6
7


{
  "alias": "signer_1",
  "name": "James",
  "last_name": "Smith",
  "document_number": "25478547L",
  "language": "ES"
}

Name	Type	Required	Description
alias	string	true	none
name	string	true	none
last_name	string	true	none
document_number	string	true	none
language	language	true	Languages available to configure operation Not all values are available to all organizations. If language text it is not defined, a default language text will be provided (by default `ES`). Locale defined lists: * `ES` - Spanish language * `EN` - English language * `EU` - Basque language * `GL` - Galician language * `CA` - Catalan language * ‘UNDEFINED’ - Use default language

SignerData

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


{
  "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"
  }
}

Name	Type	Required	Description
alias	string	true	alias has to be a unique value within the signing process and cannot overlap with other signers
name	string	true	none
last_name	string	true	none
identity_document	object	true	none
» document_number	string	true	signer personal number that customers agent will use to identification
» document_type	string	true	type of the actor document number Allowed values: ‘NIF’, ‘NIE’, ‘PASSPORT’
email	string	true	none
msisdn	Msisdn	true	none
language	language	true	Languages available to configure operation Not all values are available to all organizations. If language text it is not defined, a default language text will be provided (by default `ES`). Locale defined lists: * `ES` - Spanish language * `EN` - English language * `EU` - Basque language * `GL` - Galician language * `CA` - Catalan language * ‘UNDEFINED’ - Use default language
identification	any	false	none

Name	Type	Required	Description
» anonymous	OtpIdentificationOptions	false	none

Name	Type	Required	Description
» anonymous	AgentIdentificationOptions	false	none

language

1

"ES"

Name	Type	Required	Description
anonymous	string	false	Languages available to configure operation Not all values are available to all organizations. If language text it is not defined, a default language text will be provided (by default `ES`). Locale defined lists: * `ES` - Spanish language * `EN` - English language * `EU` - Basque language * `GL` - Galician language * `CA` - Catalan language * ‘UNDEFINED’ - Use default language

Msisdn

1
2
3
4


{
  "phone_number": 6123456789,
  "country_code": "34"
}

Name	Type	Required	Description
phone_number	string	true	Phone number of the signatory that we will use to contact us
country_code	string	true	country code of the phone number. Numeric code ISO 3166-1

DocumentToSign

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12


{
  "id": "0a394423-6f6d-4295-8ce7-c0bd70881836",
  "owner": "2357893",
  "sign_fields": [
    {
      "signer": "signer_1",
      "fields": [
        "SIGNATURE_CUSTOMER"
      ]
    }
  ]
}

Name	Type	Required	Description
id	string	true	none
owner	string	true	The string id related with the document owner.
sign_fields	[FieldsBySigner]	true	none

FieldsBySigner

1
2
3
4
5
6


{
  "signer": "signer_1",
  "fields": [
    "SIGNATURE_CUSTOMER"
  ]
}

Name	Type	Required	Description
signer	string	true	none
fields	[string]	true	none

SignIdentificationInfo

1
2
3
4


{
  "id": "b3041b0c-95fe-459c-8df3-bdea4a83233a",
  "type": "AGENT"
}

Name	Type	Required	Description
id	string	true	identification process id of this signer
type	SignIdentificationType	true	Sign identification types: - OTP: Identification by One Time Password (online) - AGENT: Identification by a trusted agent (on-site)

DigitalIdentificationRequest

1
2
3


{
  "type": "AGENT"
}

Name	Type	Required	Description
type	SignIdentificationType	true	Sign identification types: - OTP: Identification by One Time Password (online) - AGENT: Identification by a trusted agent (on-site)

DigitalSignRequest

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


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

Name	Type	Required	Description
type	DigitalSignType	true	Sign processes type: - SIMPLE: Simple Sign - BIOMETRIC: Biometric Sign
documents	[DocumentToSign]	true	none
preview_documents	[string]	false	none

DownloadableDocuments

1
2
3
4
5
6


[
  {
    "name": "Document_Name",
    "url": "https://storage.googleapis.com/mas-documents-prod/cbd2e693-d71a-4cee-8313-1972acc0394d"
  }
]

Name	Type	Required	Description
name	string	true	none
url	string(uri)	true	Temporary signed URL fully accessible without authentication or authorisation.

SignatureInfo

1
2
3
4
5


{
  "id": "0b9bbe95-f080-4317-b371-1f9ae0b9bf4f",
  "status": "CLOSED",
  "modification_date": "2023-04-21T17:32:28Z"
}

Name	Type	Required	Description
id	string	true	none
status	SignStatus	true	A signature can be in one of the following statuses: - CREATED: Signature process has been started. - IDENTIFIED: Signers have been identified. - PREVIEWED: Documents have been previewed. (This status is OPTIONAL.) - SIGNED: Signature has been collected, but the process is pending due to the asynchronous document generation process (This status persists while there are other pending signatures). - SUCCEEDED: Signature has been stamped on the document. - FAILED: Contract signature has failed due to an error along the process.
modification_date	string(date-time)	true	none

SignStatus

1

"CLOSED"

Name	Type	Required	Description
anonymous	string	false	A signature can be in one of the following statuses: - CREATED: Signature process has been started. - IDENTIFIED: Signers have been identified. - PREVIEWED: Documents have been previewed. (This status is OPTIONAL.) - SIGNED: Signature has been collected, but the process is pending due to the asynchronous document generation process (This status persists while there are other pending signatures). - SUCCEEDED: Signature has been stamped on the document. - FAILED: Contract signature has failed due to an error along the process.

DigitalSignProcessStatus

1

"CREATED"

Name	Type	Required	Description
anonymous	string	false	Digital sign processes management. A digital sign process can be on one of the following statuses: - CREATED: New process has been created. - SIGNED: Process has been successfully finished. All signs have to be on SUCCEEDED status. See Signature signs. - FAILED: Process has failed. Signature is in an error state. See signature statuses. - CANCELLED: Process has been cancelled. A process cannot be cancelled if it is already in SIGNED, EXPIRED or FAILED status. - EXPIRED: Process has exceeded the maximum time waiting for signature - CERTIFIED: Signatures and identifications have been certified in a PDF document. Certificate_id has been associated with the process.

DigitalSignType

1

"BIOMETRIC"

Name	Type	Required	Description
anonymous	string	false	Sign processes type: - SIMPLE: Simple Sign - BIOMETRIC: Biometric Sign

SignIdentificationType

1

"AGENT"

Name	Type	Required	Description
anonymous	string	false	Sign identification types: - OTP: Identification by One Time Password (online) - AGENT: Identification by a trusted agent (on-site)

SecurizeSign

1
2
3


{
  "sign_process_id": "string"
}

Name	Type	Required	Description
sign_process_id	string	true	none

SecurizeSignResponse

1
2
3


{
  "web_component_token": "string"
}

Name	Type	Required	Description
web_component_token	string	true	none

TwoFactorType

1

"EMAIL"

Name	Type	Required	Description
anonymous	string	false	Two factor type to validate actor identity. Possible values: * `DOCUMENT_NUMBER`: value defined in actor’s document number field * `EMAIL`: value defined in actor’s email field * `PERSONAL_DOCUMENT_IMAGE`: Image of the document number (back and front) defined in actor’s document number field

OtpIdentificationOptions

1
2
3


{
  "two_factor_type": "EMAIL"
}

Name	Type	Required	Description
two_factor_type	TwoFactorType	true	Two factor type to validate actor identity. Possible values: * `DOCUMENT_NUMBER`: value defined in actor’s document number field * `EMAIL`: value defined in actor’s email field * `PERSONAL_DOCUMENT_IMAGE`: Image of the document number (back and front) defined in actor’s document number field

AgentIdentificationOptions

1
2
3


{
  "personal_document_image": true
}

Name	Type	Required	Description
personal_document_image	boolean	true	Flag to indicate if the agent needs to take a picture of the actor personal document. If true, the agent will take a picture of the document. If false, or null, the agent will not take a picture of the document.

ConfigurationPatchRequest

 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

SignConfiguration

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


{
  "landing_url": "www.masmovil.com",
  "expiration_duration": "P7D",
  "channels": [
    "SMS",
    "EMAIL",
    "WHATSAPP"
  ],
  "certificate": {
    "expiration_date": "2025-04-20T11:43:13Z",
    "common_name": "Mas_Orange_CA",
    "organization": "MasOrange",
    "organizational_unit": "MasOrangeCAUnit",
    "issuer": "Mas_Orange_Root_CA"
  },
  "notification_email": "example@email.com"
}

Name	Type	Required	Description
landing_url	string	false	Sign process url
expiration_duration	string	false	Validity duration time (ISO-8601 format) of any sign process for the tenant.
channels	[Channel]	false	Channels to send notifications. Possible values: SMS, EMAIL or WHATSAPP
certificate	SignCertificateMetadata	false	none
notification_email	NotificationEmail	false	Email where the notifications about certificate expiration will be sent

SignCertificateMetadata

1
2
3
4
5
6
7


{
  "expiration_date": "2025-04-20T11:43:13Z",
  "common_name": "Mas_Orange_CA",
  "organization": "MasOrange",
  "organizational_unit": "MasOrangeCAUnit",
  "issuer": "Mas_Orange_Root_CA"
}

Name	Type	Required	Description
expiration_date	string(date-time)	false	Date when certificate expires
common_name	string	false	The common name (CN) of the certificate subject. Typically represents the entity or domain name associated with the certificate.
organization	string	false	The organization (O) associated with the certificate. Usually represents the company or entity that owns the certificate.
organizational_unit	string	false	The organizational unit (OU) within the organization that is associated with the certificate. Often used to indicate a department or division.
issuer	string	false	The issuer of the certificate. This is the common name (CN) of the certificate authority (CA) that signed and issued the certificate.

CreateSignConfigurationRequest

 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	string	true	Sign process url
expiration_duration	string	true	Validity duration time (ISO-8601 format) of any sign process for the tenant.
channels	[Channel]	true	Channels to send notifications. Possible values: SMS, EMAIL or WHATSAPP
content	string(binary)	true	The PKCS#12 (.p12) certificate file
sign_certificate_password	SignCertificatePassword	true	Password for the PKCS#12 certificate
notification_email	NotificationEmail	true	Email where the notifications about certificate expiration will be sent

UpdateSignConfigurationRequest

 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	string	false	Sign process url
expiration_duration	string	false	Validity duration time (ISO-8601 format) of any sign process for the tenant.
channels	[Channel]	false	Channels to send notifications. Possible values: SMS, EMAIL or WHATSAPP
content	string(binary)	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

SignCertificatePassword

1

"Passw0rd"

Name	Type	Required	Description
anonymous	string	false	Password for the PKCS#12 certificate

Channel

1

"SMS"

Name	Type	Required	Description
anonymous	string	false	Channel to send notifications. Possible values: SMS, EMAIL or WHATSAPP

LandingUrl

1

"www.masmovil.com"

Name	Type	Required	Description
anonymous	string	false	Sign process URL

ExpirationDuration

1

"P7D"

Name	Type	Required	Description
anonymous	string	false	Validity duration time (ISO-8601 format) of any sign process for the tenant.

NotificationChannels

1
2
3
4
5


[
  "SMS",
  "EMAIL",
  "WHATSAPP"
]

Name	Type	Required	Description
anonymous	[Channel]	false	Channels to send notifications. Possible values: SMS, EMAIL, or WHATSAPP.

SignCertificateContent

1

"string"

Name	Type	Required	Description
anonymous	string(binary)	false	The PKCS#12 (.p12) certificate file

NotificationEmail

1

"example@email.com"

Name	Type	Required	Description
anonymous	string	false	Email where the notifications about certificate expiration will be sent

TwoFactorValueResponse

1
2
3


{
  "two_factor_value": "12345678A"
}

Name	Type	Required	Description
two_factor_value	TwoFactorValue	true	Value used for two factor. Will match a national id, passport number or email.

ValidateAgentIdentificationRequest

1
2
3
4
5


{
  "agent": "Jose Luis Garcia",
  "evidence": "iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAABbklEQVR42mNkAAYYgZ",
  "evidence_metadata": "{ \"document_number\": \"12345678A\",\n  \"document_type\": \"NIF\" }"
}

Name	Type	Required	Description
agent	string	true	shop agent identifier of who is validating this identification
evidence	PersonalDocumentImage	false	Evidence of the actor identified. It should be a personal document image. Uploaded in Base64 string format. Image extension should ONLY ‘*.png’
evidence_metadata	PersonalIdentificationEvidenceMetadata	false	Metadata of apply OCR to Evidence file. It should be in a valid Json format.

LanguageIdentification

1

"ES"

Name	Type	Required	Description
anonymous	string	false	Languages available to configure operation Not all values are available to all organizations. If language text it is not defined, a default language text will be provided (by default `ES`). Locale defined lists: * `ES` - Spanish language * `EN` - English language * `EU` - Basque language * `GL` - Galician language * `CA` - Catalan language * ‘UNDEFINED’ - Use default language

ValidateOtpIdentificationRequest

1
2
3
4


{
  "code": "k4khb9",
  "two_factor": "12345678A"
}

Name	Type	Required	Description
code	string	true	challenge code
two_factor	TwoFactorValue	false	Value used for two factor. Will match a national id, passport number or email.

CreateOtpChallengeRequest

1
2
3


{
  "two_factor": "12345678A or actor@email.com or 'iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAABbklEQVR42mNkAAYYgZ=='"
}

Name	Type	Required	Description
two_factor	TwoFactorValueOrImage	false	Value used for two factor. Value depends of two factor type: - DOCUMENT_NUMBER: Value must be actor’s personal identification id or passport number. - EMAIL: Value must be actor’s email address. - PERSONAL_DOCUMENT_IMAGE: Image in Base64 format of the document number (back and front) defined in actor’s document number field

GetAgentIdentificationMetadataResponse

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


{
  "actor": {
    "name": "James",
    "last_name": "Williams Smith",
    "language": "ES",
    "document_type": "NIF"
  },
  "agent_id": "shop.agente.name@masmovil.com",
  "creation_date": "2023-04-20T11:43:13Z",
  "modification_date": "2023-04-20T11:43:13Z",
  "expiration_date": "2023-04-20T11:43:13Z",
  "state": "CREATED",
  "personal_document_image": true
}

Name	Type	Required	Description
actor	GetAgentIdentificationActorResponse	true	none
agent_id	string	false	Agent which will identify the actor
creation_date	string(date-time)	true	none
modification_date	string(date-time)	false	none
expiration_date	string(date-time)	true	none
state	IdentificationState	true	An identification process can be in one of the following statuses: - CREATED: Identification process has been started. - VALIDATED: Identification has been validated (I.e. OTP challenge has been solved or agent approved identification). - EXPIRED: Identification process has expired. - CANCELLED: Identification process has been cancelled. - SUCCEEDED: Actor has been identified successfully and the process has been closed. - FAILED: Identification process has ended with failure due to an error along the process.
personal_document_image	PersonalIdentificationEvidence	false	Flag to indicate if the agent needs to take a picture of the actor personal document. If true, the agent will take a picture of the document. If false, the agent will not take a picture of the document. Default value is ‘false’.

GetAgentIdentificationActorResponse

1
2
3
4
5
6


{
  "name": "James",
  "last_name": "Williams Smith",
  "language": "ES",
  "document_type": "NIF"
}

Name	Type	Required	Description
name	string	true	none
last_name	string	true	none
language	LanguageIdentification	true	Languages available to configure operation Not all values are available to all organizations. If language text it is not defined, a default language text will be provided (by default `ES`). Locale defined lists: * `ES` - Spanish language * `EN` - English language * `EU` - Basque language * `GL` - Galician language * `CA` - Catalan language * ‘UNDEFINED’ - Use default language
document_type	DocumentType	true	type of the actor document number Allowed values: ‘NIF’, ‘NIE’, ‘PASSPORT’

GetOtpIdentificationActorResponse

1
2
3
4
5


{
  "name": "James",
  "language": "ES",
  "document_type": "NIF"
}

Name	Type	Required	Description
name	string	true	none
language	LanguageIdentification	true	Languages available to configure operation Not all values are available to all organizations. If language text it is not defined, a default language text will be provided (by default `ES`). Locale defined lists: * `ES` - Spanish language * `EN` - English language * `EU` - Basque language * `GL` - Galician language * `CA` - Catalan language * ‘UNDEFINED’ - Use default language
document_type	DocumentType	false	type of the actor document number Allowed values: ‘NIF’, ‘NIE’, ‘PASSPORT’

GetOtpIdentificationMetadataResponse

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


{
  "actor": {
    "name": "James",
    "language": "ES",
    "document_type": "NIF"
  },
  "creation_date": "2023-04-20T11:43:13Z",
  "modification_date": "2023-04-20T11:43:13Z",
  "expiration_date": "2023-04-20T11:43:13Z",
  "remaining_challenges": 3,
  "remaining_validation_attempts": 3,
  "next_challenge_retry": "2023-04-20T11:43:13Z",
  "two_factor_type": "EMAIL",
  "personal_document_validated": true,
  "state": "CREATED"
}

Name	Type	Required	Description
actor	GetOtpIdentificationActorResponse	true	none
creation_date	string(date-time)	true	none
modification_date	string(date-time)	false	none
expiration_date	string(date-time)	true	none
remaining_challenges	integer	true	Remaining challenge codes to request before identification process fail.
remaining_validation_attempts	integer	true	Remaining validation attempts of the current challenge code. Null when not challenge is requested.
next_challenge_retry	string(date-time)	false	Minimum date before request a new challenge code. Null when remaining_challenges is zero.
two_factor_type	TwoFactorType	false	Two factor type to validate actor identity. Possible values: * `DOCUMENT_NUMBER`: value defined in actor’s document number field * `EMAIL`: value defined in actor’s email field * `PERSONAL_DOCUMENT_IMAGE`: Image of the document number (back and front) defined in actor’s document number field
personal_document_validated	boolean	false	Indicate if actor’s personal document (PASSPORT, NIF, NIE) has been validated in the identification process. Only apply in case that ‘two factor’ configured requires to validate an actor’s personal document image
state	IdentificationState	true	An identification process can be in one of the following statuses: - CREATED: Identification process has been started. - VALIDATED: Identification has been validated (I.e. OTP challenge has been solved or agent approved identification). - EXPIRED: Identification process has expired. - CANCELLED: Identification process has been cancelled. - SUCCEEDED: Actor has been identified successfully and the process has been closed. - FAILED: Identification process has ended with failure due to an error along the process.

IdentificationState

1

"CREATED"

Name	Type	Required	Description
anonymous	string	false	An identification process can be in one of the following statuses: - CREATED: Identification process has been started. - VALIDATED: Identification has been validated (I.e. OTP challenge has been solved or agent approved identification). - EXPIRED: Identification process has expired. - CANCELLED: Identification process has been cancelled. - SUCCEEDED: Actor has been identified successfully and the process has been closed. - FAILED: Identification process has ended with failure due to an error along the process.

PersonalDocumentImage

1

"iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAABbklEQVR42mNkAAYYgZ"

Name	Type	Required	Description
anonymous	string	false	Evidence of the actor identified. It should be a personal document image. Uploaded in Base64 string format. Image extension should ONLY ‘*.png’

PersonalIdentificationEvidenceMetadata

1

"{ \"document_number\": \"12345678A\",\n  \"document_type\": \"NIF\" }"

Name	Type	Required	Description
anonymous	string	false	Metadata of apply OCR to Evidence file. It should be in a valid Json format.

TwoFactorValue

1

"12345678A"

Name	Type	Required	Description
anonymous	string	false	Value used for two factor. Will match a national id, passport number or email.

DocumentType

1

"NIF"

Name	Type	Required	Description
anonymous	string	false	type of the actor document number Allowed values: ‘NIF’, ‘NIE’, ‘PASSPORT’

PersonalIdentificationEvidence

1

true

Name	Type	Required	Description
anonymous	boolean	false	Flag to indicate if the agent needs to take a picture of the actor personal document. If true, the agent will take a picture of the document. If false, the agent will not take a picture of the document. Default value is ‘false’.

TwoFactorValueOrImage

1

"12345678A or actor@email.com or 'iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAABbklEQVR42mNkAAYYgZ=='"

Name	Type	Required	Description
anonymous	string	false	Value used for two factor. Value depends of two factor type: - DOCUMENT_NUMBER: Value must be actor’s personal identification id or passport number. - EMAIL: Value must be actor’s email address. - PERSONAL_DOCUMENT_IMAGE: Image in Base64 format of the document number (back and front) defined in actor’s document number field

CreateAgentIdentificationRequest

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


{
  "actor": {
    "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"
  },
  "personal_document_image": true,
  "expires_in": "P7D"
}

Name	Type	Required	Description
actor	IdentificationActor	true	none
personal_document_image	PersonalIdentificationEvidence1	false	Flag to indicate if the agent needs to take a picture of the actor personal document. If true, the agent will take a picture of the document. If false, the agent will not take a picture of the document.
expires_in	string	true	Minimum 1 minute. Max 30 days. Validity duration time (ISO-8601 format) from now.

CreateOtpIdentificationRequest

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22


{
  "actor": {
    "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"
  },
  "expires_in": "P7D",
  "two_factor_type": "DOCUMENT_NUMBER",
  "channel": {
    "type": "SMS",
    "external": "true"
  }
}

Name	Type	Required	Description
actor	IdentificationActor	true	none
expires_in	string	true	Default to 30 days. Max 30 days. Validity duration time (ISO-8601 format) from now.
two_factor_type	TwoFactorType1	false	Two factor type to validate actor identity. Possible values: * `DOCUMENT_NUMBER`: value defined in actor’s document number field * `EMAIL`: value defined in actor’s email field * `PERSONAL_DOCUMENT_IMAGE`: Image of the document number (back and front) defined in actor’s document number field
channel	CommunicationChannel	true	none

CommunicationChannel

1
2
3
4


{
  "type": "SMS",
  "external": "true"
}

Name	Type	Required	Description
type	string	true	Channel which will be used to send the OTP to complete the identification. Possible values: SMS or EMAIL
external	boolean	true	Identification communications to send the OTP will be sent through third-party gateway instead of MasOrange one

IdentificationActor

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


{
  "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"
}

Name	Type	Required	Description
name	string	true	none
last_name	string	false	none
identity_document	object	false	none
» document_number	string	true	actor personal number that customers agent will use to identification
» document_type	string	true	type of the actor document number Allowed values: ‘NIF’, ‘NIE’, ‘PASSPORT’
email	string	false	none
msisdn	Msisdn	false	none
language	language	true	Languages available to configure operation Not all values are available to all organizations. If language text it is not defined, a default language text will be provided (by default `ES`). Locale defined lists: * `ES` - Spanish language * `EN` - English language * `EU` - Basque language * `GL` - Galician language * `CA` - Catalan language * ‘UNDEFINED’ - Use default language

TwoFactorType1

1

"DOCUMENT_NUMBER"

Name	Type	Required	Description
anonymous	string	false	Two factor type to validate actor identity. Possible values: * `DOCUMENT_NUMBER`: value defined in actor’s document number field * `EMAIL`: value defined in actor’s email field * `PERSONAL_DOCUMENT_IMAGE`: Image of the document number (back and front) defined in actor’s document number field

PersonalIdentificationEvidence1

1

true

Name	Type	Required	Description
anonymous	boolean	false	Flag to indicate if the agent needs to take a picture of the actor personal document. If true, the agent will take a picture of the document. If false, the agent will not take a picture of the document.

CreateAgentIdentificationResponse

1
2
3


{
  "id": "7902cd2d-80f4-4766-a3e9-a1760e0df9bd"
}

Name	Type	Required	Description
id	string	true	uuid that identifies an agent identification, referenced on the endpoints as admin_identification_id

CreateOtpIdentificationResponse

1
2
3


{
  "id": "7902cd2d-80f4-4766-a3e9-a1760e0df9bd"
}

Name	Type	Required	Description
id	string	true	uuid that identifies an otp identification, referenced on the endpoints as admin_identification_id

CancelIdentificationRequest

1
2
3


{
  "reason": "The client does not want to continue with the identification process."
}

Name	Type	Required	Description
reason	string	true	The reason why the process is going to be cancelled.

Language1

1

"string"

Name	Type	Required	Description
anonymous	string	false	Templates languages allowed to generate contract Allowed values: ES, EN, EU, GL, CA, DE, UNDEFINED

Condition1

1

"GDPR:YES"

Name	Type	Required	Description
anonymous	string	false	Tuple FLAG:VALUE (flag and expected value) that will evaluated to know if this template section have to be filled

Tag1

1

"DRAFT"

Name	Type	Required	Description
anonymous	string	false	Free values (user-defined) to tag document filled. These values are normalized following the next rules: - All tags will be converted to lowercase - All whitespaces will be removed - Empty or blank tags are not allowed - Tags matching reserved words (null, undefined or nan) are not allowed

DocumentId

1

"d290f1ee-6c54-4b01-90e6-d701748f0851"

Name	Type	Required	Description
anonymous	string(uuid)	false	Unique identifier of a document stored in mas-documents

ContractId

1

"310484e7-40ec-4b4b-8731-3e7ed29f7ef5"

Name	Type	Required	Description
anonymous	string(uuid)	false	Unique identifier of a contract

ContractWithoutOwner

1
2
3


{
  "contract_id": "310484e7-40ec-4b4b-8731-3e7ed29f7ef5"
}

Name	Type	Required	Description
contract_id	ContractId	true	Unique identifier of a contract

Signer

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


{
  "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_options": {
    "personal_document_evidence": true
  }
}

Name	Type	Required	Description
alias	string	true	alias has to be a unique value within the signing process and cannot overlap with other signers
name	string	true	none
last_name	string	true	none
identity_document	object	true	none
» document_number	string	true	signer personal number that customers agent will use to identification
» document_type	string	true	type of the actor document number Allowed values: ‘NIF’, ‘NIE’, ‘PASSPORT’
email	string	true	none
msisdn	Msisdn	true	none
language	language	true	Languages available to configure operation Not all values are available to all organizations. If language text it is not defined, a default language text will be provided (by default `ES`). Locale defined lists: * `ES` - Spanish language * `EN` - English language * `EU` - Basque language * `GL` - Galician language * `CA` - Catalan language * ‘UNDEFINED’ - Use default language
identification_options	object	false	additional options to configure signer identification on sign process
» personal_document_evidence	PersonalDocumentEvidence	false	Flag to indicate if the signer has to provide a personal document evidence when is identificated to sign the contract

PersonalDocumentEvidence

1

true

Name	Type	Required	Description
anonymous	boolean	false	Flag to indicate if the signer has to provide a personal document evidence when is identificated to sign the contract

ContractValues

1
2
3
4


{
  "name": "string",
  "value": "string"
}

Name	Type	Required	Description
name	string	true	contract field name to be filled
value	string	true	contract field value to be filled

ChangeContractOwnerRequest

1
2
3


{
  "new_owner": "subsCrIptIon8172241"
}

Name	Type	Required	Description
new_owner	string	true	New contract owner

CreateFilledContractRequest

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


{
  "template_external_id": "telco_services",
  "template_version": "1",
  "language": "string",
  "flags_conditions": [
    "GDPR:YES"
  ],
  "fields_values": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "name": "personal_contract",
  "tags": [
    "Draft",
    "CONTRACT",
    "v1.0"
  ]
}

Name	Type	Required	Description
template_external_id	string	true	Template external id unique identifier
template_version	integer	true	version of the template to be updated
language	Language1	true	Templates languages allowed to generate contract Allowed values: ES, EN, EU, GL, CA, DE, UNDEFINED
flags_conditions	[Condition1]	false	list of conditions which trigger specific sections of the template to be filled
fields_values	[ContractValues]	true	template variables whose values will be printed in the filled template
name	string	false	Name of the document filled (without spaces). The document is renamed with this value.
tags	[Tag1]	false	Free values (user-defined) to tag document. These values are normalized following the next rules: - All tags will be converted to lowercase - All whitespaces will be removed - Empty or blank tags are not allowed - Tags matching reserved words (null, undefined or nan) are not allowed

SignContractsRequest

 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


{
  "sign_type": "ONLINE",
  "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_options": {
        "personal_document_evidence": true
      }
    }
  ],
  "contracts": [
    {
      "contract_id": "310484e7-40ec-4b4b-8731-3e7ed29f7ef5"
    }
  ],
  "additional_options": {
    "preview_documents": [
      "d290f1ee-6c54-4b01-90e6-d701748f0851"
    ]
  }
}

Name	Type	Required	Description
sign_type	string	true	type of the sign process in which contracts are going to be signed. values: ‘ONSITE’, ‘ONLINE’
signers	[Signer]	true	none
contracts	[ContractWithoutOwner]	true	List of contracts to be signed
additional_options	SignContractAdditionalOptions	false	additional options to configure on contracts sign process

GetContractResponse

1
2
3
4
5


{
  "signed_document_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "filled_document_id": "8d104722-610b-4d7c-ba89-0dd825442d88",
  "sign_process_id": "d2d3b2d0-cc4e-4280-b967-90edee0aB3d2"
}

Name	Type	Required	Description
signed_document_id	string(uuid)	false	signed document unique identifier
filled_document_id	string(uuid)	false	filled document unique identifier
sign_process_id	string(uuid)	false	digital process unique identifier in which contract was signed

CreateFilledContractResponse

1
2
3
4


{
  "contract_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "document_id": "8d104722-610b-4d7c-ba89-0dd825442d88"
}

Name	Type	Required	Description
contract_id	string(uuid)	true	Contract unique identifier
document_id	string(uuid)	true	filled document unique identifier

ChangeContractOwnerResponse

1
2
3


{
  "owner": "subscription8172241"
}

Name	Type	Required	Description
owner	string	true	Successfully assigned new contract owner

SignContractsResponse

1
2
3


{
  "sign_process_id": "d290f1ee-6c54-4b01-90e6-d701748f0851"
}

Name	Type	Required	Description
sign_process_id	string(uuid)	true	Digital sign process unique identifier where contracts will be signed

SignContractAdditionalOptions

1
2
3
4
5


{
  "preview_documents": [
    "d290f1ee-6c54-4b01-90e6-d701748f0851"
  ]
}

Name	Type	Required	Description
preview_documents	[DocumentId]	false	list of public documents that will be previewed on sign process

DelegateIdentityDocumentResponse

1
2
3
4
5


{
  "provider_id": "cbd2e693-d71a-4cee-8313-1972acc0394d",
  "access_token": "access-token",
  "provider": "GOOGLE"
}

Name	Type	Required	Description
provider_id	string	false	provider external id
access_token	string	false	access token
provider	Provider	false	Scoring provider. Possible values [GOOGLE, VERIDAS]

IdentityDocument

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


{
  "creation_date": "2023-04-20T11:43:13Z",
  "modification_date": "2023-04-20T11:43:13Z",
  "expiration_date": "2023-04-20T11:43:13Z",
  "remaining_score_attempts": 15,
  "state": "CREATED",
  "document": {
    "type": {
      "type": "IDENTITY_CARD",
      "country": "ES"
    },
    "captures": {
      "front": "https://storage.googleapis.com/mas-documents-prod/cbd2e693-d71a-4cee-8313-1972acc0394d",
      "back": "https://storage.googleapis.com/mas-documents-prod/cbd2e693-d71a-4cee-8313-1972acc0394d"
    }
  },
  "score": 0.85,
  "provider": "GOOGLE"
}

Name	Type	Required	Description
creation_date	string(date-time)	false	none
modification_date	string(date-time)	false	none
expiration_date	string(date-time)	false	none
remaining_score_attempts	number	false	none
state	string	false	Possible values: CREATED, SCORED, SUCCEEDED, EXPIRED, FAILED
document	Document	false	Document
score	number	false	total score
provider	Provider	false	Scoring provider. Possible values [GOOGLE, VERIDAS]

Document

 1
 2
 3
 4
 5
 6
 7
 8
 9
10


{
  "type": {
    "type": "IDENTITY_CARD",
    "country": "ES"
  },
  "captures": {
    "front": "https://storage.googleapis.com/mas-documents-prod/cbd2e693-d71a-4cee-8313-1972acc0394d",
    "back": "https://storage.googleapis.com/mas-documents-prod/cbd2e693-d71a-4cee-8313-1972acc0394d"
  }
}

Name	Type	Required	Description
type	DocumentType1	false	Document type
captures	DocumentCaptures	false	Document captures

DocumentCaptures

1
2
3
4


{
  "front": "https://storage.googleapis.com/mas-documents-prod/cbd2e693-d71a-4cee-8313-1972acc0394d",
  "back": "https://storage.googleapis.com/mas-documents-prod/cbd2e693-d71a-4cee-8313-1972acc0394d"
}

Name	Type	Required	Description
front	string	false	Storage URI of front document image
back	string	false	Storage URI of back document image

CreateScoringRequest

1
2
3
4
5
6
7
8


{
  "document": {
    "type": "IDENTITY_CARD",
    "country": "ES"
  },
  "provider": "GOOGLE",
  "expires_in": "P7D"
}

Name	Type	Required	Description
document	DocumentType1	true	Document type
provider	Provider	true	Scoring provider. Possible values [GOOGLE, VERIDAS]
expires_in	ExpiresIn	true	Minimum 1 minute. Max 30 days. Validity duration time (ISO-8601 format) from now.

CreateScoringResponse

1
2
3


{
  "id": "d290f1ee-6c54-4b01-90e6-d701748f0851"
}

Name	Type	Required	Description
id	string(uuid)	false	Created scoring id

ExpiresIn

1

"P7D"

Name	Type	Required	Description
anonymous	string	false	Minimum 1 minute. Max 30 days. Validity duration time (ISO-8601 format) from now.

Provider

1

"GOOGLE"

Name	Type	Required	Description
anonymous	string	false	Scoring provider. Possible values [GOOGLE, VERIDAS]

DocumentType1

1
2
3
4


{
  "type": "IDENTITY_CARD",
  "country": "ES"
}

Name	Type	Required	Description
type	string	true	Document type, one of these values (IDENTITY_CARD, RESIDENCE_PERMIT, PASSPORT)
country	string	true	Country/region code in ISO 3166 2-letter code