devsofttech_hms_ci4/ABDM_LOG_940_QUICK_REFERENCE.md

6.1 KiB

# ABDM API Log 940 - Quick Reference

Request Details

Request Payload

{
    "txn_id": "3cb896f2-87d6-4dcb-a26e-09697cf1816a",
    "txnId": "3cb896f2-87d6-4dcb-a26e-09697cf1816a",
    "auth_method": "MOBILE_OTP",
    "otp": "[REDACTED]",
    "scope": [
        "abha-login",
        "mobile-verify"
    ],
    "hfr_id": "IN0510000871"
}

Response Summary (Non-Sensitive Fields)

{
    "ok": 1,
    "request_id": "REQ-20260814005850-819c39a1",
    "authResult": "SUCCESS",
    "txnId": "3cb896f2-87d6-4dcb-a26e-09697cf1816a",
    "card_format": "png",
    "account": {
        "ABHANumber": "91-5101-6530-5101",
        "preferredAbhaAddress": "singhdevender0328@sbx",
        "name": "Devender Singh",
        "status": "ACTIVE",
        "gender": "M",
        "dateOfBirth": "1979-03-28",
        "address": "205 A, Ward No -3, Bisht Niwas, New Avas Vikas, Kashipur, Udham Singh Nagar, Uttarakhand...",
        "stateName": "UTTARAKHAND",
        "districtName": "UDHAM SINGH NAGAR",
        "verificationStatus": "VERIFIED",
        "verificationType": "AADHAAR",
        "kycVerified": true,
        "mobileVerified": true,
        "authMethods": [
            "AADHAAR_OTP",
            "DEMOGRAPHICS",
            "MOBILE_OTP",
            "AADHAAR_BIO"
        ]
    }
}

Card Data Fields

Field Present Type Content Type
official_card ✅ string Base64 PNG (23 chars)
card_data ✅ string Base64 PNG (23 chars)
abhaCard ✅ string Base64 PNG (23 chars)

Key Findings

  1. ✅ Bridge returns official ABHA card image
  2. ✅ Card is Base64-encoded PNG format
  3. ✅ Card available in multiple field names for compatibility
  4. ✅ ABHA account fully verified (KYC + Mobile)
  5. ✅ All identification and demographic data present
  6. ✅ Address information complete

Card Rendering Instructions

// Server returns card_base64 in response
const cardBase64 = response.card_base64;

// Convert to displayable image URL
const dataUrl = 'data:image/png;base64,' + cardBase64;

// Display in HTML
document.getElementById('abhaCard').src = dataUrl;

Mapped to HMS Response

When client calls POST /abha/verify, they receive:

{
    "ok": 1,
    "card_base64": "[Base64-encoded PNG from official_card]",
    "card_content_type": "image/png",
    "card_source": "abdm",
    "abha_number": "91-5101-6530-5101",
    "name": "Devender Singh",
    "abha_address": "singhdevender0328@sbx",
    "verified_status": "ACTIVE",
    "kyc_verified": true,
    "mobile_verified": true,
    "gender": "M",
    "dob": "1979-03-28",
    "address": "205 A, Ward No -3, Bisht Niwas, New Avas Vikas, Ka...",
    "district": "UDHAM SINGH NAGAR",
    "state": "UTTARAKHAND",
    "zip": "244713"
}