Individual wallet units

Create individual wallet unit

POST/v4/config/ows/wallet-provider/individual-wallet-units

Registers an individual wallet unit in advance: the wallet of a natural person in a mobile app on one device. A mobile wallet that is not registered registers itself, authorised, at its first Wallet Unit Attestation (WUA) request, so this operation is optional. Use it to register a wallet unit before that request, or with isAuthorised: false to hold its WUA requests until you authorise it with Update individual wallet unit.

The client id is unique for the wallet provider over both kinds of wallet unit and stays taken after a delete. No operation makes an organisation wallet unit.

Language of the request sample

curl -X POST 'https://demo-api.igrant.io/v4/config/ows/wallet-provider/individual-wallet-units' \
  -H 'Authorization: ApiKey <your-api-key>' \
  -H 'Content-Type: application/json' \
  -d '{
  "clientId": "wallet-unit-4f2a9c71",
  "clientUrl": "https://wallet.example.com",
  "clientPublicKey": {
    "kty": "EC",
    "crv": "P-256",
    "x": "Nbii9ohvDybKefFdAx4QfqqUAKPyZnihqOHDp3Z2jEA",
    "y": "DeBO5yAoahfS3HqfDmvrVsXvCzDrco4WLJ5wVIvTZ5s"
  },
  "isAuthorised": true,
  "devicePlatform": "android"
}'

{
  "individualWalletUnit": {
    "id": "6bf3bd97-50ba-4fec-9a78-1076b5627b5a",
    "clientId": "wallet-unit-4f2a9c71",
    "clientUrl": "https://wallet.example.com",
    "clientPublicKey": {
      "kty": "EC",
      "crv": "P-256",
      "x": "Nbii9ohvDybKefFdAx4QfqqUAKPyZnihqOHDp3Z2jEA",
      "y": "DeBO5yAoahfS3HqfDmvrVsXvCzDrco4WLJ5wVIvTZ5s"
    },
    "isAuthorised": true,
    "clientMetadata": null,
    "attestationStatus": "authorised",
    "attestationExpiresAt": 0,
    "createdAt": 1794149364,
    "updatedAt": 1794149364,
    "devicePlatform": "android",
    "deviceIntegrityToken": "",
    "deviceKeyId": "",
    "assertionToken": "",
    "assertionTokenType": ""
  }
}

Authorizations

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

Body

application/json

The new individual wallet unit.

clientIdstringrequired
Required. The client id of the wallet unit, usually its DID: the sub of its Wallet Unit Attestations. It must be new for the wallet provider: no wallet unit of either kind, also a deleted one, may have it.
clientUrlstring
Optional. The credential offer URL of the wallet. A wallet unit replaces it with the credential_offer_url of its next WUA request.
clientPublicKeyobjectrequired
Required. The public key of the wallet unit as a JWK: an EC key on P-256, P-384 or P-521 with kty, crv, x and y, and no private member. A single WUA request of the wallet replaces it with the key of its client assertion (cnf).
isAuthorisedboolean
true authorises the wallet unit at once, so that it can get Wallet Unit Attestations. Default false: authorise it later with Update individual wallet unit.
Default:false
devicePlatformenum<string>required
Required. The device platform of the wallet unit. The wallet provider refuses a WUA request of the wallet unit from another platform.
Available options:ios,android
Example:"android"

Response

application/json

The new individual wallet unit. Its device members and assertionToken stay empty until its first WUA request.

individualWalletUnitobject
The new individual wallet unit.