Verification Inquiry

The verification inquiry is the counter part to the verification request. This entity is created on the holders side, when he receives a new request to share a presentation or a credential with the verifier.

The verification inquiry model

The verification inquiry model contains all information which was requested from the verifier to the holder, such as the requested template and the holders did.

Properties

Name
id
Type
string
Description
Unique identifier for the verification request.
Name
verifier
Type
string
Description
Verifier did of the request (usually the initiator of the request)
Name
holder
Type
string
Description
Holder did of the request.
Name
data
Type
string
Description
JSON payload of the request
Name
nonce
Type
string
Description
Unique identifier of the verification request (included in the proofs)
Name
state
Type
string
Description
Current state of the request

GET/verification-inquiries?organizationId=:organizationId

List all inquiries

This endpoint allows you to retrieve a paginated list of all verification inquiries. By default, a maximum of 20 inquiries are shown per page.

Required attributes

Name
organizationId
Type
string
Description
id of the organization

Optional attributes

Name
take
Type
integer
Description
Take the number of verification inquiries returned.
Name
skip
Type
integer
Description
Skip the number of verification inquiries returned.

Response

{
    "meta": {},
    "data": [{
        "id": "0ab1d747-29d9-44f3-ace5-b974cd4836de",
        "createdAt": "2024-01-11T13:37:27.188Z",
        "updatedAt": "2024-01-11T13:37:27.188Z",
        "data": {},
        "verifier": "did:ethr:0x022e10f219c3c9fe6932912198b124c3f9d7acc99d30c943e83b09d587a2362552",
        "holder": "did:ethr:0x038f5185bd3a9d07be70d5bb329d74a6bf6ba5f19c2b583c93a3e533780635d973",
        "walletId": "f91f845a-f218-4dae-b16c-773319282b42",
        "organizationId": "b278b70e-385b-4b58-90f5-50ba2d7913b3",
        "templateId": "f16989f6-ef97-48b2-a446-b85fd3575f19",
        "nonce": "963a13aa-8d98-41bc-946c-d21d8c2654ce",
        "state": "Received"
    }]
}

GET/verification-inquiries/:uuid?organizationId=:organizationId

Get single inquiry

This endpoint allows you to retrieve a single verification inquiries based on his id.

Required attributes

Name
uuid
Type
string
Description
uuid of the requested verification inquiry
Name
organizationId
Type
string
Description
id of the organization

Response

{
    "meta": {},
    "data": {
        "id": "0ab1d747-29d9-44f3-ace5-b974cd4836de",
        "createdAt": "2024-01-11T13:37:27.188Z",
        "updatedAt": "2024-01-11T13:37:27.188Z",
        "data": {},
        "verifier": "did:ethr:0x022e10f219c3c9fe6932912198b124c3f9d7acc99d30c943e83b09d587a2362552",
        "holder": "did:ethr:0x038f5185bd3a9d07be70d5bb329d74a6bf6ba5f19c2b583c93a3e533780635d973",
        "walletId": "f91f845a-f218-4dae-b16c-773319282b42",
        "organizationId": "b278b70e-385b-4b58-90f5-50ba2d7913b3",
        "templateId": "f16989f6-ef97-48b2-a446-b85fd3575f19",
        "nonce": "963a13aa-8d98-41bc-946c-d21d8c2654ce",
        "state": "Received"
    }
}

PUT/verification-inquiries/:uuid?organizationId=:organizationId

Answer a verification inquiry

This endpoint allows you answer an existing verification inquiry. This answer can either be accepted or declined. Additionally you can define if a verifiable credential or a verifiable presentation is sent back.

Required URL attributes

Name
uuid
Type
string
Description
uuid of the requested verification inquiry
Name
organizationId
Type
string
Description
id of the organization

Required payload body (application/json)

{
    "state": "Accepted" | "Declined",
        "data": {
            "sendCredential": true | false // sends either a VC or VP back
        }
}

Response

{
    "meta": {},
    "data": {
        "id": "6b7cf58b-cdb6-41e0-a798-93b44f9e1efd",
        "createdAt": "2024-01-11T13:14:44.980Z",
        "updatedAt": "2024-01-11T13:14:44.980Z",
        "data": {},
        "verifier": "did:ethr:0x022e10f219c3c9fe6932912198b124c3f9d7acc99d30c943e83b09d587a2362552",
        "holder": "did:ethr:0x038f5185bd3a9d07be70d5bb329d74a6bf6ba5f19c2b583c93a3e533780635d973",
        "walletId": "67d97d8a-e252-4870-841f-ed4339cb3fc1",
        "organizationId": "b278b70e-385b-4b58-90f5-50ba2d7913b3",
        "templateId": "f16989f6-ef97-48b2-a446-b85fd3575f19",
        "nonce": "2a747704-8238-4a8b-b578-75f7813bd277",
        "state": "Created"
    }
}