API Reference

• 1. Info
• 2. Paths
  • WorldCheck
• 3. Components
  • 3.1 Schemas
  • 3.2 Enums
• 4. Scalar Value Types

---

1. Info

• Title: gRPC API
• Version: 1.0.0
• Description: This documentation is generated from protobuf files using protoc-gen-doc.

---

2. Paths

WorldCheck

NewCases

• Summary: 新建案件
• Method: NewCases
• Endpoint: world_check_bridge.WorldCheck/NewCases
• Request:
  • Content-Type: application/grpc
  • Schema: NewCasesRequest
• Response:
  • Content-Type: application/grpc
  • Schema: NewCasesResponse

GetCases

• Summary: 查询案件
• Method: GetCases
• Endpoint: world_check_bridge.WorldCheck/GetCases
• Request:
  • Content-Type: application/grpc
  • Schema: GetCasesRequest
• Response:
  • Content-Type: application/grpc
  • Schema: GetCasesResponse

UpdateCases

• Summary: 更新案件
• Method: UpdateCases
• Endpoint: world_check_bridge.WorldCheck/UpdateCases
• Request:
  • Content-Type: application/grpc
  • Schema: UpdateCasesRequest
• Response:
  • Content-Type: application/grpc
  • Schema: NewCasesResponse

---

3. Components

3.1 Schemas

GetCasesRequest

Field	Type	Description
caseId	string	案件ID

GetCasesResponse

Field	Type	Description
caseId	string	报告id
caseSystemId	string	系统案件ID
reportData	bytes	报告内容

NewCasesRequest

Field	Type	Description
name	string	姓名或名称
entityType	EntityType	实体类型
watchlist	NewCasesRequest.Watchlist	观察名单信息
passportCheck	NewCasesRequest.PassportCheck	护照校验信息

PassportCheck

Field	Type	Description
individual	NewCasesRequest.PassportCheck.Individual	护照个人信息

Individual

Field	Type	Description
passportGivenNames	string	护照上的名字（必填）
passportLastName	string	护照上的姓氏（必填）
passportGender	string	护照上的性别（必填）
passportIssuingState	string	护照发行国（必填）
passportNationality	string	护照上的国籍（必填）
passportDateOfBirth	string	护照上的出生日期（必填）
passportDocumentType	string	护照文件类型（必填）
passportIDNumber	string	护照编号（必填）
passportDateOfExpiry	string	护照到期日期（必填）

Watchlist

Field	Type	Description
individual	NewCasesRequest.Watchlist.Individual	个人信息
organisation	NewCasesRequest.Watchlist.Organisation	组织信息

Individual

Field	Type	Description
gender	string	性别
dateOfBirth	string	出生日期
countryLocation	string	所在国家
placeOfBirth	string	出生地点
nationality	string	国籍
documentID	string	证件号码
documentIDCountry	string	证件发行国家
documentIDType	string	证件类型

Organisation

Field	Type	Description
registerdCountry	string	注册国家
documentID	string	证件号码
documentIDCountry	string	证件发行国家
documentIDType	string	证件类型

NewCasesResponse

Field	Type	Description
name	string	姓名或名称
caseId	string	案件ID
caseSystemId	string	系统案件ID
results	NewCasesResponse.Result	匹配结果列表

Result

Field	Type	Description
matchScore	double	匹配分数
categories	string	匹配类别
resolution	NewCasesResponse.Result.Resolution	处理结果

Resolution

Field	Type	Description
statusId	string	状态ID

UpdateCasesRequest

Field	Type	Description
caseSystemId	string	系统案件ID

3.2 Enums

EntityType

实体类型

Name	Number	Description
UNKNOW_TYPE	0	未知类型
ORGANISATION	1	组织
INDIVIDUAL	2	个人
VESSEL	3	船只
UNSPECIFIED	4	未指定

---

4. Scalar Value Types

Proto Type	Go Type	C++ Type	Java Type	Python Type	Notes
double	float64	double	double	float
float	float32	float	float	float
int32	int32	int32	int	int	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.
int64	int64	int64	long	int/long	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.
uint32	uint32	uint32	int	int/long	Uses variable-length encoding.
uint64	uint64	uint64	long	int/long	Uses variable-length encoding.
sint32	int32	int32	int	int	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.
sint64	int64	int64	long	int/long	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.
fixed32	uint32	uint32	int	int	Always four bytes. More efficient than uint32 if values are often greater than 2^28.
fixed64	uint64	uint64	long	int/long	Always eight bytes. More efficient than uint64 if values are often greater than 2^56.
sfixed32	int32	int32	int	int	Always four bytes.
sfixed64	int64	int64	long	int/long	Always eight bytes.
bool	bool	bool	boolean	boolean
string	string	string	String	str/unicode	A string must always contain UTF-8 encoded or 7-bit ASCII text.
bytes	[]byte	string	ByteString	str	May contain any arbitrary sequence of bytes.

---