curl --request GET \
--url https://api.platform.sandbox.dakota.xyz/customers/{customer_id}/persons \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.platform.sandbox.dakota.xyz/customers/{customer_id}/persons', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.platform.sandbox.dakota.xyz/customers/{customer_id}/persons"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.platform.sandbox.dakota.xyz/customers/{customer_id}/persons"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"data": [
{
"id": "33KqV8cN2pLmR5tW7xYzA1bC3dE",
"first_name": "Ada",
"last_name": "Lovelace",
"roles": [
"ubo",
"control_person"
],
"cardholder_id": null,
"missing_for_cards": [
"phone"
]
},
{
"id": "33KqVBwT4nQs8uY1zA3cE5gJ7kM",
"first_name": "Grace",
"last_name": "Hopper",
"roles": [
"applicant"
],
"cardholder_id": "31TgwQ7hM2nP4rS6uW8yA1cE3gJ",
"missing_for_cards": [
"phone"
]
}
]
}{
"type": "https://docs.dakota.xyz/api-reference/errors#not-found",
"title": "Customer Not Found",
"status": 404,
"detail": "Customer cst_2abc123 was not found in your organization.",
"instance": "https://api.platform.dakota.xyz/customers/cst_2abc123",
"request_id": "req_7f3a8b2c"
}{
"type": "https://docs.dakota.xyz/api-reference/errors#not-found",
"title": "Customer Not Found",
"status": 404,
"detail": "Customer cst_2abc123 was not found in your organization.",
"instance": "https://api.platform.dakota.xyz/customers/cst_2abc123",
"request_id": "req_7f3a8b2c"
}{
"type": "https://docs.dakota.xyz/api-reference/errors#not-found",
"title": "Customer Not Found",
"status": 404,
"detail": "Customer cst_2abc123 was not found in your organization.",
"instance": "https://api.platform.dakota.xyz/customers/cst_2abc123",
"request_id": "req_7f3a8b2c"
}{
"type": "https://docs.dakota.xyz/api-reference/errors#not-found",
"title": "Customer Not Found",
"status": 404,
"detail": "Customer cst_2abc123 was not found in your organization.",
"instance": "https://api.platform.dakota.xyz/customers/cst_2abc123",
"request_id": "req_7f3a8b2c"
}List a customer's persons
List the individuals on the customer’s latest approved onboarding application: the same
set GET /applications returns as individuals[], less any person whose own decision on
the application is declined, auto-declined or withdrawn. Not paginated — a customer has
few persons.
Each person shows whether a cardholder already exists for them (cardholder_id) and
which details a cardholder needs that onboarding does not hold (missing_for_cards).
Use this to let a client pick an existing person to create a cardholder for, instead of
collecting their contact details again. For a BUSINESS customer, pass a person’s id as
person_id on POST /customers/{customer_id}/cardholders. An INDIVIDUAL customer’s
cardholder is the customer themself: send the phone-only request, without person_id.
A UBO or control person keeps the bank record already made for them at onboarding. Any
other person (for example, an applicant who is neither) gets a new bank record when their
cardholder is created. A UBO or control person added by a later review of the customer’s
onboarding has no bank record yet; creating a cardholder from them returns
#cardholder-person-unavailable until Dakota adds that record.
Returns an empty list if the customer has no approved application.
curl --request GET \
--url https://api.platform.sandbox.dakota.xyz/customers/{customer_id}/persons \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.platform.sandbox.dakota.xyz/customers/{customer_id}/persons', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.platform.sandbox.dakota.xyz/customers/{customer_id}/persons"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.platform.sandbox.dakota.xyz/customers/{customer_id}/persons"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"data": [
{
"id": "33KqV8cN2pLmR5tW7xYzA1bC3dE",
"first_name": "Ada",
"last_name": "Lovelace",
"roles": [
"ubo",
"control_person"
],
"cardholder_id": null,
"missing_for_cards": [
"phone"
]
},
{
"id": "33KqVBwT4nQs8uY1zA3cE5gJ7kM",
"first_name": "Grace",
"last_name": "Hopper",
"roles": [
"applicant"
],
"cardholder_id": "31TgwQ7hM2nP4rS6uW8yA1cE3gJ",
"missing_for_cards": [
"phone"
]
}
]
}{
"type": "https://docs.dakota.xyz/api-reference/errors#not-found",
"title": "Customer Not Found",
"status": 404,
"detail": "Customer cst_2abc123 was not found in your organization.",
"instance": "https://api.platform.dakota.xyz/customers/cst_2abc123",
"request_id": "req_7f3a8b2c"
}{
"type": "https://docs.dakota.xyz/api-reference/errors#not-found",
"title": "Customer Not Found",
"status": 404,
"detail": "Customer cst_2abc123 was not found in your organization.",
"instance": "https://api.platform.dakota.xyz/customers/cst_2abc123",
"request_id": "req_7f3a8b2c"
}{
"type": "https://docs.dakota.xyz/api-reference/errors#not-found",
"title": "Customer Not Found",
"status": 404,
"detail": "Customer cst_2abc123 was not found in your organization.",
"instance": "https://api.platform.dakota.xyz/customers/cst_2abc123",
"request_id": "req_7f3a8b2c"
}{
"type": "https://docs.dakota.xyz/api-reference/errors#not-found",
"title": "Customer Not Found",
"status": 404,
"detail": "Customer cst_2abc123 was not found in your organization.",
"instance": "https://api.platform.dakota.xyz/customers/cst_2abc123",
"request_id": "req_7f3a8b2c"
}Authorizations
Path Parameters
KSUID is a 27-character globally unique ID that combines a timestamp with a random component. Used for all entity identifiers in the Dakota platform.
27^[0-9A-Za-z]{27}$"1NFHrqBHb3cTfLVkFSGmHZqdDPi"
Response
List of persons
Show child attributes
Show child attributes
Was this page helpful?

