API Reference
Last updated
Last updated
Creates a Certificate Authority (CA) identifier (DID) and a new wallet address.
POST
'https://demo.eidcmp.wallid.io/api/v1/ca/
Headers
Name | Value |
---|---|
Request Body
Name | Type | Description |
---|---|---|
Example Request
Example Response
Creates a Certificate template as achema with fixed attributes and corresponding dynamic attestations.
POST
'https://demo.eidcmp.wallid.io/api/v1/template/
Headers
Request Body
Example Request
Component Object elements
Styles object elements:
Example Response
Returns the certificate template json file
GET
'https://demo.eidcmp.wallid.io/api/v1/template/:tid
Returns a the certificate template file in the specified file format (eg. .csv or .xls)
GET
'https://demo.eidcmp.wallid.io/api/v1/template/:tid/download/:fileFormat
Deletes Template from the API
DELETE
'https://demo.eidcmp.wallid.io/api/v1/template/:tid
Issues new certificate to and sends it to the a recipient email address.
POST
'https://demo.eidcmp.wallid.io/api/v1/credential/create
Headers
Request Body
Example Request
Example Response
Creates a verification URL to get and display certificate and verification data.
POST
'https://demo.eidcmp.wallid.io/api/v1/credential/create-verify-url
Headers
Request Body
Example Request
Example Response
Triggers socket io event in the Verify page session
GET
'https://demo.eidcmp.wallid.io/api/v1/credential/redirect/:sessionId
Gets certificate data for the session in the OIDC format
GET
'https://demo.eidcmp.wallid.io/api/v1/credential/data/:sessionId
Name | Value |
---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Value |
---|---|
Name | Type | Description |
---|---|---|
Name | Value |
---|---|
Name | Type | Description |
---|---|---|
Content-Type
application/json
Authorization
Bearer <token>
wa
string
wallet address
admin_email
string
registered email address of the account admin
Content-Type
application/json
Authorization
Bearer <token>
cid
string
CA identifier
name
string
Name of the Template
wa
string
CA wallet address
frontendProps
object
frontend elements and attributes of the certificate schema. Contains components
object and current_layout
array
components
object
contains all the visual and atribute elements of the certificate
CurrentLayout
string
type of certificate visual format (card, badge, vertical A4, horizontal H4)
id
string
type
string
inputType
string
content
string
styles
object
className
string
placeholder
string
src
string
text
string
name
string
value
string
isActive
boolean
isDraggable
boolean
x
number
y
number
baseText
(string | undefined)[]
originalText
string
maxCharacters
string
minCharacters
string
isMandatory
boolean
width
string
height
string
color
string
backgroundColor
string
fontSize
string | number
fontWeight
string
textAlign
string
fontFamily
string
isItalic
boolean
isBold
boolean
isUnderlined
boolean
letterSpacing
string
previousWidth
number
warp
number
cursor
string
Content-Type
application/json
Authorization
Bearer <token>
cid
string
CA identifier
tid
string
Template identifier
waAdmin
string
CA wallet address
data
dictionary
object with data to be stored in the credential (in the format of a list of "key": "value" pairs)
email
string
recipient person email address
Content-Type
application/json
Authorization
Bearer <token>
id
string
Certificate identifier
tid
string
Template identifier
guid
string
a unique identifier for the verification session and is returned in the init method