Kiểu

Diễn giải

Ví dụ

Địa chỉ adapter Nền tảng HCM chính

Địa chỉ cổng dịch vụ chính thức

https://hcmlgsp.tphcm.gov.vn

Địa chỉ adapter Nền tảng HCM thử nghiệm

Địa chỉ cổng dịch vụ thử nghiệm

https://hcmesb-test.tphcm.gov.vn

AccessKey

Khóa

rTkhYCBwHM

SecretKey

Khóa bí mật

DWkQgY1YSS

AppName

Đơn vị kết nối

TPHCM

PartnerCode

Mã đơn vị cung cấp ứng dụng

000.00.01.H29

PartnerCodeCus

Mã đơn vị sử dụng dịch vụ

000.00.01.H29

Authorization

Khai báo trong Header, Là chuỗi gồm 5 tham số dạng json được mã hóa thành StringBase64

ewoiQWNjZXNzS2V5IjoiclRraFlDQndITSIsCiJTZ

WNyZXRLZXkiOiJEV2tRZ1kxWVNTIiwKIkFw

cE5hbWUiOiAiVFBIQ00iLAoiUGFydG5lckNvZG

UiOiAiMDAwLj

AwLjAxLkgyOSIsCiJQYXJ0bmV

yQ29kZUN1cyI6ICIwMDAuM

DAuMDEuSDI5Igp9Cg==

được stringbase64 từ:

{

"AccessKey":"rTkhYCBwHM",

"SecretKey":"DWkQgY1YSS",

"AppName": "TPHCM",

"PartnerCode": "000.00.01.H29",

"PartnerCodeCus": "000.00.01.H29"

}

STT

Tên trường

Định dạng

Mô tả

Yêu cầu

1

SoGiayCNDKKD

String

Độ dài tối đa: 255

Số giấy chứng nhận đang ký kinh doanh

Bắt buộc

2

NgayCapGCN

String

Độ dài tối đa: 50

Ngày cấp giấy phép
(dd/MM/yyyy HH:mm:ss)

Bắt buộc

3

NgayHetHan

String

Độ dài tối đa: 50

Ngày hết hạn giấy phép
(dd/MM/yyyy HH:mm:ss)
Bắt buộc khi voThoiHan = false

Không bắt buộc

4

VoThoiHan

Boolean

Quy định giấy phép không có thời gian hết hạn

Bắt buộc

5

TenNguoiDaiDien

String

Tên người đại diện doanh nghiệp

Bắt buộc

6

LoaiGiayChungThuc

Number

Loại giấy chứng thực
1: Giấy CMND
2: Giấy chứng thực
3: Hộ chiếu

Bắt buộc

7

SoGiayChungThuc

String

Độ dài  tối đa: 50

Số giấy chứng thực

Bắt buộc

8

NgayCapGiayChungThuc

String

Ngày cấp giấy chứng thực
(dd/MM/yyyy HH:mm:ss)

Bắt buộc

9

NoiCapGiayChungThuc

String

Nơi cấp giấy chứng thực
(dd/MM/yyyy HH:mm:ss)

Không bắt buộc

10

NgaySinh

String

Độ dài tối đa: 50

Ngày sinh người đại diện
(dd/MM/yyyy HH:mm:ss)

Không bắt buộc

11

GioiTinh

Number

Giới tính người đại diện

Không bắt buộc

12

DanToc

String

Độ dài tối đa: 255

Tên dân tộc của người đại diện

Không bắt buộc

13

QuocTich

String

Độ dài tối đa: 255

Tên quốc tịch của người đại diện

Không bắt buộc

14

DiaChiKinhDoanh

JSON Object

Địa chỉ đăng ký kinh doanh tại mục 3.3

Bắt buộc

15

BangHieu

String

Bảng hiệu đăng ký kinh doanh

Bắt buộc

16

MatHangKinhDoanh

String

Mặt hàng kinh doanh

Bắt buộc

17

LinhVucCapPhep

String

Lĩnh vực cấp phép

Bắt buộc

18

NganhKinhDoanh

JSONArray

Danh sách ngành nghề kinh doanh tại mục 3.4

Không bắt buộc

19

VonKinhDoanh

Number

Vốn đăng ký kinh doanh

Bắt buộc

20

ThongTinThanhVien

JSON Array

Json Thông tin thành viên tham gia doanh nghiệp tại mục 3.5

Bắt buộc

21

DienThoai

String

Điện thoại của người đại diện

Không bắt buộc

22

Email

String

Email của người đại diện

Không bắt buộc

23

Version

Kiểu string

Phiên bản của chuẩn gói tin

Bắt buộc

STT

Tên trường

Định dạng

Mô tả

Yêu cầu

1

MaThanhPho

String

Mã thành phố

Bắt buộc

2

TenThanhPho

String

Tên thành phố

Bắt buộc

3

MaQuanHuyen

String

Mã quận huyện

Bắt buộc

4

TenQuanHuyen

String

Tên quận huyện

Bắt buộc

5

MaPhuongXa

String

Mã phường

Bắt buộc

6

TenPhuongXa

String

Tên phường

Bắt buộc

7

SoNha

String

Số nhà

Không bắt buộc

STT

Tên trường

Định dạng

Mô tả

Yêu cầu

1

TenNganhKD

String

Tên ngành nghề kinh doanh

Bắt buộc

2

MaNganhKD

String

Mã ngành KD

Bắt buộc

STT

Tên trường

Định dạng

Mô tả

Yêu cầu

1

TenThanhVien

String

Tên thành viên

Bắt buộc

2

DiaChi

String

Địa chỉ thành viên

Bắt buộc

3

SoGiayChungThuc

String

Số giấy chứng thực

Bắt buộc

4

SoTienGopVon

String

Số tiền góp vốn

Không bắt buộc