v1

latestOpenAPI 3.0.12026-07-24501176.6 MB
Get Customer Image

Lets you retrieve a customer’s profile image.
get/customers/{userId}/setImage
Path parameters

customerIdinteger required
Unique ID of the customer.
Query parameters

sourcestring required
Source on which the customer is registered.
embed=CUSTOMERIMAGEstring
Pass to retrieve the customer image
Response

200
idinteger
segmentsobject
associatedWithstring
Example response

{
  "id": 565039505,
  "profiles": [
    {
      "firstName": "Aditi",
      "lastName": "Khan",
      "attribution": {
        "createDate": "2025-02-28T06:16:17Z",
        "createdBy": {
          "id": 75155282,
          "code": "neeraj.doc",
          "name": "neeraj.doc",
          "type": "TILL",
          "referenceId": -1
        },
        "modifiedBy": {
          "id": 75155297,
          "code": "tj_capillary",
          "name": "tj_capillary",
          "type": "TILL",
          "referenceId": -1
        },
        "modifiedDate": "2025-04-29T09:55:34Z"
      },
      "fields": {
        "address": "Bangalore1234",
        "city_name": "Bangalore"
      },
      "identifiers": [
        {
          "type": "email",
          "value": "tom.sawyer@capillarytech.com"
        }
      ],
      "commChannels": [
        {
          "type": "email",
          "value": "tom.sawyer@capillarytech.com",
          "primary": true
        }
      ],
      "source": "INSTORE",
      "userId": 565039505,
      "autoUpdateTime": "2025-04-30T06:58:25Z",
      "identifiersAll": [
        {
          "type": "email",
          "value": "tom.sawyer@capillarytech.com"
        }
      ]
    }
  ],
  "loyaltyInfo": {
    "loyaltyType": "loyalty",
    "attributionV2": {
      "createDate": "2025-02-28T06:16:17Z",
      "createdBy": {
        "id": 75155282,
        "code": "neeraj.doc",
        "name": "neeraj.doc",
        "type": "TILL",
        "referenceId": -1
      },
      "modifiedBy": {
        "id": 75155297,
        "code": "tj_capillary",
        "name": "tj_capillary",
        "type": "TILL",
        "referenceId": -1
      },
      "modifiedDate": "2025-04-29T09:55:34Z",
      "createdFromSource": "instore"
    }
  },
  "associatedWith": "neeraj.doc",
  "customerImage": [
    {
      "code": 200,
      "file": {
        "acl": "PRIVATE",
        "fileSize": "209859",
        "fileHandle": "01a24b35-f1fa-4dc3-bbce-ab9bc5094e2c",
        "lastModified": "2025-04-30 12:25:56",
        "latestVersion": 1,
        "name": "100737/565039505/0",
        "namespace": "customerImage",
        "s3Token": "customerImage/100737/565039505/a3982817-21ca-46f6-acfa-0d1c23d1fe2e",
        "version": 1
      },
      "filePath": "https://s3-eu-west-1.amazonaws.com/fs.capillary.eu/customerImage/100737/565039505/a3982817-21ca-46f6-acfa-0d1c23d1fe2e?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEAcaCWV1LXdlc3QtMSJGMEQCICKLUTRBXx%2BTJ2wGVBDyt1aYBV3AqawRLSbNDW%2BEHtrtAiBEnCThKTWAH8Qw9Xh9miPqzbTEfAsohXda8DKXgb3uTSq6Agig%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F8BEAAaDDUwMjgxMjc3OTI2NyIM2UufjIFYFCcHDhTPKo4ClmWqDNs4g2f05Phlk%2B%2B7DlflnMPP6HyqUZC9tnamJdyEwbDkaIwBetXukJMyXaHdwF96O953BNR33pL4yBP3rFmsEOHA3Q3yIIeWYMlgFpC9lL4Cffn%2FAMRMAIbm7YYPofWWEALjpYYKzKizmDvzm24GQl%2FD%2BRrgYymWDSKxQp9TCd7TP1EfdHJ8kjhqMJ5ofpYE2MOnUJfFEe%2Fwyx7QpPrmcYLgDyRGgPohcYyGJb%2B1sZEaI%2BVNvE9QwBtDcOfS%2BgEZXkKZOQcWeMY3%2Ff6XGYHwm%2FezO5MvRBdP01pthNCJhszuqlH9Z53g1UqfhBfgL0ihOfmHmlUWSWNECShIr9MuI4KadbLrIhPAZL3wMLOOx8AGOp4B8HXDLoMJwlk3Si%2F5hx5moqswH3jgo5s3t8srZwwchTHnh9du9kkF7r7OhTR4wm1RAK5bQvJ%2B%2B7vTNrbfngmu9FNkTqDao%2BDWAWHv7WhocB2ouZehTezduIfolV8GxF5RNhhJmN4G8DhYV22MCpZAc9IvpH93yJQXRC%2B0Oj6mfc9nFJft9FBq8kUhpdnAX0S4tLw2JgijOhJwOGpJIcc%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20250430T065825Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3599&X-Amz-Credential=ASIAXKEP2EMB3PGOSBW6%2F20250430%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Signature=ff24aa76c4be68bda8e5a7b0cfe5915c03e1a2e350ec5366698b7111b4616c53",
      "message": "Success",
      "secureFilePath": "https://s3-eu-west-1.amazonaws.com/fs.capillary.eu/customerImage/100737/565039505/a3982817-21ca-46f6-acfa-0d1c23d1fe2e?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEAcaCWV1LXdlc3QtMSJGMEQCICKLUTRBXx%2BTJ2wGVBDyt1aYBV3AqawRLSbNDW%2BEHtrtAiBEnCThKTWAH8Qw9Xh9miPqzbTEfAsohXda8DKXgb3uTSq6Agig%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F8BEAAaDDUwMjgxMjc3OTI2NyIM2UufjIFYFCcHDhTPKo4ClmWqDNs4g2f05Phlk%2B%2B7DlflnMPP6HyqUZC9tnamJdyEwbDkaIwBetXukJMyXaHdwF96O953BNR33pL4yBP3rFmsEOHA3Q3yIIeWYMlgFpC9lL4Cffn%2FAMRMAIbm7YYPofWWEALjpYYKzKizmDvzm24GQl%2FD%2BRrgYymWDSKxQp9TCd7TP1EfdHJ8kjhqMJ5ofpYE2MOnUJfFEe%2Fwyx7QpPrmcYLgDyRGgPohcYyGJb%2B1sZEaI%2BVNvE9QwBtDcOfS%2BgEZXkKZOQcWeMY3%2Ff6XGYHwm%2FezO5MvRBdP01pthNCJhszuqlH9Z53g1UqfhBfgL0ihOfmHmlUWSWNECShIr9MuI4KadbLrIhPAZL3wMLOOx8AGOp4B8HXDLoMJwlk3Si%2F5hx5moqswH3jgo5s3t8srZwwchTHnh9du9kkF7r7OhTR4wm1RAK5bQvJ%2B%2B7vTNrbfngmu9FNkTqDao%2BDWAWHv7WhocB2ouZehTezduIfolV8GxF5RNhhJmN4G8DhYV22MCpZAc9IvpH93yJQXRC%2B0Oj6mfc9nFJft9FBq8kUhpdnAX0S4tLw2JgijOhJwOGpJIcc%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20250430T065825Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3599&X-Amz-Credential=ASIAXKEP2EMB3PGOSBW6%2F20250430%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Signature=ff24aa76c4be68bda8e5a7b0cfe5915c03e1a2e350ec5366698b7111b4616c53",
      "status": "true"
    }
  ],
  "extendedFields": {
    "gender": "Male"
  }
}