Skip to content

KYC Authentication 2.0

Tip

  • This request uses POST and the data format is multipart/form-data.
Brief Description

This API is used by merchants to access user KYC identity verification for Japan bank transfer scenarios.

Merchants can submit user KYC information through this API and query the review result. After KYC is approved, the user can access Japan payment capabilities that require identity verification, such as:

  1. Japan Dedicated VA
  2. Other Japan local payment capabilities that require real-name verification
Request URL
  • /v1/vexora/kycApplyFor
Request Method
  • Method: POST
  • Content-Type: multipart/form-data
Header Required Type Description
merchantNo Yes String Merchant number.
Body
Parameter Required Type Description
sign Yes String Request signature. Sort all fields except sign alphabetically by parameter name, concatenate them as key1=value1key2=value2, append the app secret as the salt, and generate a lowercase MD5 hash.
timestamp Yes String Request timestamp in milliseconds, for example 1715941383720.
userId Yes String Merchant-side user identifier. This value must uniquely identify the user within the merchant system.
callBackUrl Yes String Callback URL. The final KYC result will be sent to this address after the review is completed.
usernameFurigana Yes String User name in Katakana.
Request Parameter Example
curl --request POST \
  --url https://sandbox-api.vexora.com/japan/v1/vexora/kycApplyFor \
  --header 'Accept: */*' \
  --header 'Accept-Encoding: gzip, deflate, br' \
  --header 'Connection: keep-alive' \
  --header 'User-Agent: PostmanRuntime-ApipostRuntime/1.1.0' \
  --header 'content-type: multipart/form-data' \
  --header 'merchantNo: 1027749636' \
  --form userId=abc_100008 \
  --form callBackUrl=https://merchant.example.com/api/kyc/callback \
  --form 'usernameFurigana=ใƒ†ใ‚นใƒˆ014' \
  --form sign=aa3d61235fb4b1f13e44c95b98d3fff1 \
  --form timestamp=1774925553256
Response Result
Parameter Required Type Description
msg Yes String Request result. When the value is success, it only indicates that this API request succeeded and must not be used as the merchant-side business result.
code Yes String Response code. When the value is 0000, it only indicates that this API request succeeded. For specific status and error codes, refer to the Status/Error Code section.
timestamp Yes String Transaction time.
success Yes Boolean API request result.
data Yes Object Response object.
data.userId Yes String Merchant-side user ID.
data.authenticationStatus Yes String Authentication status. 0: Pending authentication, 1: Under review, 2: Approved, 3: Rejected.
data.message Yes String Message.
Successful Response Example
{
  "msg": "success",
  "code": "0000",
  "timestamp": 1728609277476,
  "success": true,
  "data": {
    "userId": "79x7p10nh4xd121m",
    "authenticationStatus": "0",
    "message": "apply for kyc successful, Please authentication"
  }
}