Select
Templates Configuration
Templates Tenant configuration
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
org_id | path | string | true | The string id related with one of Grupo MasOrange tenants |
page | query | Page | false | Defines templates configuration page number to be show. If not defined, default value is 0 (first page). |
pageSize | query | PageSize | false | Defines the number of items returned in each page. If not defined, default value is 50. |
name | query | string | false | Filter by document name |
extension | query | string | false | Filter by document extension |
body | body | object | true | Define configuration fields with value by language |
Request body - Content-Type: multipart/form-data
Custom schema example
|
|
Name | Type | Required | Description |
---|---|---|---|
name | string | true | Name of the document (without spaces). |
extension | string | true | Format of the document to be stored. It must match the format of the binary |
Allowed values: jpeg, jpg, png | |||
content | string | true | Document content in binary format |
Request example
|
|
Responses
Code | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Configuration is created. Expected response for a valid request. | CreateConfigurationDocumentResponse |
400 | Bad Request | Request input is not valid | None |
401 | Unauthorized | Unauthorized. AuthN and AuthZ validations have fail | None |
422 | Unprocessable Entity | Request input can not be processed (is incomplete) | None |
500 | Internal Server Error | Not expected error | None |
default | Default | Error response | ErrorsResponse |
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
org_id | path | string | true | The string id related with one of Grupo MasOrange tenants |
Request example
|
|
Responses
Code | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Tenant all templates configurations | GetAllConfigurationDocumentsResponse |
400 | Bad Request | Request input is not valid | None |
401 | Unauthorized | Unauthorized. AuthN and AuthZ validations have fail | None |
422 | Unprocessable Entity | Request input can not be processed (is incomplete) | None |
500 | Internal Server Error | Not expected error | None |
default | Default | Error response | ErrorsResponse |
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
org_id | path | string | true | The string id related with one of Grupo MasOrange tenants |
body | body | CreateOrUpdateTemplateConfigurationRequest | true | Define configuration fields with value by language |
Request body - instance of CreateOrUpdateTemplateConfigurationRequest
|
|
Name | Type | Required | Description |
---|---|---|---|
changelog | ConfigurationChangelog | false | Description of the template change in this version |
defaultLanguage | Language | true | Templates languages allowed Allowed values: ES, EN, EU, GL, CA, DE, UNDEFINED |
fieldValues | ConfigurationFieldValues | true | Configuration fields with default values by language |
Request example
|
|
Responses
Code | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Configuration is created. Expected response for a valid request. | CreateOrUpdateTemplateConfigurationResponse |
400 | Bad Request | Request input is not valid | None |
401 | Unauthorized | Unauthorized. AuthN and AuthZ validations have fail | None |
422 | Unprocessable Entity | Request input can not be processed (is incomplete) | None |
500 | Internal Server Error | Not expected error | None |
default | Default | Error response | ErrorsResponse |
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
org_id | path | string | true | The string id related with one of Grupo MasOrange tenants |
page | query | Page | false | Defines templates configuration page number to be show. If not defined, default value is 0 (first page). |
pageSize | query | PageSize | false | Defines the number of items returned in each page. If not defined, default value is 50. |
Request example
|
|
Responses
Code | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Tenant all templates configurations | GetAllTenantConfigurationsResponse |
400 | Bad Request | Request input is not valid | None |
401 | Unauthorized | Unauthorized. AuthN and AuthZ validations have fail | None |
422 | Unprocessable Entity | Request input can not be processed (is incomplete) | None |
500 | Internal Server Error | Not expected error | None |
default | Default | Error response | ErrorsResponse |
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
org_id | path | string | true | The string id related with one of Grupo MasOrange tenants |
version | path | string | true | Higher version of the template. You can use also ‘latest’ to get latest version |
Request example
|
|
Responses
Code | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Tenant templates configuration | GetTenantConfigurationResponse |
400 | Bad Request | Request input is not valid | None |
401 | Unauthorized | Unauthorized. AuthN and AuthZ validations have fail | None |
404 | Not Found | resource not found | None |
422 | Unprocessable Entity | Request input can not be processed (is incomplete) | None |
500 | Internal Server Error | Not expected error | None |
default | Default | Error response | ErrorsResponse |
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
org_id | path | string | true | The string id related with one of Grupo MasOrange tenants |
version | path | string | true | Version of the template configuration. |
Request example
|
|
Responses
Code | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | Action executed correctly | None |
400 | Bad Request | Request input is not valid | None |
401 | Unauthorized | Unauthorized. AuthN and AuthZ validations have fail | None |
404 | Not Found | resource not found | None |
409 | Conflict | conflict if form is in some section | None |
422 | Unprocessable Entity | Request input can not be processed (is incomplete) | None |
500 | Internal Server Error | Not expected error | None |
default | Default | Error response | ErrorsResponse |
Endpoints
Documents
Forms
Sections
Templates
Templates Configuration
Digital Sign Process
Biometric Signature
Simple Signature
Identification Agent
Sign Configuration
Identification OTP
Identification with identity document
Identification Agent Admin
Identification OTP Admin
Identification with identity document Admin
Contracts
Scoring
Securize