---
updatedAt: 2026-05-29T13:25:42.000Z
agentTools:
  projectIndex: https://developer.eftcorp.com/llms.txt
---

# Get a list of the customers addresses

This will return all addresses linked to the customer

# OpenAPI definition

```json
{
  "servers": [
    {
      "url": "https://eclipse-java-sandbox.ukheshe.rocks",
      "description": "Eclipse sandbox environment"
    },
    {
      "url": "https://ukheshe.live",
      "description": "Eclipse production environment"
    },
    {
      "url": "https://eclipse-java-develop.ukheshe.rocks",
      "description": "Eclipse development environment"
    },
    {
      "url": "https://zw.ukheshe.live",
      "description": "Zim Eclipse production environment"
    }
  ],
  "openapi": "3.1.0",
  "components": {
    "schemas": {
      "AddressType": {
        "type": "string",
        "enum": [
          "BRANCH",
          "HEADQUARTERS",
          "OPERATING",
          "PHYSICAL",
          "POSTAL",
          "PRIMARY",
          "REGISTERED"
        ]
      },
      "EclipseAddress": {
        "description": "A physical, postal or other type of address that can be captured against an organisation or customer",
        "type": "object",
        "properties": {
          "addressId": {
            "type": "integer",
            "format": "int64",
            "description": "Unique system generated identifier for an address",
            "exclusiveMinimum": 0
          },
          "addressType": {
            "$ref": "#/components/schemas/AddressType",
            "description": "Type of address",
            "type": "string"
          },
          "city": {
            "type": "string",
            "minLength": 2,
            "maxLength": 20
          },
          "code": {
            "type": "string",
            "pattern": "^$|^.{3,10}$",
            "minLength": 0,
            "maxLength": 10
          },
          "country": {
            "type": "string",
            "minLength": 2,
            "maxLength": 60
          },
          "customerId": {
            "type": "integer",
            "format": "int64",
            "description": "The customer the address is for"
          },
          "gpsLatitude": {
            "type": "number",
            "description": "GPS latitude of the address in decimal degrees",
            "maximum": 90,
            "minimum": -90
          },
          "gpsLongitude": {
            "type": "number",
            "description": "GPS longitude of the address in decimal degrees",
            "maximum": 180,
            "minimum": -180
          },
          "line1": {
            "type": "string",
            "pattern": "^[A-Za-z0-9À-ÿ][A-Za-z0-9À-ÿ_\\s'.,&:#*()_`/-]*$",
            "minLength": 1,
            "maxLength": 150
          },
          "line2": {
            "type": "string",
            "pattern": "^$|^[A-Za-z0-9À-ÿ][A-Za-z0-9À-ÿ_\\s'.,&:#*()_`/-]*$",
            "minLength": 0,
            "maxLength": 150
          },
          "line3": {
            "type": "string",
            "pattern": "^$|^[A-Za-z0-9À-ÿ][A-Za-z0-9À-ÿ_\\s'.,&:#*()_`/-]*$",
            "minLength": 0,
            "maxLength": 150
          },
          "organisationId": {
            "type": "integer",
            "format": "int64",
            "description": "The organisation the address is for"
          },
          "state": {
            "type": "string",
            "minLength": 3,
            "maxLength": 50
          },
          "tenantId": {
            "type": "integer",
            "format": "int64"
          },
          "version": {
            "type": "integer",
            "format": "int32",
            "description": "A number indicating the version of the record. Updates will only be accepted if the passed in version is the same as the current version on record. This is in order to prevent concurrent modifications by multiple users.",
            "minimum": 0
          }
        },
        "required": [
          "addressType",
          "line1",
          "city",
          "state",
          "country",
          "version"
        ]
      },
      "ExceptionData": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "environment": {
            "type": "string"
          },
          "info": {
            "type": "object",
            "additionalProperties": {}
          },
          "severity": {
            "$ref": "#/components/schemas/ExceptionSeverity"
          },
          "spanId": {
            "type": "string"
          },
          "stackTrace": {
            "type": "string"
          },
          "traceId": {
            "type": "string"
          },
          "type": {
            "$ref": "#/components/schemas/ExceptionType"
          }
        }
      },
      "ExceptionSeverity": {
        "type": "string",
        "enum": [
          "CRITICAL",
          "HIGH",
          "INFO",
          "LOW",
          "MEDIUM"
        ]
      },
      "ExceptionType": {
        "type": "string",
        "enum": [
          "BUSINESS",
          "SYSTEM"
        ]
      }
    },
    "securitySchemes": {
      "JWTBearerAuthorisation": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      }
    }
  },
  "info": {
    "description": "A RESTful API using JSON as the data transfer model, covering all tenant-facing functionality in the Eclipse payments platform.",
    "title": "Eclipse ReST API",
    "version": "3.0.0"
  },
  "tags": [
    {
      "name": "d) Customer Management",
      "description": "Operations on an individual customer profile including identity management, addresses, documents, wallets, cards, beneficiaries, and KYC ratification."
    }
  ],
  "paths": {
    "/eclipse-conductor/rest/v1/tenants/{tenantId}/customers/{customerId}/addresses": {
      "get": {
        "summary": "Get a list of the customers addresses",
        "description": "This will return all addresses linked to the customer",
        "tags": [
          "d) Customer Management"
        ],
        "parameters": [
          {
            "name": "tenantId",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          },
          {
            "name": "customerId",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/EclipseAddress"
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal Server error",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/ExceptionData"
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "JWTBearerAuthorisation": []
          }
        ]
      }
    }
  }
}
```