Back to All

Verifiable Presentation

Create a new authorisation request to start a verification process.

post

Endpoint facilitates the retrieval of a correlationId, definitionId, authStatusURIand 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

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
definitionIdstringRequired

The definitionId defines the credential to ask for, eg: emailCredential.The value should start with lowercase and continue using camelCase pattern.Must be one of the allowed definitions in the template endpoint.

Example: emailCredential
Responses
post
/api/v1/verifiable-presentations/definition/{definitionId}

Get verifiable presentation

get

Retrieve a single verifiable presentation record

Claim-based access control: Verifier_Admin, Verifier_Auditor, Verifier_User

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
correlationIdstring · uuidRequired

A UUID value that is bound to the VP

Example: f9dbff8e-6dba-4955-bd7f-61c083db290d
Responses
200

OK

application/json
get
/api/v1/verifiable-presentations/{correlationId}

Get verifiable presentations

get

Retrieve a paginated response of verifiable presentations

Claim-based access control: Verifier_Admin, Verifier_Auditor, Verifier_User

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
pagenumberOptional

Page number to retrieve.If you provide invalid value the default page number will applied Example: 1 Default Value: 1

limitnumberOptional

Number of records per page. Example: 20 Default Value: 20 Max Value: 100 

  If provided value is greater than max value, max value will be applied.
filter.correlationIdstring[]Optional

Filter by correlationId query param. Format: filter.correlationId={$not}:OPERATION:VALUE Example: filter.correlationId=$not:$like:John Doe&filter.correlationId=like:John Available Operations$eq

filter.definitionIdstring[]Optional

Filter by definitionId query param. Format: filter.definitionId={$not}:OPERATION:VALUE Example: filter.definitionId=$not:$like:John Doe&filter.definitionId=like:John Available Operations$eq

filter.createdBystring[]Optional

Filter by createdBy query param. Format: filter.createdBy={$not}:OPERATION:VALUE Example: filter.createdBy=$not:$like:John Doe&filter.createdBy=like:John Available Operations$eq

filter.modifiedBystring[]Optional

Filter by modifiedBy query param. Format: filter.modifiedBy={$not}:OPERATION:VALUE Example: filter.modifiedBy=$not:$like:John Doe&filter.modifiedBy=like:John Available Operations$eq

filter.createdAtstring[]Optional

Filter by createdAt query param. Format: filter.createdAt={$not}:OPERATION:VALUE Example: filter.createdAt=$not:$like:John Doe&filter.createdAt=like:John Available Operations$eq

filter.updatedAtstring[]Optional

Filter by updatedAt query param. Format: filter.updatedAt={$not}:OPERATION:VALUE Example: filter.updatedAt=$not:$like:John Doe&filter.updatedAt=like:John Available Operations$eq

filter.verifiedAtstring[]Optional

Filter by verifiedAt query param. Format: filter.verifiedAt={$not}:OPERATION:VALUE Example: filter.verifiedAt=$not:$like:John Doe&filter.verifiedAt=like:John Available Operations$eq

filter.statusstring[]Optional

Filter by status query param. Format: filter.status={$not}:OPERATION:VALUE Example: filter.status=$not:$like:John Doe&filter.status=like:John Available Operations$eq

filter.searchstring[]Optional

Filter by search query param. Format: filter.search={$not}:OPERATION:VALUE Example: filter.search=$not:$like:John Doe&filter.search=like:John Available Operations$fulltext

Responses
200Success
application/json
get
/api/v1/verifiable-presentations

Verifiable presentation search history audit log pagination

get

Endpoint returns history of verifiable presentation search requests

Claim-based access control: Verifier_Admin, Verifier_Auditor, Verifier_User

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
pagenumberOptional

Page number to retrieve.If you provide invalid value the default page number will applied Example: 1 Default Value: 1

limitnumberOptional

Number of records per page. Example: 20 Default Value: 20 Max Value: 100 

  If provided value is greater than max value, max value will be applied.
filter.createdBystring[]Optional

Filter by createdBy query param. Format: filter.createdBy={$not}:OPERATION:VALUE Example: filter.createdBy=$not:$like:John Doe&filter.createdBy=like:John Available Operations$eq

filter.updatedBystring[]Optional

Filter by updatedBy query param. Format: filter.updatedBy={$not}:OPERATION:VALUE Example: filter.updatedBy=$not:$like:John Doe&filter.updatedBy=like:John Available Operations$eq

filter.createdAtstring[]Optional

Filter by createdAt query param. Format: filter.createdAt={$not}:OPERATION:VALUE Example: filter.createdAt=$not:$like:John Doe&filter.createdAt=like:John Available Operations$gt

filter.updatedAtstring[]Optional

Filter by updatedAt query param. Format: filter.updatedAt={$not}:OPERATION:VALUE Example: filter.updatedAt=$not:$like:John Doe&filter.updatedAt=like:John Available Operations$gt

Responses
200Success
application/json
get
/api/v1/verifiable-presentations/search/history
PreviousAuthNextAgent > DID

Last updated