Request a Verifiable Presentation with OIDC4VP
Integrators can use this endpoint to request a Verifiable Presentation using OIDC4VP. The request includes the scope of the request, an identifier for the request, and a callback URL where the credentials presented by the user will be sent if the presentation is successful.
A POST request will be sent to the callbackUrl
provided in the request.
This POST request will contain a validation report indicating how the
validation of the presentation went and what types of validation were performed.
ValidationReport Schema:
globalResult
: The overall result of the validation, with potential error messages.verifiablePresentation
: The received verifiable presentation.credentialsPresentedList
: List of credentials presented, each containing validation details.
Validation types include:
- Expiration
- NotYetValid
- Revocation
- Schema
- CredentialSignature
Possible validation results:
OK
: The validation was successful.KO
: The validation failed.NotValidated
: The validation was not performed.
{
"globalResult": {
"result": "OK | KO | NotValidated",
"errorMessage": "string (optional)"
},
"verifiablePresentation": {
// Verifiable Presentation details (JSON object)
},
"credentialsPresentedList": [
{
"verifiableCredential": "string | object",
"verifiableCredentialsDecoded": "object",
"validations": [
{
"type": "Expiration | NotYetValid | Revocation | Schema | CredentialSignature",
"result": "OK | KO | NotValidated",
"errorMessage": "string (optional)"
}
]
}
]
}
Request Body — REQUIRED |
---|
scope string — REQUIREDThe scope that defines the type of presentation to perform. Each scope will be associated with a Presentation Definition that will define the constrains of the presentation. |
verificationRequestId string — REQUIREDAn identifier of the Presentation Request. |
callbackUrl string — REQUIREDThe callback URL where the credentials presented by the user will be sent if the presentation is successful. The call to the callback URL will a POST request including a Validation Report. |
Responses | |||
---|---|---|---|
201 The response provides two different values and the integrator can consume whichever is useful in integrator's flow.
|