KYC URL Generation

API Description

Share Exchange Link User KYC Info API.

HTTP Request

POST /bapi/ekyc/v2/public/ekyc/customer/share-kyc-data

Request Header

Name	Type	Mandatory	Description
X-SHA2-Signature	STRING	YES	Request Signature

Request Parameters

Name	Type	Mandatory	Description
bizEntityKey	STRING	YES	business entity key, each access entity has its own bizEntityKey
requestNo	STRING	YES	every request unique number, max length is 120
kycInfo	STRING	YES	KycInfo

KycInfo

Name	Type	Mandatory	Description
userInfo	UserInfo	YES
basicInfo	BasicInfo	YES
identifyInfo	IdentifyInfo	YES

UserInfo

Name	Type	Mandatory	Description
bizEntityKey	STRING	YES	business entity key, each access entity has its own bizEntityKey
entityCustomerId	STRING	YES	customer id，that is, the user id of the access entity site, max length is 128
brokerMainAccountId	STRING	YES	broker main account id
brokerSubAccountId	STRING	YES	broker sub account id
notifyUrl	STRING	YES	notify url when kyc status changed
extra	STRING	NO	extra info in JSON format

BasicInfo

Name	Type	Mandatory	Description
firstName	STRING	YES
middleName	STRING	NO
lastName	STRING	YES
residentialCountry	STRING	YES	country of residence: 2-alpha code in UPPER CASE
dob	STRING	YES	yyyy-MM-dd
country	STRING	YES	nationality, 2-alpha code in UPPER CASE
userSubmitIp	STRING	YES
address	STRING	YES	max is 400
city	STRING	YES	max is 100
postalCode	STRING	NO	max is 50

IdentifyInfo

Name	Type	Mandatory	Description
documentType	STRING	YES	document type, for example: ID_CARD, PASSPORT, DRIVING_LICENSE,RESIDENCE_PERMIT
selectCountry	STRING	Yes	user selected country when do Id verification 2-alpha code in UPPER CASE
frontFileUrl	STRING	YES	id front image download url
backFileUrl	STRING	NO	id back image download url
faceFileUrl	STRING	YES	face image download url
firstName	STRING	YES	please ensure this matches the “firstName” under Basic Info table above, if not it will be rejected.
middleName	STRING	NO
lastName	STRING	YES	please ensure this matches the “lastName” under Basic Info table above, if not it will be rejected.
dob	STRING	YES	date of birth: yyyy-MM-dd
idType	STRING	YES	id doc type. for example: ID_CARD, PASSPORT, DRIVING_LICENSE,RESIDENCE_PERMIT
idSubType	STRING	NO	id doc sub type
idCountry	STRING	YES	2-alpha code in UPPER CASE
nationalityCountry	STRING	YES	2-alpha code in UPPER CASE
idNumber	STRING	YES	id Number
idExpiry	STRING	NO	yyyy-MM-dd
userSubmitIp	STRING	YES
idUsState	STRING	NO
personalNumber	STRING	NO
gender	STRING	NO
issuingAuthority	STRING	NO
issuingDate	STRING	NO	yyyy-MM-dd
issuingPlace	STRING	NO
registrationNumber	STRING	NO
city	STRING	NO
stateCode	STRING	NO
postalCode	STRING	NO
address	STRING	NO

Request Body Example

{
  "bizEntityKey": "BROKERKEY",
  "kycInfo": {
    "userInfo": {
      "brokerMainAccountId": "1234567",
      "brokerSubAccountId": "12345678123456767",
      "bizEntityKey": "BROKERKEY",
      "entityCustomerId": "12345678123456767",
      "extra": "extraTestData",
      "notifyUrl": "https://webhook.site/"
    },
    "identityInfo": {
      "lastName": "testLastNameLItest01",
      "frontFileUrl": "https://image.cnbcfm.com/api/v1/image/104853635-GettyImages-870113330.jpg?v=1709055832&w=740&h=416&ffmt=webp&vtcrop=y",
      "gender": "M",
      "documentType": "ID_CARD",
      "idUsState": "testIdUsState",
      "issuingDate": "2010-09-19",
      "city": "testCity",
      "postalCode": "123456",
      "selectCountry": "SG",
      "idNumber": "testSaasBrokers0144288491",
      "userSubmitIp": "192.168.1.1",
      "issuingPlace": "AE",
      "backFileUrl": "https://cdn.shortpixel.ai/spai/q_lossless+w_1776+to_webp+ret_img/independent-photo.com/wp-content/uploads/2022/03/Karen-Pape-1800x1200.jpeg",
      "idSubType": "INTERNATIONAL_PASSPORT",
      "idType": "ID_CARD",
      "address": "testAddressData",
      "personalNumber": "personalNumber6462313972",
      "idCountry": "AE",
      "firstName": "testFirstName",
      "issuingAuthority": "firstName",
      "faceFileUrl": "https://cdn.shortpixel.ai/spai/q_lossless+w_1776+to_webp+ret_img/independent-photo.com/wp-content/uploads/2022/03/Karen-Pape-1800x1200.jpeg",
      "dob": "1999-09-19",
      "idExpiry": "2030-09-19",
      "registrationNumber": "registrationNumber4039460415",
      "middleName": "testMiddleNameboli",
      "stateCode": "QWER",
      "nationalityCountry": "AE"
    },
    "basicInfo": {
      "firstName": "AA",
      "lastName": "BB",
      "country": "AE",
      "residentialCountry": "AE",
      "dob": "1999-09-19",
      "middleName": "testMiddleName",
      "userSubmitIp": "192.168.1.1",
      "address": "aaa",
      "city": "bbb",
      "postalCode": "123456"

    }
  },
  "requestNo": "23454312345365012111113"
}

Response Example

{
    "code": "000000",
    "message": null,
    "messageDetail": null,
    "data": null,
    "success": true
}