Get customer requirements

curl --request GET \
  --url https://api.cdp.coinbase.com/platform/v2/customers/requirements \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.cdp.coinbase.com/platform/v2/customers/requirements"

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

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.cdp.coinbase.com/platform/v2/customers/requirements', 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.cdp.coinbase.com/platform/v2/customers/requirements",
  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.cdp.coinbase.com/platform/v2/customers/requirements"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.cdp.coinbase.com/platform/v2/customers/requirements")

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

{
  "tos": {
    "status": "due",
    "impact": [
      "custodyCrypto",
      "transferCrypto"
    ],
    "tosVersions": [
      {
        "versionId": "us_individual_2026-05-29",
        "languages": [
          "en"
        ],
        "url": "https://docs.cdp.coinbase.com/legal/terms/us_individual"
      }
    ]
  }
}

Customers

Get customer requirements

Preview the requirements a hypothetical customer of the given customerType and jurisdiction would need to satisfy to enable the requested capabilities, without creating a customer record. Partner onboarding UIs can use this to render the collection flow before any customer state exists.

Today this endpoint only previews the Terms of Service requirement: the response’s RequirementsMap will only ever contain a tos key. Other requirement families (PII / CDD inputs) are not yet available through this endpoint; use POST /v2/customers or PUT /v2/customers/{customerId} to discover those via Customer.requirements.

Only customerType: individual customers resident in or citizens of the US are currently supported; every other combination returns 400 invalid_request.

GET

customers

requirements

Get customer requirements

curl --request GET \
  --url https://api.cdp.coinbase.com/platform/v2/customers/requirements \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.cdp.coinbase.com/platform/v2/customers/requirements"

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

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.cdp.coinbase.com/platform/v2/customers/requirements', 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.cdp.coinbase.com/platform/v2/customers/requirements",
  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.cdp.coinbase.com/platform/v2/customers/requirements"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.cdp.coinbase.com/platform/v2/customers/requirements")

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

{
  "tos": {
    "status": "due",
    "impact": [
      "custodyCrypto",
      "transferCrypto"
    ],
    "tosVersions": [
      {
        "versionId": "us_individual_2026-05-29",
        "languages": [
          "en"
        ],
        "url": "https://docs.cdp.coinbase.com/legal/terms/us_individual"
      }
    ]
  }
}

Authorizations

Authorization

string

header

required

A JWT signed using your CDP API Key Secret, encoded in base64. Refer to the Generate Bearer Token section of our Authentication docs for information on how to generate your Bearer Token.

Query Parameters

customerType

enum<string>

required

The type of the hypothetical customer. The type of the customer. Required on create; accepted but ignored on update.

Available options:

individual

Example:

"individual"

capabilities

enum<string>[]

required

The capabilities the hypothetical customer would request. Repeat the parameter to specify multiple capabilities, for example capabilities=custodyCrypto&capabilities=transferCrypto.

Minimum array length: 1

The name of a capability. Capabilities represent granular functional permissions that determine what actions a customer can perform. Each capability must be explicitly requested before use.

Available options:

custodyCrypto,

custodyFiat,

custodyStablecoin,

tradeCrypto,

tradeStablecoin,

transferCrypto,

transferFiat,

transferStablecoin

countryCode

string

The hypothetical customer's country of residence. At least one of countryCode or citizenship is required. When both are present, countryCode takes precedence.

An ISO 3166-1 alpha-2 country code.

Required string length: 2

Pattern: ^[A-Z]{2}$

Example:

"US"

citizenship

string

The hypothetical customer's citizenship. At least one of countryCode or citizenship is required.

An ISO 3166-1 alpha-2 country code.

Required string length: 2

Pattern: ^[A-Z]{2}$

Example:

"US"

Response

Successfully previewed requirements.

Map of requirements to be submitted. Each key is the field name (e.g., "ssnLast4"), with values to describe its state. Requirements are only shown for requested capabilities. When a requirement is verified, it disappears from this map.

For the tos key, each entry in tosVersions[] has its own optional deadline. The requirement-level deadline is an aggregate of those rows: the earliest set deadline among unaccepted versions, not a separate clock. A version with no deadline requires immediate acceptance but keeps the aggregate status due. A future deadline is also due and represents non-blocking grace. The aggregate status is past_due only when at least one unaccepted version has a deadline set in the past. Do not infer status or blocking behavior from omission of the aggregate deadline.

{key}

object

A single requirement that a customer must submit to enable capabilities. Requirements are only shown for requested capabilities.

Show child attributes

Example:

{
  "status": "due",
  "impact": ["custodyCrypto", "transferCrypto"]
}