Create Digital Wallet
POST {{apiPath}}/environments/{{envID}}/users/{{userID}}/digitalWallets
The POST {{apiPath}}/environments/{{envID}}/users/{{userID}}/digitalWallets operation creates a digital wallet for the specified user in the specified environment.
A request body is required to create a digital wallet.
Prerequisites
Create a user to get a
userIDfor the endpoint. See also Users, especially User operations.Create Digital Wallet App to get a
digitalWalletApplication.idfor the body. See also PingOne Credentials, especially Credential Digital Wallets.
See Credential digital wallet data model for full property descriptions.
| Property | Type | Required? |
|---|---|---|
digitalWalletApplication.id | String | Required |
applicationInstance.id | String | Optional |
notification | Object | Optional |
notification.template | Object | Optional |
notification.template.locale | String | Required |
notification.template.variant | String | Required |
notification.template.variables | Object[] | Required/Optional |
After receipt of this request, the digital wallet service uses the digital_wallet_pairing notification template to send the pairing session URL to the user via email or SMS text. The notification.template object can define a variant and locale for the notification, if needed.
Note: You must include a notification object in this create request if you want to use a custom notification template. You cannot use Update Digital Wallet to add it later.
Request Body
{"digitalWalletApplication"=>{"id"=>"{{digitalWalletApplicationID}}"}, "notification"=>{"methods"=>["EMAIL", "SMS"], "template"=>{"locale"=>"en", "variant"=>"variant_B"}}}
RESPONSES
status: Created
{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/49825b76-e1df-4cdc-b973-0c580f1cb049/digitalWallets/46e7018d-b2d5-482f-a44c-3fa9dd34e7d9"},"appOpen":{"href":"https://credentials.customer.com?u=https%3A%2F%2Fapi.pingone.com%2Fv1%2Fdistributedid%2Frequests%2F4766467d-2dd8-4cba-a9b7-10ba09b97354"},"qrUrl":{"href":"https://api.pingone.com/v1/distributedid/requests/4766467d-2dd8-4cba-a9b7-10ba09b97354"}},"id":"46e7018d-b2d5-482f-a44c-3fa9dd34e7d9","createdAt":"2023-02-10T14:46:24.669Z","updatedAt":"2023-02-10T14:46:24.669Z","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"user":{"id":"49825b76-e1df-4cdc-b973-0c580f1cb049"},"digitalWalletApplication":{"id":"9f698462-21d5-4fd6-8599-c2b56683eb57"},"status":"PAIRING_REQUIRED","pairingSession":{"id":"37d2b506-0ea7-4697-8884-c66ada3f4c48","createdAt":"2023-02-10T14:46:24.669Z","updatedAt":"2023-02-10T14:46:24.669Z","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"user":{"id":"49825b76-e1df-4cdc-b973-0c580f1cb049"},"digitalWallet":{"id":"46e7018d-b2d5-482f-a44c-3fa9dd34e7d9"},"challenge":"48p16h6eouv734ob","qrUrl":"https://api.pingone.com/v1/distributedid/requests/4766467d-2dd8-4cba-a9b7-10ba09b97354","status":"INITIAL"},"notification":{"methods":["EMAIL","SMS"],"template":{"locale":"en","variant":"variant_B"},"results":[{"method":"EMAIL","sent":true,"notification":{"id":"00a9e836-c339-4763-ab69-fcd3aa9c5417"}},{"method":"SMS","sent":false,"error":{"id":"17c006ef-9e5f-443b-b883-86f0855aa936","code":"INVALID_DATA","message":"The request could not be completed. One or more validation errors were in the request.","details":[{"code":"INVALID_VALUE","message":"Could not find phone attribute for user 49825b76-e1df-4cdc-b973-0c580f1cb049."}]}}]}}