Developer Quickstart

Route-specific integration quickstart

Choose Gateway, RSS or SIC; connect actions with operations, correlation and reconciliation. Reference examples remain separate below.

Integration journeys Watch Viewer actions

ON THIS PAGE

Integrating GoPaperless Gateway

Steps and correlation
Step	Action	Responsibility and outcome	Documentation
1	Upload	Persist the file token and check upload status; confirm encoding before a live call.	Details
2	Create / template	Agree signers, authority, file tokens and process_type units.	Details
3	Prepare	Bind the certificate and signer_id to the document version; inspect dtbs/dtbs_hash.	Details
4	Authorize / sign	Select RSS or SIC; signing consent differs from login and data sharing.	Scope and prerequisites
5	Finalize	Obtain signature_value and finalize under the contract; detached signature data is not the final file.	Details
6	Status / validation	Read the final file, reconcile state and validate separately.	Details

This is a contract-reading guide, not a live API program. For lost responses, retain the request and correlation references and reconcile before resubmission.

Watch related Viewer actions

Integrating RSS / RS-HUB

Steps and correlation
Step	Action	Responsibility and outcome	Documentation
1	Authentication	Obtain the service token through SSO §2.1 on the backend; keep secrets out of Viewer.	Scope and prerequisites
2	Credential	Choose provider/package and retain x-rp-id and returned x-billcode-id.	Details
3	Certificates	Bind credential_id to the correct certificate; credential status is not signature validation.	Details
4	Sign hash	Prepare the digest from the correct document; persist service references and await user/outcome.	Details
5	Reconcile	Query with persisted references when callbacks are missing or outcomes unknown.	Details
6	Document / validation	Assemble and validate under the confirmed architecture; citizen ID checks do not replace this step.	Scope and prerequisites

This is a contract-reading guide, not a live API program. For lost responses, retain the request and correlation references and reconcile before resubmission.

Watch related Viewer actions

Integrating Trusted SIC

Steps and correlation
Step	Action	Responsibility and outcome	Documentation
1	Credential	Issue or select an eligible credential; do not infer S/A mode where the source conflicts.	Details
2	Digest	Bind documentDigests.hashes and hashAlgorithmOID to the correct document.	Details
3	Authorize	202 acceptance is not completed authorization. Open the UI with confirmed token/URL semantics.	Details
4	SAD	Obtain activation data under the contract; application/UI tokens are not substitutes for SAD.	Scope and prerequisites
5	Sign hash	Use credentialID, SAD, hashes and signAlgo from the source; no complete fixture until required values are confirmed.	Details
6	Result / document	Receive the signature, assemble and validate; missing Compact polling text does not establish API removal.	Scope and prerequisites

This is a contract-reading guide, not a live API program. For lost responses, retain the request and correlation references and reconcile before resubmission.

Watch related Viewer actions

QUICKSTART

From record to outcome

Reference model, not a production API contract. Examples use synthetic data only.

1. Prepare the record
Finalize the document version and authorized signer in the source system.
2. Create the transaction
Use document_ref, signer_ref, purpose and route from the reference example.
3. Persist and follow
Persist transaction_id on 202; do not mark completion.
4. User authorization
The user reviews the document and decides on the approved route.
5. Receive the result
Follow state or authenticated events and prevent duplicate effects.
6. Verify and hand off
Verify in the live system and hand outcome and evidence to the source system.

REFERENCE

One consistent dataset

POST /v1/signing-transactions
{
  "document_ref": "doc_demo_001",
  "signer_ref": "subject_demo_001",
  "purpose": "contract-approval",
  "route": "AUTO"
}

202 Accepted
{
  "transaction_id": "sig_txn_demo_001",
  "state": "WAITING_USER_ACTION",
  "model_status": "SIMULATED_ONLY"
}

If creation loses its response, retain the source record and reconcile. Do not silently create a new signing intent.

Practice in the simulator

Practice safe reconciliation locally

Application controls
Stage	Handling
Before submission	Persist the application case reference and document version. Do not substitute a local identifier for a service identifier.
Accepted or response lost	Retain the submitted request. 202 does not establish signing; response loss does not establish non-processing.
Callback/query	Correlate service references, verify source under the contract and persist durably. Reconcile duplicate/out-of-order callbacks.
Finalize and validate	Receiving a signature is not the final document. Finalization/assembling and validation have separate outcomes.

The Python example below runs with the standard library and a synthetic application journal. It makes no network calls, performs no cryptographic signing and does not emulate a service wire response.

Download runnable offline Python example

python3 reconciliation_demo.py