api/v1/user/kyc/share

post

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

This endpoint is designed for institutional users who need to submit KYB (Know Your Business) information for account creation. Send the KYB data to OSL Pay via this endpoint. OSL Pay will review the submitted KYB information. Once reviewed, whether approved or rejected, the result will be sent to the merchant via Webhook. Alternatively, merchants can poll the KYB status using the KYB status query API.

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 identifier

deviceId

string

Unique device fingerprint for identification

registerTime

string

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

callbackUrl

string

Webhook URL for asynchronous KYB result notifications. The Webhook payload format can be found in the Webhook documentation. (This optional parameter allows OSL Pay to push the user’s KYB account creation result to your system. If provided, OSL Pay will send notifications to this URL. The URL must start with http or https. If IP whitelisting is required to access this URL, please contact OSL Pay before going live.)

kybIdentityInfoVo

object

required

Detailed KYB information for the enterprise

Response

Language

Response

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

application/json

200Success response