Example Client APIs - User KYC Check APIs

User KYC Check APIs

Click an API to expand/collapse it.

PUTFetch User KYC History

Description

Fetches the history of a user kyc.

Request Endpoint

PUT https://<Example api server address>/user/{userid}/kyc/history

Parameters

Parameter	Type	Use	Description
userId	String	Required	UUID of a user.

cURL syntax

curl --include \
     --request PUT \
'https://core.dev.Example.net/api/user/userid/kyc/history'

Response body

Headers: Content-Type: application/json | HTTPS Status Code: 200

{
  "data": [
    {
      "id": "84923ec5-900e-4f4d-a91a-5d7398093203",
      "extKYCCheckResult": "PASS",
      "extKYCCheckDateTime": 1469108573334,
      "extKYCCheckData": {
        "xmlns": "http://www.orchestra.com",
        "finalResult": null,
        "fraudResult": "Success",
        "kycResult": null,
        "fraudScore": null,
        "rulesTriggered": null,
        "triggers": null,
        "geo": null,
        "velo": null,
        "xyVelo": null,
        "emailAge": null,
        "telesignLive": null,
        "txnId": null
      },
      "requestId": "96f6a337-187a-4af2-85e2-4e4c58b8245c"
    }
  ],
  "detail": null,
  "error": false,
  "message": "Fetching user kyc history successful"
}

Return to top

POSTKYC Check During Creation of User's 1st PM

Description

This is a KYC check during the creation of User's 1st PM by adding PM or by depositing with SAVE_CARD / ONE_TIME_TRANSACTION.

It helps when doing a KYC check of a User when the user tries to add their PM by using "add PM" or by depositing with "SAVE_CARD / ONE_TIME_TRANSACTION".

Request Endpoint

POST https://<Example api server address>/user/kyc/check

Parameters

None.

cURL syntax
curl --include \
     --request POST \
     --header "Content-Type: application/json" \
     --data-binary "{
    \"userId\" : \"82c8a4e4-f373-451c-8509-8e9687313a3c\",
    \"deviceUdid\" : \"udid-12345\",
    \"firstName\" : \"Shruti\",
    \"lastName\" : \"Nagarkar\",
    \"dob\" : \"1991-04-09\",
    \"mobileNumber\" : \"+918050022027\",
    \"emailAddress\" : \"rn.shruti@gmail.com\",
    \"billingAddress\" : {
        \"street\" : \"3rd cross\",
        \"street2\" : \"wilson garden\",
        \"city\" : \"Bangalore\",
        \"state\" : \"karnataka\",
        \"countryCode\" : \"India\",
        \"postalCode\" : \"134413\"
    }
}" \
'https://core.dev.Example.net/api/user/kyc/check'
PUT body attributes (JSON)

Attribute Type Use Description

userId String Required UUID of a User.

deviceUdid String Required UDID of a Device that belongs to an user.

firstName String Optional First name of a user.

lastName String Optional Last name of a user.

dob String Optional Date of birth of a User in "yyyy-mm-dd" format.

mobileNumber String Optional Mobile number of a user that can be used for a KYC check.

emailAddress String Optional Email address of a user that can be used for a KYC check.

billingAddress Object Required Billing Address (of a user) object with the following attributes that can be used for a KYC check.

street String Required Street address of a user.

street2 String Required Continuation of a user address.

city String Required City of a user.

state String Required State of a user.

postalCode String Required postal code of a user.

countryCode String Required Country code of a user.

POST body
Headers: Content-Type: application/json
{
  "userId": "82c8a4e4-f373-451c-8509-8e9687313a3c",
  "deviceUdid": "udid-12345",
  "firstName": "Shruti",
  "lastName": "Nagarkar",
  "dob": "1991-04-09",
  "mobileNumber": "+918050022027",
  "emailAddress": "rn.shruti@gmail.com",
  "billingAddress": {
    "street": "3rd cross",
    "street2": "wilson garden",
    "city": "Bangalore",
    "state": "karnataka",
    "countryCode": "India",
    "postalCode": "134413"
  }
}
Response body
Headers: Content-Type: application/json | HTTPS Status Code: 200
{
  "data": {
    "extKYCCheckResult": "PASS"
  },
  "detail": null,
  "error": false,
  "message": "User KYC check successful"
}
Return to top

Attribute	Type	Use	Description
`userId`	String	Required	UUID of a User.
`deviceUdid`	String	Required	UDID of a Device that belongs to an user.
`firstName`	String	Optional	First name of a user.
`lastName`	String	Optional	Last name of a user.
`dob`	String	Optional	Date of birth of a User in "yyyy-mm-dd" format.
`mobileNumber`	String	Optional	Mobile number of a user that can be used for a KYC check.
`emailAddress`	String	Optional	Email address of a user that can be used for a KYC check.
`billingAddress`	Object	Required	Billing Address (of a user) object with the following attributes that can be used for a KYC check.
`street`	String	Required	Street address of a user.
`street2`	String	Required	Continuation of a user address.
`city`	String	Required	City of a user.
`state`	String	Required	State of a user.
`postalCode`	String	Required	postal code of a user.
`countryCode`	String	Required	Country code of a user.

PUTKYC Check When User Updates KYC Info

Description

Helps in doing the KYC check when a user updates any of his information or all of them (mobile number, or email address, or dob, or billing address).

Request Endpoint

PUT https://<Example api server address>/user/kyc/mobile/email

Parameters

None.

cURL syntax
curl --include \
     --request PUT \
     --header "Content-Type: application/json" \
     --data-binary "{
    \"userId\" : \"82c8a4e4-f373-451c-8509-8e9687313a3c\",
    \"deviceUdid\" : \"udid-12345\",
    \"dob\" : \"1991-07-10\",
    \"mobileNumber\" : \"+918050022027\",
    \"emailAddress\" : \"rn.shruti@gmail.com\",
    \"firstName\" : \"Shruti\",
    \"lastName\" : \"Nagarkar\",
    \"billingAddress\" : {
        \"street\" : \"street address\",
        \"street2\" : \"street 2 address\",
        \"city\" : \"Bangalore\",
        \"state\" : \"karnataka\",
        \"countryCode\" : \"India\",
        \"postalCode\" : \"134418\"
    }
}" \
'https://core.dev.Example.net/api/user/kyc/mobile/email'
PUT body attributes (JSON)

Attribute Type Use Description

userId String Required UUID of a User.

deviceUdid String Required UDID of a Device that belongs to an user.

firstName String Optional First name of a user.

lastName String Optional Last name of a user.

dob String Optional Date of birth of a User in "yyyy-mm-dd" format.

mobileNumber String Optional Mobile number of a user that can be used for a KYC check.

emailAddress String Optional Email address of a user that can be used for a KYC check.

billingAddress Object Required Billing Address (of a user) object with the following attributes that can be used for a KYC check.

street String Required Street address of a user.

street2 String Required Continuation of a user address.

city String Required City of a user.

state String Required State of a user.

postalCode String Required postal code of a user.

countryCode String Required Country code of a user.

PUT body
Headers: Content-Type: application/json
{
  "userId": "82c8a4e4-f373-451c-8509-8e9687313a3c",
  "deviceUdid": "udid-12345",
  "dob": "1991-07-10",
  "mobileNumber": "+918050022027",
  "emailAddress": "rn.shruti@gmail.com",
  "billingAddress": {
    "street": "street address",
    "street2": "street 2 address",
    "city": "Bangalore",
    "state": "karnataka",
    "countryCode": "India",
    "postalCode": "134418"
  }
}
Response body
Headers: Content-Type: application/json | HTTPS Status Code: 200
{
  "data": {
    "extKYCCheckResult": "PASS"
  },
  "detail": null,
  "error": false,
  "message": "Updating user kyc mobile number or email address successful."
}
Return to top