BÊN MUA
NA

Tài liệu & API Documentation

Hướng dẫn tích hợp, API reference (OpenAPI 3.0), SDK và code samples đầy đủ

Bắt đầu trong 5 phút

3 bước đơn giản để gọi API đầu tiên

1
Tạo API Key
# Vào trang /buyer/api-keys và nhấn "Tạo API Key mới"
# Lưu key an toàn - chỉ hiển thị 1 lần
SDL_API_KEY=sdl_live_7f4a8b2c9d3e1f5a6b8c9d0e1f2a3b4c
2
Gọi API đầu tiên (cURL)
curl -X POST https://api.sdl.gov.vn/v1/vneid/verify \
  -H "Authorization: Bearer $SDL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "cccd": "079123456789",
    "purpose": "KYC"
  }'
3
Nhận response
{
  "verified": true,
  "data": {
    "ho_ten": "NGUYEN VAN AN",
    "ngay_sinh": "1990-05-15",
    "quoc_tich": "Việt Nam"
  },
  "consent_receipt": "CR-2026-04-0124",
  "rate_limit_remaining": 982
}

SDK chính thức

Được bảo trì bởi Trung tâm Dữ liệu Quốc gia

Node.js / TypeScript
@sdl/node-sdk
v2.4.1
Python
sdl-python
v2.3.8
Java
vn.sdl:sdl-java
v2.4.0
.NET / C#
SDL.VietNam
v2.3.5
Go
github.com/sdl/go-sdk
v2.4.2
PHP
sdl/php-sdk
v2.3.1

API Endpoints phổ biến

Top 5 endpoints được sử dụng nhiều nhất · Full reference trong Swagger UI

POST
/api/v1/vneid/verifyXác thực danh tính qua VNeID
DV-DC-001
GET
/api/v1/company/{mst}Tra cứu thông tin doanh nghiệp
DV-DN-042
POST
/api/v1/tax/lookupTra cứu mã số thuế cá nhân
DV-TC-118
GET
/api/v1/bhxh/historyLịch sử tham gia BHXH
DV-BHXH-007
GET
/api/v1/resident/infoThông tin cư trú theo CCCD
DV-DC-002