Skip to main content

Out Of Band Verification

DARS provides a verification request mode called Out Of Band which allows the wallet to scan the qrcode and be directed to the proof view without waiting for a notification.

To activate this mode just add a parameter out_of_band=true to the verify/request API

DARS Api

verify/request

The /verify/request service allows you to ask for verifiable credentials to a user

In order to request verifiable credentials to a user, a proof template (or request) must be previously created for the own organization. The proof request can be configured using Dizme Studio (see documentation) Enable out_of_band request.

POST  /verify​/request
Request body:
{
  "business_code": "string",
  "allow_multiple_read": true,
  "request_uid": "string",
  "out_of_band": true
}
busines_code : business code of the proof template configured on Dizme Studio.
By example PROOF_01 business code

allow_multiple_read : true value consent to scan many time the same qrcode from several users

request_uid : must be set with an own generated unique identifier for the request, if the attribute is omitted, a unique identifier will be automatically generated 
Example Response body with allow_multiple_read=true:
{
   "status_code": 100,
   "message_code": 400,
   "message": "Invitation Created!",
   "request_uid": "12345-12345-12345",
   "invitation_short_link": "https://agent.dizme.io/api/v1/invitation/12345-12345-12345"
}


status_code : 100 success, 101 failure
message_code : internal code for operation 400 for “Invitation Created”
message : label for message of the operation
request_uid : the unique identifier of the request already sent or generated by the system.

invitation_short_link: url to be embended into ar qrcode/or to send to the user via other method (sms, email, webpage)

Example Response body with allow_multiple_read=false:

{
    "invitation": {
        "@type": "did:sov:BzCbsNYhMrjHiqZDTUASHg;spec/out-of-band/1.1/invitation",
        "@id": "a87c7c42-8567-40cc-9549-2ec5d322dc60",
        "handshake_protocols": [
            "did:sov:BzCbsNYhMrjHiqZDTUASHg;spec/didexchange/1.0"
        ],
        "requests~attach": [
            {
                "@id": "request-0",
                "mime-type": "application/json",
                "data": {
                    "json": {
                        "@type": "did:sov:BzCbsNYhMrjHiqZDTUASHg;spec/present-proof/1.0/request-presentation",
                        "@id": "9c84adbc-184a-4fce-bac9-874242c2677a",
                        "request_presentations~attach": [
                            {
                                "@id": "libindy-request-presentation-0",
                                "mime-type": "application/json",
                                "data": {
                                    "base64": "eyJ2ZXJzaW9uIjogIjEiLCAicmVxdWVzdGVkX2F0dHJpYnV0ZXMiOiB7ImF0dHJfcmVmZXJlbmNlMSI6IHsibmFtZSI6ICJ1c2VybmFtZSIsICJyZXN0cmljdGlvbnMiOiBbeyJjcmVkX2RlZl9pZCI6ICJOa202R3Z5YjV3Q3J1NTJyYUo4RGtWOjM6Q0w6ODA5MTQ6RDAifSwgeyJjcmVkX2RlZl9pZCI6ICI5TThNZkZYenc5ZmlhM1pOVDhRcXVCOjM6Q0w6NDM0NDY6RDBWMDEifV19fSwgIm5vbmNlIjogIjQ3Nzc5MjIwMTc2MTY3Mzc0NTcwMDYxMiIsICJuYW1lIjogIk9OTFlEMCIsICJyZXF1ZXN0ZWRfcHJlZGljYXRlcyI6IHt9fQ=="
                                }
                            }
                        ],
                        "comment": "eyJwcm9vZl9kZXRhaWxzIjogW3siYXR0cl9yZWZlcmVuY2UiOiAiYXR0cl9yZWZlcmVuY2UxIiwgInJldmVhbGVkIjogdHJ1ZSwgImRlc2NyaXB0aW9uIjogW3sibGFuZyI6ICJlbiIsICJtZXNzYWdlIjogIkQwIn1dLCAibWFuZGF0b3J5IjogdHJ1ZX1dLCAiY29tbWVudCI6IFt7ImxhbmciOiAiZW4iLCAibWVzc2FnZSI6ICJvbmx5IEQwIn1dfQ==",
                        "~thread": {
                            "pthid": "a87c7c42-8567-40cc-9549-2ec5d322dc60"
                        }
                    }
                }
            }
        ],
        "label": "Dizme",
        "services": [
            {
                "id": "#inline",
                "type": "did-communication",
                "recipientKeys": [
                    "did:key:z6MkixdveRusXXmMLV11Jrhi3eu7NupqfBSkN8Dg96tMSr3D"
                ],
                "serviceEndpoint": "https://aka-cl.dizme.io"
            }
        ],
        "public_did": "9M8MfFXzw9fia3ZNT8QquB"
    },
    "message_code": 400,
    "request_uid": "5079a3e4-4d66-11ee-aa4c-5a0e62058114",
    "status_code": 100,
    "invitation_short_link": "https://agent-cl.dizme.io/api/v1/out_of_band/invitation/5079a3e4-4d66-11ee-aa4c-5a0e62058114",
    "tid": "50a7eb82-4d66-11ee-aa4c-5a0e62058114",
    "message": "Invitation Created!"
}

status_code : 100 success, 101 failure
message_code : internal code for operation 400 for “Invitation Created”
message : label for message of the operation
request_uid : the unique identifier of the request already sent or generated by the system.

invitation_short_link: url to be embended into ar qrcode/or to send to the user via other method (sms, email, webpage)

invitation: low level details of invitation request (Plan to be removed).
Back to top