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>'
import requests

url = "https://api.lumx.io/customers/{id}/associated-parties/{associatedPartyId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.lumx.io/customers/{id}/associated-parties/{associatedPartyId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.lumx.io/customers/{id}/associated-parties/{associatedPartyId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.lumx.io/customers/{id}/associated-parties/{associatedPartyId}"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.lumx.io/customers/{id}/associated-parties/{associatedPartyId}")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.lumx.io/customers/{id}/associated-parties/{associatedPartyId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "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"