Skip to main content
GET
/
customers
/
{id}
/
associated-parties
/
{associatedPartyId}
Read an associated party
curl --request GET \
  --url https://api.lumx.io/customers/{id}/associated-parties/{associatedPartyId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "type": "INDIVIDUAL",
  "roles": [],
  "name": "Maria Santos",
  "taxId": "987.654.321-00",
  "birthDate": "1985-07-10",
  "email": "maria.santos@example.com",
  "address": {
    "country": "BRA",
    "line1": "Rua das Flores, 123",
    "city": "São Paulo",
    "state": "SP",
    "postalCode": "01234-567"
  },
  "ownershipPercentage": 40,
  "parentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "verification": {
    "status": "NOT_STARTED",
    "level": "STANDARD",
    "link": "https://in.sumsub.com/websdk/p/sbx_aA00bB11cC33dD44"
  },
  "createdAt": "2024-01-15T11:00:00Z",
  "updatedAt": "2024-01-15T11:00:00Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header on the format Bearer <API_KEY>.

Path Parameters

​
id
string<uuid>
required

Customer's unique identifier.

​
associatedPartyId
string<uuid>
required

Associated party's unique identifier.

Response

200 - application/json

Associated party successfully retrieved.

​
id
string<uuid>

Associated party's unique identifier.

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

​
type
enum<string>
Available options:
INDIVIDUAL
​
roles
enum<string>[]
Available options:
UBO,
SHAREHOLDER,
REPRESENTATIVE
​
name
string
Example:

"Maria Santos"

​
taxId
string
Example:

"987.654.321-00"

​
birthDate
string<date>
Example:

"1985-07-10"

​
email
string<email>
Example:

"maria.santos@example.com"

​
address
object

Address information.

​
ownershipPercentage
number
Example:

40

​
parentId
string<uuid>

Parent associated party ID. Used for multi-level corporate structures, allowing you to nest shareholders across 2, 3, or more levels of ownership hierarchy.

​
verification
object

Customer's verification.

​
createdAt
string<date-time>
Example:

"2024-01-15T11:00:00Z"

​
updatedAt
string<date-time>
Example:

"2024-01-15T11:00:00Z"