...
Requirement is to perform
Create SCD to register the remote device
Create certificate to create user certificatesIdentification at ID BB
Payment at payment BB
SCD enrollment (install App, create keys)
After that the Usage Create SCD and Certificate API is available
Create SCD and Certificate
Item
Item | Type | MandatoryDescription |
|---|---|---|
Certificate request | CSR | CSR (public key) is collected from SCD to create a Certificate. How the CSR is sent from a remote device is currently out of scope (can be e/mail/sms with request to install app, etc). Mandatory |
SCD type |
| Type of SCD. Mandatory |
AddressSCD remote ID | String | ID in a remote system that handles the messaging between SCD-s, depends on SCD type. Mandatory |
Key SCD key id | Number | They private key ID inside SCD for what the CSR corresponds with Mandatory |
Create SCD response
Name | X.509 Distinguished name | Mandatory |
Document ID | String |
Mandatory
Status
OK|Error
Mandatory
Description
String
Mandatory
...
Document ID based on what the verification has been performed. Optional | ||
Authentication token | JWT | Authentication token as result of ID Building Block. Mandatory |
Payment token | String | Payment token to indicate that payment has been done. If not present and payment is required HTTP 402 error is thrown. Optional |
Create SCD and Certificate response
Item | Type |
|---|
Description |
|---|
SCD ID | String | SCD ID identifies the SCD and binds it with the Certificate to be used. Mandatory |
Certificate |
PEM | Certificate that was issued. Mandatory |
Document type
passport | ID card | driver license
Optional
Document ID
String
Optional
Verification ID
Reference to ID Building Block
Mandatory
SCD ID
Reference to SCD
Mandatory
SCD type
local SCD/HSM or remote SCD
Mandatory
Payment option
free | paid | extended
Optional
...
Status & description |
| Mandatory |
List certificate
Item | Type | Descripiton |
|---|---|---|
SCD ID | String | Mandatory |
Authentication token | String | User can query his/her certificate & status, identification at ID BB required Mandatory |
List certificate response
Item | Type |
|---|
Mandatory
Certificate ID
String
Mandatory
Descripiton | ||
|---|---|---|
Certificate | X.509 | User’s certificate Mandatory when Status is OK |
Status & description |
|
Mandatory
Description
| Mandatory |
...
Update certificate status
Item | Type |
|---|
Item
Type
Mandatory
Certificate ID
String
Mandatory
Certificate
X.509
Mandatory
Status
OK|ERROR
Mandatory
Description
String
Descripiton | ||
|---|---|---|
SCD ID | String | Mandatory |
List certificate response
Authentication Token | JWT | Authentication token is necessary and should belong to a user or an authority Mandatory |
Status & reason |
| Mandatory |
Update certificate response
Item | Type | Descripiton |
|---|---|---|
Status & description |
| Mandatory |
Usage API
Sign
Item | Type | MandatoryDescripiton |
|---|---|---|
SCD ID | String | Mandatory |
format |
| Pre format the signature in a given format so that it can be more easily inserted by the formatting library. Mandatory |
hash | byte []array in base64 | Has to be signed. Hashing of document is responsibility of Signer Application and is done by formatting library. Mandatory |
hash typeSHA256 | SHA384 | SHA512 |
| Mandatory |
data to be displayed | String | Information to be displayed on users device, can involve free text like “Accept childcare request”, transactionId, etc. Mandatory |
Sign Response
Item | Type | Mandatory | ||
|---|---|---|---|---|
signature | byte [] | signature key type | RSA|ECC|..array in base64 | signature that is preformatted according to format |
certificate | X.509 | certificate with public key |