Identity verification sharing

Interface address: /api/v1/user/kyc/share
Note: This interface allows you to send users' identity verification information to OSL Pay.

Request input parameters

Parameter	Type	Mandatory	Encrypted	Description
email	String	Y	Y	User’s Email
kycType	String	Y	Y	Identity verification type. For individual: USER. For enterprise: ENTERPRISE
registerTime	String	N	Y	Account sign-up time (yyyy-MM-dd HH:mm:ss)
ip	String	Y	Y	User access IP
merchantUserId	String	Y	Y	The merchant side user ID.
deviceId	String	Y	Y	Device finger print
kycIdentityInfoVo	Object	Y	N	Identity verification details
callbackUrl	String	N	N	Webhook push address. Preferred for pushing user status. If the merchant does not provide this parameter, the default callback URL configured by the merchant will be used by default.

KycIdentityInfoVo

Parameter	Type	Mandatory	Encrypted	Description
shareType	String	Y	Y	KYC sharing type: Using sumsub token sharing Using file sharing
shareToken	String	N	Y	Sumsub token
accountPurpose	String	Y	Y	User's account purpose
monthSpend	String	Y	Y	User's monthly spend
sourceFunds	String	Y	Y	User's source funds
occupation	String	Y	Y	User's occupation
firstName	String	N	Y	First name
middleName	String	N	Y	Middle name
lastName	String	N	Y	Last name
firstNameEn	String	N	Y	First name in English
middleNameEn	String	N	Y	Middle name in English
lastNameEn	String	N	Y	Last name in English
phoneNumber	String	N	Y	Phone number
gender	String	N	Y	Gender (Male: M. Female: F)
idType	String	N	Y	Identity document type: PASSPORT, DRIVERS, VISA, ID_CARD, RESIDENCE_PERMIT, UTILITY_BILL
idNumber	String	N	Y	ID number
nationality	String	N	Y	Nationality (3-digit country code in ISO 3166-1)
residentialCountry	String	Y	Y	Country/region of residence (3-digit country code in ISO 3166-1)
idCountry	String	N	Y	Country of ID issuance (3-digit country code in ISO 3166-1)
dob	String	N	Y	Date of birth
idExpiry	String	N	Y	Expiration date of ID document
street	String	N	Y	Street name
number	String	N	Y	Door number
district	String	N	Y	District
city	String	N	Y	City
state	String	N	Y	State
zip	String	N	Y	Postal code
address	String	N	Y	Residential address
frontFileUrl	String	N	Y	Front image URL of the document (URL obtained upon uploading identity verification documents)
backFileUrl	String	N	Y	Back image URL of the document (URL obtained upon uploading identity verification documents)
selfieFileUrl	String	N	Y	URL to user photo (URL obtained upon uploading identity verification documents)
amlFileUrl	String	N	Y	User's AML report (URL obtained upon uploading identity verification documents)
kycTime	String	N	Y	Identity verification date/time (yyyy-MM-dd HH:mm:ss)
kycLevel	String	N	Y	Identity verification level (L0: not verified. L1: Face + document + liveness detection L2: Face + document + liveness detection + proof of residential address + proof of income)

Output parameters

Parameter	Type	Mandatory	Description
userId	String	Y	User's unique tag on OSL Pay