Credential definitions

Upload image

POST/v4/config/ows/wallet/images

Uploads an image and returns its public URL (imageUrl). Put the URL in a display image of a credential definition (display.logo.uri or display.backgroundImage.uri) when you create or update the definition. Anybody can read the image at the URL with Read image, and the image stays: there is no delete. The image must be PNG, JPEG, GIF or WebP, at most 5 MiB and 4096 x 4096 pixels (the default limits). To set the logo or cover image of a stored credential definition in one call, use Update credential definition logo image.

Upload image

Language of the request sample

curl -X POST 'https://demo-api.igrant.io/v4/config/ows/wallet/images' \
  -H 'Authorization: ApiKey <your-api-key>' \
  -F 'image=@/path/to/file'

{
  "imageUrl": "https://demo-api.igrant.io/v4/config/ows/wallet/images/6af0c4254a55cecc6011ecd8"
}

Authorizations

Authorizationstringheaderrequired
Your API key with the prefix ApiKey: ApiKey <your-api-key>. Get an API key.
Scope:files:create

Body

multipart/form-data

A multipart form with the image file in the field image.

imagefilerequired
The image file: PNG, JPEG, GIF or WebP.

Response

application/json

The image is stored.

imageUrlstring<uri>
The public URL of the image: <API host>/v4/config/ows/wallet/images/<imageId>.