Kyc RFI Records Query API

API Description

Kyc RFI Record Submit API

HTTP Request

POST /bapi/ekyc/v2/public/ekyc/customer/page-query-rfi-records

Request Header

Name	Type	Mandatory	Description
X-SHA2-Signature	STRING	YES	Request Signature

Request Parameters

Name	Type	Mandatory	Description
bizEntityKey	STRING	YES	business entity key, each access entity has its own bizEntityKey
entityCustomerId	STRING	NO	customer id, that is, the user id of the access entity site.
kycType	STRING	NO	kyc type，USER
recordId	STRING	NO	Rfi Record Id
status	STRING	NO	Rfi record status: PROCESS(under process) UPLOADING(uploading files) REVIEW(under review) PASS(file review pass) REFUSED(file refused) EXPIRED(file expired) CLOSE(close file flow)
startTime	STRING	NO	min create time, yyyy-MM-dd
endTime	STRING	NO	max create time, yyyy-MM-dd
page	INT	YES	page number, start from 1
rows	INT	YES	rows

Response Fields

Name	Type	Mandatory	Description
code	STRING	YES
data	SearchResult	NO

SearchResult

Name	Type	Description
total	LONG	total records count
rows	List<SimpleKycRfiRecordVo>

SimpleKycRfiRecordVo

Name	Type	Description
recordId	STRING	Rfi record id
bizEntityKey	STRING	business entity key
entityCustomerId	STRING	Customer id
kycType	STRING	KYC type
status	STRING	Rfi record status:PROCESS,UPLOADING,REVIEW,PASS,REFUSED,EXPIRED,CLOSE
fileTypes	List<STRING>	Rfi record required file types
expireTime	DATE	Expired time
recordType	STRING	Rfi record type:IDENTITY,WCK
auditor	STRING	auditor
auditTime	DATE	Audit time
dbCreateTime	DATE	Rfi record create time

Request Body Example

{
    "bizEntityKey": "BROKERKEY",
    "entityCustomerId": "45712345678999212345",
    "kycType": "USER"
}

Response Example

{
    "code": "000000",
    "message": null,
    "messageDetail": null,
    "data": {
        "total": 1,
        "rows": [
            {
                "recordId": "12345",
                "bizEntityKey": "BROKERKEY",
                "kycUserId": "4276875665261234567",
                "entityCustomerId": "45712345678999212345",
                "kycType": "USER",
                "status": "PROCESS",
                "subStatus": "INIT",
                "fileTypes": [
                    "SOF"
                ],
                "fileData": null,
                "expireTime": 1752105600000,
                "requestComment": "test",
                "recordType": "IDENTITY",
                "reason": null,
                "remark": null,
                "creator": "test@example.com",
                "submitter": null,
                "auditor": null,
                "auditTime": null,
                "completeTime": null,
                "dbCreateTime": 1750927524935,
                "dbModifyTime": 1750927524935
            }
        ]
    },
    "success": true
}