curl --request GET \
--url https://api.platform.dakota.xyz/customers/{customer_id}/limits \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.platform.dakota.xyz/customers/{customer_id}/limits', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.platform.dakota.xyz/customers/{customer_id}/limits"
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.dakota.xyz/customers/{customer_id}/limits"
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))
}{
"limits": [
{
"type": "proof_of_address_volume",
"currency": "USD",
"limit": "3000.00",
"used": "1250.00",
"remaining": "1750.00"
}
]
}Get a customer's limits
Returns the limits currently in force for the customer, with how much of each is used and how much remains.
The list is an open set keyed by type: new types can appear without a
new API version, so clients must ignore types they do not recognise. A
limit that is not in force for the customer is omitted rather than
returned with a zero or unbounded value. For example, businesses and
individuals with an approved proof of address on file have no
proof_of_address_volume entry, so the list can be empty.
Types:
proof_of_address_volume: caps the inbound volume an individual without an approved proof of address may receive over a rolling 7 days. A deposit counts once it has landed, gross before fees, when it is in USD, a USD stablecoin or a Dakota-issued token. A deposit that is held or paused still counts as used. A deposit that is returned, reversed or refunded stops counting. Deposits in other assets neither count toward the limit nor are checked against it.remainingis the most this limit allows before the next deposit is paused for proof of address, at which point the customer must provide proof of address. Other controls, such as compliance holds, can pause a deposit independently of this limit.remainingis0while the customer cannot receive deposits: when they are frozen, or when their account status refuses deposits.
Amounts are rounded so they never overstate what is allowed: used
rounds up and remaining rounds down to the cent.
The figures are advisory, not a reservation. Another deposit can land
between this read and a later one, and the rolling window moves as old
deposits age out, so remaining can change at any time.
curl --request GET \
--url https://api.platform.dakota.xyz/customers/{customer_id}/limits \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.platform.dakota.xyz/customers/{customer_id}/limits', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.platform.dakota.xyz/customers/{customer_id}/limits"
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.dakota.xyz/customers/{customer_id}/limits"
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))
}{
"limits": [
{
"type": "proof_of_address_volume",
"currency": "USD",
"limit": "3000.00",
"used": "1250.00",
"remaining": "1750.00"
}
]
}Authorizations
Path Parameters
Unique identifier (ksuid) of the customer record 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
Limits retrieved successfully
The limits currently in force for a customer. An open set keyed by type; clients must ignore types they do not recognise.
Show child attributes
Show child attributes
Was this page helpful?

