Imported data
AuthNToken Bearer Token (JWT) administrator — masdoc.squad@masmovil.com
| Recurso | Descripción |
|---|---|
| Documents | Binary documents business logic |
| Forms | Binary documents with field's map to fill |
| Sections | Grouping of forms by language |
| Templates | Document builder with sections |
| Templates Configuration | Templates Tenant configuration |
| DynamicTemplates | HTML based templates with fields to fill |
| Sign Process | Access to digital sign processes management. |
| Biometric Signature | Access to biometric signature endpoints. |
| Simple Signature | Access to simple signature endpoints. |
| Identification Agent | Digital agent identification services |
| Sign Configuration | Sign Configuration |
| Identification OTP | Digital OTP identification services |
| Identification with identity document | Identification with identity document |
| Identification Agent Admin | Digital agent identification administrative services |
| Identification OTP Admin | Digital OTP identification administrative services |
| Identification with identity document Admin | Identification with identity document administrative services |
| Contracts | Contracts document services |
| Scoring | Scoring services |
| Securize | |
| Identification Chain | |
| Identification Chain Admin |
AuthNToken Bearer Token (JWT) administrator — masdoc.squad@masmovil.com
| Recurso | Descripción |
|---|---|
| Documents | Binary documents business logic |
| Forms | Binary documents with field's map to fill |
| Sections | Grouping of forms by language |
| Templates | Document builder with sections |
| Templates Configuration | Templates Tenant configuration |
| DynamicTemplates | HTML based templates with fields to fill |
| Sign Process | Access to digital sign processes management. |
| Biometric Signature | Access to biometric signature endpoints. |
| Simple Signature | Access to simple signature endpoints. |
| Identification Agent | Digital agent identification services |
| Sign Configuration | Sign Configuration |
| Identification OTP | Digital OTP identification services |
| Identification with identity document | Identification with identity document |
| Identification Agent Admin | Digital agent identification administrative services |
| Identification OTP Admin | Digital OTP identification administrative services |
| Identification with identity document Admin | Identification with identity document administrative services |
| Contracts | Contracts document services |
| Scoring | Scoring services |
| Securize | |
| Identification Chain | |
| Identification Chain Admin |
Upload a document from a file name and its content. The document unique identifier and its name are returned.
PATH PARAMETERS
The string id related with one of Grupo MasOrange tenants
HEADER PARAMETERS
The string id related with the document owner. It is mandatory when document is not public
File name, content and metadata for creating the document.
{
"name": "New_document",
"extension": "pdf",
"tags": [
"DRAFT",
"CONFIDENTIAL",
"v1.0"
]
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
name* | string | Name of the document (without spaces). The document is renamed with this value. | ||
extension* | string | Format of the document to be stored. It must match the format of the binary Allowed values: pdf, jpeg, jpg, png, html, json, hbs | ||
tags | string[] | Free values (user-defined) to tag document. 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 | maxItems: 5, uniqueItems | |
content* | string (binary) | Document content in binary format |
Created New Document is created. Expected response for a valid request.
{
"documentId": "d290f1ee-6c54-4b01-90e6-d701748f0851"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
documentId* | string (uuid) | Document unique identifier |
Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have fail
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X POST 'https://documents.masstack.com/v1/orgs/masmovil/documents' \
-H 'x-auth-owner: 2357893' \
-H 'Accept: application/json' \
-F 'name=personal_contract' \
-F 'extension=pdf' \
-F 'tags=Draft,Top_Secret,v1.0' \
-F 'content=@/path/to/file;type=application/pdf, application/octet-stream, image/png, image/jpeg'Returns the document content as binary data, if document is present; else, returns an error message.
PATH PARAMETERS
The string id related with one of Grupo MasOrange tenants
The string id related with one of Grupo MasOrange tenants/organizations
HEADER PARAMETERS
The string id related with the document owner. It is mandatory when document is not public
OK The document binary content. Expected response to a valid request.
"binary file"Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have fail
Not Found resource not found
resource is not longer available
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Content-Typestringdefines response binary media type
Content-Dispositionstringcontains downloaded document file name
curl -X GET 'https://documents.masstack.com/v1/orgs/masmovil/documents/d290f1ee-6c54-4b01-90e6-d701748f0851' \
-H 'x-auth-owner: 2357893' \
-H 'Accept: application/octet-stream'Delete document.
PATH PARAMETERS
The string id related with one of Grupo MasOrange tenants
The string id related with one of Grupo MasOrange tenants/organizations
HEADER PARAMETERS
The string id related with the document owner. It is mandatory when document is not public
OK Action executed correctly
{
"deletedDocumentId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"deleteTS": "2023-04-20T11:43:13Z"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
deletedDocumentId* | string (uuid) | deleted document unique identifier | ||
deleteTS* | string (date-time) | instant when document was deleted by first time |
Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have fail
Not Found resource not found
Conflict resource already deleted
resource is not longer available
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X DELETE 'https://documents.masstack.com/v1/orgs/masmovil/documents/d290f1ee-6c54-4b01-90e6-d701748f0851' \
-H 'x-auth-owner: 2357893' \
-H 'Accept: application/json'Delete document physically.
PATH PARAMETERS
The string id related with one of Grupo MasOrange tenants
The string id related with one of Grupo MasOrange tenants/organizations
HEADER PARAMETERS
The string id related with the document owner. It is mandatory when document is not public
OK Action executed correctly
{
"deletedDocumentId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"deleteTS": "2023-04-20T11:43:13Z"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
deletedDocumentId* | string (uuid) | deleted document unique identifier | ||
deleteTS* | string (date-time) | instant when document was deleted by first time |
Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have fail
Not Found resource not found
Conflict resource already deleted
resource is not longer available
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X DELETE 'https://documents.masstack.com/v1/orgs/masmovil/documents/d290f1ee-6c54-4b01-90e6-d701748f0851/physical' \
-H 'x-auth-owner: 2357893' \
-H 'Accept: application/json'Returns metadata information associated to a document
PATH PARAMETERS
The string id related with one of Grupo MasOrange tenants
The string id related with one of Grupo MasOrange tenants/organizations
HEADER PARAMETERS
The string id related with the document owner. It is mandatory when document is not public
OK Expected response for a valid request.
{
"documentId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"name": "personal_contract",
"tags": [
"Draft",
"Top_Secret",
"v1.0"
],
"extension": "pdf",
"archiveHash": "938c2cc0dcc05f2b68c4287040cfcf71",
"size": 400000000,
"isPublic": true
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
documentId* | string (uuid) | Document unique identifier | ||
name* | string | Name of the document (without spaces). The document is renamed with this value. | ||
tags* | string[] | Free values (user-defined) to tag document. 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 | maxItems: 5, uniqueItems | |
extension* | string | Format of the document to be stored. It must match the format of the binary Allowed values: pdf, jpeg, jpg, png, html, json, hbs | ||
archiveHash* | string | Document hash digest | ||
size* | integer | The size of the document in bytes. | ||
isPublic* | boolean | Indicates if document is public (without owner) or private (with owner defined) |
Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have fail
Not Found resource not found
resource is not longer available
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://documents.masstack.com/v1/orgs/masmovil/documents/d290f1ee-6c54-4b01-90e6-d701748f0851/metadata' \
-H 'x-auth-owner: 2357893' \
-H 'Accept: application/json'Returns the url to download the specified document, if document is present and reachable; else, returns an error message.
PATH PARAMETERS
The string id related with one of Grupo MasOrange tenants
The string id related with one of Grupo MasOrange tenants/organizations
HEADER PARAMETERS
The string id related with the document owner. It is mandatory when document is not public
Duration before public url expires and becomes not accesible
{
"expiresIn": "PT24H",
"downloadDisposition": "inline"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
expiresIn | string | Default to 24 hours. Max 24 hours. Validity duration time (ISO-8601 format) of the public url from now. | ||
downloadDisposition | string
()
attachmentinline | Controls the disposition of the content (if the PDF is rendered inline or downloaded). Allowed values "attachment" or "inline". | "attachment" |
OK The generated public url. Expected response to a valid request.
{
"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"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
expirationDate* | string | Timestamp (ISO-8601 format) at which public url becomes inaccesible. | ||
publicUrl* | string | Signed url fully accessible without authentication or authorization. | ||
mediaType | string | Binary media type of the downloadable document | ||
name* | string | Name of the downloadable document |
Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have fail
Not Found resource not found
resource is not longer available
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X POST 'https://documents.masstack.com/v1/orgs/masmovil/documents/d290f1ee-6c54-4b01-90e6-d701748f0851/public_url' \
-H 'x-auth-owner: 2357893' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"expiresIn": "PT24H",
"downloadDisposition": "inline"
}'Changes document owner, if document exists and is already private; else, returns an error message.
PATH PARAMETERS
The string id related with one of Grupo MasOrange tenants
The string id related with one of Grupo MasOrange tenants/organizations
HEADER PARAMETERS
The string id related with the document owner. It is mandatory when document is not public
The identifier of the new owner to whom ownership of the document is transferred
{
"newOwner": "sUbScRiPtiOn_12123112a"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
newOwner | string | The identifier of the new owner of the document |
OK Ownership change succeeded. Expected response to a valid request.
{
"owner": "subscription_12123112a"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
owner* | string | The normalized identifier of the new owner of the document |
Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have fail
Not Found resource not found
resource is not longer available
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X PUT 'https://documents.masstack.com/v1/orgs/masmovil/documents/d290f1ee-6c54-4b01-90e6-d701748f0851/owner' \
-H 'x-auth-owner: 2357893' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"newOwner": "sUbScRiPtiOn_12123112a"
}'Get all stored forms metadata (by tenant)
PATH PARAMETERS
The string id related with one of Grupo MasOrange tenants
QUERY PARAMETERS
Defines forms page number to be show. If not defined, default value is 0 (first page).
Defines the number of forms returned in each page. If not defined, default value is 50.
OK The forms metadata is returned. Expected response for a valid request.
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
totalResults* | integer | Number of total forms to get | ||||||||||||||||||||||||||||||||||||||||||||||||||||
currentPage* | integer | Current page | ||||||||||||||||||||||||||||||||||||||||||||||||||||
forms* | object[] | |||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have fail
Not Found resource not found
resource is not longer available
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://documents.masstack.com/v1/orgs/masmovil/templates/forms?page=0&pageSize=1' \
-H 'Accept: application/json'Upload a form from a file name and its content. The form unique identifier and its name are returned.The map of the fillable fields will be extracted.
PATH PARAMETERS
The string id related with one of Grupo MasOrange tenants
File name, content and metadata for creating the form.
{
"name": "new_form",
"extension": "pdf"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
name* | string | Name of the form (without spaces). The form is renamed with this value (will be normalized on form external Id). | ||
extension* | string | Format of the form to be stored. It must match the format of the binary Allowed values: pdf | ||
tags | string[] | 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 | maxItems: 5, uniqueItems | |
content* | string (binary) | Document content in binary format |
Created New form is created. Expected response for a valid request.
{
"id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"externalId": "contract_gdpr_es",
"fields": [
{
"key": "NAME",
"type": "FILLABLE"
}
],
"tags": [
"DRAFT"
],
"creationDate": "2022-08-21T17:32:28Z"
}| Property | Type | Description | Constraints | Default | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id* | string (uuid) | form unique identifier | |||||||||||||||||
externalId* | string | form name normalized | |||||||||||||||||
fields* | object[] | list all fields types | uniqueItems | ||||||||||||||||
Array items:
| |||||||||||||||||||
tags | string[] | 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 | maxItems: 5, uniqueItems | ||||||||||||||||
creationDate* | string (date-time) | date of creation of the form | |||||||||||||||||
Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have fail
Conflict Conflict. Resource already exist
Unprocessable Entity Request input can not be processed (is incomplete)
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X POST 'https://documents.masstack.com/v1/orgs/masmovil/templates/forms' \
-H 'Accept: application/json' \
-F 'name=customer_contract' \
-F 'extension=pdf' \
-F 'tags=DRAFT' \
-F 'content=@/path/to/file;type=application/pdf, application/octet-stream'Returns the filled form as PDF file, if form exists; else, returns an error message.
PATH PARAMETERS
The string id related with one of Grupo MasOrange tenants
The external id or id of the form
values to fill a form
{
"fieldsValues": [
{
"name": "string",
"value": "string"
}
],
"fillMode": "default"
}| Property | Type | Description | Constraints | Default | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
fieldsValues* | object[] | form variables whose values will be printed in the filled form | |||||||||||||||||
Array items:
| |||||||||||||||||||
fillMode | string | 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 | |||||||||||||||||
OK The filled form as pdf document. Expected response to a valid request.
"pdf document"Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have fail
Not Found resource not found
resource is not longer available
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Content-Typestringdefines response binary media type
Content-Dispositionstringcontains downloaded filled form
curl -X POST 'https://documents.masstack.com/v1/orgs/masmovil/templates/forms/d290f1ee-6c54-4b01-90e6-d701748f0851,form_name/fill' \
-H 'Content-Type: application/json' \
-H 'Accept: application/octet-stream' \
--data-raw '{
"fieldsValues": [
{
"name": "string",
"value": "string"
}
],
"fillMode": "default"
}'Get uploaded form metadata by form id. This endpoint returns the same response as create form endpoint.
PATH PARAMETERS
The string id related with one of Grupo MasOrange tenants
The string 'id' or 'external id' of the desired form
OK The form metadata is returned. Expected response for a valid request.
{
"id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"externalId": "contract_gdpr_es",
"fields": [
{
"key": "NAME",
"type": "FILLABLE"
}
],
"tags": [
"DRAFT"
],
"creationDate": "2022-08-21T17:32:28Z"
}| Property | Type | Description | Constraints | Default | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id* | string (uuid) | form unique identifier | |||||||||||||||||
externalId* | string | form name normalized | |||||||||||||||||
fields* | object[] | list all fields types | uniqueItems | ||||||||||||||||
Array items:
| |||||||||||||||||||
tags | string[] | 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 | maxItems: 5, uniqueItems | ||||||||||||||||
creationDate* | string (date-time) | date of creation of the form | |||||||||||||||||
Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have fail
Not Found resource not found
resource is not longer available
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://documents.masstack.com/v1/orgs/masmovil/templates/forms/d290f1ee-6c54-4b01-90e6-d701748f0851,form_name/metadata' \
-H 'Accept: application/json'Download form
PATH PARAMETERS
The string id related with one of Grupo MasOrange tenants
The string 'id' or 'external id' of the desired form
OK The form binary content. Expected response to a valid request.
"binary file"Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have fail
Not Found resource not found
resource is not longer available
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Content-Typestringdefines response binary media type
Content-Dispositionstringcontains downloaded form name
curl -X GET 'https://documents.masstack.com/v1/orgs/masmovil/templates/forms/d290f1ee-6c54-4b01-90e6-d701748f0851,form_name' \
-H 'Accept: application/octet-stream'Delete form
PATH PARAMETERS
The string id related with one of Grupo MasOrange tenants
The string 'id' or 'external id' of the desired form
No Content Action executed correctly
Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have fail
Not Found resource not found
Conflict conflict if form is in some section
resource is not longer available
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X DELETE 'https://documents.masstack.com/v1/orgs/masmovil/templates/forms/d290f1ee-6c54-4b01-90e6-d701748f0851,form_name' \
-H 'Accept: application/json'Get all stored sections info (by tenant) sorted by creation date in descending order. Results can be paginated by page and pageSize. If any values of page or pageSize are be provided, response will be all sections in one page (no pagination).
PATH PARAMETERS
The string id related with one of Grupo MasOrange tenants
QUERY PARAMETERS
Defines sections page number to be show. If not defined, default value is 0 (first page).
Defines the number of sections returned in each page. If not defined, default value is 50.
OK The sections metadata is returned. Expected response for a valid request.
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
totalResults* | integer | Number of total sections to get | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
currentPage* | integer | Current page | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sections* | object[] | List of sections metadata | uniqueItems | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have fail
Not Found resource not found
resource is not longer available
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://documents.masstack.com/v1/orgs/masmovil/templates/sections?page=0&pageSize=1' \
-H 'Accept: application/json'Create a new section of forms
PATH PARAMETERS
The string id related with one of Grupo MasOrange tenants
metadata for creating a language section
{
"sectionName": "contract_gdpr",
"forms": [
{
"language": "ES",
"formExternalId": "contract_gdpr_en"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
sectionName* | string | name of section of forms (will be normalized on section external Id) | |||||||||||||||||
forms* | object[] | defines which form is defined to each language | minItems: 1 | ||||||||||||||||
Array items:
| |||||||||||||||||||
Created New section is created. Expected response for a valid request.
{
"externalId": "anexo_gdpr",
"forms": [
{
"language": "ES",
"formExternalId": "contract_gdpr_en"
}
],
"fields": [
{
"key": "NAME",
"type": "FILLABLE"
}
],
"creationDate": "2022-08-21T17:32:28Z"
}| Property | Type | Description | Constraints | Default | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
externalId* | string | normalized name of section (external id) | |||||||||||||||||
forms* | object[] | defines which form is defined to each language | minItems: 1 | ||||||||||||||||
Array items:
| |||||||||||||||||||
fields* | object[] | list all fields types | uniqueItems | ||||||||||||||||
Array items:
| |||||||||||||||||||
creationDate* | string (date-time) | ||||||||||||||||||
No Content Section created successfully.
Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have fail
Not Found resource not found
Conflict Conflict. Resource already exist
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X POST 'https://documents.masstack.com/v1/orgs/masmovil/templates/sections' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"sectionName": "contract_gdpr",
"forms": [
{
"language": "ES",
"formExternalId": "contract_gdpr_en"
}
]
}'Get section metadata by section external id. This endpoint returns the same response as create section endpoint.
PATH PARAMETERS
The string id related with one of Grupo MasOrange tenants
The external id of the desired section
OK The section metadata is returned. Expected response for a valid request.
{
"externalId": "anexo_gdpr",
"forms": [
{
"language": "ES",
"formExternalId": "contract_gdpr_en"
}
],
"fields": [
{
"key": "NAME",
"type": "FILLABLE"
}
],
"creationDate": "2022-08-21T17:32:28Z"
}| Property | Type | Description | Constraints | Default | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
externalId* | string | normalized name of section (external id) | |||||||||||||||||
forms* | object[] | defines which form is defined to each language | minItems: 1 | ||||||||||||||||
Array items:
| |||||||||||||||||||
fields* | object[] | list all fields types | uniqueItems | ||||||||||||||||
Array items:
| |||||||||||||||||||
creationDate* | string (date-time) | ||||||||||||||||||
Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have fail
Not Found resource not found
resource is not longer available
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://documents.masstack.com/v1/orgs/masmovil/templates/sections/anexo_gdpr/metadata' \
-H 'Accept: application/json'Delete section by section external id.
PATH PARAMETERS
The string id related with one of Grupo MasOrange tenants
The external id of the desired section
No Content The section is deleted successfully
Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have fail
Not Found resource not found
Conflict Conflict. Section is in use in some template
resource is not longer available
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X DELETE 'https://documents.masstack.com/v1/orgs/masmovil/templates/sections/anexo_gdpr' \
-H 'Accept: application/json'Get all stored templates info (by tenant) sorted by creation date in descending order. Results can be paginated by page and pageSize. If any values of page or pageSize are be provided, response will be all templates in one page (no pagination).
PATH PARAMETERS
The string id related with one of Grupo MasOrange tenants
QUERY PARAMETERS
Defines templates page number to be show. If not defined, default value is 0 (first page).
Defines the number of templates returned in each page. If not defined, default value is 50.
OK The templates metadata is returned. Expected response for a valid request.
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
totalResults* | integer | Number of total templates to get | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
currentPage* | integer | Current page | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
templates* | object[] | List of templates metadatas | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have fail
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://documents.masstack.com/v1/orgs/masmovil/templates?page=0&pageSize=1' \
-H 'Accept: application/json'Create a new template of sections
PATH PARAMETERS
The string id related with one of Grupo MasOrange tenants
Metadata for creating a template from language sections.
{
"templateName": "contracto_convergente",
"defaultLanguage": "ES",
"orderedSectionNames": [
"introduction",
"personal_data",
"anexo_gdpr"
],
"rules": [
{
"sectionExternalId": "introduction",
"condition": "PREVIEW:ALLOW"
},
{
"sectionExternalId": "anexo_gdpr",
"condition": "GDPR:YES"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
templateName* | string | name of template of sections (will be normalized on template external Id) | |||||||||||||||||
defaultLanguage* | string | Templates languages allowed Allowed values: ES, EN, EU, GL, CA, DE, UNDEFINED | |||||||||||||||||
orderedSectionNames* | string[] | list sections external Ids that belongs to the template IN THE ORDER in which they should be concatenated when filled | minItems: 1 | ||||||||||||||||
rules | object[] | defines conditions rules that have to be matched in fill flags values, to allow this section to be filled | |||||||||||||||||
Array items:
| |||||||||||||||||||
Created New template is created. Expected response for a valid request.
{
"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"
}| Property | Type | Description | Constraints | Default | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
externalId* | string | normalized name of template (external id) | |||||||||||||||||
version* | string | Higher version of the template | |||||||||||||||||
defaultLanguage* | string | Templates languages allowed Allowed values: ES, EN, EU, GL, CA, DE, UNDEFINED | |||||||||||||||||
languages* | string[] | list of available languages for the template | minItems: 1 | ||||||||||||||||
orderedSectionNames* | string[] | list sections external Ids that belongs to the template IN THE ORDER in which they should be concatenated when filled | minItems: 1 | ||||||||||||||||
fields* | object[] | list all fields types | uniqueItems | ||||||||||||||||
Array items:
| |||||||||||||||||||
rules | object[] | defines conditions rules that have to be matched in fill flags values, to allow this section to be filled | |||||||||||||||||
Array items:
| |||||||||||||||||||
creationDate* | string (date-time) | date when template was created | |||||||||||||||||
No Content Template created successfully.
Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have fail
Not Found resource not found
Conflict Conflict. Resource already exist
resource is not longer available
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X POST 'https://documents.masstack.com/v1/orgs/masmovil/templates' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"templateName": "contracto_convergente",
"defaultLanguage": "ES",
"orderedSectionNames": [
"introduction",
"personal_data",
"anexo_gdpr"
],
"rules": [
{
"sectionExternalId": "introduction",
"condition": "PREVIEW:ALLOW"
},
{
"sectionExternalId": "anexo_gdpr",
"condition": "GDPR:YES"
}
]
}'Upgrading a template version creating a new one with it is own use contract
PATH PARAMETERS
The string id related with one of Grupo MasOrange tenants
The external id of the template
Metadata for upgrading a template from language sections
{
"defaultLanguage": "ES",
"orderedSectionNames": [
"introduction",
"personal_data",
"contract_gdpr"
],
"rules": [
{
"sectionId": "introduction",
"condition": "PREVIEW:ALLOW"
},
{
"sectionId": "contract_gdpr",
"condition": "GDPR:YES"
}
],
"changelog": "Added new GDPR descriptive text and formatting changes to the contract."
}| Property | Type | Description | Constraints | Default | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
defaultLanguage* | string | Templates languages allowed Allowed values: ES, EN, EU, GL, CA, DE, UNDEFINED | |||||||||||||||||
orderedSectionNames* | string[] | list sections external Ids that belongs to the template IN THE ORDER in which they should be concatenated when filled | minItems: 1 | ||||||||||||||||
rules | object[] | defines conditions rules that have to be matched in fill flags values, to allow this section to be filled | |||||||||||||||||
Array items:
| |||||||||||||||||||
changelog | string | ||||||||||||||||||
Created New version template is created. Expected response for a valid request.
{
"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"
}| Property | Type | Description | Constraints | Default | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
externalId* | string | normalized name of template (external id) | |||||||||||||||||
version* | string | Higher version of the template | |||||||||||||||||
defaultLanguage* | string | Templates languages allowed Allowed values: ES, EN, EU, GL, CA, DE, UNDEFINED | |||||||||||||||||
languages* | string[] | list of available languages for the template | minItems: 1 | ||||||||||||||||
orderedSectionNames* | string[] | list sections external Ids that belongs to the template IN THE ORDER in which they should be concatenated when filled | minItems: 1 | ||||||||||||||||
fields* | object[] | list all fields types | uniqueItems | ||||||||||||||||
Array items:
| |||||||||||||||||||
rules | object[] | defines conditions rules that have to be matched in fill flags values, to allow this section to be filled | |||||||||||||||||
Array items:
| |||||||||||||||||||
creationDate* | string (date-time) | date when template was created | |||||||||||||||||
No Content Template upgraded successfully.
Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have fail
Not Found resource not found
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X POST 'https://documents.masstack.com/v1/orgs/masmovil/templates/contract_sales/versions' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"defaultLanguage": "ES",
"orderedSectionNames": [
"introduction",
"personal_data",
"contract_gdpr"
],
"rules": [
{
"sectionId": "introduction",
"condition": "PREVIEW:ALLOW"
},
{
"sectionId": "contract_gdpr",
"condition": "GDPR:YES"
}
],
"changelog": "Added new GDPR descriptive text and formatting changes to the contract."
}'Update a template version without change use contract
PATH PARAMETERS
The string id related with one of Grupo MasOrange tenants
The external id of the template
version of the template to be updated
Metadata for upgrading a template from language sections
{
"defaultLanguage": "ES",
"orderedSectionNames": [
"introduction",
"personal_data",
"anexo_gdpr"
],
"rules": [
{
"sectionExternalId": "contract_gdpr",
"condition": "GDPR:YES"
}
],
"changelog": "Template change reason description."
}| Property | Type | Description | Constraints | Default | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
defaultLanguage | string | Templates languages allowed Allowed values: ES, EN, EU, GL, CA, DE, UNDEFINED | |||||||||||||||||
orderedSectionNames | string[] | list sections external Ids that belongs to the template IN THE ORDER in which they should be concatenated when filled | minItems: 1 | ||||||||||||||||
rules | object[] | defines conditions rules that have to be matched in fill flags values, to allow this section to be filled | |||||||||||||||||
Array items:
| |||||||||||||||||||
changelog | string | ||||||||||||||||||
Created Version template is updated. Expected response for a valid request.
{
"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"
}| Property | Type | Description | Constraints | Default | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
externalId* | string | normalized name of template (external id) | |||||||||||||||||
version* | string | Higher version of the template | |||||||||||||||||
defaultLanguage* | string | Templates languages allowed Allowed values: ES, EN, EU, GL, CA, DE, UNDEFINED | |||||||||||||||||
languages* | string[] | list of available languages for the template | minItems: 1 | ||||||||||||||||
orderedSectionNames* | string[] | list sections external Ids that belongs to the template IN THE ORDER in which they should be concatenated when filled | minItems: 1 | ||||||||||||||||
fields* | object[] | list all fields types | uniqueItems | ||||||||||||||||
Array items:
| |||||||||||||||||||
rules | object[] | defines conditions rules that have to be matched in fill flags values, to allow this section to be filled | |||||||||||||||||
Array items:
| |||||||||||||||||||
creationDate* | string (date-time) | date when template was created | |||||||||||||||||
No Content Template updated successfully.
Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have fail
Not Found resource not found
Conflict Conflict. Resource already exist
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X PATCH 'https://documents.masstack.com/v1/orgs/masmovil/templates/convergente_particulares/versions/1' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"defaultLanguage": "ES",
"orderedSectionNames": [
"introduction",
"personal_data",
"anexo_gdpr"
],
"rules": [
{
"sectionExternalId": "contract_gdpr",
"condition": "GDPR:YES"
}
],
"changelog": "Template change reason description."
}'Delete the latest major version of a template
PATH PARAMETERS
The string id related with one of Grupo MasOrange tenants
The external id of the template
version of the template to be updated
No Content Template deleted successfully.
Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have fail
Not Found resource not found
Conflict Conflict. Major version can not be deleted, it is not latest
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X DELETE 'https://documents.masstack.com/v1/orgs/masmovil/templates/convergente_particulares/versions/1' \
-H 'Accept: application/json'Delete the latest minor version of a template
PATH PARAMETERS
The string id related with one of Grupo MasOrange tenants
The external id of the template
version of the template to be updated
No Content Template deleted successfully.
Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have fail
Not Found resource not found
Conflict Conflict. Minor version can not be deleted
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X DELETE 'https://documents.masstack.com/v1/orgs/masmovil/templates/convergente_particulares/versions/1/minor' \
-H 'Accept: application/json'Returns the filled template as PDF file, if template exists; else, returns an error message.
PATH PARAMETERS
The string id related with one of Grupo MasOrange tenants
The external id of the template
version of the template to be updated
Metadata to fill a template
{
"language": "ES",
"flagsConditions": [
"GDPR:YES",
"PREVIEW:ALLOW"
],
"fieldsValues": [
{
"name": "string",
"value": "string"
}
],
"fillMode": "default"
}| Property | Type | Description | Constraints | Default | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
language* | string | Templates languages allowed Allowed values: ES, EN, EU, GL, CA, DE, UNDEFINED | |||||||||||||||||
flagsConditions | string[] | list of conditions which trigger specific sections of the template to be filled | minItems: 0 | ||||||||||||||||
fieldsValues* | object[] | form variables whose values will be printed in the filled form | |||||||||||||||||
Array items:
| |||||||||||||||||||
fillMode | string | 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 | |||||||||||||||||
OK The filled template as pdf document. Expected response to a valid request.
"pdf document"Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have fail
Not Found resource not found
resource is not longer available
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Content-Typestringdefines response binary media type
Content-Dispositionstringcontains downloaded filled template
X-Tenant-Config-Versionstringtenant config version used to fill
X-Template-Versionstringtemplate version used to fill
curl -X POST 'https://documents.masstack.com/v1/orgs/masmovil/templates/contract_sales/versions/1/fill' \
-H 'Content-Type: application/json' \
-H 'Accept: application/octet-stream' \
--data-raw '{
"language": "ES",
"flagsConditions": [
"GDPR:YES",
"PREVIEW:ALLOW"
],
"fieldsValues": [
{
"name": "string",
"value": "string"
}
],
"fillMode": "default"
}'Fill a template and return documentId (storage reference)
PATH PARAMETERS
The string id related with one of Grupo MasOrange tenants
The external id of the template
version of the template to be updated
HEADER PARAMETERS
The string id related with the document owner. It is mandatory when document is not public
Metadata to fill a template
{
"language": "ES",
"flagsConditions": [
"GDPR:YES",
"PREVIEW:ALLOW"
],
"fieldsValues": [
{
"name": "string",
"value": "string"
}
],
"name": "personal_contract",
"tags": [
"DRAFT"
],
"fillMode": "default",
"flatten": true
}| Property | Type | Description | Constraints | Default | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
language* | string | Templates languages allowed Allowed values: ES, EN, EU, GL, CA, DE, UNDEFINED | |||||||||||||||||
flagsConditions | string[] | list of conditions which trigger specific sections of the template to be filled | minItems: 0 | ||||||||||||||||
fieldsValues* | object[] | form variables whose values will be printed in the filled form | |||||||||||||||||
Array items:
| |||||||||||||||||||
name | string | Name of the document (without spaces). The document is renamed with this value. | |||||||||||||||||
tags | string[] | 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 | maxItems: 5, uniqueItems | ||||||||||||||||
fillMode | string | 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 | boolean | Describes if the filled template will be flattened or not. | true | ||||||||||||||||
OK The filled template as pdf document. Expected response to a valid request.
{
"documentId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"renamedKeys": [
{
"currentName": "SUBSCRIPTION_ID_212",
"originalName": "SUBSCRIPTION_ID"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
documentId* | string (uuid) | Document unique identifier | |||||||||||||||||
renamedKeys* | object[] | List of template keys which name has changed from original template | minItems: 0 | ||||||||||||||||
Array items:
| |||||||||||||||||||
Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have fail
Not Found resource not found
resource is not longer available
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
X-Tenant-Config-Versionstringtenant config version used to fill
X-Template-Versionstringtemplate version used to fill
curl -X POST 'https://documents.masstack.com/v1/orgs/masmovil/templates/contract_sales/versions/1/fill/documents' \
-H 'x-auth-owner: 2357893' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"language": "ES",
"flagsConditions": [
"GDPR:YES",
"PREVIEW:ALLOW"
],
"fieldsValues": [
{
"name": "string",
"value": "string"
}
],
"name": "personal_contract",
"tags": [
"DRAFT"
],
"fillMode": "default",
"flatten": true
}'Get template metadata by template external id. This endpoint returns the same response as create template endpoint.
PATH PARAMETERS
The string id related with one of Grupo MasOrange tenants
The external id of the desired template
version of the template
QUERY PARAMETERS
Define extra options to include in response. Values: * 'history': return all versions (previous minor versions) of a major template version
OK The template metadata is returned. Expected response for a valid request.
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
templates | object[] | List of templates metadatas | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have fail
Not Found resource not found
resource is not longer available
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://documents.masstack.com/v1/orgs/masmovil/templates/ifcc_template/versions/1/metadata?include=include%3Dhistory' \
-H 'Accept: application/json'Get template change log history by template's external id.
PATH PARAMETERS
The string id related with one of Grupo MasOrange tenants
The external id of the desired template
OK The template changelog history is returned. Expected response for a valid request.
{
"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."
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
changelogHistory* | object[] | list of all template's version changes with its changelog and date | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have fail
Not Found resource not found
resource is not longer available
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://documents.masstack.com/v1/orgs/masmovil/templates/ifcc_template/changelog' \
-H 'Accept: application/json'Get all configuration documents
PATH PARAMETERS
The string id related with one of Grupo MasOrange tenants
OK Tenant all templates configurations
{
"totalResults": "100",
"currentPage": 0,
"items": [
{
"id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"name": "new_logo_mm",
"extension": "png",
"creationDate": "2022-08-21T17:32:28Z"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
totalResults* | integer | Number of total forms to get | |||||||||||||||||||||||||||
currentPage* | integer | Current page | |||||||||||||||||||||||||||
items* | object[] | List of configuration documents | uniqueItems | ||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have fail
Unprocessable Entity Request input can not be processed (is incomplete)
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://documents.masstack.com/v1/orgs/masmovil/templates/configurations/documents' \
-H 'Accept: application/json'Upload a new document to be used in templates
PATH PARAMETERS
The string id related with one of Grupo MasOrange tenants
QUERY PARAMETERS
Defines templates configuration page number to be show. If not defined, default value is 0 (first page).
Defines the number of items returned in each page. If not defined, default value is 50.
Filter by document name
Filter by document extension
Define configuration fields with value by language
{
"name": "new_logo",
"extension": "jpg"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
name* | string | Name of the document (without spaces). | ||
extension* | string | Format of the document to be stored. It must match the format of the binary Allowed values: jpeg, jpg, png | ||
content* | string (binary) | Document content in binary format |
OK Configuration is created. Expected response for a valid request.
{
"id": "d290f1ee-6c54-4b01-90e6-d701748f0851"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
id* | string (uuid) | Templates document unique identifier |
Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have fail
Unprocessable Entity Request input can not be processed (is incomplete)
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X POST 'https://documents.masstack.com/v1/orgs/masmovil/templates/configurations/documents?page=0&pageSize=1&name=my_logo&extension=png' \
-H 'Accept: application/json' \
-F 'name=masorange_logo' \
-F 'extension=pdf' \
-F 'content=@/path/to/file;type=image/png, image/jpeg'Get all tenant templates configurations
PATH PARAMETERS
The string id related with one of Grupo MasOrange tenants
QUERY PARAMETERS
Defines templates configuration page number to be show. If not defined, default value is 0 (first page).
Defines the number of items returned in each page. If not defined, default value is 50.
OK Tenant all templates configurations
{
"totalResults": "100",
"currentPage": 0,
"configurations": [
{
"version": 1,
"changelog": "TEXT",
"creationDate": "2022-08-21T17:32:28Z"
}
]
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
totalResults* | integer | Number of total forms to get | ||||||||||||||||||||||
currentPage* | integer | Current page | ||||||||||||||||||||||
configurations* | object[] | List of forms metadata | uniqueItems | |||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||
Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have fail
Unprocessable Entity Request input can not be processed (is incomplete)
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://documents.masstack.com/v1/orgs/masmovil/templates/configurations?page=0&pageSize=1' \
-H 'Accept: application/json'Create or update a tenant templates configuration
PATH PARAMETERS
The string id related with one of Grupo MasOrange tenants
Define configuration fields with value by language
{
"changelog": "TEXT",
"defaultLanguage": "ES",
"fieldValues": [
{
"name": "CONFIG_TENANT.SOCIAL_REASON",
"type": "TEXT",
"value": [
{
"language": "ES",
"content": "Avenida de Bruselas 38, Alcobendas, Madrid"
}
]
}
]
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
changelog | string | Description of the template change in this version | ||||||||||||||||||||||||||||||||||||||||||
defaultLanguage* | string | Templates languages allowed Allowed values: ES, EN, EU, GL, CA, DE, UNDEFINED | ||||||||||||||||||||||||||||||||||||||||||
fieldValues* | object[] | Configuration fields with default values by language | minItems: 1, uniqueItems | |||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||
OK Configuration is created. Expected response for a valid request.
{
"version": 1
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
version* | integer | Defines template configuration version (initial version is '1') |
Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have fail
Unprocessable Entity Request input can not be processed (is incomplete)
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X POST 'https://documents.masstack.com/v1/orgs/masmovil/templates/configurations' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"changelog": "TEXT",
"defaultLanguage": "ES",
"fieldValues": [
{
"name": "CONFIG_TENANT.SOCIAL_REASON",
"type": "TEXT",
"value": [
{
"language": "ES",
"content": "Avenida de Bruselas 38, Alcobendas, Madrid"
}
]
}
]
}'Get tenant templates configuration
PATH PARAMETERS
The string id related with one of Grupo MasOrange tenants
Higher version of the template. You can use also 'latest' to get latest version
OK Tenant templates configuration
{
"defaultLanguage": "ES",
"fieldValues": [
{
"name": "CONFIG_TENANT.SOCIAL_REASON",
"type": "TEXT",
"value": [
{
"language": "ES",
"content": "Avenida de Bruselas 38, Alcobendas, Madrid"
}
]
}
]
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
defaultLanguage* | string | Templates languages allowed Allowed values: ES, EN, EU, GL, CA, DE, UNDEFINED | ||||||||||||||||||||||||||||||||||||||||||
fieldValues* | object[] | Configuration fields with default values by language | minItems: 1, uniqueItems | |||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||
Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have fail
Not Found resource not found
Unprocessable Entity Request input can not be processed (is incomplete)
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://documents.masstack.com/v1/orgs/masmovil/templates/configurations/1' \
-H 'Accept: application/json'Delete template configuration by version
PATH PARAMETERS
The string id related with one of Grupo MasOrange tenants
Version of the template configuration.
No Content Action executed correctly
Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have fail
Not Found resource not found
Conflict conflict if form is in some section
Unprocessable Entity Request input can not be processed (is incomplete)
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X DELETE 'https://documents.masstack.com/v1/orgs/masmovil/templates/configurations/1' \
-H 'Accept: application/json'Returns a paginated list of all dynamic templates for an organization. Only the latest version of each major version (the ones that could be edited) is included, ordered by creation_date in descending order.
PATH PARAMETERS
The string id related with one of Grupo MasOrange tenants
QUERY PARAMETERS
Optional filter to retrieve templates for a specific external_id
Defines templates page number to be show. If not defined, default value is 0 (first page).
Defines the number of templates returned in each page. If not defined, default value is 50.
OK The templates list is returned. Expected response for a valid request.
{
"page": 0,
"page_size": 20,
"templates": [
{
"external_id": "factura_bilingue_premium",
"description": "Plantilla para facturas en Español e Inglés.",
"version": "2.7",
"default_language": "ES",
"languages": [
"ES"
],
"creation_date": "2025-09-22T10:00:00Z"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
page* | integer | Page to be shown | min: 0 | 0 | |||||||||||||||||||||||||||||||||||
page_size* | integer | Number of templates that will be shown by page | min: 1 | 50 | |||||||||||||||||||||||||||||||||||
templates* | object[] | ||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||
Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have failed
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://documents.masstack.com/v1/orgs/masmovil/dynamic_templates?external_id=factura_mensual&page=0&page_size=20' \
-H 'Accept: application/json'Creates a new dynamic template by uploading HBS and JSON configuration files for multiple languages. The structure (JSON schema) is provided as part of each source metadata, extracted from the template editor. The system validates the structure and persists the template with version 1.0.
PATH PARAMETERS
The string id related with one of Grupo MasOrange tenants
Template metadata and sources (HBS and JSON files) for each language. Each source includes the pre-extracted structure with fields, rules, and engine version.
{
"metadata": {
"external_id": "factura_bilingue_premium",
"description": "Plantilla para facturas en Español e Inglés.",
"default_language": "ES",
"tags": [
"factura",
"multi-idioma"
],
"sources": [
{
"language": "ES",
"template_part_name": "string",
"editor_config_part_name": "string",
"structure": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"CUSTOMER": {
"type": "object",
"properties": {
"DNI": {
"type": "string"
},
"NAME": {
"type": "string"
},
"EMAIL": {
"type": "string",
"format": "email"
},
"ADDRESS": {
"type": "object",
"properties": {
"CITY": {
"type": "string"
},
"COORDINATES": {
"type": "object",
"properties": {
"LATITUDE": {
"type": "number"
},
"LONGITUDE": {
"type": "number"
}
}
}
}
}
},
"required": [
"dni",
"name"
]
},
"CONTRACT_DATE": {
"type": "string",
"format": "date-time"
},
"TAGS": {
"type": "array",
"items": {
"type": "string"
}
},
"PRODUCTS": {
"type": "array",
"items": {
"type": "object",
"properties": {
"NAME": {
"type": "string"
},
"PRICE": {
"type": "number"
},
"QUANTITY": {
"type": "integer"
}
},
"required": [
"NAME",
"PRICE"
]
}
},
"TOTAL_AMOUNT": {
"type": "number"
},
"HAS_DISCOUNT": {
"type": "boolean"
},
"DISCOUNT_AMOUNT": {
"type": "number"
},
"PAYMENT_METHOD": {
"type": "string",
"enum": [
"bank_transfer",
"card",
"mobile_payment"
]
},
"IBAN": {
"type": "string"
},
"CARD_LAST_DIGITS": {
"type": "string"
},
"MOBILE_PAYMENT_TYPE": {
"type": "string"
},
"MOBILE_PHONE": {
"type": "string"
},
"MOBILE_WALLET_ID": {
"type": "string"
}
},
"required": [
"CUSTOMER",
"PRODUCTS",
"TOTAL_AMOUNT",
"PAYMENT_METHOD"
],
"additionalProperties": false,
"allOf": [
{
"if": {
"properties": {
"HAS_DISCOUNT": {
"const": true
}
}
},
"then": {
"required": [
"DISCOUNT_AMOUNT"
]
}
},
{
"if": {
"properties": {
"PAYMENT_METHOD": {
"const": "BANK_TRANSFER"
}
}
},
"then": {
"required": [
"IBAN"
]
}
},
{
"if": {
"properties": {
"PAYMENT_METHOD": {
"const": "card"
}
}
},
"then": {
"required": [
"CARD_LAST_DIGITS"
]
}
},
{
"if": {
"properties": {
"PAYMENT_METHOD": {
"const": "mobile_payment"
}
}
},
"then": {
"required": [
"MOBILE_PAYMENT_TYPE"
],
"oneOf": [
{
"properties": {
"MOBILE_PAYMENT_TYPE": {
"const": "bizum"
}
},
"required": [
"MOBILE_PHONE"
]
},
{
"properties": {
"MOBILE_PAYMENT_TYPE": {
"const": "wallet"
}
},
"required": [
"MOBILE_WALLET_ID"
]
}
]
}
}
]
},
"engine_version": "3.12"
}
]
},
"files": [
"string"
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata* | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
files | string (binary)[] | Array of template and editor config files for each language | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Created New dynamic template is created. Expected response for a valid request.
{
"external_id": "factura_bilingue_premium",
"description": "Plantilla para facturas en Español e Inglés.",
"version": "1.0",
"default_language": "ES",
"languages": [
"ES",
"EN"
],
"tags": [
"factura",
"multi-idioma"
],
"creation_date": "2025-08-29T08:50:00Z"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
external_id* | string | Unique identifier for the template. Must be lowercase, numbers, and underscores only. | ||
description* | string | Human-readable description of the template | ||
version* | string | Template version | ||
default_language* | string | Language of the template in ISO 639-1 format. Possible values: ES, EN, EU, GL, CA, DE, UNDEFINED Not all values are available to all organizations. | ||
languages* | string[] | Supported languages | ||
tags | string[] | Free values (user-defined) to tag dynamic template. Maximum 5 tags allowed. | minItems: 0, maxItems: 5, uniqueItems | |
creation_date* | string (date-time) | Template creation date |
Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have failed
Conflict Conflict. External ID already exists
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X POST 'https://documents.masstack.com/v1/orgs/masmovil/dynamic_templates' \
-H 'Content-Type: multipart/mixed' \
-H 'Accept: application/json' \
--data-raw '{
"metadata": {
"external_id": "factura_bilingue_premium",
"description": "Plantilla para facturas en Español e Inglés.",
"default_language": "ES",
"tags": [
"factura",
"multi-idioma"
],
"sources": [
{
"language": "ES",
"template_part_name": "string",
"editor_config_part_name": "string",
"structure": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"CUSTOMER": {
"type": "object",
"properties": {
"DNI": {
"type": "string"
},
"NAME": {
"type": "string"
},
"EMAIL": {
"type": "string",
"format": "email"
},
"ADDRESS": {
"type": "object",
"properties": {
"CITY": {
"type": "string"
},
"COORDINATES": {
"type": "object",
"properties": {
"LATITUDE": {
"type": "number"
},
"LONGITUDE": {
"type": "number"
}
}
}
}
}
},
"required": [
"dni",
"name"
]
},
"CONTRACT_DATE": {
"type": "string",
"format": "date-time"
},
"TAGS": {
"type": "array",
"items": {
"type": "string"
}
},
"PRODUCTS": {
"type": "array",
"items": {
"type": "object",
"properties": {
"NAME": {
"type": "string"
},
"PRICE": {
"type": "number"
},
"QUANTITY": {
"type": "integer"
}
},
"required": [
"NAME",
"PRICE"
]
}
},
"TOTAL_AMOUNT": {
"type": "number"
},
"HAS_DISCOUNT": {
"type": "boolean"
},
"DISCOUNT_AMOUNT": {
"type": "number"
},
"PAYMENT_METHOD": {
"type": "string",
"enum": [
"bank_transfer",
"card",
"mobile_payment"
]
},
"IBAN": {
"type": "string"
},
"CARD_LAST_DIGITS": {
"type": "string"
},
"MOBILE_PAYMENT_TYPE": {
"type": "string"
},
"MOBILE_PHONE": {
"type": "string"
},
"MOBILE_WALLET_ID": {
"type": "string"
}
},
"required": [
"CUSTOMER",
"PRODUCTS",
"TOTAL_AMOUNT",
"PAYMENT_METHOD"
],
"additionalProperties": false,
"allOf": [
{
"if": {
"properties": {
"HAS_DISCOUNT": {
"const": true
}
}
},
"then": {
"required": [
"DISCOUNT_AMOUNT"
]
}
},
{
"if": {
"properties": {
"PAYMENT_METHOD": {
"const": "BANK_TRANSFER"
}
}
},
"then": {
"required": [
"IBAN"
]
}
},
{
"if": {
"properties": {
"PAYMENT_METHOD": {
"const": "card"
}
}
},
"then": {
"required": [
"CARD_LAST_DIGITS"
]
}
},
{
"if": {
"properties": {
"PAYMENT_METHOD": {
"const": "mobile_payment"
}
}
},
"then": {
"required": [
"MOBILE_PAYMENT_TYPE"
],
"oneOf": [
{
"properties": {
"MOBILE_PAYMENT_TYPE": {
"const": "bizum"
}
},
"required": [
"MOBILE_PHONE"
]
},
{
"properties": {
"MOBILE_PAYMENT_TYPE": {
"const": "wallet"
}
},
"required": [
"MOBILE_WALLET_ID"
]
}
]
}
}
]
},
"engine_version": "3.12"
}
]
},
"files": [
"string"
]
}'Returns all minor versions for a specific major version of a dynamic template, ordered by minor version in descending order (newest to oldest). Includes JSON schema extracted from the template file.
PATH PARAMETERS
The string id related with one of Grupo MasOrange tenants
The external id of the dynamic template
The major version number
OK The template versions are returned. Expected response for a valid request.
{
"templates": [
{
"external_id": "factura_bilingue_premium",
"description": "Plantilla para facturas en Español e Inglés.",
"version": "1.1",
"default_language": "ES",
"languages": [
"ES",
"EN"
],
"tags": [
"factura",
"multi-idioma"
],
"creation_date": "2025-09-22T10:00:00Z",
"structure": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"CUSTOMER": {
"type": "object",
"properties": {
"DNI": {
"type": "string"
},
"NAME": {
"type": "string"
},
"EMAIL": {
"type": "string",
"format": "email"
},
"ADDRESS": {
"type": "object",
"properties": {
"CITY": {
"type": "string"
},
"COORDINATES": {
"type": "object",
"properties": {
"LATITUDE": {
"type": "number"
},
"LONGITUDE": {
"type": "number"
}
}
}
}
}
},
"required": [
"dni",
"name"
]
},
"CONTRACT_DATE": {
"type": "string",
"format": "date-time"
},
"TAGS": {
"type": "array",
"items": {
"type": "string"
}
},
"PRODUCTS": {
"type": "array",
"items": {
"type": "object",
"properties": {
"NAME": {
"type": "string"
},
"PRICE": {
"type": "number"
},
"QUANTITY": {
"type": "integer"
}
},
"required": [
"NAME",
"PRICE"
]
}
},
"TOTAL_AMOUNT": {
"type": "number"
},
"HAS_DISCOUNT": {
"type": "boolean"
},
"DISCOUNT_AMOUNT": {
"type": "number"
},
"PAYMENT_METHOD": {
"type": "string",
"enum": [
"bank_transfer",
"card",
"mobile_payment"
]
},
"IBAN": {
"type": "string"
},
"CARD_LAST_DIGITS": {
"type": "string"
},
"MOBILE_PAYMENT_TYPE": {
"type": "string"
},
"MOBILE_PHONE": {
"type": "string"
},
"MOBILE_WALLET_ID": {
"type": "string"
}
},
"required": [
"CUSTOMER",
"PRODUCTS",
"TOTAL_AMOUNT",
"PAYMENT_METHOD"
],
"additionalProperties": false,
"allOf": [
{
"if": {
"properties": {
"HAS_DISCOUNT": {
"const": true
}
}
},
"then": {
"required": [
"DISCOUNT_AMOUNT"
]
}
},
{
"if": {
"properties": {
"PAYMENT_METHOD": {
"const": "BANK_TRANSFER"
}
}
},
"then": {
"required": [
"IBAN"
]
}
},
{
"if": {
"properties": {
"PAYMENT_METHOD": {
"const": "card"
}
}
},
"then": {
"required": [
"CARD_LAST_DIGITS"
]
}
},
{
"if": {
"properties": {
"PAYMENT_METHOD": {
"const": "mobile_payment"
}
}
},
"then": {
"required": [
"MOBILE_PAYMENT_TYPE"
],
"oneOf": [
{
"properties": {
"MOBILE_PAYMENT_TYPE": {
"const": "bizum"
}
},
"required": [
"MOBILE_PHONE"
]
},
{
"properties": {
"MOBILE_PAYMENT_TYPE": {
"const": "wallet"
}
},
"required": [
"MOBILE_WALLET_ID"
]
}
]
}
}
]
},
"sources": [
{
"language": "ES",
"template_url": "https://storage.googleapis.com/.../v1.1_es.html",
"editor_config_url": "https://storage.googleapis.com/.../v1.1_es.json",
"engine_version": "2.0"
}
]
}
]
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
templates* | object[] | minItems: 1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have failed
Not Found Template or version not found
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://documents.masstack.com/v1/orgs/masmovil/dynamic_templates/factura_mensual/versions/1' \
-H 'Accept: application/json'Creates a new minor version of an existing dynamic template with non-breaking changes such as adding new languages or updating existing language content. Breaking changes like modifying the JSON schema structure, removing sources or changing default language will result in a 409 error.
PATH PARAMETERS
The string id related with one of Grupo MasOrange tenants
The external id of the dynamic template
The major version number
Template metadata and sources for creating a minor version
{
"metadata": {
"description": "Plantilla actualizada con soporte para Catalán.",
"sources": [
{
"language": "ES",
"template_part_name": "string",
"editor_config_part_name": "string",
"structure": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"CUSTOMER": {
"type": "object",
"properties": {
"DNI": {
"type": "string"
},
"NAME": {
"type": "string"
},
"EMAIL": {
"type": "string",
"format": "email"
},
"ADDRESS": {
"type": "object",
"properties": {
"CITY": {
"type": "string"
},
"COORDINATES": {
"type": "object",
"properties": {
"LATITUDE": {
"type": "number"
},
"LONGITUDE": {
"type": "number"
}
}
}
}
}
},
"required": [
"dni",
"name"
]
},
"CONTRACT_DATE": {
"type": "string",
"format": "date-time"
},
"TAGS": {
"type": "array",
"items": {
"type": "string"
}
},
"PRODUCTS": {
"type": "array",
"items": {
"type": "object",
"properties": {
"NAME": {
"type": "string"
},
"PRICE": {
"type": "number"
},
"QUANTITY": {
"type": "integer"
}
},
"required": [
"NAME",
"PRICE"
]
}
},
"TOTAL_AMOUNT": {
"type": "number"
},
"HAS_DISCOUNT": {
"type": "boolean"
},
"DISCOUNT_AMOUNT": {
"type": "number"
},
"PAYMENT_METHOD": {
"type": "string",
"enum": [
"bank_transfer",
"card",
"mobile_payment"
]
},
"IBAN": {
"type": "string"
},
"CARD_LAST_DIGITS": {
"type": "string"
},
"MOBILE_PAYMENT_TYPE": {
"type": "string"
},
"MOBILE_PHONE": {
"type": "string"
},
"MOBILE_WALLET_ID": {
"type": "string"
}
},
"required": [
"CUSTOMER",
"PRODUCTS",
"TOTAL_AMOUNT",
"PAYMENT_METHOD"
],
"additionalProperties": false,
"allOf": [
{
"if": {
"properties": {
"HAS_DISCOUNT": {
"const": true
}
}
},
"then": {
"required": [
"DISCOUNT_AMOUNT"
]
}
},
{
"if": {
"properties": {
"PAYMENT_METHOD": {
"const": "BANK_TRANSFER"
}
}
},
"then": {
"required": [
"IBAN"
]
}
},
{
"if": {
"properties": {
"PAYMENT_METHOD": {
"const": "card"
}
}
},
"then": {
"required": [
"CARD_LAST_DIGITS"
]
}
},
{
"if": {
"properties": {
"PAYMENT_METHOD": {
"const": "mobile_payment"
}
}
},
"then": {
"required": [
"MOBILE_PAYMENT_TYPE"
],
"oneOf": [
{
"properties": {
"MOBILE_PAYMENT_TYPE": {
"const": "bizum"
}
},
"required": [
"MOBILE_PHONE"
]
},
{
"properties": {
"MOBILE_PAYMENT_TYPE": {
"const": "wallet"
}
},
"required": [
"MOBILE_WALLET_ID"
]
}
]
}
}
]
},
"engine_version": "3.12"
}
],
"changelog": "Added Catalan language support"
},
"files": [
"string"
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata* | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
files | string (binary)[] | Array of template and editor config files for each language | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
OK New minor version is created. Expected response for a valid request.
{
"external_id": "factura_bilingue_premium",
"description": "Plantilla para facturas en Español e Inglés.",
"version": "1.0",
"default_language": "ES",
"languages": [
"ES",
"EN"
],
"tags": [
"factura",
"multi-idioma"
],
"creation_date": "2025-08-29T08:50:00Z"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
external_id* | string | Unique identifier for the template. Must be lowercase, numbers, and underscores only. | ||
description* | string | Human-readable description of the template | ||
version* | string | Template version | ||
default_language* | string | Language of the template in ISO 639-1 format. Possible values: ES, EN, EU, GL, CA, DE, UNDEFINED Not all values are available to all organizations. | ||
languages* | string[] | Supported languages | ||
tags | string[] | Free values (user-defined) to tag dynamic template. Maximum 5 tags allowed. | minItems: 0, maxItems: 5, uniqueItems | |
creation_date* | string (date-time) | Template creation date |
Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have failed
Not Found Template not found
Conflict Breaking changes detected. Use major version endpoint instead.
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X PATCH 'https://documents.masstack.com/v1/orgs/masmovil/dynamic_templates/factura_mensual/versions/1' \
-H 'Content-Type: multipart/mixed' \
-H 'Accept: application/json' \
--data-raw '{
"metadata": {
"description": "Plantilla actualizada con soporte para Catalán.",
"sources": [
{
"language": "ES",
"template_part_name": "string",
"editor_config_part_name": "string",
"structure": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"CUSTOMER": {
"type": "object",
"properties": {
"DNI": {
"type": "string"
},
"NAME": {
"type": "string"
},
"EMAIL": {
"type": "string",
"format": "email"
},
"ADDRESS": {
"type": "object",
"properties": {
"CITY": {
"type": "string"
},
"COORDINATES": {
"type": "object",
"properties": {
"LATITUDE": {
"type": "number"
},
"LONGITUDE": {
"type": "number"
}
}
}
}
}
},
"required": [
"dni",
"name"
]
},
"CONTRACT_DATE": {
"type": "string",
"format": "date-time"
},
"TAGS": {
"type": "array",
"items": {
"type": "string"
}
},
"PRODUCTS": {
"type": "array",
"items": {
"type": "object",
"properties": {
"NAME": {
"type": "string"
},
"PRICE": {
"type": "number"
},
"QUANTITY": {
"type": "integer"
}
},
"required": [
"NAME",
"PRICE"
]
}
},
"TOTAL_AMOUNT": {
"type": "number"
},
"HAS_DISCOUNT": {
"type": "boolean"
},
"DISCOUNT_AMOUNT": {
"type": "number"
},
"PAYMENT_METHOD": {
"type": "string",
"enum": [
"bank_transfer",
"card",
"mobile_payment"
]
},
"IBAN": {
"type": "string"
},
"CARD_LAST_DIGITS": {
"type": "string"
},
"MOBILE_PAYMENT_TYPE": {
"type": "string"
},
"MOBILE_PHONE": {
"type": "string"
},
"MOBILE_WALLET_ID": {
"type": "string"
}
},
"required": [
"CUSTOMER",
"PRODUCTS",
"TOTAL_AMOUNT",
"PAYMENT_METHOD"
],
"additionalProperties": false,
"allOf": [
{
"if": {
"properties": {
"HAS_DISCOUNT": {
"const": true
}
}
},
"then": {
"required": [
"DISCOUNT_AMOUNT"
]
}
},
{
"if": {
"properties": {
"PAYMENT_METHOD": {
"const": "BANK_TRANSFER"
}
}
},
"then": {
"required": [
"IBAN"
]
}
},
{
"if": {
"properties": {
"PAYMENT_METHOD": {
"const": "card"
}
}
},
"then": {
"required": [
"CARD_LAST_DIGITS"
]
}
},
{
"if": {
"properties": {
"PAYMENT_METHOD": {
"const": "mobile_payment"
}
}
},
"then": {
"required": [
"MOBILE_PAYMENT_TYPE"
],
"oneOf": [
{
"properties": {
"MOBILE_PAYMENT_TYPE": {
"const": "bizum"
}
},
"required": [
"MOBILE_PHONE"
]
},
{
"properties": {
"MOBILE_PAYMENT_TYPE": {
"const": "wallet"
}
},
"required": [
"MOBILE_WALLET_ID"
]
}
]
}
}
]
},
"engine_version": "3.12"
}
],
"changelog": "Added Catalan language support"
},
"files": [
"string"
]
}'Deletes a complete major version line including all its minor versions. Only the latest major version can be deleted.
PATH PARAMETERS
The string id related with one of Grupo MasOrange tenants
The external id of the dynamic template
The major version number
No Content Major version deleted successfully
Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have failed
Not Found Template or version not found
Conflict Cannot delete. Not the latest major version.
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X DELETE 'https://documents.masstack.com/v1/orgs/masmovil/dynamic_templates/factura_mensual/versions/1' \
-H 'Accept: application/json'Returns complete information for a specific minor version of a dynamic template, including JSON schema and source URLs for rendering or analysis.
PATH PARAMETERS
The string id related with one of Grupo MasOrange tenants
The external id of the dynamic template
The major version number
The minor version number
OK The specific template version details are returned. Expected response for a valid request.
{
"external_id": "factura_bilingue_premium",
"description": "Plantilla para facturas en Español e Inglés.",
"version": "1.1",
"default_language": "ES",
"languages": [
"ES",
"EN"
],
"tags": [
"factura",
"multi-idioma"
],
"creation_date": "2025-09-22T10:00:00Z",
"structure": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"CUSTOMER": {
"type": "object",
"properties": {
"DNI": {
"type": "string"
},
"NAME": {
"type": "string"
},
"EMAIL": {
"type": "string",
"format": "email"
},
"ADDRESS": {
"type": "object",
"properties": {
"CITY": {
"type": "string"
},
"COORDINATES": {
"type": "object",
"properties": {
"LATITUDE": {
"type": "number"
},
"LONGITUDE": {
"type": "number"
}
}
}
}
}
},
"required": [
"dni",
"name"
]
},
"CONTRACT_DATE": {
"type": "string",
"format": "date-time"
},
"TAGS": {
"type": "array",
"items": {
"type": "string"
}
},
"PRODUCTS": {
"type": "array",
"items": {
"type": "object",
"properties": {
"NAME": {
"type": "string"
},
"PRICE": {
"type": "number"
},
"QUANTITY": {
"type": "integer"
}
},
"required": [
"NAME",
"PRICE"
]
}
},
"TOTAL_AMOUNT": {
"type": "number"
},
"HAS_DISCOUNT": {
"type": "boolean"
},
"DISCOUNT_AMOUNT": {
"type": "number"
},
"PAYMENT_METHOD": {
"type": "string",
"enum": [
"bank_transfer",
"card",
"mobile_payment"
]
},
"IBAN": {
"type": "string"
},
"CARD_LAST_DIGITS": {
"type": "string"
},
"MOBILE_PAYMENT_TYPE": {
"type": "string"
},
"MOBILE_PHONE": {
"type": "string"
},
"MOBILE_WALLET_ID": {
"type": "string"
}
},
"required": [
"CUSTOMER",
"PRODUCTS",
"TOTAL_AMOUNT",
"PAYMENT_METHOD"
],
"additionalProperties": false,
"allOf": [
{
"if": {
"properties": {
"HAS_DISCOUNT": {
"const": true
}
}
},
"then": {
"required": [
"DISCOUNT_AMOUNT"
]
}
},
{
"if": {
"properties": {
"PAYMENT_METHOD": {
"const": "BANK_TRANSFER"
}
}
},
"then": {
"required": [
"IBAN"
]
}
},
{
"if": {
"properties": {
"PAYMENT_METHOD": {
"const": "card"
}
}
},
"then": {
"required": [
"CARD_LAST_DIGITS"
]
}
},
{
"if": {
"properties": {
"PAYMENT_METHOD": {
"const": "mobile_payment"
}
}
},
"then": {
"required": [
"MOBILE_PAYMENT_TYPE"
],
"oneOf": [
{
"properties": {
"MOBILE_PAYMENT_TYPE": {
"const": "bizum"
}
},
"required": [
"MOBILE_PHONE"
]
},
{
"properties": {
"MOBILE_PAYMENT_TYPE": {
"const": "wallet"
}
},
"required": [
"MOBILE_WALLET_ID"
]
}
]
}
}
]
},
"sources": [
{
"language": "ES",
"template_url": "https://storage.googleapis.com/.../v1.1_es.html",
"editor_config_url": "https://storage.googleapis.com/.../v1.1_es.json",
"engine_version": "2.0"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
external_id* | string | Unique identifier for the template. Must be lowercase, numbers, and underscores only. | |||||||||||||||||||||||||||
description* | string | Human-readable description of the template | |||||||||||||||||||||||||||
version* | string | Current template version | |||||||||||||||||||||||||||
default_language* | string | Language of the template in ISO 639-1 format. Possible values: ES, EN, EU, GL, CA, DE, UNDEFINED Not all values are available to all organizations. | |||||||||||||||||||||||||||
languages* | string[] | Supported languages | |||||||||||||||||||||||||||
tags* | string[] | Free values (user-defined) to tag dynamic template. Maximum 5 tags allowed. | minItems: 0, maxItems: 5, uniqueItems | ||||||||||||||||||||||||||
creation_date* | string (date-time) | Version creation date | |||||||||||||||||||||||||||
structure* | object | Complete JSON Schema defining the structure and validation rules for the template's data. Includes field definitions in 'properties', required fields, and conditional rules using 'allOf', 'if/then', 'oneOf'. | |||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||
sources* | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have failed
Not Found Template or version not found
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://documents.masstack.com/v1/orgs/masmovil/dynamic_templates/factura_mensual/versions/1/minors/1' \
-H 'Accept: application/json'Creates a new major version of an existing dynamic template with breaking changes. All languages must be provided with their sources. The new version will be X+1.0 where X is the highest existing major version. All new information in the template must be provided, as the information from the previous version will not be kept.
PATH PARAMETERS
The string id related with one of Grupo MasOrange tenants
The external id of the dynamic template
Template metadata and sources for creating a major version
{
"metadata": {
"description": "Plantilla para facturas en Español e Inglés.",
"default_language": "ES",
"tags": [
"factura",
"multi-idioma"
],
"sources": [
{
"language": "ES",
"template_part_name": "string",
"editor_config_part_name": "string",
"structure": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"CUSTOMER": {
"type": "object",
"properties": {
"DNI": {
"type": "string"
},
"NAME": {
"type": "string"
},
"EMAIL": {
"type": "string",
"format": "email"
},
"ADDRESS": {
"type": "object",
"properties": {
"CITY": {
"type": "string"
},
"COORDINATES": {
"type": "object",
"properties": {
"LATITUDE": {
"type": "number"
},
"LONGITUDE": {
"type": "number"
}
}
}
}
}
},
"required": [
"dni",
"name"
]
},
"CONTRACT_DATE": {
"type": "string",
"format": "date-time"
},
"TAGS": {
"type": "array",
"items": {
"type": "string"
}
},
"PRODUCTS": {
"type": "array",
"items": {
"type": "object",
"properties": {
"NAME": {
"type": "string"
},
"PRICE": {
"type": "number"
},
"QUANTITY": {
"type": "integer"
}
},
"required": [
"NAME",
"PRICE"
]
}
},
"TOTAL_AMOUNT": {
"type": "number"
},
"HAS_DISCOUNT": {
"type": "boolean"
},
"DISCOUNT_AMOUNT": {
"type": "number"
},
"PAYMENT_METHOD": {
"type": "string",
"enum": [
"bank_transfer",
"card",
"mobile_payment"
]
},
"IBAN": {
"type": "string"
},
"CARD_LAST_DIGITS": {
"type": "string"
},
"MOBILE_PAYMENT_TYPE": {
"type": "string"
},
"MOBILE_PHONE": {
"type": "string"
},
"MOBILE_WALLET_ID": {
"type": "string"
}
},
"required": [
"CUSTOMER",
"PRODUCTS",
"TOTAL_AMOUNT",
"PAYMENT_METHOD"
],
"additionalProperties": false,
"allOf": [
{
"if": {
"properties": {
"HAS_DISCOUNT": {
"const": true
}
}
},
"then": {
"required": [
"DISCOUNT_AMOUNT"
]
}
},
{
"if": {
"properties": {
"PAYMENT_METHOD": {
"const": "BANK_TRANSFER"
}
}
},
"then": {
"required": [
"IBAN"
]
}
},
{
"if": {
"properties": {
"PAYMENT_METHOD": {
"const": "card"
}
}
},
"then": {
"required": [
"CARD_LAST_DIGITS"
]
}
},
{
"if": {
"properties": {
"PAYMENT_METHOD": {
"const": "mobile_payment"
}
}
},
"then": {
"required": [
"MOBILE_PAYMENT_TYPE"
],
"oneOf": [
{
"properties": {
"MOBILE_PAYMENT_TYPE": {
"const": "bizum"
}
},
"required": [
"MOBILE_PHONE"
]
},
{
"properties": {
"MOBILE_PAYMENT_TYPE": {
"const": "wallet"
}
},
"required": [
"MOBILE_WALLET_ID"
]
}
]
}
}
]
},
"engine_version": "3.12"
}
],
"changelog": "Added discount field and removed unused languages"
},
"files": [
"string"
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata* | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
files | string (binary)[] | Array of template and editor config files for each language | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Created New major version is created. Expected response for a valid request.
{
"external_id": "factura_bilingue_premium",
"description": "Plantilla para facturas en Español e Inglés.",
"version": "1.0",
"default_language": "ES",
"languages": [
"ES",
"EN"
],
"tags": [
"factura",
"multi-idioma"
],
"creation_date": "2025-08-29T08:50:00Z"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
external_id* | string | Unique identifier for the template. Must be lowercase, numbers, and underscores only. | ||
description* | string | Human-readable description of the template | ||
version* | string | Template version | ||
default_language* | string | Language of the template in ISO 639-1 format. Possible values: ES, EN, EU, GL, CA, DE, UNDEFINED Not all values are available to all organizations. | ||
languages* | string[] | Supported languages | ||
tags | string[] | Free values (user-defined) to tag dynamic template. Maximum 5 tags allowed. | minItems: 0, maxItems: 5, uniqueItems | |
creation_date* | string (date-time) | Template creation date |
Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have failed
Not Found Template not found
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X POST 'https://documents.masstack.com/v1/orgs/masmovil/dynamic_templates/factura_mensual/versions' \
-H 'Content-Type: multipart/mixed' \
-H 'Accept: application/json' \
--data-raw '{
"metadata": {
"description": "Plantilla para facturas en Español e Inglés.",
"default_language": "ES",
"tags": [
"factura",
"multi-idioma"
],
"sources": [
{
"language": "ES",
"template_part_name": "string",
"editor_config_part_name": "string",
"structure": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"CUSTOMER": {
"type": "object",
"properties": {
"DNI": {
"type": "string"
},
"NAME": {
"type": "string"
},
"EMAIL": {
"type": "string",
"format": "email"
},
"ADDRESS": {
"type": "object",
"properties": {
"CITY": {
"type": "string"
},
"COORDINATES": {
"type": "object",
"properties": {
"LATITUDE": {
"type": "number"
},
"LONGITUDE": {
"type": "number"
}
}
}
}
}
},
"required": [
"dni",
"name"
]
},
"CONTRACT_DATE": {
"type": "string",
"format": "date-time"
},
"TAGS": {
"type": "array",
"items": {
"type": "string"
}
},
"PRODUCTS": {
"type": "array",
"items": {
"type": "object",
"properties": {
"NAME": {
"type": "string"
},
"PRICE": {
"type": "number"
},
"QUANTITY": {
"type": "integer"
}
},
"required": [
"NAME",
"PRICE"
]
}
},
"TOTAL_AMOUNT": {
"type": "number"
},
"HAS_DISCOUNT": {
"type": "boolean"
},
"DISCOUNT_AMOUNT": {
"type": "number"
},
"PAYMENT_METHOD": {
"type": "string",
"enum": [
"bank_transfer",
"card",
"mobile_payment"
]
},
"IBAN": {
"type": "string"
},
"CARD_LAST_DIGITS": {
"type": "string"
},
"MOBILE_PAYMENT_TYPE": {
"type": "string"
},
"MOBILE_PHONE": {
"type": "string"
},
"MOBILE_WALLET_ID": {
"type": "string"
}
},
"required": [
"CUSTOMER",
"PRODUCTS",
"TOTAL_AMOUNT",
"PAYMENT_METHOD"
],
"additionalProperties": false,
"allOf": [
{
"if": {
"properties": {
"HAS_DISCOUNT": {
"const": true
}
}
},
"then": {
"required": [
"DISCOUNT_AMOUNT"
]
}
},
{
"if": {
"properties": {
"PAYMENT_METHOD": {
"const": "BANK_TRANSFER"
}
}
},
"then": {
"required": [
"IBAN"
]
}
},
{
"if": {
"properties": {
"PAYMENT_METHOD": {
"const": "card"
}
}
},
"then": {
"required": [
"CARD_LAST_DIGITS"
]
}
},
{
"if": {
"properties": {
"PAYMENT_METHOD": {
"const": "mobile_payment"
}
}
},
"then": {
"required": [
"MOBILE_PAYMENT_TYPE"
],
"oneOf": [
{
"properties": {
"MOBILE_PAYMENT_TYPE": {
"const": "bizum"
}
},
"required": [
"MOBILE_PHONE"
]
},
{
"properties": {
"MOBILE_PAYMENT_TYPE": {
"const": "wallet"
}
},
"required": [
"MOBILE_WALLET_ID"
]
}
]
}
}
]
},
"engine_version": "3.12"
}
],
"changelog": "Added discount field and removed unused languages"
},
"files": [
"string"
]
}'Deletes the latest minor version of a specific major version line. Cannot delete the base version (X.0) or if it's the only minor version in the major line.
PATH PARAMETERS
The string id related with one of Grupo MasOrange tenants
The external id of the dynamic template
The major version number
No Content Minor version deleted successfully
Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have failed
Not Found Template or version not found
Conflict Cannot delete base version (X.0) or only minor version in major line
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X DELETE 'https://documents.masstack.com/v1/orgs/masmovil/dynamic_templates/factura_mensual/versions/1/minor' \
-H 'Accept: application/json'Returns the complete changelog history for a dynamic template, showing all version transitions ordered by version in descending order (newest to oldest).
PATH PARAMETERS
The string id related with one of Grupo MasOrange tenants
The external id of the dynamic template
OK The template changelog history is returned. Expected response for a valid request.
{
"changelog_history": [
{
"from_version": "1.1",
"to_version": "2.0",
"on_date": "2025-10-01T15:00:00Z",
"changelog": "Versión Mayor: Añadido campo de descuento y se elimina el soporte para idiomas no usados.",
"subject": "myuser@example"
}
]
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
changelog_history* | object[] | minItems: 1 | ||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||
Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have failed
Not Found Template not found
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://documents.masstack.com/v1/orgs/masmovil/dynamic_templates/factura_mensual/changelog' \
-H 'Accept: application/json'Submit an asynchronous request to fill a specific version of a dynamic template with provided data. The system validates the field values against the template's JSON schema and registers the request for asynchronous processing. Returns immediately with a fill_process_id that can be used to check status via the GET /fill_process endpoint. The system automatically adds a template tag with format '{templateExternalId}-v{templateVersion}' to user-provided tags when creating the document.
PATH PARAMETERS
The string id related with one of Grupo MasOrange tenants
The external id of the dynamic template
The major version number
HEADER PARAMETERS
Identifies the system originating the request. If not provided, it defaults to the Authn token's audience (x-auth-aud).
{
"language": "ES",
"document": {
"name": "personal_contract_2025_001",
"tags": [
"DRAFT",
"RETAIL"
]
},
"fields_values": {
"customer": {
"name": "Juan Pérez",
"id": "12345678Z"
},
"products": [
{
"name": "Fibra 1Gb",
"price": 20
},
{
"name": "Móvil Ilimitado",
"price": 15
}
],
"total_amount": 35
},
"fill_priority": "string"
}| Property | Type | Description | Constraints | Default | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
language* | string | Language of the template in ISO 639-1 format. Possible values: ES, EN, EU, GL, CA, DE, UNDEFINED Not all values are available to all organizations. | |||||||||||||||||
document* | object | ||||||||||||||||||
| |||||||||||||||||||
fields_values* | object | Field values that will be used to fill the template. Must conform to the template's JSON schema. The entire payload is validated against the template's JSON schema definition. | |||||||||||||||||
| |||||||||||||||||||
fill_priority | string | Processing priority for the fill request. Possible values: low, high | "low" | ||||||||||||||||
Accepted Fill request accepted and registered for processing
{
"fill_process_id": "11223344-aabb-ccdd-eeff-009988776655"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
fill_process_id* | string | Unique identifier for the fill process request |
Bad Request Invalid input or field values don't match template schema
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized - Missing or invalid authentication
Not Found Template or version not found
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal server error
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
fill-process-originstringThe origin that was set for this fill process (either provided or defaulted to aud)
sales-platformcurl -X POST 'https://documents.masstack.com/v1/orgs/masmovil/dynamic_templates/factura_mensual/versions/1/fill' \
-H 'fill-process-origin: sales-platform' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"language": "ES",
"document": {
"name": "personal_contract_2025_001",
"tags": [
"DRAFT",
"RETAIL"
]
},
"fields_values": {
"customer": {
"name": "Juan Pérez",
"id": "12345678Z"
},
"products": [
{
"name": "Fibra 1Gb",
"price": 20
},
{
"name": "Móvil Ilimitado",
"price": 15
}
],
"total_amount": 35
},
"fill_priority": "string"
}'Check the status of an asynchronous document fill process. Returns the current state (CREATED, PROCESSING, COMPLETED, FAILED) and relevant metadata based on the state.
PATH PARAMETERS
The string id related with one of Grupo MasOrange tenants
Unique identifier of the fill process
OK Fill process status retrieved successfully
{
"fill_process_id": "11223344-aabb-ccdd-eeff-009988776655",
"status": "COMPLETED",
"filled_document_id": "4833979c-e045-46a9-9b1e-412d19294237",
"creation_date": "2025-11-18T09:35:00Z",
"finish_date": "2025-11-18T09:35:15Z",
"template": {
"external_id": "telco_services",
"major_version": 1,
"minor_version": 2
},
"error": {
"message": "Template variable 'customerName' missing in payload."
}
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
fill_process_id* | string | Unique identifier for the fill process request | ||||||||||||||||||||||
status* | string | Current status of the fill process. Possible values: CREATED, PROCESSING, COMPLETED, FAILED | ||||||||||||||||||||||
filled_document_id | string | UUID of the generated document. Present only when status is COMPLETED | ||||||||||||||||||||||
creation_date* | string (date-time) | Timestamp when the fill process was created | ||||||||||||||||||||||
finish_date | string (date-time) | Timestamp when processing finished. Present only when status is COMPLETED or FAILED | ||||||||||||||||||||||
template* | object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
error | object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
Bad Request Invalid input
Unauthorized Unauthorized
Not Found Fill process not found
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal server error
curl -X GET 'https://documents.masstack.com/v1/orgs/masmovil/fill_process/11223344-aabb-ccdd-eeff-009988776655' \
-H 'Accept: application/json'Creates a new digital sign process according with its input data. The digital sign process unique identifier is returned.
PATH PARAMETERS
Organization name
Data about signers, documents to be signed and associated identification processes.
{
"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": null,
"fields": null
}
]
}
],
"preview_documents": [
"827d7367-8ff4-4748-970e-009680a87813"
]
},
"identification": {
"type": "AGENT"
},
"expires_in": "P7D"
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
signers* | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sign* | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
identification* | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
expires_in | string | Minimum 15 minutes. Default to 30 days. Max 30 days. Validity duration time (ISO-8601 format) from now. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Created New digital sign process is created. Expected response for a valid request.
{
"id": "7902cd2d-80f4-4766-a3e9-a1760e0df9bd"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
id* | string | uuid that identifies a digital sign process, referenced on the endpoints as sign_process_id |
Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have fail
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
LocationstringCreated resource URI. Example /orgs/masmovil/sign_process/00cf016d-070d-4fe0-9fd2-ffb80cb6a642
/orgs/masmovil/sign_process/00cf016d-070d-4fe0-9fd2-ffb80cb6a642curl -X POST 'https://documents.masstack.com/v1/orgs/masmovil/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": null,
"fields": null
}
]
}
],
"preview_documents": [
"827d7367-8ff4-4748-970e-009680a87813"
]
},
"identification": {
"type": "AGENT"
},
"expires_in": "P7D"
}'Get digital sign process information
PATH PARAMETERS
Organization name
uuid that identifies a digital sign process
OK Expected response for a valid request.
{
"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"
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
signatures* | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status* | string | 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* | string | Sign processes type: - SIMPLE: Simple Sign - BIOMETRIC: Biometric Sign | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
modification_date* | string (date-time) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_date* | string (date-time) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
certificate_id | string | Document id of the sign process certificate | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have fail
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://documents.masstack.com/v1/orgs/masmovil/sign_process/7902cd2d-80f4-4766-a3e9-a1760e0df9bd' \
-H 'Accept: application/json'Cancel digital sign process
PATH PARAMETERS
Organization name
uuid that identifies a digital sign process
Necessary data to execute action
{
"reason": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
reason* | string | reason for cancellation of the digital signature |
No Content Action executed correctly
Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have fail
Conflict process is not in a cancelable state
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X POST 'https://documents.masstack.com/v1/orgs/masmovil/sign_process/7902cd2d-80f4-4766-a3e9-a1760e0df9bd/cancel' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"reason": "string"
}'Get biometric signature information
PATH PARAMETERS
Organization name
uuid that identifies signature data by signer, associated to a digital sign process
OK Expected response for a valid request.
{
"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"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
signer* | object | |||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||
preview_documents | object[] | Temporary signed URL fully accessible without authentication or authorisation, plus the document name, for the signed documents. | ||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||
signable_documents* | object[] | Temporary signed URL fully accessible without authentication or authorisation, plus the document name, for the signed documents. | ||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||
signed_documents | object[] | Temporary signed URL fully accessible without authentication or authorisation, plus the document name, for the signed documents. | ||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||
status* | string | 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 | object | |||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||
modification_date* | string (date-time) | |||||||||||||||||||||||||||||||||
creation_date* | string (date-time) | |||||||||||||||||||||||||||||||||
Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have fail
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://documents.masstack.com/v1/orgs/masmovil/biometric_signs/0b9bbe95-f080-4317-b371-1f9ae0b9bf4f' \
-H 'Accept: application/json'Preview biometric signature
PATH PARAMETERS
Organization name
uuid that identifies signature data by signer, associated to a digital sign process
HEADER PARAMETERS
browser installation id (unique identifier)
device fingerprint
device location coordinate
No Content Action executed correctly
Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have fail
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X POST 'https://documents.masstack.com/v1/orgs/masmovil/biometric_signs/0b9bbe95-f080-4317-b371-1f9ae0b9bf4f/preview' \
-H 'x-installation_id: 625fc44b-5b1c-451e-bcc7-276c911f0af8' \
-H 'x-fingerprint: 33dd65c7fefc7078776965ca85cee243' \
-H 'x-location: 88.52,-123.1' \
-H 'Accept: application/json'Sign using biometric signature
PATH PARAMETERS
Organization name
uuid that identifies signature data by signer, associated to a digital sign process
HEADER PARAMETERS
browser installation id (unique identifier)
device fingerprint
device location coordinate
Necessary data to execute action
{
"biometric_data": "string",
"signature_image": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
biometric_data* | string | biometric data extracted from the signatory's handwritten signature. (Max allowed length 300kb) | ||
signature_image* | string | base64 encoded image of the signature. (Max allowed length 500kb) |
No Content Action executed correctly
Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have fail
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X POST 'https://documents.masstack.com/v1/orgs/masmovil/biometric_signs/0b9bbe95-f080-4317-b371-1f9ae0b9bf4f/sign' \
-H 'x-installation_id: 625fc44b-5b1c-451e-bcc7-276c911f0af8' \
-H 'x-fingerprint: 33dd65c7fefc7078776965ca85cee243' \
-H 'x-location: 88.52,-123.1' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"biometric_data": "string",
"signature_image": "string"
}'Get simple signature information
PATH PARAMETERS
Organization name
uuid that identifies signature data by signer, associated to a digital sign process
OK Expected response for a valid request.
{
"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"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
signer* | object | |||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||
preview_documents | object[] | Temporary signed URL fully accessible without authentication or authorisation, plus the document name, for the signed documents. | ||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||
signable_documents* | object[] | Temporary signed URL fully accessible without authentication or authorisation, plus the document name, for the signed documents. | ||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||
signed_documents | object[] | Temporary signed URL fully accessible without authentication or authorisation, plus the document name, for the signed documents. | ||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||
status* | string | 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 | object | |||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||
modification_date* | string (date-time) | |||||||||||||||||||||||||||||||||
creation_date* | string (date-time) | |||||||||||||||||||||||||||||||||
Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have fail
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://documents.masstack.com/v1/orgs/masmovil/simple_signs/0b9bbe95-f080-4317-b371-1f9ae0b9bf4f' \
-H 'Accept: application/json'Preview simple signature
PATH PARAMETERS
Organization name
uuid that identifies signature data by signer, associated to a digital sign process
HEADER PARAMETERS
browser installation id (unique identifier)
device fingerprint
device location coordinate
No Content Action executed correctly
Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have fail
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X POST 'https://documents.masstack.com/v1/orgs/masmovil/simple_signs/0b9bbe95-f080-4317-b371-1f9ae0b9bf4f/preview' \
-H 'x-installation_id: 625fc44b-5b1c-451e-bcc7-276c911f0af8' \
-H 'x-fingerprint: 33dd65c7fefc7078776965ca85cee243' \
-H 'x-location: 88.52,-123.1' \
-H 'Accept: application/json'Sign simple signature
PATH PARAMETERS
Organization name
uuid that identifies signature data by signer, associated to a digital sign process
HEADER PARAMETERS
browser installation id (unique identifier)
device fingerprint
device location coordinate
No Content Action executed correctly
Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have fail
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X POST 'https://documents.masstack.com/v1/orgs/masmovil/simple_signs/0b9bbe95-f080-4317-b371-1f9ae0b9bf4f/sign' \
-H 'x-installation_id: 625fc44b-5b1c-451e-bcc7-276c911f0af8' \
-H 'x-fingerprint: 33dd65c7fefc7078776965ca85cee243' \
-H 'x-location: 88.52,-123.1' \
-H 'Accept: application/json'Validates an existing identification by agent. The agent acts as a trusted verifier, validating the actor's identification.
PATH PARAMETERS
Organization name
uuid for each signer's identification process associated to a digital sign process
HEADER PARAMETERS
browser installation id (unique identifier)
device fingerprint
device location coordinate
information to identify the application, operating system, vendor, and/or version of the requester
Required data to execute action
{
"agent": "Jose Luis Garcia",
"evidence": "iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAABbklEQVR42mNkAAYYgZ",
"evidence_metadata": "{ \"document_number\": \"12345678A\",\n \"document_type\": \"NIF\" }"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
agent* | string | shop agent identifier of who is validating this identification | ||
evidence | string | Evidence of the actor identified. It should be a personal document image. Uploaded in Base64 string format. Image extension should ONLY '*.png' | ||
evidence_metadata | string | Metadata of apply OCR to Evidence file. It should be in a valid Json format. |
No Content Action executed correctly
Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have fail
Not Found Not found. Entity does not exist or can not be found
Conflict Conflict. Entity state has conflicts between its new state and the old one.
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X POST 'https://documents.masstack.com/v1/orgs/masmovil/identifications/agent/0b9bbe95-f080-4317-b371-1f9ae0b9bf4f/validate' \
-H 'x-installation_id: 625fc44b-5b1c-451e-bcc7-276c911f0af8' \
-H 'x-fingerprint: 33dd65c7fefc7078776965ca85cee243' \
-H 'x-location: 88.52,-123.1' \
-H 'User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X x.y; rv:42.0) Gecko/20100101 Firefox/42.0' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"agent": "Jose Luis Garcia",
"evidence": "iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAABbklEQVR42mNkAAYYgZ",
"evidence_metadata": "{ \"document_number\": \"12345678A\",\n \"document_type\": \"NIF\" }"
}'Get information about agent identification process
PATH PARAMETERS
Organization name
uuid for each signer's identification process associated to a digital sign process
OK Expected response for a valid request.
{
"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"
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
actor* | object | ||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||
agent_id | string | Agent which will identify the actor | |||||||||||||||||||||||||||
creation_date* | string (date-time) | ||||||||||||||||||||||||||||
modification_date | string (date-time) | ||||||||||||||||||||||||||||
expiration_date* | string (date-time) | ||||||||||||||||||||||||||||
state* | string | 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. | |||||||||||||||||||||||||||
Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have fail
Not Found Not found. Entity does not exist or can not be found
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://documents.masstack.com/v1/orgs/masmovil/identifications/agent/0b9bbe95-f080-4317-b371-1f9ae0b9bf4f' \
-H 'Accept: application/json'Get sign configuration
PATH PARAMETERS
Organization name
OK Sign configuration of given tenant.
{
"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",
"identification_config": {
"identity_document": {
"providers": [
{
"sign_type": "SIMPLE",
"provider_type": "EXTERNAL"
}
]
}
}
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
landing_url | string | Sign process url | |||||||||||||||||||||||||||||||||||||||||||||||
expiration_duration | string | Validity duration time (ISO-8601 format) of any sign process for the tenant. | |||||||||||||||||||||||||||||||||||||||||||||||
channels | string[] | Channels to send notifications. Possible values: SMS, EMAIL or WHATSAPP | |||||||||||||||||||||||||||||||||||||||||||||||
certificate | object | ||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||
notification_email | string | Email where the notifications about certificate expiration will be sent | |||||||||||||||||||||||||||||||||||||||||||||||
identification_config | object | ||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||
Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have fail or certificate password is not correct
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://documents.masstack.com/v1/orgs/masmovil/sign_process/configurations' \
-H 'Accept: application/json'Create new configuration
PATH PARAMETERS
Organization name
Data about sign configuration
{
"landing_url": "www.masmovil.com",
"expiration_duration": "P7D",
"channels": [
"SMS",
"EMAIL",
"WHATSAPP"
],
"content": "string",
"sign_certificate_password": "Passw0rd",
"notification_email": "example@email.com",
"identification_config": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
landing_url* | string | Sign process URL | ||
expiration_duration* | string | Validity duration time (ISO-8601 format) of any sign process for the tenant. | ||
channels* | string[] | Channels to send notifications. Possible values: SMS, EMAIL, or WHATSAPP. | ||
content* | string (binary) | The PKCS#12 (.p12) certificate file | ||
sign_certificate_password* | string | Password for the PKCS#12 certificate | ||
notification_email* | string | Email where the notifications about certificate expiration will be sent | ||
identification_config | string | JSON array of scoring provider configurations per sign type |
No Content New sign configuration is created.
Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have fail or certificate password is not correct
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X POST 'https://documents.masstack.com/v1/orgs/masmovil/sign_process/configurations' \
-H 'Accept: application/json' \
-F 'landing_url=www.masmovil.com' \
-F 'expiration_duration=P7D' \
-F 'channels=SMS,EMAIL,WHATSAPP' \
-F 'content=string' \
-F 'sign_certificate_password=Passw0rd' \
-F 'notification_email=example@email.com' \
-F 'identification_config=string'Update configuration
PATH PARAMETERS
Organization name
Data about sign configuration
{
"landing_url": "www.masmovil.com",
"expiration_duration": "P7D",
"channels": [
"SMS",
"EMAIL",
"WHATSAPP"
],
"content": "string",
"sign_certificate_password": "Passw0rd",
"notification_email": "example@email.com",
"identification_config": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
landing_url | string | Sign process URL | ||
expiration_duration | string | Validity duration time (ISO-8601 format) of any sign process for the tenant. | ||
channels | string[] | Channels to send notifications. Possible values: SMS, EMAIL, or WHATSAPP. | ||
content | string (binary) | The PKCS#12 (.p12) certificate file | ||
sign_certificate_password | string | Password for the PKCS#12 certificate | ||
notification_email | string | Email where the notifications about certificate expiration will be sent | ||
identification_config | string | JSON array of scoring provider configurations per sign type |
No Content Sign configuration is created.
Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have fail or certificate password is not correct
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X PATCH 'https://documents.masstack.com/v1/orgs/masmovil/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",
"identification_config": "string"
}'Get information about otp identification process
PATH PARAMETERS
Organization name
uuid for each signer's identification process associated to a digital sign process
OK Expected response for a valid request.
{
"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",
"state": "CREATED"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
actor* | object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
creation_date* | string (date-time) | |||||||||||||||||||||||
modification_date* | string (date-time) | |||||||||||||||||||||||
expiration_date* | string (date-time) | |||||||||||||||||||||||
remaining_challenges* | integer | Remaining challenge codes to request before identification process fail. | min: 0 | |||||||||||||||||||||
remaining_validation_attempts* | integer | Remaining validation attempts of the current challenge code. Null when not challenge is requested. | min: 0 | |||||||||||||||||||||
next_challenge_retry | string (date-time) | Minimum date before request a new challenge code. Null when remaining_challenges is zero. | ||||||||||||||||||||||
two_factor_type | string | 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 | ||||||||||||||||||||||
state* | string | 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. | ||||||||||||||||||||||
Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have fail
Not Found Not found. Entity does not exist or can not be found
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://documents.masstack.com/v1/orgs/masmovil/identifications/otp/0b9bbe95-f080-4317-b371-1f9ae0b9bf4f' \
-H 'Accept: application/json'OTP identification token validation
PATH PARAMETERS
Organization name
uuid for each signer's identification process associated to a digital sign process
HEADER PARAMETERS
browser installation id (unique identifier)
device fingerprint
device location coordinate
information to identify the application, operating system, vendor, and/or version of the requester
Necessary data to execute action
{
"code": "k4khb9",
"two_factor": "12345678A"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code* | string | challenge code | ||
two_factor | string | Value used for two factor. Will match a national id, passport number or email. |
No Content Action executed correctly
Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have fail
Forbidden Forbidden. Request has invalid credentials
Not Found Not found. Entity does not exist or can not be found
Conflict Conflict. Entity state has conflicts between its new state and the old one.
Gone. Resource is no longer available
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
x-access-tokenstringsecurized authn web_component token.
curl -X PUT 'https://documents.masstack.com/v1/orgs/masmovil/identifications/otp/0b9bbe95-f080-4317-b371-1f9ae0b9bf4f/validate' \
-H 'x-installation_id: 625fc44b-5b1c-451e-bcc7-276c911f0af8' \
-H 'x-fingerprint: 33dd65c7fefc7078776965ca85cee243' \
-H 'x-location: 88.52,-123.1' \
-H 'User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X x.y; rv:42.0) Gecko/20100101 Firefox/42.0' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"code": "k4khb9",
"two_factor": "12345678A"
}'OTP identification token challenge
PATH PARAMETERS
Organization name
uuid for each signer's identification process associated to a digital sign process
Necessary data to execute action
{
"two_factor": "12345678A or actor@email.com"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
two_factor | string | 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. |
OK Action executed correctly
{
"two_factor_value": "12345678A"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
two_factor_value* | string | Value used for two factor. Will match a national id, passport number or email. |
No Content Action executed correctly
Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have fail
Forbidden Forbidden. Request has invalid credentials
Not Found Not found. Entity does not exist or can not be found
Conflict Conflict. Entity state has conflicts between its new state and the old one.
Precondition failed. Request can not be processed yet
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X PUT 'https://documents.masstack.com/v1/orgs/masmovil/identifications/otp/0b9bbe95-f080-4317-b371-1f9ae0b9bf4f/challenge' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"two_factor": "12345678A or actor@email.com"
}'Get identity document identification
PATH PARAMETERS
Organization name
uuid for each signer's identification process associated to a digital sign process
OK Expected response for a valid request.
{
"actor": {
"name": "James",
"last_name": "Smith",
"identity_document": {
"document_number": "12345678A",
"document_type": "IDENTITY_CARD",
"country": "ES"
}
},
"state": "CREATED",
"remaining_validation_attempts": 3,
"creation_date": "2023-04-20T11:43:13Z",
"modification_date": "2023-04-20T11:43:13Z",
"expiration_date": "2023-04-20T11:43:13Z",
"scoring_id": "625fc44b-5b1c-451e-bcc7-276c911f0af8"
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
actor* | object | ||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||
state* | string | 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. | |||||||||||||||||||||||||||||||||||||||||||||||
remaining_validation_attempts* | integer | Remaining validation attempts | min: 0 | ||||||||||||||||||||||||||||||||||||||||||||||
creation_date* | string (date-time) | ||||||||||||||||||||||||||||||||||||||||||||||||
modification_date* | string (date-time) | ||||||||||||||||||||||||||||||||||||||||||||||||
expiration_date* | string (date-time) | ||||||||||||||||||||||||||||||||||||||||||||||||
scoring_id | string (uuid) | ||||||||||||||||||||||||||||||||||||||||||||||||
Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have fail
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://documents.masstack.com/v1/orgs/masmovil/identifications/identity_document/0b9bbe95-f080-4317-b371-1f9ae0b9bf4f' \
-H 'Accept: application/json'Validates an existing and previously scored identification by identity document.
PATH PARAMETERS
Organization name
uuid for each signer's identification process associated to a digital sign process
HEADER PARAMETERS
browser installation id (unique identifier)
device fingerprint
device location coordinate
information to identify the application, operating system, vendor, and/or version of the requester
No Content Action executed correctly
Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have fail
Not Found Not found. Entity does not exist or can not be found
Conflict Conflict. Entity state has conflicts between its new state and the old one.
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
x-access-tokenstringsecurized authn web_component token.
curl -X POST 'https://documents.masstack.com/v1/orgs/masmovil/identifications/identity_document/0b9bbe95-f080-4317-b371-1f9ae0b9bf4f/validate' \
-H 'x-installation_id: 625fc44b-5b1c-451e-bcc7-276c911f0af8' \
-H 'x-fingerprint: 33dd65c7fefc7078776965ca85cee243' \
-H 'x-location: 88.52,-123.1' \
-H 'User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X x.y; rv:42.0) Gecko/20100101 Firefox/42.0' \
-H 'Accept: application/json'Creates a new agent identification according with its input data. The agent identification unique identifier is returned.
PATH PARAMETERS
Organization name
Data about actor and the identification process.
{
"actor": {
"name": "James",
"last_name": "Smith",
"identity_document": {
"document_number": "12345678A",
"document_type": "NIF",
"country": "ES"
},
"email": "example@email.com",
"msisdn": {
"phone_number": 6123456789,
"country_code": "34"
},
"language": "ES"
},
"expires_in": "P7D"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
actor* | object | Actor data for agent identification. Identity document is mandatory for agent identification. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
expires_in* | string | Minimum 1 minute. Max 30 days. Validity duration time (ISO-8601 format) from now. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Created New agent identification is created. Expected response for a valid request.
{
"id": "7902cd2d-80f4-4766-a3e9-a1760e0df9bd"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
id* | string | uuid that identifies an agent identification, referenced on the endpoints as admin_identification_id |
Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have fail
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X POST 'https://documents.masstack.com/v1/orgs/masmovil/identifications/agent' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"actor": {
"name": "James",
"last_name": "Smith",
"identity_document": {
"document_number": "12345678A",
"document_type": "NIF",
"country": "ES"
},
"email": "example@email.com",
"msisdn": {
"phone_number": 6123456789,
"country_code": "34"
},
"language": "ES"
},
"expires_in": "P7D"
}'Cancels an ongoing agent identification process. A cancel reason must be provided.
PATH PARAMETERS
Organization name
uuid identification unique identifier
Required data to cancel an identification process
{
"reason": "The client does not want to continue with the identification process."
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
reason | string | The reason why the process is going to be cancelled. |
No Content Action executed correctly
Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have fail
Not Found Not found. Entity does not exist or can not be found
Conflict Conflict. Entity state has conflicts between its new state and the old one.
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X POST 'https://documents.masstack.com/v1/orgs/masmovil/identifications/agent/0b9bbe95-f080-4317-b371-1f9ae0b9bf4f/cancel' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"reason": "The client does not want to continue with the identification process."
}'Close an Agent Identification process if not is finished
PATH PARAMETERS
Organization name
uuid identification unique identifier
No Content Action executed correctly
Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have fail
Not Found Not found. Entity does not exist or can not be found
Conflict Conflict. Entity state has conflicts between its new state and the old one.
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X POST 'https://documents.masstack.com/v1/orgs/masmovil/identifications/agent/0b9bbe95-f080-4317-b371-1f9ae0b9bf4f/close' \
-H 'Accept: application/json'Delete agent identification process. It is intended for incomplete identifications unless force param is used
PATH PARAMETERS
Organization name
uuid identification unique identifier
QUERY PARAMETERS
If the process is not in CREATED state this parameter has to be passed as true AND needed permission has to be present at the token for the deletion to happen. A FORBIDDEN code will be thrown otherwise. - 'true' if identification process must be deleted regardless of the state. - 'false' or not present otherwise.
No Content Action executed correctly
Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have fail
Forbidden Forbidden. Request has invalid credentials
Not Found Not found. Entity does not exist or can not be found
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X DELETE 'https://documents.masstack.com/v1/orgs/masmovil/identifications/agent/0b9bbe95-f080-4317-b371-1f9ae0b9bf4f?force=true' \
-H 'Accept: application/json'Create otp identification process
PATH PARAMETERS
Organization name
Data about actor and the otp identification process.
{
"actor": {
"name": "James",
"last_name": "Smith",
"identity_document": {
"document_number": "12345678A",
"document_type": "NIF",
"country": "ES"
},
"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"
}
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
actor* | object | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
expires_in* | string | Default to 30 days. Max 30 days. Validity duration time (ISO-8601 format) from now. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
two_factor_type | string | 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 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
channel* | object | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Created New otp identification is created.
{
"id": "7902cd2d-80f4-4766-a3e9-a1760e0df9bd"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
id* | string | uuid that identifies an otp identification, referenced on the endpoints as admin_identification_id |
Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have fail
Not Found Not found. Entity does not exist or can not be found
Conflict Conflict. Entity state has conflicts between its new state and the old one.
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X POST 'https://documents.masstack.com/v1/orgs/masmovil/identifications/otp' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"actor": {
"name": "James",
"last_name": "Smith",
"identity_document": {
"document_number": "12345678A",
"document_type": "NIF",
"country": "ES"
},
"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"
}
}'Cancels an ongoing OTP identification process. A cancel reason must be provided.
PATH PARAMETERS
Organization name
uuid identification unique identifier
Required data to cancel an identification process
{
"reason": "The client does not want to continue with the identification process."
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
reason | string | The reason why the process is going to be cancelled. |
No Content Action executed correctly
Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have fail
Not Found Not found. Entity does not exist or can not be found
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X POST 'https://documents.masstack.com/v1/orgs/masmovil/identifications/otp/0b9bbe95-f080-4317-b371-1f9ae0b9bf4f/cancel' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"reason": "The client does not want to continue with the identification process."
}'Close an OTP identification process if not is finished
PATH PARAMETERS
Organization name
uuid identification unique identifier
No Content Action executed correctly
Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have fail
Not Found Not found. Entity does not exist or can not be found
Conflict Conflict. Entity state has conflicts between its new state and the old one.
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X POST 'https://documents.masstack.com/v1/orgs/masmovil/identifications/otp/0b9bbe95-f080-4317-b371-1f9ae0b9bf4f/close' \
-H 'Accept: application/json'Delete otp identification process. It is intended for incomplete identifications unless force param is used
PATH PARAMETERS
Organization name
uuid identification unique identifier
QUERY PARAMETERS
If the process is not in CREATED state this parameter has to be passed as true AND needed permission has to be present at the token for the deletion to happen. A FORBIDDEN code will be thrown otherwise. - 'true' if identification process must be deleted regardless of the state. - 'false' or not present otherwise.
No Content Action executed correctly
Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have fail
Forbidden Forbidden. Request has invalid credentials
Not Found Not found. Entity does not exist or can not be found
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X DELETE 'https://documents.masstack.com/v1/orgs/masmovil/identifications/otp/0b9bbe95-f080-4317-b371-1f9ae0b9bf4f?force=true' \
-H 'Accept: application/json'Creates a new identification according with its input data. The identification unique identifier is returned.
PATH PARAMETERS
Organization name
Data about actor and the identification process.
{
"actor": {
"name": "James",
"last_name": "Smith",
"identity_document": {
"document_number": "12345678A",
"document_type": "IDENTITY_CARD",
"country": "ES"
},
"email": "example@email.com",
"msisdn": {
"phone_number": 6123456789,
"country_code": "34"
},
"language": "ES"
},
"name": "James",
"last_name": "Smith",
"identity_document": {
"document_number": "12345678A",
"document_type": "NIF",
"country": "ES"
},
"configuration_name": "HIGH",
"expires_in": "P7D",
"scoring": {
"provider": "INTERNAL"
}
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
actor | object | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_name | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
identity_document | object | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
configuration_name | string | Configuration name. Possible values: ["LOW", "MEDIUM", "HIGH"] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
expires_in | string | Default to 30 days. Max 30 days. Validity duration time (ISO-8601 format) from now. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
scoring | object | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
OK New agent identification is created. Expected response for a valid request.
{
"id": "7902cd2d-80f4-4766-a3e9-a1760e0df9bd",
"scoring_id": "8902cd2d-80f4-4766-a3e9-a1760e0df9bd"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
id* | string | uuid that identifies an identity document identification | ||
scoring_id* | string | Scoring id |
Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have fail
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X POST 'https://documents.masstack.com/v1/orgs/masmovil/identifications/identity_document' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"actor": {
"name": "James",
"last_name": "Smith",
"identity_document": {
"document_number": "12345678A",
"document_type": "IDENTITY_CARD",
"country": "ES"
},
"email": "example@email.com",
"msisdn": {
"phone_number": 6123456789,
"country_code": "34"
},
"language": "ES"
},
"name": "James",
"last_name": "Smith",
"identity_document": {
"document_number": "12345678A",
"document_type": "NIF",
"country": "ES"
},
"configuration_name": "HIGH",
"expires_in": "P7D",
"scoring": {
"provider": "INTERNAL"
}
}'Cancels an ongoing identity document identification process. A cancel reason must be provided.
PATH PARAMETERS
Organization name
uuid identification unique identifier
Required data to cancel an identity document identification process
{
"reason": "The client does not want to continue with the identification process."
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
reason | string | The reason why the process is going to be cancelled. |
No Content Action executed correctly
Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have fail
Not Found Not found. Entity does not exist or can not be found
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X POST 'https://documents.masstack.com/v1/orgs/masmovil/identifications/identity_document/0b9bbe95-f080-4317-b371-1f9ae0b9bf4f/cancel' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"reason": "The client does not want to continue with the identification process."
}'Close an identity document Identification process if not is finished
PATH PARAMETERS
Organization name
uuid identification unique identifier
No Content Action executed correctly
Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have fail
Not Found Not found. Entity does not exist or can not be found
Conflict Conflict. Entity state has conflicts between its new state and the old one.
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X POST 'https://documents.masstack.com/v1/orgs/masmovil/identifications/identity_document/0b9bbe95-f080-4317-b371-1f9ae0b9bf4f/close' \
-H 'Accept: application/json'Get contract information from mas-documents storage
PATH PARAMETERS
The string id related with tenants which contract belongs to
Contract identifier
OK Expected response
{
"signed_document_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"filled_document_id": "8d104722-610b-4d7c-ba89-0dd825442d88",
"sign_process_id": "d2d3b2d0-cc4e-4280-b967-90edee0aB3d2"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
signed_document_id | string (uuid) | signed document unique identifier | ||
filled_document_id | string (uuid) | filled document unique identifier | ||
sign_process_id | string (uuid) | digital process unique identifier in which contract was signed |
Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have fail
Not Found Resource not found
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://documents.masstack.com/v1/orgs/yoigo/contracts/00c6a5a6-2d8a-4857-9b32-a4abbdbd0c2c' \
-H 'Accept: application/json'Fill a template and return a contractId and a documentId (storage reference)
PATH PARAMETERS
The string id related with one of Grupo MasOrange tenants
HEADER PARAMETERS
The string id related with the contract owner. It is mandatory
Data to fill (and sign data) a template contract
{
"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"
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
template_external_id* | string | Template external id unique identifier | |||||||||||||||||
template_version* | integer | version of the template to be updated | min: 1, max: 32767 | ||||||||||||||||
language* | string | Templates languages allowed to generate contract Allowed values: ES, EN, EU, GL, CA, DE, UNDEFINED | |||||||||||||||||
flags_conditions | string[] | list of conditions which trigger specific sections of the template to be filled | minItems: 0 | ||||||||||||||||
fields_values* | object[] | template variables whose values will be printed in the filled template | |||||||||||||||||
Array items:
| |||||||||||||||||||
name | string | Name of the document filled (without spaces). The document is renamed with this value. | |||||||||||||||||
tags | string[] | 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 | maxItems: 5, uniqueItems | ||||||||||||||||
OK Expected response to a valid request.
{
"contract_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"document_id": "8d104722-610b-4d7c-ba89-0dd825442d88"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
contract_id* | string (uuid) | Contract unique identifier | ||
document_id* | string (uuid) | filled document unique identifier |
Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have fail
Not Found resource not found
resource is not longer available
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X POST 'https://documents.masstack.com/v1/orgs/masmovil/contracts/fill' \
-H 'x-auth-owner: string' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"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"
]
}'Allows to change the owner of an existing contract
PATH PARAMETERS
The string id related with one of Grupo MasOrange tenants
Contract identifier
HEADER PARAMETERS
The string id related with the contract owner. It is mandatory
Data required to update contract's owner
{
"new_owner": "subsCrIptIon8172241"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
new_owner* | string | New contract owner |
OK Owner changed successfully.
{
"owner": "subscription8172241"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
owner* | string | Successfully assigned new contract owner |
Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have fail
Not Found resource not found
resource is not longer available
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X PUT 'https://documents.masstack.com/v1/orgs/masmovil/contracts/00c6a5a6-2d8a-4857-9b32-a4abbdbd0c2c/owner' \
-H 'x-auth-owner: string' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"new_owner": "subsCrIptIon8172241"
}'Creates a new sign process according with its input data. The digital process unique identifier is returned.
PATH PARAMETERS
The string id related with one of Grupo MasOrange tenants
metadata for creating the contract's sign process
{
"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"
]
}
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
sign_type* | string | type of the sign process in which contracts are going to be signed. values: 'ONSITE', 'ONLINE' | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
signers* | object[] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
contracts* | object[] | List of contracts to be signed | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
additional_options | object | additional options to configure on contracts sign process | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Created New sign process is created to sign contracts. Expected response for a valid request.
{
"sign_process_id": "d290f1ee-6c54-4b01-90e6-d701748f0851"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
sign_process_id* | string (uuid) | Digital sign process unique identifier where contracts will be signed |
Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have fail
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X POST 'https://documents.masstack.com/v1/orgs/masmovil/contracts/sign' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"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"
]
}
}'Create scoring
PATH PARAMETERS
The string id related with tenants which contract belongs to
Data to create scoring
{
"document": {
"type": "IDENTITY_CARD",
"country": "ES"
},
"provider": "GOOGLE",
"expires_in": "P7D",
"max_score_retries": 5
}| Property | Type | Description | Constraints | Default | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
document* | object | Structure defining the document’s classification and issuing country. | |||||||||||||||||
| |||||||||||||||||||
provider* | string | Name of the external service provider used for performing the document verification (e.g., GOOGLE, VERIDAS). | |||||||||||||||||
expires_in* | string | ISO-8601 duration string specifying how long (minimum 1 minute, maximum 30 days) the scoring session will remain active. | |||||||||||||||||
max_score_retries | integer | Maximum number of retries allowed for scoring attempts. This helps prevent abuse or excessive retries. By default, it is set to 5 retries. | |||||||||||||||||
OK Expected response to a valid request.
{
"id": "d290f1ee-6c54-4b01-90e6-d701748f0851"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
id | string (uuid) | Globally unique identifier for the newly created scoring session. |
Bad Request Request input is not valid
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized The user is not authorized
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found The specified resource was not found
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error The request failed to be processed by the server
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X POST 'https://documents.masstack.com/v1/orgs/yoigo/scorings/identity_document' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"document": {
"type": "IDENTITY_CARD",
"country": "ES"
},
"provider": "GOOGLE",
"expires_in": "P7D",
"max_score_retries": 5
}'Get identity document captures
PATH PARAMETERS
The string id related with tenants which contract belongs to
Scoring id
OK Expected response to a valid request.
{
"document": {
"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"
}
}
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
document* | object | High-level metadata for the document under verification. | ||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||
Bad Request Request input is not valid
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized The user is not authorized
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found The specified resource was not found
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error The request failed to be processed by the server
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://documents.masstack.com/v1/orgs/yoigo/scorings/identity_document/d290f1ee-6c54-4b01-90e6-d701748f0851/captures' \
-H 'Accept: application/json'Get identity document scoring
PATH PARAMETERS
The string id related with tenants which contract belongs to
Scoring id
OK Expected response to a valid request.
{
"creation_date": "2023-04-20T11:43:13Z",
"modification_date": "2023-04-20T12:05:27Z",
"expiration_date": "2023-05-20T11:43:13Z",
"total_score_attempts": 15,
"remaining_score_attempts": 15,
"remaining_delegate_attempts": 15,
"state": "CREATED",
"document": {
"type": "IDENTITY_CARD",
"country": "ES"
},
"score_result": {
"global_score": 0.85,
"extracted_values": {
"NAME": "John",
"LAST_NAME": "Doe",
"BIRTH_DATE": "1990-01-01T00:00:00.000Z",
"DOCUMENT_NUMBER": "X1234567",
"DOCUMENT_EXPIRATION_DATE": "2030-12-31T00:00:00.000Z"
},
"scored_date": "2023-04-20T11:43:13Z",
"trace_metadata": {
"browser_user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X x.y; rv:42.0) Gecko/20100101 Firefox/42.0",
"ip_address": "172.17.0.4",
"browser_installation_id": "string",
"device_location": "88.52,-123.1",
"device_finger_print": "33dd65c7fefc7078776965ca85cee243"
},
"scores": [
{
"score_type": "MRZ_CONTROL_DIGIT",
"is_fraud": false,
"score": 0.85
}
]
},
"provider": "GOOGLE"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
creation_date | string (date-time) | Exact UTC timestamp when this scoring session was first created. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
modification_date | string (date-time) | Exact UTC timestamp of the last update to this scoring session. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
expiration_date | string (date-time) | UTC timestamp after which this scoring session can no longer accept new submissions or updates. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
total_score_attempts | integer | Maximum number of image submissions allowed before this session is automatically locked. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
remaining_score_attempts | integer | Remaining number of additional image submissions allowed before this session is automatically locked. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
remaining_delegate_attempts | integer | Remaining number of additional delegate calls allowed before this session is automatically locked. This field is deprecated: use the 'remaining_score_attempts' field instead, which is now the only valid counter. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
state | string | Current lifecycle state of the scoring session: • CREATED – Initialized but no images submitted yet. • SCORED – Images submitted and initial checks run. • SUCCEEDED – All verification checks passed. • FAILED – One or more verification checks failed. • EXPIRED – Session expired before completion. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
document | object | Structure defining the document’s classification and issuing country. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
score_result | object | Overall scoring results and extracted values. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provider | string | Name of the external service provider used for performing the document verification (e.g., GOOGLE, VERIDAS). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bad Request Request input is not valid
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized The user is not authorized
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found The specified resource was not found
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error The request failed to be processed by the server
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://documents.masstack.com/v1/orgs/yoigo/scorings/identity_document/d290f1ee-6c54-4b01-90e6-d701748f0851' \
-H 'Accept: application/json'Uploads front and/or back images of the identity document to perform fraud and authenticity checks, updating the scoring session with results.
PATH PARAMETERS
Unique identifier of the organization (tenant) that owns this scoring session.
Unique identifier of the identity document scoring session to update.
HEADER PARAMETERS
Browser installation id (unique identifier)
Device fingerprint for tracking and fraud detection.
Device location coordinates (latitude, longitude).
Information to identify the application, operating system, vendor, and/or version of the requester
Device IP address automatically collected by the backend server. Any value provided by the client will be ignored. Make sure this value is not dropped within nested requests on calls between microservices
Multipart payload containing binary images for the front and/or back of the document to be evaluated.
{
"front": "string",
"back": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
front | string (binary) | Binary image data for the front side of the identity document. | ||
back | string (binary) | Binary image data for the back side of the identity document. |
No Content Identity document scored successfully; no content returned.
Bad Request Request input is not valid
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized The user is not authorized
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found The specified resource was not found
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
The request cannot be processed at this time, try again later
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error The request failed to be processed by the server
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X PUT 'https://documents.masstack.com/v1/orgs/yoigo/scorings/identity_document/d290f1ee-6c54-4b01-90e6-d701748f0851/score' \
-H 'x-installation_id: 625fc44b-5b1c-451e-bcc7-276c911f0af8' \
-H 'x-fingerprint: 33dd65c7fefc7078776965ca85cee243' \
-H 'x-location: 88.52,-123.1' \
-H 'User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X x.y; rv:42.0) Gecko/20100101 Firefox/42.0' \
-H 'x-forwarded-for: 88.88.88.88' \
-H 'Content-Type: multipart/mixed' \
-H 'Accept: application/json' \
--data-raw '{
"front": "string",
"back": "string"
}'Finalizes and closes the scoring session, preventing any further image submissions or status changes.
PATH PARAMETERS
Unique identifier of the organization (tenant) that owns this scoring session.
Unique identifier of the identity document scoring session to close.
No Content Scoring session successfully closed; no content returned.
Bad Request Request input is not valid
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized The user is not authorized
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found The specified resource was not found
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error The request failed to be processed by the server
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X POST 'https://documents.masstack.com/v1/orgs/yoigo/scorings/identity_document/d290f1ee-6c54-4b01-90e6-d701748f0851/close' \
-H 'Accept: application/json'Sends the scoring request to an external provider and returns the provider’s access details.
PATH PARAMETERS
Unique identifier of the organization (tenant) that owns this scoring session.
Unique identifier of the identity document scoring session to delegate.
JSON with provider configuration
{
"provider_config": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
provider_config | string | Provider-specific configuration json content. |
OK Delegation successful; returns external provider credentials and metadata.
{
"provider_id": "cbd2e693-d71a-4cee-8313-1972acc0394d",
"access_token": "access-token",
"provider": "GOOGLE"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
provider_id | string | The unique identifier assigned by the external provider for this delegated scoring request. | ||
access_token | string | Token granting access to the provider’s scoring endpoint. | ||
provider | string | Name of the external service provider used for performing the document verification (e.g., GOOGLE, VERIDAS). |
Bad Request Request input is not valid
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized The user is not authorized
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found The specified resource was not found
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error The request failed to be processed by the server
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X POST 'https://documents.masstack.com/v1/orgs/yoigo/scorings/identity_document/d290f1ee-6c54-4b01-90e6-d701748f0851/delegate' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"provider_config": "string"
}'Returns the list of scoring attempts for the specified identity document scoring session.
PATH PARAMETERS
Unique identifier of the organization (tenant) that owns this scoring session.
Unique identifier of the identity document scoring session.
OK Expected response to a valid request.
{
"attempts": [
{
"attempt_number": 1,
"creation_date": "2024-01-01T10:00:00Z",
"provider_id": "cbd2e693-d71a-4cee-8313-1972acc0394d",
"score_result": {
"global_score": 0.85,
"extracted_values": {
"NAME": "John",
"LAST_NAME": "Doe",
"BIRTH_DATE": "1990-01-01T00:00:00.000Z",
"DOCUMENT_NUMBER": "X1234567",
"DOCUMENT_EXPIRATION_DATE": "2030-12-31T00:00:00.000Z"
},
"scored_date": "2023-04-20T11:43:13Z",
"trace_metadata": {
"browser_user_agent": null,
"ip_address": null,
"browser_installation_id": null,
"device_location": null,
"device_finger_print": null
},
"scores": [
null
]
},
"fail_reason": "PROVIDER_TIMEOUT",
"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"
}
}
]
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
attempts | object[] | List of scoring attempts ordered by attempt number. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bad Request Request input is not valid
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized The user is not authorized
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found The specified resource was not found
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error The request failed to be processed by the server
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://documents.masstack.com/v1/orgs/yoigo/scorings/identity_document/d290f1ee-6c54-4b01-90e6-d701748f0851/attempts' \
-H 'Accept: application/json'Securizes an Authn token with necessary payload and roles to validate AuthZ
PATH PARAMETERS
Organization name
Sign data to securize
{
"sign_process_id": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
sign_process_id* | string |
Created Success response
{
"web_component_token": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
web_component_token* | string |
curl -X POST 'https://documents.masstack.com/v1/orgs/masmovil/securize' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"sign_process_id": "string"
}'Returns the global status and step details of a chained identification process.
PATH PARAMETERS
Organization name
Unique identifier for the chained identification process
HEADER PARAMETERS
information to identify the application, operating system, vendor, and/or version of the requester
OK Chained identification status found
{
"status": "CREATED",
"step_details": [
{
"type": "OTP",
"id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
"status": "VALIDATED",
"modification_date": "2025-06-03T10:35:00Z"
}
],
"creation_date": "2025-06-03T10:30:00Z",
"modification_date": "2025-06-03T10:40:15Z",
"expiry_from_creation": "PT15M",
"failure_reason": null
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
status | string | Global status of the chained identification process. Enum: CREATED, VALIDATED, SUCCEEDED, FAILED, EXPIRED, CANCELLED | |||||||||||||||||||||||||||
step_details* | object[] | Array with the status and references of each step in the original sequence, in order. | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
creation_date* | string (date-time) | ||||||||||||||||||||||||||||
modification_date* | string (date-time) | ||||||||||||||||||||||||||||
expiry_from_creation* | string (duration) | Validity duration (ISO-8601 format) from the time it was created | |||||||||||||||||||||||||||
failure_reason | string | null | Reason for failure if status is FAILED or EXPIRED, otherwise null. | |||||||||||||||||||||||||||
Forbidden Forbidden. Request has invalid credentials
Not Found Not found. Entity does not exist or can not be found
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://documents.masstack.com/v1/orgs/masmovil/identifications/chain/a1b2c3d4-e5f6-7890-1234-567890abcdef' \
-H 'User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X x.y; rv:42.0) Gecko/20100101 Firefox/42.0' \
-H 'Accept: application/json'Validates a chained identification process. If the process exists and is in CREATED state, and all nested identifications are VALIDATED, the chain transitions to VALIDATED and a short-lived x-access-token (JWT) is generated and returned in the response header. Otherwise, returns 409 Conflict if the process or any nested identification is not in the required state, or 404 Not Found if the chain does not exist.
PATH PARAMETERS
Organization name
Unique identifier for the chained identification process
HEADER PARAMETERS
browser installation id (unique identifier)
device location coordinate
device fingerprint
Device IP address automatically collected by the backend server. Any value provided by the client will be ignored.
information to identify the application, operating system, vendor, and/or version of the requester
No Content Action executed correctly
Bad Request Request input is not valid
Forbidden Forbidden. Request has invalid credentials
Not Found Not found. Entity does not exist or can not be found
Conflict Conflict. Entity state has conflicts between its new state and the old one.
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
x-access-tokenstringsecurized authn web_component token.
curl -X POST 'https://documents.masstack.com/v1/orgs/masmovil/identifications/chain/a1b2c3d4-e5f6-7890-1234-567890abcdef/validate' \
-H 'x-installation_id: 625fc44b-5b1c-451e-bcc7-276c911f0af8' \
-H 'x-location: 88.52,-123.1' \
-H 'x-fingerprint: 33dd65c7fefc7078776965ca85cee243' \
-H 'x-forwarded-for: 88.88.88.88' \
-H 'User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X x.y; rv:42.0) Gecko/20100101 Firefox/42.0' \
-H 'Accept: application/json'Restores the states and metadata for a chained identification process to CREATED state so that all VALIDATED steps are invalidated and should be done again. If a step is in CREATED state, it remains unchanged. This operation can only be performed if the chained identification process is in VALIDATED or CREATED state.
PATH PARAMETERS
Organization name
Unique identifier for the chained identification process
HEADER PARAMETERS
information to identify the application, operating system, vendor, and/or version of the requester
No Content Restoration successful. No Content returned.
Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have fail
Forbidden Forbidden. Request has invalid credentials
Not Found Not found. Entity does not exist or can not be found
Conflict Conflict. Entity state has conflicts between its new state and the old one.
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X POST 'https://documents.masstack.com/v1/orgs/masmovil/identifications/chain/a1b2c3d4-e5f6-7890-1234-567890abcdef/restart' \
-H 'User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X x.y; rv:42.0) Gecko/20100101 Firefox/42.0' \
-H 'Accept: application/json'Creates a new chained identification process with a ordered sequence of identification steps (at least one, without repeated elements).
PATH PARAMETERS
Organization name
HEADER PARAMETERS
information to identify the application, operating system, vendor, and/or version of the requester
Data about actor and the identification chain process.
{
"actor": {
"name": "James",
"last_name": "Smith",
"identity_document": {
"document_number": "12345678A",
"document_type": "IDENTITY_CARD",
"country": "ES"
},
"email": "example@email.com",
"msisdn": {
"phone_number": 6123456789,
"country_code": "34"
},
"language": "ES"
},
"expires_in": "PT15M",
"sequence": [
{
"identification_type": "OTP",
"otp_step": {
"two_factor_type": "DOCUMENT_NUMBER",
"channel": {
"type": "SMS",
"external": false
}
}
},
{
"identification_type": "AGENT"
},
{
"identification_type": "IDENTITY_DOCUMENT",
"identity_document_step": {
"provider_type": "INTERNAL"
}
}
]
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
actor* | object | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
expires_in* | string | Validity duration time (ISO-8601 format) from now. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sequence* | object[] | Ordered array defining the identification steps (each step should be unique). | minItems: 1, maxItems: 10 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Created New chain identification is created.
{
"id": "cadd9e8e-7bb5-4f73-9a1a-124f8a8b0c1d"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
id* | string | uuid that identifies a chain identification |
Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have fail
Not Found Not found. Entity does not exist or can not be found
Conflict Conflict. Entity state has conflicts between its new state and the old one.
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X POST 'https://documents.masstack.com/v1/orgs/masmovil/identifications/chain' \
-H 'User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X x.y; rv:42.0) Gecko/20100101 Firefox/42.0' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"actor": {
"name": "James",
"last_name": "Smith",
"identity_document": {
"document_number": "12345678A",
"document_type": "IDENTITY_CARD",
"country": "ES"
},
"email": "example@email.com",
"msisdn": {
"phone_number": 6123456789,
"country_code": "34"
},
"language": "ES"
},
"expires_in": "PT15M",
"sequence": [
{
"identification_type": "OTP",
"otp_step": {
"two_factor_type": "DOCUMENT_NUMBER",
"channel": {
"type": "SMS",
"external": false
}
}
},
{
"identification_type": "AGENT"
},
{
"identification_type": "IDENTITY_DOCUMENT",
"identity_document_step": {
"provider_type": "INTERNAL"
}
}
]
}'Cancels an active chained identification. State will transition to CANCELLED. Also attempts to cancel any active nested identification steps. Identification chain status must be in a cancellable state, i.e. CREATED. 409 Conflict (MDOC_005) will be returned otherwise.
PATH PARAMETERS
Organization name
Unique identifier for the chained identification process
HEADER PARAMETERS
information to identify the application, operating system, vendor, and/or version of the requester
Optional reason for cancellation
{
"reason": "The client does not want to continue with the identification process."
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
reason | string | The reason why the process is going to be cancelled. |
No Content Action executed correctly
Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have fail
Not Found Not found. Entity does not exist or can not be found
Conflict Conflict. Entity state has conflicts between its new state and the old one.
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X POST 'https://documents.masstack.com/v1/orgs/masmovil/identifications/chain/a1b2c3d4-e5f6-7890-1234-567890abcdef/cancel' \
-H 'User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X x.y; rv:42.0) Gecko/20100101 Firefox/42.0' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"reason": "The client does not want to continue with the identification process."
}'Closes a chained identification process if it is in VALIDATED state. In case of SUCCEEDED, close will be ignored. If the process is not in the VALIDATED or SUCCEEDED state (e.g., CREATED, FAILED, EXPIRED, CANCELLED), it will return a 409 Conflict (MDOC_005), indicating the operation is not allowed in the current state. If the process is in VALIDATED state: Closes all nested identifications. Updates the chain process state to SUCCEEDED. Registers the close date/time.
PATH PARAMETERS
Organization name
Unique identifier for the chained identification process
HEADER PARAMETERS
information to identify the application, operating system, vendor, and/or version of the requester
No Content Action executed correctly
Bad Request Request input is not valid
Unauthorized Unauthorized. AuthN and AuthZ validations have fail
Not Found Not found. Entity does not exist or can not be found
Conflict Conflict. Entity state has conflicts between its new state and the old one.
Internal Server Error Not expected error
Error response
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | List of errors | |||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X POST 'https://documents.masstack.com/v1/orgs/masmovil/identifications/chain/a1b2c3d4-e5f6-7890-1234-567890abcdef/close' \
-H 'User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X x.y; rv:42.0) Gecko/20100101 Firefox/42.0' \
-H 'Accept: application/json'