Verifying
OpenAPI documentation for the "Verifying" module
Last updated
OpenAPI documentation for the "Verifying" module
Last updated
Endpoint facilitates the retrieval of a correlationId
, definitionId
, authStatusURI
and authRequestURI
.
The correlationId
is a unique identifier for the request. The definitionId
is a name that's passed in the request
and represents name of credential (characterCredential). The authStatusURI
is a URI that shows where auth-status endpoint
is located. The authRequestURI
contains info that is put in QR data and is used to scan with mobile wallet app.Claim-based access control: Verifier_Admin, Verifier_User
A UUID value that is bound to the VP
"f9dbff8e-6dba-4955-bd7f-61c083db290d"
The definitionId defines the credential to ask for, eg: emailCredential. The value should start with lowercase and continue using camelCase pattern
"emailCredential"
Verification URL the wallet needs to consume to start SIOP communications
"openid-vc://?request_uri=https%3A%2F%2Fverifier-api-url%2Fprivate%2Fsiop%2Fdefinitions%2FcharacterCredential%2Fauth-requests%2Fc35f4780-8570-4346-9252-6941747107b5"
The url to use to fetch the status of the verification
"https://verifier-api-url/private/webapp/auth-status"
Returns the status of the auth request. The correlationId
is a unique identifier for the request that was passed in the request.
The definitionId
is a name that's passed in the request and represents name of credential (characterCredential).
The lastUpdated
is the time the request was last updated and
the status
indicates if the request was verified and shared or not. status
can be any of created
, sent
and verified
.
When it is verified, the payload
contains details about the credential. The id_token
is a JWT token that contains the
nonce
and state
ids. The vp_token
is a JWT token that contains the verifiableCredential
JWT token. That token contains
all the info about the credential being verified.Claim-based access control: Verifier_Admin, Verifier_User
A UUID value that is bound to the VP
"f9dbff8e-6dba-4955-bd7f-61c083db290d"
The definitionId defines the credential to ask for, eg: emailCredential. The value should start with lowercase and continue using camelCase pattern
"emailCredential"
A UUID value that is bound to the VP
"f9dbff8e-6dba-4955-bd7f-61c083db290d"
The definitionId defines the credential to ask for, eg: emailCredential. The value should start with lowercase and continue using camelCase pattern
"emailCredential"
The status of the verification. If status property is set verified the payload property should be defined!
"verified"
1732184934133
Verifiable Presentation object. If set means the client successfully provided its credentials
Additional claims part of the verifiable presentation
A detail description of the error