/api/v1/user/kyc/share

post

https://openapitest.osl-pay.com/api/v1/user/kyc/share

This endpoint is one of the account creation methods provided by OSL Pay. If you are using Sumsub as your KYC provider, you can integrate using this mode. The integrator only needs to generate a Sumsub token, attach a few required parameters, and the account creation process with OSL Pay can be completed.

Body Params

string

required

User’s email address

kycType

string

enum

required

KYC type. For this scenario, always set to USER

Allowed:

string

required

Please collect user’s IP address at the time of account creation. Must comply with IPv4 or IPv6 standards.

merchantUserId

string

Merchant-side user ID

deviceId

string

Unique device fingerprint

registerTime

string

User registration time on the merchant side (yyyy-MM-dd HH:mm:ss)

callbackUrl

string

Optional Webhook URL for receiving asynchronous account creation results. Must start with http or https. If IP whitelisting is required, contact us before going live. See Webhook documentation for format.

kycIdentityInfoVo

object

required

Detailed KYC information, using the KycIdentityInfoVo structure

kycExtendVo

object

KYC additional information

Response

Language

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful operation