Upload relevant identification documents

Introduction:

This api support merchant to upload user's photo file.

• Supported format for ID and face photos: jpg, jpeg, png
• Supported format for aml/idv reports: pdf
• All types must be uploaded (except idBack)

API Description

Request Method: POST

Request Path: /open/api/kyc/share/fileUpload

Request Parameters

Header Parameters:

Parameter	Mandatory	Type	Remarks
appId	Y	string	App unique identifier
timestamp	Y	string	Current UTC 13-digit timestamp, valid within 5 minutes
sign	Y	string	Signature, you can refer to the signature Click Here

Body Parameters:

Parameter	Required	Type	Length	Description
file	Yes	stream		File stream (max 5M)
requestNo	Yes	string	64	Request number
type	Yes	enum	64	ID Front: idFront ID Back: idBack Face: face AML Report: amlReport IDV Report: idvReport

Request Parameter Example:

JSON

{
    file: 
    requestNo: 123
    type: idFront
}

Response Parameters

Parameter	Type	Description
success	boolean	Success flag
error	boolean	Error flag
msg	string	Response message
code	integer	Response code
model	Object	Response data
traceId	string	Trace ID

Response Parameter Example:

JSON

{
    code: 0
    msg: Operation successful
    model: null
    traceId: 652366764a52596446c629939e486913
    success: true
    error: false
}

Note

For more error codes please refer to the error code description on the homepage.