Mobile-ID Sign · INTEGRATION & PRACTICE

RSS: Registration, hash signing and reconciliation

Read structures edited from the Specification. Source conflicts are attached to operations; no execution server is configured.

Integration journeys Watch Viewer actions

ON THIS PAGE

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
`POST /v1/create/credential`	Selected fields	Deployment not confirmed	Not tested
`GET /v1/get/credential/status`	Selected response fields	Deployment not confirmed	Not tested
`POST /v1/sign/hash`	Selected fields	Deployment not confirmed	Not tested
`GET /v1/get/signing/status`	Selected response fields	Deployment not confirmed	Not tested
`GET /v1/get/certificates`	Selected response fields	Deployment not confirmed	Not tested
`POST /v1/request/citizen/identity-sharing`	Selected fields	Deployment not confirmed	Not tested
`GET /v1/get/citizen/identity-sharing`	Selected response fields	Deployment not confirmed	Not tested

Download scope-specific OpenAPI · Download documentary Postman

RSS, Postman and event channels

The supplied source is Specification 1.11.260911. Distinguish partner REST, callbacks and internal Kafka. Keep operation-specific x-billcode-id with caller references; identity sharing or a citizen-ID check is not signature validation.

Gateway API Gateway Viewer SIC Compact

Scope and assets

Source: RSS 1.11.260911. OpenAPI edits 7 operations with selected fields; the catalog retains all 18 source REST functions. This is not an accepted production contract.

OpenAPI JSON OpenAPI YAML Postman Environment

Operations and data structures

POST/v1/create/credential

Register a credential

Source documented · Deployment contract unconfirmed · Sandbox not tested

OperationId: RssCreateCredential · RSS 1.11.260911 · PDF pages: 15, 16, 17, 18, 19

Source-derived; deployment remains unconfirmed. Sample inputs are for reading, not live submission.

Preconditions and authentication

Confirm provider/package, partner_code and originator_id; prepare registration data within consent scope. An issued credential is not yet required. Keep the Bearer token server-side; exclude tokens/SAD from frontend code and public logs.

Operation headers
Header	Required	Meaning
`x-language`	No	Response language.
`x-rp-id`	No	RP-generated reference, distinct from service-generated x-billcode-id.

Request · application/json

Request schema
Field	Type	Presence	Description
`provider`	string	Required	RSS provider identifier; confirm deployment configuration.
`service_package_code`	string	Required	Provider service package code.
`partner_code`	string	Required	Code of the partner submitting the request.
`originator_id`	string	Required	Identifier of the originating application.
`platform`	string	Optional / source conditions	Originating channel: WEB or APP. enum: WEB, APP; default: WEB
`operation_mode`	string	Optional / source conditions	S: Synchronous; A: asynchronous, default A in the RSS table. enum: S, A; default: A
`postback_url`	string	Optional / source conditions	RP result receiver; confirm registration and sender verification. format: uri
`user_info`	object	Required
`user_info.citizen_pid`	string	Required	Citizen personal identifier; never enter real data in the demo.
`user_info.full_name`	string	Optional / source conditions	Full name when supplied.
`user_info.birth_date`	string	Optional / source conditions	Birth date in the deployment format.
`user_info.phone`	string	Optional / source conditions	Phone number when needed.
`user_info.email`	string	Optional / source conditions	Email when needed.
`user_info.issuing_authority`	string	Optional / source conditions	Citizen-ID issuing authority; optional. Format follows the deployment contract.
`user_info.date_of_issue`	string	Optional / source conditions	Citizen-ID issue date; optional. Format follows the deployment contract.
`user_info.gender`	string	Optional / source conditions	Gender; optional. Format follows the deployment contract.
`user_info.nationality_code`	string	Optional / source conditions	Nationality code; optional. Format follows the deployment contract.
`user_info.permanent_address`	string	Optional / source conditions	Permanent address; optional. Format follows the deployment contract.
`user_info.permanent_village_text`	string	Optional / source conditions	Permanent locality name; optional. Format follows the deployment contract.
`user_info.permanent_city_text`	string	Optional / source conditions	Permanent city/province name; optional. Format follows the deployment contract.
`user_info.living_place_address`	string	Optional / source conditions	Current address; optional. Format follows the deployment contract.
`user_info.living_place_village_text`	string	Optional / source conditions	Current locality name; optional. Format follows the deployment contract.
`user_info.living_place_city_code`	string	Optional / source conditions	Current city/province code; optional. Format follows the deployment contract.
`user_info.living_place_city_text`	string	Optional / source conditions	Current city/province name; optional. Format follows the deployment contract.
`user_info.id_card_expire_date`	string	Optional / source conditions	Citizen-ID expiry date; optional. Format follows the deployment contract.

Illustrative payload — Not executed against the service

{
  "provider": "HUD-FPT-CA",
  "service_package_code": "DEMO_PACKAGE",
  "partner_code": "DEMO_PARTNER",
  "originator_id": "DEMO_APP",
  "user_info": {
    "citizen_pid": "DEMO_CITIZEN_ONLY"
  },
  "operation_mode": "A"
}

Response · 200

Read HTTP status and business outcome separately.

Response 200
Field	Type	Presence	Description
`status`	string	Optional / source conditions	Credential registration processing status.

Response · default

Read HTTP status and business outcome separately.

Response default
Field	Type	Presence	Description
`code`	string	Optional / source conditions	Service error code, distinct from HTTP status.
`message`	string	Optional / source conditions	Short error message.
`description`	string	Optional / source conditions	Detailed explanation when present.

Next action

Persist x-billcode-id, await user action and reconcile status before creating another request.

GET/v1/get/credential/status

Read credential registration status

Source documented · Deployment contract unconfirmed · Sandbox not tested

OperationId: RssGetCredentialStatus · RSS 1.11.260911 · PDF pages: 20, 21

Source-derived; deployment remains unconfirmed. Sample inputs are for reading, not live submission.

Preconditions and authentication

Registration was submitted and x-billcode-id retained. Use the registration reference, not a signing request reference. Keep the Bearer token server-side; exclude tokens/SAD from frontend code and public logs.

Operation headers
Header	Required	Meaning
`x-billcode-id`	Yes	Reference from credential creation.
`x-language`	No	Response language.
`x-rp-id`	No	RP-generated reference, distinct from service-generated x-billcode-id.

Response · 200

Read HTTP status and business outcome separately.

Data presence in the table and processing examples differs; this schema does not select a production branch.

Response 200
Field	Type	Presence	Description
`status`	string	Optional / source conditions	Business status described by the source.
`data`	object	Optional / source conditions	Object from source tables.
`data.citizen_pid`	string	Optional / source conditions	Citizen ID; read presence conditions alongside the status.
`data.description`	string	Optional / source conditions	Status-dependent outcome explanation.
`data.credential_id`	string	Optional / source conditions	Credential identifier when returned.
`data.serial_number`	string	Optional / source conditions	Certificate serial number.
`data.certificate_data`	string	Optional / source conditions	Base64 certificate data in the source.

Response · default

Read HTTP status and business outcome separately.

Response default
Field	Type	Presence	Description
`code`	string	Optional / source conditions	Service error code, distinct from HTTP status.
`message`	string	Optional / source conditions	Short error message.
`description`	string	Optional / source conditions	Detailed explanation when present.

Confirmation required

RSS-01
RSS-05

Next action

Reconcile registration outcome before retrieving certificates.

POST/v1/sign/hash

Sign document digests

Source documented · Deployment contract unconfirmed · Sandbox not tested

OperationId: RssSignHash · RSS 1.11.260911 · PDF pages: 27, 28, 29, 30

Source-derived; deployment remains unconfirmed. Sample inputs are for reading, not live submission.

Preconditions and authentication

Have an eligible credential and fixed document version. Prepare digests using confirmed encoding/algorithm; signing may still require user action. Keep the Bearer token server-side; exclude tokens/SAD from frontend code and public logs.

Operation headers
Header	Required	Meaning
`x-language`	No	Response language.
`x-rp-id`	No	RP-generated reference, distinct from service-generated x-billcode-id.

Request · application/json

Request schema
Field	Type	Presence	Description
`credential_id`	string	Required	Identifier associated with the selected key and certificate.
`citizen_pid`	string	Required	Citizen personal identifier; never enter real data in the demo.
`partner_code`	string	Required	Code of the partner submitting the request.
`originator_id`	string	Required	Identifier of the originating application.
`operation_mode`	string	Optional / source conditions	S: Synchronous; A: asynchronous, default A in the RSS table. enum: S, A; default: A
`platform`	string	Optional / source conditions	Originating channel: WEB or APP. enum: WEB, APP; default: WEB
`postback_url`	string	Optional / source conditions	RP result receiver; confirm registration and sender verification. format: uri
`documents`	object[]	Required	Document names and digests; confirm the digest encoding.
`documents[].document_name`	string	Required	Document name.
`documents[].digest_value`	string	Required	Document digest; no real document in the demo.

Illustrative payload — Not executed against the service

{
  "credential_id": "DEMO_RSS_CREDENTIAL",
  "citizen_pid": "DEMO_CITIZEN_ONLY",
  "partner_code": "DEMO_PARTNER",
  "originator_id": "DEMO_APP",
  "documents": [
    {
      "document_name": "DEMO_DOCUMENT",
      "digest_value": "ypeBEsobvcr6wjGzmiPcTaeG7/gUfE5yuYB3ha/uSLs="
    }
  ],
  "operation_mode": "A"
}

Response · 200

Read HTTP status and business outcome separately.

Response 200
Field	Type	Presence	Description
`data`	object	Optional / source conditions
`data.status`	string	Optional / source conditions	Status in the response table.
`data.signatures`	string[]	Optional / source conditions	Base64 signatures according to the table; confirm envelope.
`status`	string	Optional / source conditions	Top-level status in the source example; relationship with data.status unconfirmed.

Response · default

Read HTTP status and business outcome separately.

Response default
Field	Type	Presence	Description
`code`	string	Optional / source conditions	Service error code, distinct from HTTP status.
`message`	string	Optional / source conditions	Short error message.
`description`	string	Optional / source conditions	Detailed explanation when present.

Confirmation required

RSS-01
RSS-02
RSS-04

Next action

Persist the reference and reconcile via callback or status lookup; PROCESSING is not completion.

GET/v1/get/signing/status

Read signing outcome

Source documented · Deployment contract unconfirmed · Sandbox not tested

OperationId: RssGetSigningStatus · RSS 1.11.260911 · PDF pages: 31, 32

Source-derived; deployment remains unconfirmed. Sample inputs are for reading, not live submission.

Preconditions and authentication

Retain x-billcode-id from sign/hash. Reconcile its outcome before deciding to create another request. Keep the Bearer token server-side; exclude tokens/SAD from frontend code and public logs.

Operation headers
Header	Required	Meaning
`x-billcode-id`	Yes	Reference returned by sign/hash.
`x-language`	No	Response language.
`x-rp-id`	No	RP-generated reference, distinct from service-generated x-billcode-id.

Response · 200

Read HTTP status and business outcome separately.

Response 200
Field	Type	Presence	Description
`status`	string	Optional / source conditions	Signing request state.
`data`	object	Optional / source conditions
`data.signatures`	string[]	Optional / source conditions	Inconsistent source description; not sufficient to interpret cryptographic output.
`data.description`	string	Optional / source conditions	Outcome explanation.

Response · default

Read HTTP status and business outcome separately.

Response default
Field	Type	Presence	Description
`code`	string	Optional / source conditions	Service error code, distinct from HTTP status.
`message`	string	Optional / source conditions	Short error message.
`description`	string	Optional / source conditions	Detailed explanation when present.

Confirmation required

RSS-01
RSS-02

Next action

Bind the outcome to the document version; assemble and validate under the contract.

GET/v1/get/certificates

Read certificates for the citizen

Source documented · Deployment contract unconfirmed · Sandbox not tested

Source: RSS 1.11.260911 · PDF 23,24,25,26 · selected-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.

Source authentication: Bearer

Parameters

Operation parameters
Name	In	Required	Type
x-language	header	No	string
x-rp-id	header	No	string
x-citizen-pid	header	Yes	string
x-certificate-info-enabled	header	No	boolean
x-certificates	header	No	string

HTTP 200

Certificate and key response
Field	Type	Presence	Meaning and limits
`certificates`	array	Optional	Service certificate list.
`certificates[].status`	string	Optional	RSS certificate status: 0 locked, 1 active, 2 expired; not a document validation result.
`certificates[].cert_chains`	array	Required	Base64 X.509 chain; signer certificate first in the source.
`certificates[].credential_id`	string	Required	Credential identifier associated with key and certificate.
`certificates[].serial_number`	string	Conditional	Serial number, returned when certificate information is enabled.
`certificates[].issuer_dn`	string	Conditional	Issuer distinguished name; conditional.
`certificates[].subject_dn`	string	Conditional	Subject distinguished name; no real data in fixtures.
`certificates[].valid_from`	string	Conditional	Validity start in ISO 8601 UTC when certificate information is enabled.
`certificates[].valid_to`	string	Conditional	Validity end in ISO 8601 UTC; not a revocation check.
`key`	object	Optional
`key.status`	string	Optional	Source key status; no invented enum.
`key.algos`	array	Optional	Returned key algorithm OIDs.
`key.len`	integer	Optional	Key length in bits.
`key.curve`	string	Optional	Curve when applicable.

Next: Inspect business state and reconcile tracking identifiers; assemble and validate the document only after receiving the correct signing result. Reconcile a lost response before creating another request.

The source uses both x-certificate-info-enabled and x-certificate-info-enable. Confirm the header before a live call; see RSS13-CERT-HEADER. Certificate metadata is not a document validation report.

POST/v1/request/citizen/identity-sharing

Request VNeID data-sharing consent

Source documented · Deployment contract unconfirmed · Sandbox not tested

Source: RSS 1.11.260911 · PDF 33,34,35 · selected-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.

Source authentication: Bearer

Parameters

Operation parameters
Name	In	Required	Type
x-language	header	No	string
x-rp-id	header	No	string

Input — Documented fields

Content-Type: application/json

Fields edited from the source
Field	Type	Presence	Meaning and limits
`citizen_pid`	string	Required	Citizen identifier.
`request_time`	string	Optional	Source format ddMMyyyyHHmmss.
`target_code`	string · Update-info-web, update-info-app	Required	Sharing target.
`postback_url`	string	Optional	Backend postback URL.

HTTP 200

Fields edited from the source
Field	Type	Presence	Meaning and limits
`status`	string	Required	Business outcome; not an HTTP status or signature validation result.
`code`	string	Optional	Source error identifier; do not translate.
`message`	string	Optional	Error summary.
`description`	string	Optional	Error explanation.
`data`	object	Conditional	Initialization result, not shared data or a signature.
`data.transaction_code`	string	Required	VNeID transaction code returned after initialization.
`data.response_time`	string	Optional	Source table says String[] while its example is String; unresolved.

Items to confirm: RSS12-SHARE-TYPE

GET/v1/get/citizen/identity-sharing

Read the data-sharing result

Source documented · Deployment contract unconfirmed · Sandbox not tested

Source: RSS 1.11.260911 · PDF 36,37,38 · selected-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.

Source authentication: Bearer

Parameters

Operation parameters
Name	In	Required	Type
x-language	header	No	string
x-rp-id	header	No	string
x-transaction-code	header	Yes	string
x-request-time	header	No	string
x-target-code	header	Yes	string

HTTP 200

Fields edited from the source
Field	Type	Presence	Meaning and limits
`status`	string	Required	Business outcome; not an HTTP status or signature validation result.
`code`	string	Optional	Source error identifier; do not translate.
`message`	string	Optional	Error summary.
`description`	string	Optional	Error explanation.
`data`	object	Conditional	Sharing outcome; full citizen fields intentionally not used in demo fixtures.
`data.user_info_token`	string	Conditional	JWS-formatted sharing token; check under the agreed trust contract.
`data.response_time`	string	Optional	Response time in source format.
`data.description`	string	Optional	Outcome explanation.

Items to confirm: RSS12-SHARE-HEADER

Source function catalog

Specification functions
Function	Method / path	PDF page	Page coverage
Authentication	`POST {sso-url}/realms/{realm}/protocol/openid-connect/token`	8	Source catalog; schema not fully transcribed
System info	`GET /v1/get/system/info`	9	Source catalog; schema not fully transcribed
Register partner	`POST /v1/register/partner`	12	Source catalog; schema not fully transcribed
Create credential	`POST /v1/create/credential`	15	Read schema here
Credential status	`GET /v1/get/credential/status`	20	Read schema here
Certificates	`GET /v1/get/certificates`	23	Source catalog; schema not fully transcribed
Sign hash	`POST /v1/sign/hash`	27	Read schema here
Signing status	`GET /v1/get/signing/status`	31	Read schema here
Identity sharing request	`POST /v1/request/citizen/identity-sharing`	33	Source catalog; schema not fully transcribed
Identity sharing result	`GET /v1/get/citizen/identity-sharing`	36	Source catalog; schema not fully transcribed
Transactions	`GET /v1/get/transactions`	39	Source catalog; schema not fully transcribed
RP universal link	`GET /v1/get/rp/universal-link`	42	Source catalog; schema not fully transcribed
Tax information	`GET /v1/get/tax/information`	44	Source catalog; schema not fully transcribed
Tax information result	`GET /v1/get/tax/information/result`	54	Source catalog; schema not fully transcribed
Application type	`GET /v1/get/application/type`	62	Source catalog; schema not fully transcribed
Partners	`GET /v1/get/partners`	65	Source catalog; schema not fully transcribed
Verify citizen ID	`POST /v1/verify/eid`	67	Source catalog; schema not fully transcribed
Reload system	`POST /v1/reload/system`	70	Source catalog; schema not fully transcribed

Items to settle before integration

RSS-01 · RSS §1.4; endpoint tables

The base URL already contains /v1 while paths also contain /v1.

Confirm composed URLs before configuring an environment.

RSS-02 · RSS signHash / signing status, physical pp.27–32

Tables and examples differ in envelope; lookup signature description is unclear.

Confirm success/processing schemas per operation.

RSS-03 · RSS createCredential, physical pp.15–19

Example omits mandatory table fields and includes fields not listed.

Edited examples include mandatory fields; they are not executed requests.

RSS-04 · RSS signHash, physical pp.27–30

Digest encoding and conditional outcomes need deployment confirmation.

Do not import SIC algorithms/encoding into RSS.

RSS-05 · RSS credential status, physical pp.20–21

Table requires data.citizen_pid/data.description while PROCESSING examples omit data.

Confirm status-dependent presence; do not invent production schema branches.

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

RSS: Registration, hash signing and reconciliation

Coverage and integration prerequisites

RSS, Postman and event channels

Scope and assets

Operations and data structures

Preconditions and authentication

Request · application/json

Response · 200

Response · default

Confirmation required

Next action

Preconditions and authentication

Response · 200

Response · default

Confirmation required

Next action

Preconditions and authentication

Request · application/json

Response · 200

Response · default

Confirmation required

Next action

Preconditions and authentication

Response · 200

Response · default

Confirmation required

Next action

Parameters

HTTP 200

Parameters

Input — Documented fields

HTTP 200

Parameters

HTTP 200

Source function catalog

Items to settle before integration

RSS-01 · RSS §1.4; endpoint tables

RSS-02 · RSS signHash / signing status, physical pp.27–32

RSS-03 · RSS createCredential, physical pp.15–19

RSS-04 · RSS signHash, physical pp.27–30

RSS-05 · RSS credential status, physical pp.20–21

Data sharing: Tracking and limits

Compare with Viewer actions