Example Client APIs - User - Admin Portal Functionalities APIs

User - Admin Portal Functionalities APIs

Click an API to expand/collapse it.

PUTBlacklist a User or Device

Description

Use this API to blacklist a user, device, payment, or login mechanism.

Request Endpoint

PUT https://<Example api server address>/user/blacklist

Parameters

None.

cURL syntax (for Device)

curl --include \
     --request PUT \
     --header "Content-Type: application/json" \
     --data-binary "{
    \"userId\":\"1a630978-0053-4f84-9976-ccfcd4dc9aab\",
    \"blockType\":\"DEVICE\",
    \"deviceUdid\":\"udid-12345\"
}" \
'https://core.dev.Example.net/api/user/blacklist'

PUT body attributes (JSON)

Attribute	Type	Use	Description
`userId`	String	Required	UUID of the user to be blacklisted.
`blockType`	String	Required	Takes one of following values: USER, PAYMENT, EMAIL, SOCIAL, PHONE, OR DEVICE.
`deviceUdid`	String	Optional	UDID of the device to be blacklisted.
`paymentId`	String	Optional	Payment Id of method to be blacklisted.
`emailAddress`	String	Optional	Email address being blacklisted.
`mobileNumber`	String	Optional	Phone being blacklisted.
`socialLoginType`	String	Optional	Login type for the social id being blacklisted, like TWITTER, FACEBOOK. etc.
`socialId`	String	Optional	The social id being blacklisted.

PUT body (for Device)

Headers: Content-Type: application/json

{
  "userId": "1a630978-0053-4f84-9976-ccfcd4dc9aab",
  "blockType": "DEVICE",
  "deviceUdid": "udid-12345"
}

Response body

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

{
  "error": false,
  "message": "Blacklisting of user/device/payment successful.",
  "detail": null,
  "data": null
}

PUT body (for Email)

Headers: Content-Type: application/json

{
  "userId": "1a630978-0053-4f84-9976-ccfcd4dc9aab",
  "blockType": "EMAIL",
  "emailAddress": "rn.shruti@gmail.com",
  "paymentId": null
}

Response body

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

{
    "error": false,
    "message": "Blacklisting of user/device/payment successful.",
    "detail": null,
    "data": {
        "id": "1a630978-0053-4f84-9976-ccfcd4dc9aab",
        "updatedBy": "",
        "firstName": "Shruti",
        "lastName": "Nagarkar",
        "fullName": "Shruti Nagarkar",
        "profileName": "ShrutiN",
        "registrationDate": 1453116326399,
        "birthDateDay": 15,
        "birthDateMonth": 9,
        "birthDateYear": 1991,
        "locationCountry": "India",
        "locationZipCode": "581320",
        "timezone": "IST",
        "profileImagePath": "www.google.com",
        "userSetting": {
            "autoUpdateBetcadeApp": true,
            "autoUpdateDownloadedApps": false,
            "userEmailProvided": false,
            "monthlyDepositMaxLimit": null,
            "monthlyDepositMaxLimitCurrency": "USD",
            "wifiDownloadLimitInMB": 23,
            "prefillUserInfoInCasino": true,
            "versionOfDownloadedBetcadeApp": null,
            "receiveEmailReceipt": null,
            "receiveNotifications": null,
            "shareRegistrationInfo": true
        },
        "socialAuthenticationChannels": [
            {
                "loginType": "FACEBOOK",
                "socialId": "social12345",
                "addedOn": 1453116326444,
                "lastUsedOn": 1453116326444,
                "deletedOn": null,
                "blockStatus": "BLACKLISTED"
            }
        ],
        "emailAuthenticationChannels": [
            {
                "loginType": "EMAIL",
                "primary": null,
                "emailAddress": "rn.shruti@gmail.com",
                "blockStatus": "BLACKLISTED",
                "emailVerificationStatus": "VERIFIED",
                "emailPinResetStatus": null,
                "addedOn": 1453116326444,
                "lastUsedOn": 1453116326444,
                "deletedOn": null
            }
        ],
        "mobileAuthenticationChannels": [
            {
                "loginType": "MOBILE",
                "primary": false,
                "mobileNumber": "+918050022027",
                "mobileVerificationStatus": "VERIFIED",
                "mobilePinResetStatus": null,
                "blockStatus": "NORMAL",
                "addedOn": 1453116326444,
                "lastUsedOn": 1453116326444,
                "deletedOn": null
            }
        ],
        "addresses": [
            {
                "id": "9ac4966c-073a-4d46-a3e3-06de07bbef99",
                "updatedBy": "",
                "street1": "Wilson garden",
                "street2": null,
                "street3": null,
                "city": "Bangalore",
                "state": null,
                "county": null,
                "postal": "560073",
                "country": null,
                "addressType": "HOME"
            },
            {
                "id": "b896b33f-7111-4564-970d-c07b9e7c609c",
                "updatedBy": "",
                "street1": "Wilson garden",
                "street2": null,
                "street3": null,
                "city": "Bangalore",
                "state": null,
                "county": null,
                "postal": "560073",
                "country": null,
                "addressType": "HOME"
            }
        ],
        "blockTypes": [
            "EMAIL",
            "SOCIAL"
        ],
        "status": "EXISTING",
        "verified": true,
        "blockStatus": "PARTIAL_BLACKLIST",
        "pinCreated": true,
        "reasonForDeleting": null,
        "lastWrongPinAttemptTime": null,
        "blockedMinutes": 0,
        "userBlockedNumber": 0,
        "userBlockedTime": null
    }
}

PUT body (for Login)

Headers: Content-Type: application/json

{
    "userId": "1a630978-0053-4f84-9976-ccfcd4dc9aab",
    "blockType": "SOCIAL",
    "socialLoginType": "FACEBOOK",
    "socialId": "social12345",
    "emailAddress": null,
    "paymentId": null
}

Response body

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

{
    "error": false,
    "message": "Blacklisting of user/device/payment successful.",
    "detail": null,
    "data": {
        "id": "1a630978-0053-4f84-9976-ccfcd4dc9aab",
        "updatedBy": "",
        "firstName": "Shruti",
        "lastName": "Nagarkar",
        "fullName": "Shruti Nagarkar",
        "profileName": "ShrutiN",
        "registrationDate": 1453116326399,
        "birthDateDay": 15,
        "birthDateMonth": 9,
        "birthDateYear": 1991,
        "locationCountry": "India",
        "locationZipCode": "581320",
        "timezone": "IST",
        "profileImagePath": "www.google.com",
        "userSetting": {
            "autoUpdateBetcadeApp": true,
            "autoUpdateDownloadedApps": false,
            "userEmailProvided": false,
            "monthlyDepositMaxLimit": null,
            "monthlyDepositMaxLimitCurrency": "USD",
            "wifiDownloadLimitInMB": 23,
            "prefillUserInfoInCasino": true,
            "versionOfDownloadedBetcadeApp": null,
            "receiveEmailReceipt": null,
            "receiveNotifications": null,
            "shareRegistrationInfo": true
        },
        "socialAuthenticationChannels": [
            {
                "loginType": "FACEBOOK",
                "socialId": "social12345",
                "addedOn": 1453116326444,
                "lastUsedOn": 1453116326444,
                "deletedOn": null,
                "blockStatus": "BLACKLISTED"
            }
        ],
        "emailAuthenticationChannels": [
            {
                "loginType": "EMAIL",
                "primary": null,
                "emailAddress": "rn.shruti@gmail.com",
                "blockStatus": "NORMAL",
                "emailVerificationStatus": "VERIFIED",
                "emailPinResetStatus": null,
                "addedOn": 1453116326444,
                "lastUsedOn": 1453116326444,
                "deletedOn": null
            }
        ],
        "mobileAuthenticationChannels": [
            {
                "loginType": "MOBILE",
                "primary": false,
                "mobileNumber": "+918050022027",
                "mobileVerificationStatus": "VERIFIED",
                "mobilePinResetStatus": null,
                "blockStatus": "NORMAL",
                "addedOn": 1453116326444,
                "lastUsedOn": 1453116326444,
                "deletedOn": null
            }
        ],
        "addresses": [
            {
                "id": "9ac4966c-073a-4d46-a3e3-06de07bbef99",
                "updatedBy": "",
                "street1": "Wilson garden",
                "street2": null,
                "street3": null,
                "city": "Bangalore",
                "state": null,
                "county": null,
                "postal": "560073",
                "country": null,
                "addressType": "HOME"
            },
            {
                "id": "b896b33f-7111-4564-970d-c07b9e7c609c",
                "updatedBy": "",
                "street1": "Wilson garden",
                "street2": null,
                "street3": null,
                "city": "Bangalore",
                "state": null,
                "county": null,
                "postal": "560073",
                "country": null,
                "addressType": "HOME"
            }
        ],
        "blockTypes": [
            "SOCIAL"
        ],
        "status": "EXISTING",
        "verified": true,
        "blockStatus": "PARTIAL_BLACKLIST",
        "pinCreated": true,
        "reasonForDeleting": null,
        "lastWrongPinAttemptTime": null,
        "blockedMinutes": 0,
        "userBlockedNumber": 0,
        "userBlockedTime": null
    }
}

PUT body (for Phone)

Headers: Content-Type: application/json

{
    "userId": "1a630978-0053-4f84-9976-ccfcd4dc9aab",
    "blockType": "PHONE",
    "mobileNumber": "+918050022027",
    "paymentId": null
}

Response body

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

{
    "error": false,
    "message": "Blacklisting of user/device/payment successful.",
    "detail": null,
    "data": {
        "id": "1a630978-0053-4f84-9976-ccfcd4dc9aab",
        "updatedBy": "",
        "firstName": "Shruti",
        "lastName": "Nagarkar",
        "fullName": "Shruti Nagarkar",
        "profileName": "ShrutiN",
        "registrationDate": 1453116326399,
        "birthDateDay": 15,
        "birthDateMonth": 9,
        "birthDateYear": 1991,
        "locationCountry": "India",
        "locationZipCode": "581320",
        "timezone": "IST",
        "profileImagePath": "www.google.com",
        "userSetting": {
            "autoUpdateBetcadeApp": true,
            "autoUpdateDownloadedApps": false,
            "userEmailProvided": false,
            "monthlyDepositMaxLimit": null,
            "monthlyDepositMaxLimitCurrency": "USD",
            "wifiDownloadLimitInMB": 23,
            "prefillUserInfoInCasino": true,
            "versionOfDownloadedBetcadeApp": null,
            "receiveEmailReceipt": null,
            "receiveNotifications": null,
            "shareRegistrationInfo": true
        },
        "socialAuthenticationChannels": [
            {
                "loginType": "FACEBOOK",
                "socialId": "social12345",
                "addedOn": 1453116326444,
                "lastUsedOn": 1453116326444,
                "deletedOn": null,
                "blockStatus": "BLACKLISTED"
            }
        ],
        "emailAuthenticationChannels": [
            {
                "loginType": "EMAIL",
                "primary": null,
                "emailAddress": "rn.shruti@gmail.com",
                "blockStatus": "BLACKLISTED",
                "emailVerificationStatus": "VERIFIED",
                "emailPinResetStatus": null,
                "addedOn": 1453116326444,
                "lastUsedOn": 1453116326444,
                "deletedOn": null
            }
        ],
        "mobileAuthenticationChannels": [
            {
                "loginType": "MOBILE",
                "primary": false,
                "mobileNumber": "+918050022027",
                "mobileVerificationStatus": "VERIFIED",
                "mobilePinResetStatus": null,
                "blockStatus": "BLACKLISTED",
                "addedOn": 1453116326444,
                "lastUsedOn": 1453116326444,
                "deletedOn": null
            }
        ],
        "addresses": [
            {
                "id": "9ac4966c-073a-4d46-a3e3-06de07bbef99",
                "updatedBy": "",
                "street1": "Wilson garden",
                "street2": null,
                "street3": null,
                "city": "Bangalore",
                "state": null,
                "county": null,
                "postal": "560073",
                "country": null,
                "addressType": "HOME"
            },
            {
                "id": "b896b33f-7111-4564-970d-c07b9e7c609c",
                "updatedBy": "",
                "street1": "Wilson garden",
                "street2": null,
                "street3": null,
                "city": "Bangalore",
                "state": null,
                "county": null,
                "postal": "560073",
                "country": null,
                "addressType": "HOME"
            }
        ],
        "blockTypes": [
            "EMAIL",
            "PHONE",
            "SOCIAL"
        ],
        "status": "EXISTING",
        "verified": true,
        "blockStatus": "PARTIAL_BLACKLIST",
        "pinCreated": true,
        "reasonForDeleting": null,
        "lastWrongPinAttemptTime": null,
        "blockedMinutes": 0,
        "userBlockedNumber": 0,
        "userBlockedTime": null
    }
}

Return to top

PUTDelete by Email

Description

Allows an admin to delete users by their email address.

Request Endpoint

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

Parameters

None.

cURL syntax
curl --include \
     --request PUT \
     --header "Content-Type: application/json" \
     --data-binary "{
    \"emailList\" : [\"john.doe@gmail.com\", \"jack.doe@gmail.com\"]
}" \
'https://core.dev.Example.net/api/user/by/email'
PUT body attributes (JSON)

Attribute Type Use Description

emailList Array Required An array of strings containing the users' email addresses.

PUT body
Headers: Content-Type: application/json
{
  "emailList": [
    "john.doe@gmail.com",
    "jack.doe@gmail.com"
  ]
}
Response body
Headers: Content-Type: application/json | HTTPS Status Code: 200
{
  "error": false,
  "message": "Deleted users successfully",
  "detail": null,
  "data": true
}
Return to top

Attribute	Type	Use	Description
`emailList`	Array	Required	An array of strings containing the users' email addresses.

PUTDelete by Mobile

Description

Allows an admin to delete users by their mobile number.

Request Endpoint

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

Parameters

None.

cURL syntax
curl --include \
     --request PUT \
     --header "Content-Type: application/json" \
     --data-binary "{
    \"mobileList\" : [\"8120321321\", \"1239812093\"]
}" \
'https://core.dev.Example.net/api/user/by/mobile'
PUT body attributes (JSON)

Attribute Type Use Description

mobileList Array Required An array of strings containing the users' mobile numbers.

PUT body
Headers: Content-Type: application/json
{
  "mobileList": [
    "8120321321",
    "1239812093"
  ]
}
Response body
Headers: Content-Type: application/json | HTTPS Status Code: 200
{
  "error": false,
  "message": "Deleted users successfully",
  "detail": null,
  "data": true
}
Return to top

Attribute	Type	Use	Description
`mobileList`	Array	Required	An array of strings containing the users' mobile numbers.

PUTDelete by Social ID

Description

Allows an admin to delete users by their social ID.

Request Endpoint

PUT https://<Example api server address>/user/by/social

Parameters

None.

cURL syntax
curl --include \
     --request PUT \
     --header "Content-Type: application/json" \
     --data-binary "{
    \"socialList\" : [\"123719831931\", \"123761029312\"]
}" \
'https://core.dev.Example.net/api/user/by/social'
PUT body attributes (JSON)

Attribute Type Use Description

socialList Array Required An array of strings containing the users' social IDs.

PUT body
Headers: Content-Type: application/json
{
  "socialList": [
    "123719831931",
    "123761029312"
  ]
}
Response body
Headers: Content-Type: application/json | HTTPS Status Code: 200
{
  "error": false,
  "message": "Deleted users successfully",
  "detail": null,
  "data": true
}
Return to top

Attribute	Type	Use	Description
`socialList`	Array	Required	An array of strings containing the users' social IDs.

POSTFetch by Tags

Description

Find all the users where a group matches with the tag passed.

One or more than one group may match.
You can pass the following tag value : login type, zip code, postal code, state, country, county, city, birth year, device OS, device manufacturer, device model.
Note: The birth year is considered as an integer.

Request Endpoint

POST https://<Example api server address>/user/getUsersByGroup

Parameters

None.

cURL syntax

curl --include \
     --request POST \
     --header "Content-Type: application/json" \
     --data-binary "{
    \"groups\" : [\"MOBILE\", \"Samsung\",\"Apple\", \"1980\", \"56789\"]
}" \
'https://core.dev.Example.net/api/user/tags'

POST body attributes (JSON)

Attribute	Type	Use	Description
`groups`	String	Required	An array of string of tags to filter the results.

POST body

Headers: Content-Type: application/json

{
  "groups": [
    "MOBILE",
    "Samsung",
    "Apple",
    "1980",
    "56789"
  ]
}

Response body

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

{
  "error": false,
  "message": "Getting user list is successfully",
  "detail": null,
  "data": [
    {
      "id": "a257c0e8-7109-402e-a9dc-68c70dee4814",
      "firstName": "Sudipta",
      "lastName": "Sudipta",
      "fullName": "Sudipta Bhaumik",
      "profileName": "profile",
      "registrationDate": 1450350326271,
      "birthDateDay": 12,
      "birthDateMonth": 5,
      "birthDateYear": 1980,
      "locationCountry": "India",
      "locationZipCode": "560010",
      "timezone": "IST",
      "profileImagePath": null,
      "userSetting": null,
      "socialAuthenticationChannels": [],
      "emailAuthenticationChannels": [],
      "mobileAuthenticationChannels": [
        {
          "loginType": "MOBILE",
          "primary": true,
          "mobileNumber": "+919916248135",
          "mobileVerificationStatus": "VERIFIED",
          "mobilePinResetStatus": "RESET_COMPLETE",
          "addedOn": 1450350326272,
          "lastUsedOn": 1450350326272,
          "deletedOn": null
        }
      ],
      "addresses": [
        {
          "id": "3d6baf86-1208-4126-8ac8-e9c64f3bd1da",
          "street1": "123 Test Ln",
          "street2": "",
          "street3": "",
          "city": "Somewhere",
          "state": "st",
          "county": "Clark",
          "postal": "89101",
          "country": "United Kingdon",
          "addressType": "BILLING"
        }
      ],
      "status": "NEW",
      "verified": true,
      "wrongPinAttempts": 0,
      "pinCreated": true
    },
    {
      "id": "d1bb60d9-e856-4169-9ea3-83941cb799e2",
      "firstName": "Sudipta1",
      "lastName": "",
      "fullName": "Sudipta1 ",
      "profileName": "sudipta1",
      "registrationDate": 1450355680011,
      "birthDateDay": 4,
      "birthDateMonth": 1,
      "birthDateYear": 1978,
      "locationCountry": "",
      "locationZipCode": "",
      "timezone": null,
      "profileImagePath": null,
      "userSetting": null,
      "socialAuthenticationChannels": [],
      "emailAuthenticationChannels": [],
      "mobileAuthenticationChannels": [
        {
          "loginType": "MOBILE",
          "primary": true,
          "mobileNumber": "+91991624813",
          "mobileVerificationStatus": "VERIFICATION_PENDING",
          "mobilePinResetStatus": "RESET_NA",
          "addedOn": 1450355680011,
          "lastUsedOn": 1450355680011,
          "deletedOn": null
        }
      ],
      "addresses": null,
      "status": "NEW",
      "verified": false,
      "wrongPinAttempts": 0,
      "pinCreated": false
    }
  ]
}

Return to top

GETFetch Email Verification Status

Description

This API helps to fetch all user email verification statuses.

Request Endpoint

GET https://<Example api server address>/user/emailverificationstatus

Parameters

None.

cURL syntax
curl --include \
'https://core.dev.Example.net/api/user/emailverificationstatus'
Response body
Headers: Content-Type: application/json | HTTPS Status Code: 200
{
  "data": {
    "BLOCKED": "EmailVerificationStatus",
    "DEACTIVATED": "EmailVerificationStatus",
    "DELETED": "EmailVerificationStatus",
    "VERIFICATION_PENDING": "EmailVerificationStatus",
    "VERIFIED": "EmailVerificationStatus"
  },
  "detail": null,
  "error": false,
  "message": "Fetching the email verification status successful"
}
Return to top

GETFetch Mobile Verification Status

Description

This API helps to fetch all user mobile verification statuses.

Request Endpoint

GET https://<Example api server address>/user/mobileverificationstatus

Parameters

None.

cURL syntax
curl --include \
'https://core.dev.Example.net/api/user/mobileverificationstatus'
Response body
Headers: Content-Type: application/json | HTTPS Status Code: 200
{
  "data": {
    "BLOCKED": "MobileVerificationStatus",
    "DEACTIVATED": "MobileVerificationStatus",
    "DELETED": "MobileVerificationStatus",
    "VERIFICATION_PENDING": "MobileVerificationStatus",
    "VERIFIED": "MobileVerificationStatus"
  },
  "detail": null,
  "error": false,
  "message": "Fetching the mobile verification status successful"
}
Return to top

GETFetch Payment Method Status

Description

This API helps to fetch all user payment info statuses.

Request Endpoint

GET https://<Example api server address>/user/paymentinfostatus

Parameters

None.

cURL syntax
curl --include \
'https://core.dev.Example.net/api/user/paymentinfostatus'
Response body
Headers: Content-Type: application/json | HTTPS Status Code: 200
{
  "data": {
    "BLACKLISTED": "PaymentInfoStatus",
    "BLOCKED": "PaymentInfoStatus",
    "DEACTIVATED": "PaymentInfoStatus",
    "DELETED": "PaymentInfoStatus",
    "USER_IDENTIFICATION_PENDING": "PaymentInfoStatus",
    "VERIFICATION_PENDING": "PaymentInfoStatus",
    "VERIFIED": "PaymentInfoStatus"
  },
  "detail": null,
  "error": false,
  "message": "Fetching the payment info status successful"
}
Return to top

GETFetch User Audit Trail Data

Description

Gets data contained in a user's audit trail.

Request Endpoint

GET https://<Example api server address>/user/data/trail/{userId}?offset=0&limit=10

Parameters

Parameter Type Use Description

userId String Required UUID of the user.

offset Integer Optional Sets an offset for specifying a page number in pagination: default = 0.

limit Integer Optional Specifying a limit to use in the pagination: default = 0.

cURL syntax
curl --include \
'https://core.dev.Example.net/api/user/data/trail/userId?offset=0&limit=10'
Response body
Headers: Content-Type: application/json | HTTPS Status Code: 200
{
  "data": [
    {
      "id": "c9524c9c-da0f-42ca-b8a8-025c1d72e166",
      "event": "User is deleted",
      "message": "User Interface is not friendly",
      "timestamp": 1465373872320
    }
  ],
  "detail": null,
  "error": false,
  "message": "Fetching user audit trail data successful"
}
Return to top

Parameter	Type	Use	Description
userId	String	Required	UUID of the user.
offset	Integer	Optional	Sets an offset for specifying a page number in pagination: default = 0.
limit	Integer	Optional	Specifying a limit to use in the pagination: default = 0.

GETFetch User Statuses

Description

This API helps to fetch all user statuses.

Request Endpoint

GET https://<Example api server address>/user/userstatus

Parameters

None.

cURL syntax
curl --include \
'https://core.dev.Example.net/api/user/statuses'
Response body
Headers: Content-Type: application/json | HTTPS Status Code: 200
{
  "data": {
    "BLACKLISTED": "UserStatus",
    "BLOCKED": "UserStatus",
    "DEACTIVATED": "UserStatus",
    "DELETED": "UserStatus",
    "EXISTING": "UserStatus",
    "NEW": "UserStatus",
    "TEMPORARILY_BLOCKED": "UserStatus"
  },
  "detail": null,
  "error": false,
  "message": "Fetching the user status successful"
}
Return to top

GETGet Deleted Users

Description

An endpoint to get deleted users. Provides pagination support.

Request Endpoint

GET https://<Example api server address>/admin/deleted/user

Parameters

None.

cURL syntax

curl --include \
'https://core.dev.Example.net/api/admin/deleted/user'

Response body

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

{
  "data": [
    {
      "id": "04d97e55-d1ae-4227-9e1e-f3629905544e",
      "addresses": null,
      "birthDateDay": null,
      "birthDateMonth": null,
      "birthDateYear": null,
      "devices": [
        {
          "id": "9ca31867-2a4a-4aa4-ba6c-2241ffb2b0b0",
          "description": "desc",
          "deviceStatus": "NORMAL",
          "manufacturer": "samsung",
          "model": "SPH-L710",
          "os": "Android:4.4.2",
          "udid": "CE9B49AD-8985-4564-8204-790B073F266C",
          "simStateHashCode": null,
          "simCardState": null
        },
        {
          "id": "05b678cc-7c39-4dda-8ad5-53502fbc54d0",
          "description": "desc",
          "deviceStatus": "NORMAL",
          "manufacturer": "motorola",
          "model": "Nexus 6",
          "os": "Android:6.0.1",
          "udid": "97F5881F-43E0-4115-A408-A5CC04951DBB",
          "simStateHashCode": null,
          "simCardState": null
        }
      ],
      "emailAuthenticationChannels": [
        {
          "addedOn": 1458688528550,
          "blockStatus": "NORMAL",
          "deletedOn": null,
          "emailAddress": "james+10@impekable.com",
          "emailPinResetStatus": "RESET_COMPLETE",
          "emailVerificationStatus": "VERIFIED",
          "lastUsedOn": 1458688528550,
          "loginType": "EMAIL",
          "primary": false,
          "deleted": false,
          "recycleEmailAddress": null
        }
      ],
      "firstName": null,
      "fullName": "null null",
      "groupTag": [
        "SPH-L710",
        "samsung",
        "Android:4.4.2",
        "EMAIL"
      ],
      "lastName": null,
      "locationCountry": null,
      "locationZipCode": null,
      "mobileAuthenticationChannels": [],
      "pinCreated": true,
      "profileImagePath": null,
      "profileName": null,
      "registrationDate": 1458688528550,
      "socialAuthenticationChannels": [],
      "status": "DELETED",
      "timezone": null,
      "userSetting": {
        "autoUpdateBetcadeApp": true,
        "autoUpdateDownloadedApps": true,
        "monthlyDepositMaxLimit": 50,
        "monthlyDepositMaxLimitCurrency": "USD",
        "prefillUserInfoInCasino": true,
        "receiveEmailReceipt": true,
        "receiveNotifications": true,
        "shareRegistrationInfo": true,
        "userEmailProvided": true,
        "versionOfDownloadedBetcadeApp": "1.0",
        "wifiDownloadLimitInMB": 0,
        "preferredCategories": null,
        "autoSaveCard": null,
        "autoAddHomeIcon": null,
        "receiveUpdateNotifications": null,
        "receiveAutoUpdatedNotifications": null,
        "receiveRecommendationNotifications": null
      },
      "verified": true,
      "pinResetDate": null,
      "casinoUserData": null,
      "testUser": null
    },
  ],
  "detail": null,
  "error": false,
  "message": "fetching deleted users successful"
}

Return to top

PUTUpdate (Authentication Channel Status)

Description

Updates a user's authentication channel status.

Request Endpoint

PUT https://<Example api server address>/user/credential/status

Parameters

None.

cURL syntax
curl --include \
     --request PUT \
     --header "Content-Type: application/json" \
     --data-binary "{
    \"userId\":\"ed359f0f-064c-4ca2-a5de-720bf3e270a4\",
    \"credentialStatuses\":[
        {
            \"loginType\":\"EMAIL\",
            \"emailAddress\":\"sudipta@gmail.in.co17\",
            \"emailStatus\":\"DELETED\"
        },
        {
            \"loginType\":\"MOBILE\",
            \"mobileNumber\" : \"+919916248108\",
            \"mobileStatus\" : \"VERIFIED\"
        }
    ]
}" \
'https://core.dev.Example.net/api/user/credential/status'
PUT body attributes (JSON)

Attribute Type Use Description

userId String Required The user id.

credentialStatuses Object (Array) Required The credential statuses object.

loginType String Required Login Type (can be "EMAIL" and "MOBILE”).

emailAddress String Conditional Email address of a user (mandatory when login type is email).

mobileNumber String Conditional Mobile number of a user (mandatory when login type is mobile).

emailStatus String Conditional Email status, mandatory when login type is email (BLOCKED, VERIFIED, DELETED, DEACTIVATED, and VERIFICATION_PENDING).

mobileStatus String Conditional Mobile status, mandatory when login type is mobile (BLOCKED, VERIFIED, DELETED, DEACTIVATED, and VERIFICATION_PENDING).

PUT body
Headers: Content-Type: application/json
{
  "userId": "ed359f0f-064c-4ca2-a5de-720bf3e270a4",
  "credentialStatuses": [
    {
      "loginType": "EMAIL",
      "emailAddress": "sudipta@gmail.in.co17",
      "emailStatus": "DELETED"
    },
    {
      "loginType": "MOBILE",
      "mobileNumber": "+919916248108",
      "mobileStatus": "VERIFIED"
    }
  ]
}
Response body
Headers: Content-Type: application/json | HTTPS Status Code: 200
{
  "data": true,
  "detail": null,
  "error": false,
  "message": "Editing user credential status successful"
}
Return to top

Attribute	Type	Use	Description
`userId`	String	Required	The user id.
`credentialStatuses`	Object (Array)	Required	The credential statuses object.
`loginType`	String	Required	Login Type (can be "EMAIL" and "MOBILE”).
`emailAddress`	String	Conditional	Email address of a user (mandatory when login type is email).
`mobileNumber`	String	Conditional	Mobile number of a user (mandatory when login type is mobile).
`emailStatus`	String	Conditional	Email status, mandatory when login type is email (BLOCKED, VERIFIED, DELETED, DEACTIVATED, and VERIFICATION_PENDING).
`mobileStatus`	String	Conditional	Mobile status, mandatory when login type is mobile (BLOCKED, VERIFIED, DELETED, DEACTIVATED, and VERIFICATION_PENDING).

PUTUpdate (User Status)

Description

This Api helps to edit the user status.

Request Endpoint

PUT https://<Example api server address>/user/status

Parameters

None.

cURL syntax
curl --include \
     --request PUT \
     --header "Content-Type: application/json" \
     --data-binary "{
    \"userId\":\"ed359f0f-064c-4ca2-a5de-720bf3e270a4\",
    \"status\":\"BLACKLISTED\"
}" \
'https://core.dev.Example.net/api/user/status'
PUT body attributes (JSON)

Attribute Type Use Description

userId String Required UUID of a user.

status String Required Status of a user (status can be Blacklisted, Blocked, Existing, New, Deleted, Deactivated).

PUT body
Headers: Content-Type: application/json
{
  "userId": "ed359f0f-064c-4ca2-a5de-720bf3e270a4",
  "status": "BLACKLISTED"
}
Response body
Headers: Content-Type: application/json | HTTPS Status Code: 200
{
  "data": true,
  "detail": null,
  "error": false,
  "message": "Editing user status successful"
}
Return to top

Attribute	Type	Use	Description
`userId`	String	Required	UUID of a user.
`status`	String	Required	Status of a user (status can be Blacklisted, Blocked, Existing, New, Deleted, Deactivated).

PUTUpdate User PM Status

Description

Updates a user's PM status.

Request Endpoint

PUT https://<Example api server address>/user/payment/status

Parameters

None.

cURL syntax
curl --include \
     --request PUT \
     --header "Content-Type: application/json" \
     --data-binary "{
    \"userId\" : \"491c6bc6-8a6f-4e44-aa08-d66e36a65eec\",
    \"paymentMethodStatuses\" : [
        {
            \"paymentId\" : \"be2fdfd0-d588-4cae-844b-be3c68369916\",
            \"status\" : \"USER_IDENTIFICATION_PENDING\"
        }
    ]
}" \
'https://core.dev.Example.net/api/user/payment/staus'
PUT body attributes (JSON)

Attribute Type Use Description

userId String Required UUID of an existing User.

paymentMethodStatuses Array Required An array of the following attributes.

paymentId String Required UUID of an User PM.

status String Required Status of Payment Method (PM).
Can be either "BLACKLISTED", "BLACKLISTED_CS", "BLACKLISTED_FRAUD",
"BLOCKED_CVV", "BLOCKED_FRAUD", "BLOCKED_TEMP_CVV", "DEACTIVATED",
"DELETED", "USER_IDENTIFICATION_PENDING", "VERIFIED".

PUT body
Headers: Content-Type: application/json
{
  "userId": "491c6bc6-8a6f-4e44-aa08-d66e36a65eec",
  "paymentMethodStatuses": [
    {
      "paymentId": "be2fdfd0-d588-4cae-844b-be3c68369916",
      "status": "USER_IDENTIFICATION_PENDING"
    }
  ]
}
Response body
Headers: Content-Type: application/json | HTTPS Status Code: 200
{
  "data": true,
  "detail": null,
  "error": false,
  "message": "Editing user payment method status successful"
}
Return to top

Attribute	Type	Use	Description
`userId`	String	Required	UUID of an existing User.
`paymentMethodStatuses`	Array	Required	An array of the following attributes.
`paymentId`	String	Required	UUID of an User PM.
`status`	String	Required	Status of Payment Method (PM). Can be either "BLACKLISTED", "BLACKLISTED_CS", "BLACKLISTED_FRAUD", "BLOCKED_CVV", "BLOCKED_FRAUD", "BLOCKED_TEMP_CVV", "DEACTIVATED", "DELETED", "USER_IDENTIFICATION_PENDING", "VERIFIED".

PUTWhitelist a User or Device

Description

Note:

If UserId is passed: Whitelist a user and all their associated devices and payment methods.
If DeviceUdid is passed: Device is whitelisted.
If paymentId is passed: Payment method is whitelisted.

PUT Endpoint example: /user/{id}/whitelist

Request (application/json)
    {
        "userId":null,
        "deviceUdid" : "udid",
        "paymentId":null
    }

Response body example:

Response 200 (application/json)
    {
        "error": false,
        "message": "UnBlacklisting of user/device/payment successful.",
        "detail": null,
        "data": null
    }

Request Endpoint

PUT https://<Example api server address>/user/{id}/whitelist

Parameters

Parameter	Type	Use	Description
id	String	Required	UUID of the user.

cURL syntax

curl --include \
     --request PUT \
     --header "Content-Type: application/json" \
     --data-binary "{
    \"userId\":null,
    \"deviceUdid\" : \"udid\",
    \"paymentId\":null
}" \
'https://core.dev.Example.net/api/user/id/whitelist'

PUT body attributes (JSON)

Attribute	Type	Use	Description
`blockType`	String	Required	Takes one of following values: USER, PAYMENT, EMAIL, SOCIAL, PHONE, OR DEVICE.
`deviceUdid`	String	Optional	UDID of the device to be unblacklisted.
`paymentId`	String	Optional	Payment Id of method to be unblacklisted.
`emailAddress`	String	Optional	Email address being unblacklisted.
`mobileNumber`	String	Optional	Phone being unblacklisted.
`socialLoginType`	String	Optional	Login type for a social id being blacklisted, like TWITTER, FACEBOOK, etc.
`socialId`	String	Optional	The social id being unblacklisted.

PUT body

Headers: Content-Type: application/json

{
  "userId": "af964804-7f1d-4662-9fca-af7e6042da43",
  "deviceUdid": null,
  "paymentId": null
}

Response body

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

{
  "error": false,
  "message": "UnBlacklisting of user/device/payment successful.",
  "detail": null,
  "data": {
    "id": "af964804-7f1d-4662-9fca-af7e6042da43",
    "updatedBy": "",
    "firstName": "Shruti",
    "lastName": "Nagarkar",
    "fullName": "Shruti Nagarkar",
    "profileName": "ShrutiN",
    "registrationDate": 1452067175740,
    "birthDateDay": 15,
    "birthDateMonth": 9,
    "birthDateYear": 1991,
    "locationCountry": "India",
    "locationZipCode": "581320",
    "timezone": "IST",
    "profileImagePath": "www.google.com",
    "userSetting": {
      "autoUpdateBetcadeApp": true,
      "autoUpdateDownloadedApps": true,
      "userEmailProvided": false,
      "monthlyDepositMaxLimit": 2414,
      "monthlyDepositMaxLimitCurrency": "USD",
      "wifiDownloadLimitInMB": 232,
      "prefillUserInfoInCasino": false,
      "versionOfDownloadedBetcadeApp": "sg34",
      "receiveEmailReceipt": true,
      "receiveNotifications": false,
      "shareRegistrationInfo": false
    },
    "socialAuthenticationChannels": [
      {
        "loginType": "FACEBOOK",
        "socialId": "social12345",
        "addedOn": 1452067175742,
        "lastUsedOn": 1452067175742,
        "deletedOn": null
      }
    ],
    "emailAuthenticationChannels": [
      {
        "loginType": "EMAIL",
        "primary": null,
        "emailAddress": "rn.shruti@gmail.com",
        "emailVerificationStatus": "VERIFIED",
        "emailPinResetStatus": null,
        "addedOn": 1452067175742,
        "lastUsedOn": 1452067175742,
        "deletedOn": null
      }
    ],
    "mobileAuthenticationChannels": [
      {
        "loginType": "MOBILE",
        "primary": false,
        "mobileNumber": "+918050022027",
        "mobileVerificationStatus": "VERIFIED",
        "mobilePinResetStatus": null,
        "addedOn": 1452067175742,
        "lastUsedOn": 1452067175742,
        "deletedOn": null
      }
    ],
    "addresses": [
      {
        "id": "4827828e-0719-4510-8378-c80000318a8f",
        "updatedBy": "",
        "street1": "Wilson garden",
        "street2": null,
        "street3": null,
        "city": "Bangalore",
        "state": null,
        "county": null,
        "postal": "560073",
        "country": null,
        "addressType": "HOME"
      },
      {
        "id": "e987b583-41cb-4bf9-bfd2-8490a5ee35c5",
        "updatedBy": "",
        "street1": "Wilson garden",
        "street2": null,
        "street3": null,
        "city": "Bangalore",
        "state": null,
        "county": null,
        "postal": "560073",
        "country": null,
        "addressType": "HOME"
      }
    ],
    "status": "EXISTING",
    "verified": true,
    "pinCreated": true,
    "reasonForDeleting": null,
    "lastWrongPinAttemptTime": null,
    "blockedMinutes": 0,
    "userBlockedNumber": 0,
    "userBlockedTime": null
  }
}

Return to top