Skip to main content

主體查詢

介面路徑

請求方式API 路徑
POST{DOMAIN_NAME} /api/v1/kyc/entity/query

請求電文

Http.header 參數

Content-TypeString必填
固定值:application/json
platformIdString選填
SLP 平台 ID,平台特店必填
merchantIdString必填
直連特店串接:SLP 分配的特店 ID;平台特店串接:SLP 分配的子特店 ID
apiKeyString必填
API 介面金鑰
requestIdString(32)必填
請求流水號,每個 HTTP 請求唯一
idempotentKeyString(32)選填
冪等 KEY

Http.body

idTypeString(32)必填參考
證件類型
idNumberString(128)必填
證件號碼

回應電文

處理結果 http.statusCode

* 500 /429 /400:處理異常

codeString必填
錯誤碼,錯誤碼及錯誤描述詳情查看: Server 錯誤碼
msgString必填
錯誤描述,錯誤碼及錯誤描述詳情查看: Server 錯誤碼

* 200:處理成功

entityIdString必填
SLP 分配的主體 ID
POST/api/v1/kyc/entity/query

sandbox api

https://api-sandbox.shoplinepayments.com/api/v1/kyc/entity/query

live api

https://api.shoplinepayments.com/api/v1/kyc/entity/query
請求電文範例
{
"idType":"IDCARD",
"idNumber":"110101199001011234"
}
回應電文範例
{
"entityId": "867218770681577488"
}