Mobile-ID Sign · INTEGRATION & DOCUMENTATION

GoPaperless Gateway — Documents and signing orchestration

Follow files, transactions and signers through prepare/finalize, outcomes and validation; Viewer is a separate UI layer.

Integration journeys Watch Viewer actions

Coverage and integration prerequisites

Source documentation, contract confirmation, sandbox testing and production acceptance are separate stages. Website version changes do not advance readiness.

Review coverage for each operation

Per-operation readiness
Operation	Documentation	Contract	Sandbox
`GET /gateway/view/open/{token}`	Catalogue/parameters	Deployment not confirmed	Not tested
`GET /gateway/view/arrangement/{token}`	Catalogue/parameters	Deployment not confirmed	Not tested
`GET /gateway/view/signing/{token}`	Catalogue/parameters	Deployment not confirmed	Not tested
`GET /gateway/view/signing/batch/{token}`	Catalogue/parameters	Deployment not confirmed	Not tested
`GET /gateway/view/signing/sequence/{token}`	Catalogue/parameters	Deployment not confirmed	Not tested
`GET /gateway/view/arrangement/sequence/{token}`	Catalogue/parameters	Deployment not confirmed	Not tested
`GET /gateway/view/validation/{token}/show`	Catalogue/parameters	Deployment not confirmed	Not tested
`GET /gateway/view/configuration/{token}`	Catalogue/parameters	Deployment not confirmed	Not tested
`GET /gateway/view/template/{token}`	Catalogue/parameters	Deployment not confirmed	Not tested
`POST /gateway/api/signing/users/configure.json`	Catalogue/parameters	Deployment not confirmed	Not tested
`GET /gateway/api/signing/users/configure/{token}`	Catalogue/parameters	Deployment not confirmed	Not tested
`POST /gateway/api/signing/users/template.json`	Catalogue/parameters	Deployment not confirmed	Not tested
`GET /gateway/api/signing/users/template/{token}`	Catalogue/parameters	Deployment not confirmed	Not tested
`POST /gateway/api/file/upload`	Selected fields	Deployment not confirmed	Not tested
`GET /gateway/api/file/upload/{token}/status.json`	Selected fields	Deployment not confirmed	Not tested
`POST /gateway/api/file/{token}/delete.json`	Catalogue/parameters	Deployment not confirmed	Not tested
`POST /gateway/api/signing/create.json`	Selected fields	Deployment not confirmed	Not tested
`POST /gateway/api/signing/createbatch.json`	Selected fields	Deployment not confirmed	Not tested
`POST /gateway/api/signing/arrangement/createbatch.json`	Selected fields	Deployment not confirmed	Not tested
`POST /gateway/api/signing/{token}/addsigner.json`	Catalogue/parameters	Deployment not confirmed	Not tested
`POST /gateway/api/signing/{token}/archive.json`	Selected fields	Deployment not confirmed	Not tested
`POST /gateway/api/signing/{token}/delete.json`	Catalogue/parameters	Deployment not confirmed	Not tested
`POST /gateway/api/signing/{token}/removesigner.json`	Catalogue/parameters	Deployment not confirmed	Not tested
`GET /gateway/api/signing/{token}/status.json`	Selected fields	Deployment not confirmed	Not tested
`POST /gateway/api/signing/{token}/prepare.json`	Selected fields	Deployment not confirmed	Not tested
`POST /gateway/api/signing/{token}/sign.json`	Selected fields	Deployment not confirmed	Not tested
`POST /gateway/api/signing/{token}/seal.json`	Catalogue/parameters	Deployment not confirmed	Not tested
`POST /gateway/api/archive.json`	Catalogue/parameters	Deployment not confirmed	Not tested
`POST /gateway/api/file/check.json`	Catalogue/parameters	Deployment not confirmed	Not tested
`POST /gateway/api/validation/upload.json`	Selected fields	Deployment not confirmed	Not tested
`GET /gateway/api/validation/{token}/download/detailed-report-pdf`	Catalogue/parameters	Deployment not confirmed	Not tested
`GET /gateway/api/validation/{token}/download/diagnostic-data-xml`	Catalogue/parameters	Deployment not confirmed	Not tested
`GET /gateway/api/validation/{token}/download/report-pdf`	Catalogue/parameters	Deployment not confirmed	Not tested
`GET /gateway/api/validation/{token}/download/report-xml`	Catalogue/parameters	Deployment not confirmed	Not tested

Download scope-specific OpenAPI · Download documentary Postman

Gateway and Viewer have distinct roles

Sources: GoPaperless Gateway API Specification v1.261001 and Viewer flow V.20261008. The catalog includes all 34 method/path headings; 10 operations have selected field models. Authentication placement, request encoding and some payloads are not clear enough for executable integration.

OpenAPI JSON OpenAPI YAML Postman Environment

Component boundaries and responsibilities

Document-journey responsibilities
Component	Role	Conditions and limits
Business application	Select documents, signers, order and authority.	Keep references and document revisions.
Gateway / Viewer	Gateway orchestrates; Viewer presents documents and user actions.	A UI action is not the final backend outcome.
FPS	Prepare documents and digests; assembling is shown in the SIC flow.	The VNeID assembling step remains unresolved.
RSS / VNeID	Data sharing, issuance or signing per journey.	Citizen-ID checking is not signature validation.
Trusted SIC	Credential, authorization, SAD and hash signature.	Signature data is not a completed document.

Complete document journey

1
Upload
Receive a file token; §4.1 upload uses SHA1.
2
Create / template
Create a transaction and signers; distinguish file, signing, signer and template tokens.
3
Arrange / prepare
Set signing positions and the exact revision; prepare returns dtbs/dtbs_hash.
4
Authorize / sign
The signing service authorizes and produces signature data under its own route.
5
Finalize / reconcile
Gateway sign.json finalizes under the contract; reconcile status and the final file.
6
Validation / archive
Validate independently and read reports; archive/sealing does not itself prove long-term preservation.

The 300 MB limit and format list belong to the Gateway Specification scope, not a platform-wide SLA or compatibility guarantee. Validation upload uses SHA256 (§9.1), unlike signing-file upload.

Source-based API Reference

POST/gateway/api/file/upload

api/file/upload

Source documented · Deployment contract unconfirmed · Sandbox not tested

Source: GoPaperless Gateway API Specification v1.261001 · PDF 18 · selected-logical-fields

Prerequisites: Agree deployment scope, authentication and permissions with Mobile-ID. Keep tokens and signing data on the backend; do not execute from this demo page.

Input — Documented fields

Logical parameter model; request encoding and authentication placement remain unconfirmed. Do not send this object as a JSON wire payload.

Fields edited from the source
Field	Type	Presence	Meaning and limits
`file[name]`	string	Required	File name, maximum 64 characters.
`file[digest]`	string	Required	SHA1 digest in this upload operation; do not use the validation SHA256 rule here.
`file[url]`	string	Conditional	Source table marks URL required; Base64 content is described as an alternative. Confirm exclusivity.
`file[content]`	string	Conditional	Base64 content, alternative to URL.

Outcome — Documented fields

Fields edited from the source
Field	Type	Presence	Meaning and limits
`status`	string	Optional	Outcome status; source example ok.
`token`	string	Optional	Uploaded-file token, not a signing token.

Items to confirm: GW12-AUTH, GW12-ENCODING, GW12-UPLOAD

GET/gateway/api/file/upload/{token}/status.json

api/file/upload/{token}/status.json

Source documented · Deployment contract unconfirmed · Sandbox not tested

Source: GoPaperless Gateway API Specification v1.261001 · PDF 19 · selected-logical-fields

Prerequisites: Agree deployment scope, authentication and permissions with Mobile-ID. Keep tokens and signing data on the backend; do not execute from this demo page.

Parameters

Operation parameters
Name	In	Required	Type
token	path	Yes	string

Input — Documented fields

Logical parameter model; request encoding and authentication placement remain unconfirmed. Do not send this object as a JSON wire payload.

This section has a catalog or outcome description only; a complete request schema is not available.

Outcome — Documented fields

Fields edited from the source
Field	Type	Presence	Meaning and limits
`status`	string	Optional	File-processing status; source example uploaded is not a complete enum.

Items to confirm: GW12-AUTH

POST/gateway/api/signing/create.json

api/signing/create.json

Source documented · Deployment contract unconfirmed · Sandbox not tested

Source: GoPaperless Gateway API Specification v1.261001 · PDF 20 · selected-logical-fields

Prerequisites: Agree deployment scope, authentication and permissions with Mobile-ID. Keep tokens and signing data on the backend; do not execute from this demo page.

Input — Documented fields

Logical parameter model; request encoding and authentication placement remain unconfirmed. Do not send this object as a JSON wire payload.

Fields edited from the source
Field	Type	Presence	Meaning and limits
`type`	string	Required	Document type supported by this operation.
`name`	string	Required	Signing transaction name.
`signers[0][id]`	string	Required	Caller signer identifier.
`signers[0][name]`	string	Required	Signer given name; use synthetic fixtures.
`signers[0][surname]`	string	Required	Signer surname.
`signers[0][email]`	string	Required	Signer email.
`files[0][token]`	string	Required	Previously uploaded-file token.
`postback_url`	string	Optional	Backend postback destination.
`process_type`	string · Serial, parallel, individual, custom	Optional	Source process type; clarify whether the unit is signer, document or transaction.
`template_token`	string	Optional	Template token distinct from file and signing tokens.

Outcome — Documented fields

This section has a catalog or outcome description only; a complete request schema is not available.

Items to confirm: GW12-AUTH, GW12-ENCODING, GW12-PROCESS

POST/gateway/api/signing/createbatch.json

api/signing/createbatch.json

Source documented · Deployment contract unconfirmed · Sandbox not tested

Source: GoPaperless Gateway API Specification v1.261001 · PDF 26 · selected-logical-fields

Prerequisites: Agree deployment scope, authentication and permissions with Mobile-ID. Keep tokens and signing data on the backend; do not execute from this demo page.

Input — Documented fields

Logical parameter model; request encoding and authentication placement remain unconfirmed. Do not send this object as a JSON wire payload.

Fields edited from the source
Field	Type	Presence	Meaning and limits
`signings[0][token]`	string	Required	Existing signing token.
`signings[0][signer_token]`	string	Required	Signer-specific token.

Outcome — Documented fields

Fields edited from the source
Field	Type	Presence	Meaning and limits
`status`	string	Optional	Source example ok.
`token`	string	Optional	Batch token.

Items to confirm: GW12-AUTH, GW12-ENCODING

POST/gateway/api/signing/arrangement/createbatch.json

api/signing/arrangement/createbatch.json

Source documented · Deployment contract unconfirmed · Sandbox not tested

Source: GoPaperless Gateway API Specification v1.261001 · PDF 27 · selected-logical-fields

Prerequisites: Agree deployment scope, authentication and permissions with Mobile-ID. Keep tokens and signing data on the backend; do not execute from this demo page.

Input — Documented fields

Logical parameter model; request encoding and authentication placement remain unconfirmed. Do not send this object as a JSON wire payload.

Fields edited from the source
Field	Type	Presence	Meaning and limits
`signings[0][token]`	string	Required	Existing signing token.

Outcome — Documented fields

Fields edited from the source
Field	Type	Presence	Meaning and limits
`status`	string	Optional	Source example ok.
`token`	string	Optional	Arrangement batch token.

Items to confirm: GW12-AUTH, GW12-ENCODING

POST/gateway/api/signing/{token}/archive.json

api/signing/{token}/archive.json

Source documented · Deployment contract unconfirmed · Sandbox not tested

Source: GoPaperless Gateway API Specification v1.261001 · PDF 31 · selected-logical-fields

Prerequisites: Agree deployment scope, authentication and permissions with Mobile-ID. Keep tokens and signing data on the backend; do not execute from this demo page.

Parameters

Operation parameters
Name	In	Required	Type
token	path	Yes	string

Input — Documented fields

Logical parameter model; request encoding and authentication placement remain unconfirmed. Do not send this object as a JSON wire payload.

Fields edited from the source
Field	Type	Presence	Meaning and limits
`postback_url`	string	Conditional	Source table requires this; description also mentions a previous URL. Confirm the condition.

Outcome — Documented fields

Fields edited from the source
Field	Type	Presence	Meaning and limits
`status`	string	Optional	Source example ok; not proof of long-term preservation.

Items to confirm: GW12-AUTH, GW12-ENCODING, GW12-ARCHIVE

GET/gateway/api/signing/{token}/status.json

api/signing/{token}/status.json

Source documented · Deployment contract unconfirmed · Sandbox not tested

Source: GoPaperless Gateway API Specification v1.261001 · PDF 33 · selected-logical-fields

Prerequisites: Agree deployment scope, authentication and permissions with Mobile-ID. Keep tokens and signing data on the backend; do not execute from this demo page.

Parameters

Operation parameters
Name	In	Required	Type
token	path	Yes	string

Input — Documented fields

Logical parameter model; request encoding and authentication placement remain unconfirmed. Do not send this object as a JSON wire payload.

This section has a catalog or outcome description only; a complete request schema is not available.

Outcome — Documented fields

Fields edited from the source
Field	Type	Presence	Meaning and limits
`status`	string	Optional	Business states described: Pending, completed, archived, failed; source JSON is invalid.
`file`	string	Conditional	Final-file URL when completed/archived in the source.
`valid_to`	string	Conditional	Validity value; do not infer a retention SLA.

Items to confirm: GW12-AUTH, GW12-JSON

POST/gateway/api/signing/{token}/prepare.json

api/signing/{token}/prepare.json

Source documented · Deployment contract unconfirmed · Sandbox not tested

Source: GoPaperless Gateway API Specification v1.261001 · PDF 34 · selected-logical-fields

Prerequisites: Agree deployment scope, authentication and permissions with Mobile-ID. Keep tokens and signing data on the backend; do not execute from this demo page.

Parameters

Operation parameters
Name	In	Required	Type
token	path	Yes	string

Input — Documented fields

Logical parameter model; request encoding and authentication placement remain unconfirmed. Do not send this object as a JSON wire payload.

Fields edited from the source
Field	Type	Presence	Meaning and limits
`signer_id`	string	Required	Signer to prepare.
`certificate`	string	Required	Base64 certificate.

Outcome — Documented fields

Fields edited from the source
Field	Type	Presence	Meaning and limits
`status`	string	Optional	Source example ok.
`dtbs`	string	Optional	Data to be signed.
`dtbs_hash`	string	Optional	Hash of data to be signed.
`algorithm`	string	Optional	Algorithm returned by prepare; source example sha256.

Synthetic example — No API call

{
  "signer_id": "DEMO-SIGNER",
  "certificate": "DEMO-BASE64-CERTIFICATE"
}

Items to confirm: GW12-AUTH, GW12-ENCODING

POST/gateway/api/signing/{token}/sign.json

api/signing/{token}/sign.json

Source documented · Deployment contract unconfirmed · Sandbox not tested

Source: GoPaperless Gateway API Specification v1.261001 · PDF 34 · selected-logical-fields

Prerequisites: Agree deployment scope, authentication and permissions with Mobile-ID. Keep tokens and signing data on the backend; do not execute from this demo page.

Parameters

Operation parameters
Name	In	Required	Type
token	path	Yes	string

Input — Documented fields

Logical parameter model; request encoding and authentication placement remain unconfirmed. Do not send this object as a JSON wire payload.

Fields edited from the source
Field	Type	Presence	Meaning and limits
`signer_id`	string	Required	Signer to finalize.
`signature_value`	string	Required	Signature value to finalize; representation needs agreement.

Outcome — Documented fields

Fields edited from the source
Field	Type	Presence	Meaning and limits
`status`	string	Optional	Source example ok; check the final document separately.

Items to confirm: GW12-AUTH, GW12-ENCODING, GW12-ASSEMBLY

POST/gateway/api/validation/upload.json

api/validation/upload.json

Source documented · Deployment contract unconfirmed · Sandbox not tested

Source: GoPaperless Gateway API Specification v1.261001 · PDF 43 · selected-logical-fields

Prerequisites: Agree deployment scope, authentication and permissions with Mobile-ID. Keep tokens and signing data on the backend; do not execute from this demo page.

Input — Documented fields

Logical parameter model; request encoding and authentication placement remain unconfirmed. Do not send this object as a JSON wire payload.

Fields edited from the source
Field	Type	Presence	Meaning and limits
`file[name]`	string	Required	File name.
`file[digest]`	string	Required	SHA256 digest for validation upload.
`file[content]`	string	Required	Base64 content.
`lang`	string · En, vi	Optional	Report language.
`postback_url`	string	Optional	Backend validation result destination.

Outcome — Documented fields

Fields edited from the source
Field	Type	Presence	Meaning and limits
`status`	string	Optional	Source example ok.
`token`	string	Optional	Validation token.

Synthetic example — No API call

{
  "file[name]": "demo-contract.pdf",
  "file[digest]": "DEMO-SHA256-DIGEST",
  "file[content]": "DEMO-BASE64-DOCUMENT",
  "lang": "en"
}

Items to confirm: GW12-AUTH, GW12-ENCODING

Catalog and coverage

All 34 method/path headings from GoPaperless Gateway API Specification v1.261001. Ten operations have selected logical request/response fields. Authentication placement and request encoding are not established; x-request-model is not a wire body. No execution server is configured.

Operations in the Specification
Method	Path	Coverage	PDF
GET	`/gateway/view/open/{token}`	catalog-only	8
GET	`/gateway/view/arrangement/{token}`	catalog-only	8
GET	`/gateway/view/signing/{token}`	catalog-only	8
GET	`/gateway/view/signing/batch/{token}`	catalog-only	8
GET	`/gateway/view/signing/sequence/{token}`	catalog-only	8
GET	`/gateway/view/arrangement/sequence/{token}`	catalog-only	8
GET	`/gateway/view/validation/{token}/show`	catalog-only	9
GET	`/gateway/view/configuration/{token}`	catalog-only	9
GET	`/gateway/view/template/{token}`	catalog-only	9
POST	`/gateway/api/signing/users/configure.json`	catalog-only	9
GET	`/gateway/api/signing/users/configure/{token}`	catalog-only	12
POST	`/gateway/api/signing/users/template.json`	catalog-only	14
GET	`/gateway/api/signing/users/template/{token}`	catalog-only	17
POST	`/gateway/api/file/upload`	selected-logical-fields	18
GET	`/gateway/api/file/upload/{token}/status.json`	selected-logical-fields	19
POST	`/gateway/api/file/{token}/delete.json`	catalog-only	18
POST	`/gateway/api/signing/create.json`	selected-logical-fields	20
POST	`/gateway/api/signing/createbatch.json`	selected-logical-fields	26
POST	`/gateway/api/signing/arrangement/createbatch.json`	selected-logical-fields	27
POST	`/gateway/api/signing/{token}/addsigner.json`	catalog-only	27
POST	`/gateway/api/signing/{token}/archive.json`	selected-logical-fields	31
POST	`/gateway/api/signing/{token}/delete.json`	catalog-only	32
POST	`/gateway/api/signing/{token}/removesigner.json`	catalog-only	32
GET	`/gateway/api/signing/{token}/status.json`	selected-logical-fields	33
POST	`/gateway/api/signing/{token}/prepare.json`	selected-logical-fields	34
POST	`/gateway/api/signing/{token}/sign.json`	selected-logical-fields	34
POST	`/gateway/api/signing/{token}/seal.json`	catalog-only	37
POST	`/gateway/api/archive.json`	catalog-only	38
POST	`/gateway/api/file/check.json`	catalog-only	38
POST	`/gateway/api/validation/upload.json`	selected-logical-fields	43
GET	`/gateway/api/validation/{token}/download/detailed-report-pdf`	catalog-only	43
GET	`/gateway/api/validation/{token}/download/diagnostic-data-xml`	catalog-only	44
GET	`/gateway/api/validation/{token}/download/report-pdf`	catalog-only	44
GET	`/gateway/api/validation/{token}/download/report-xml`	catalog-only	44

Separate callback, WebSocket and iframe channels

Channels and authoritative outcomes
Channel	Direction	Handling
Callback / postback	Service → backend	Persist outcomes, authenticate under the contract, deduplicate and reconcile.
WebSocket	Backend → frontend	Refresh UI; reconnect by reading durable state. Do not invent event IDs.
JavaScript iframe	Viewer → host UI	Settle Paperless/Isign SDK; validate origin and backend session, protect tokens.
Redirect	UI → browser	Not proof of a signature or final state.

Items to settle before integration

GW12-AUTH · Gateway §1–2

Authentication placement/type is not established.

Do not invent a Gateway auth header; agree backend integration.

GW12-ENCODING · Gateway §§4–9

Parameter tables do not establish request encoding.

Logical models use x-request-model; no executable requestBody.

GW12-UPLOAD · Gateway §4.1

File[url] is required in the table while content is an alternative.

Confirm URL/content condition and operation-specific SHA1 digest.

GW12-VIEW · Gateway §2.1 và §10.1

View catalog differs from iframe sample; signerToken/accessTok differ.

No runnable iframe URL until SDK/path/token are confirmed.

GW12-JS · Gateway §10.1

Paperless and Isign callbacks use different namespaces.

Do not merge callbacks into an invented SDK.

GW12-JSON · Gateway §5.8, §10

Some status/error examples are invalid JSON.

Label edited examples; full signer schema remains unconfirmed.

GW12-PROCESS · Gateway §5.1 và sơ đồ Viewer

process_type and UI parallel/serial behavior need an agreed unit.

Do not equate WebSocket with parallel signing.

GW12-ARCHIVE · Gateway §5.5

postback_url condition is unclear; archive does not prove long-term preservation.

Confirm callback conditions and archive scope.

GW12-ASSEMBLY · Viewer V.20261008, ký VNeID

VNeID flow returns signature data then reloads a document without an explicit assembling step.

Mark an unresolved step; do not invent an execution arrow.

FLOW12-TIMEOUT · Viewer, tạo chứng thư SIC, PDF 23

Callback TIMEOUT is mapped to WebSocket CANCELED.

Retain the distinction and request mapping confirmation.

FLOW12-STATUS · Viewer ký SIC

CANCEL/CANCELED and REJECT/REJECTED belong to different layers.

Do not collapse them into one enum.

Compare with Viewer actions

Watch the appropriate route, read outcomes and omissions, then consult the operation. Videos do not replace contracts or validation reports.

Watch seven Viewer/VNeID recordings

GoPaperless Gateway — Documents and signing orchestration

Coverage and integration prerequisites

Gateway and Viewer have distinct roles

Component boundaries and responsibilities

Complete document journey

Upload

Create / template

Arrange / prepare

Authorize / sign

Finalize / reconcile

Validation / archive

Source-based API Reference

Input — Documented fields

Outcome — Documented fields

Parameters

Input — Documented fields

Outcome — Documented fields

Input — Documented fields

Outcome — Documented fields

Input — Documented fields

Outcome — Documented fields

Input — Documented fields

Outcome — Documented fields

Parameters

Input — Documented fields

Outcome — Documented fields

Parameters

Input — Documented fields

Outcome — Documented fields

Parameters

Input — Documented fields

Outcome — Documented fields

Parameters

Input — Documented fields

Outcome — Documented fields

Input — Documented fields

Outcome — Documented fields

Catalog and coverage

Separate callback, WebSocket and iframe channels

Items to settle before integration

GW12-AUTH · Gateway §1–2

GW12-ENCODING · Gateway §§4–9

GW12-UPLOAD · Gateway §4.1

GW12-VIEW · Gateway §2.1 và §10.1

GW12-JS · Gateway §10.1

GW12-JSON · Gateway §5.8, §10

GW12-PROCESS · Gateway §5.1 và sơ đồ Viewer

GW12-ARCHIVE · Gateway §5.5

GW12-ASSEMBLY · Viewer V.20261008, ký VNeID

FLOW12-TIMEOUT · Viewer, tạo chứng thư SIC, PDF 23

FLOW12-STATUS · Viewer ký SIC

Compare with Viewer actions