Onboarding API
Requirement is to perform
Create SCD to register the remote device
Create certificate to create user certificates
After that the Usage API is available
Create SCD
Item | Type | Mandatory |
|---|---|---|
Certificate request | CSR | Mandatory |
SCD type | remote SCD App | remote SCD App + Secure Element | remote SCD eSIM | remote SCD SIM | Mandatory |
Address | String | Mandatory |
Key id | Number | Mandatory |
Create SCD response
Item | Type | Mandatory |
|---|---|---|
SCD ID | String | Mandatory |
Status | OK|Error | Mandatory |
Description | String | Mandatory |
Create Certificate
Item | Type | Mandatory |
|---|---|---|
Name | String | Mandatory |
Country | String | 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 |
Create certificate response
Item | Type | Mandatory |
|---|---|---|
Certificate ID | String | Mandatory |
Certificate | X.509 | Mandatory |
Status | OK | ERROR | Mandatory |
Description | String | Mandatory |
List certificate
Item | Type | Mandatory |
|---|---|---|
SCD ID | String | Mandatory |
List certificate response
Item | Type | Mandatory |
|---|---|---|
Certificate ID | String | Mandatory |
Certificate | X.509 | Mandatory |
Status | OK|ERROR | Mandatory |
Description | String | Mandatory |
Usage API
Sign
Item | Type | Mandatory |
|---|---|---|
SCD ID | String | Mandatory |
hash | byte[] | Mandatory |
hash type | SHA256 | SHA384 | SHA512 | Mandatory |
data to be displayed | String | Mandatory |
Response
Item | Type | Mandatory |
|---|---|---|
signature | byte[] | |
signature key type | RSA|ECC|.. | |
certificate | X.509 |