The Credentials Issuance service for combined APIs combines the User Credentials and User Credentials Session APIs. Rather than calling POST {{apiPath}}/environments/{{envID}}/users/{{userID}}/credentials and POST {{apiPath}}/environments/{{envID}}/users/{{userID}}/sharingSessions, you can choose to use the Credential Issuance (Combined APIs) to do this in one call: Initiate the issuance of a credential to a user, receive the requested data from the user, and record the status of the credential issuance process.

Credential Issuance (Combined APIs) data model

Property Type Required? Mutable? Description
applicationInstanceId String Required Immutable The UUID for the application instance registered with the Id Routing service. This enables the client to send messages to the service.
encryptedApplicationInstance Object Required Immutable The encrypted JSON object containing the JSON Web Key Set (JWKS) private and public key pairs for signing and encryption. This is used to send end-to-end encrypted messages to native SDKs registered with Id Routing. The JWKS is also used to sign registration records for the Id Registration service.
environmentId String Required Immutable The UUID for the environment.
expiryDate Date Optional Mutable The date that the user credential expires. If this value is null, the credential never expires.
logo Object Optional Mutable A TEXT object containing the brand logo for the issuer. This can be used when designing the credential for the user device wallet.
name String Required Immutable The name of the credential issuer.
siteURL String Required Immutable The site URL associated with the credential issuer.

Response codes

Code Message
200 Successful operation.
400 The request could not be completed.
401 You do not have access to this resource.
403 You do not have permissions or are not licensed to make this request.
404 The requested resource was not found.
500 Unexpected server error.