Webhook format

A webhook notification is sent for each verification status update (if enabled in the Sehaci Portal). The JSON payload of the notification varies based on the verification status.

Verification Status

Status	Description
STARTED	Mobile app has invoked SehaciSDK.prepare()
IN_PROGRESS	Encrypted mDL has been sent to the Sehaci Verification Service
PASSED	Document verified and valid
FAILED	Document verification failed

Started

{
  "verification_id": "a5c7d8e9-f0a1-b2c3-d4e5-f6a7b8c9d0e1",
  "created_at": "2024-06-25T11:00:00",
  "last_updated_at": "2024-06-25T11:00:00",
  "status": "STARTED",
  "wallet": "Apple"
}

In Progress

{
  "verification_id": "a5c7d8e9-f0a1-b2c3-d4e5-f6a7b8c9d0e1",
  "created_at": "2024-06-25T11:00:00",
  "last_updated_at": "2024-06-25T11:05:00",
  "status": "IN_PROGRESS",
  "wallet": "Apple",
  "merchant_config": {
    "merchant_config_id": "e67bea25-de89-4c92-89e7-9b6a8324a7fa",
    "merchant_config_description": "Identity check + photo + video"
  }
}

Passed

{
  "verification_id": "a5c7d8e9-f0a1-b2c3-d4e5-f6a7b8c9d0e1",
  "created_at": "2024-06-25T11:00:00",
  "last_updated_at": "2024-06-25T11:10:00",
  "status": "PASSED",
  "wallet": "Apple",
  "verified_at": "2024-06-25T11:05:00",
  "merchant_config": {
    "merchant_config_id": "e67bea25-de89-4c92-89e7-9b6a8324a7fa",
    "merchant_config_description": "Identity check + photo + video"
  },
  "issuer": {
    "issuer_id": "0C",
    "issuer_description": "Arizona DOT",
    "issuer_chain_valid": true,
    "issuer_signature_exists": true,
    "issuer_signature_valid": true,
    "issuer_signature_value": "f1e2d3c4b5a6f1e2d3c4b5a6f1e2d3c4"
  },
  "device": {
    "device_signature_exists": true,
    "device_signature_valid": true,
    "device_signature_value": null
  },
  "verified_data_elements": [
    "given_name",
    "family_name",
    "document_number",
    "expiry_date",
    "document_issue_date",
    "portrait",
    "resident_country",
    "birth_date",
    "age_in_years"
  ],
  "data_elements_stored": [
        {
            "given_name": "Randy",
            "may_store": true,
            "days": 30
        },
        {
            "family_name": "Brooker",
            "may_store": true
            "days": 30
        },
        {
            "document_number": "57256321",
            "may_store": false
        }
    ]
}

Failed

{
  "verification_id": "a5c7d8e9-f0a1-b2c3-d4e5-f6a7b8c9d0e1",
  "created_at": "2024-06-25T11:00:00",
  "last_updated_at": "2024-06-25T11:10:00",
  "status": "FAILED",
  "wallet": "Apple",
  "verified_at": "2024-06-25T11:10:00",
  "merchant_config": {
    "merchant_config_id": "e67bea25-de89-4c92-89e7-9b6a8324a7fa",
    "merchant_config_description": "Identity check + photo + video"
  },
  "reason": [
    "ISSUER_NOT_RECOGNIZED",
    "ISSUER_SIGNATURE_DOES_NOT_EXIST",
    "ISSUER_SIGNATURE_NOT_VALID",
    "DEVICE_SIGNATURE_DOES_NOT_EXIST",
    "DEVICE_SIGNATURE_NOT_VALID",
    "DATA_ELEMENT_NOT_RECOGNIZED",
    "SESSION_TRANSCRIPT_NOT_VALID",
    "DEVICE_KEY_FORMAT_NOT_VALID",
    "MSO_FORMAT_NOT_VALID"
  ],
  "details": "Issuer certificate not in the trust list"
}