V1
Sections
Grouping of forms by language
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| org_id | path | string | true | The string id related with one of Grupo MasOrange tenants |
| body | body | CreateSectionRequest | true | metadata for creating a language section |
Request body - instance of CreateSectionRequest
|
|
| Name | Type | Required | Description |
|---|---|---|---|
| sectionName | string | true | name of section of forms (will be normalized on section external Id) |
| forms | Forms | true | defines which form is defined to each language |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | New section is created. Expected response for a valid request. | SectionMetadata |
| 204 | No Content | Section created successfully. | 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. Resource already exist | 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 sections page number to be show. If not defined, default value is 0 (first page). |
| pageSize | query | PageSize | false | Defines the number of sections returned in each page. If not defined, default value is 50. |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The sections metadata is returned. Expected response for a valid request. | AllSectionsResponse |
| 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 |
| 410 | Gone | resource is not longer available | 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 |
| externalId | path | string | true | The external id of the desired section |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The section metadata is returned. Expected response for a valid request. | SectionMetadata |
| 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 |
| 410 | Gone | resource is not longer available | 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 |
| externalId | path | string | true | The external id of the desired section |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | The section is deleted successfully | 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. Section is in use in some template | None |
| 410 | Gone | resource is not longer available | None |
| 500 | Internal Server Error | Not expected error | None |
| default | Default | Error response | ErrorsResponse |
Endpoints
Documents
Forms
Sections
Templates
Templates Configuration
DynamicTemplates
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
Identification Chain
Identification Chain Admin