summaryrefslogtreecommitdiff
path: root/libeufin
diff options
context:
space:
mode:
authorMarcello Stanisci <stanisci.m@gmail.com>2019-09-30 15:51:18 +0200
committerMarcello Stanisci <stanisci.m@gmail.com>2019-09-30 15:51:18 +0200
commit5a11c666e9bd2d6c8ca83710721fae8775916dfa (patch)
tree6d99c7d225c1f2682752699847740543be538751 /libeufin
parenteadbb772736c1026b9b57ec5d8254d124fbfba8d (diff)
downloaddocs-5a11c666e9bd2d6c8ca83710721fae8775916dfa.tar.gz
docs-5a11c666e9bd2d6c8ca83710721fae8775916dfa.tar.bz2
docs-5a11c666e9bd2d6c8ca83710721fae8775916dfa.zip
JSON API for INI/HIA letters emulation.
Diffstat (limited to 'libeufin')
-rw-r--r--libeufin/api-sandbox.rst71
1 files changed, 68 insertions, 3 deletions
diff --git a/libeufin/api-sandbox.rst b/libeufin/api-sandbox.rst
index df0be59b..93ee1f8a 100644
--- a/libeufin/api-sandbox.rst
+++ b/libeufin/api-sandbox.rst
@@ -81,7 +81,72 @@ HTTP API
.. code-block:: tsref
interface KeyLetterRequest {
- partnerId: string;
- userId: string;
- // FIXME: other fields: see spec and put here
+
+ INI: {
+ // The user ID that participates in a EBICS subscriber.
+ userId: string;
+
+ // The customer ID specific to the bank (therefore not
+ // participating in a EBICS subscriber).
+ customerId: string;
+
+ // Human name of the user
+ name: string;
+
+ // Date of key creation. DD.MM.YYYY format.
+ date: string;
+
+ // Time of key creation. HH:MM:SS format.
+ time: string;
+
+ // Recipient. Bank "ID" (FIXME to be specified).
+ recipient: string;
+
+ // Electronic signature version. A004, for example.
+ es_version: string;
+
+ // RSA key exponent
+ exponent: string;
+
+ // RSA key modulus
+ modulus: string;
+
+ // RSA key hash
+ hash: string;
+ }
+
+ HIA: {
+ // The user ID that participates in a EBICS subscriber.
+ userId: string;
+
+ // The customer ID specific to the bank (therefore not
+ // participating in a EBICS subscriber).
+ customerId: string;
+
+ // Human name of the user
+ name: string;
+
+ // Date of key creation. DD.MM.YYYY format.
+ date: string;
+
+ // Time of key creation. HH:MM:SS format.
+ time: string;
+
+ // Recipient. Bank "ID" (FIXME to be specified).
+ recipient: string;
+
+ // Identification and authentication signature version, X002 for example.
+ ia_version: string;
+
+ // Encryption version, E002 for example.
+ enc_version: string;
+
+ // RSA key exponent
+ exponent: string;
+
+ // RSA key modulus
+ modulus: string;
+
+ // RSA key hash
+ hash: string;
}