Discover feature requirements for a customer

curl --request GET \
  --url https://api.sandbox.conduit.financial/v2/customers/{customerId}/features/requirements \
  --header 'x-api-key: <api-key>'

import requests

url = "https://api.sandbox.conduit.financial/v2/customers/{customerId}/features/requirements"

headers = {"x-api-key": "<api-key>"}

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

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.sandbox.conduit.financial/v2/customers/{customerId}/features/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.sandbox.conduit.financial/v2/customers/{customerId}/features/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 => [
    "x-api-key: <api-key>"
  ],
]);

$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.sandbox.conduit.financial/v2/customers/{customerId}/features/requirements"

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

}

HttpResponse<String> response = Unirest.get("https://api.sandbox.conduit.financial/v2/customers/{customerId}/features/requirements")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.conduit.financial/v2/customers/{customerId}/features/requirements")

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

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "schemaVersion": "3",
  "context": "onboarding",
  "country": "USA",
  "fields": [
    {
      "pointer": "/businessInfo/taxId",
      "label": "Tax Identification Number",
      "type": "string",
      "required": true,
      "helpText": "Issued by HMRC. 10-digit number; auto-assigned on CT registration; appears on HMRC correspondence. VAT Registration Number (GB + 9 digits; XI prefix for NI–EU trade) is supplementary — collect separately if VAT-registered.",
      "group": "<string>",
      "mustEqual": true,
      "constraints": {
        "pattern": "^\\d{2}\\.\\d{3}\\.\\d{3}/\\d{4}-\\d{2}$",
        "example": "12.345.678/0001-95",
        "format": "safeString",
        "minLength": 0,
        "maxLength": 0,
        "min": 123,
        "max": 123,
        "minDate": "1800-01-01",
        "maxDate": "today",
        "maxDateTime": "now",
        "minAgeYears": 0,
        "maxAgeYears": 0,
        "checksum": "aba"
      },
      "requiredOneOf": "accountIdentifier",
      "conditions": [
        {
          "pointer": "/companyClassification/legalStructure",
          "operator": "eq",
          "value": "<string>",
          "values": [
            "<string>"
          ],
          "scope": "root"
        }
      ],
      "allowedValues": [
        "LLC",
        "CORPORATION",
        "PARTNERSHIP"
      ],
      "options": [
        {
          "value": "Sociedad Anónima",
          "label": "Sociedad Anónima",
          "abbr": "S.A.",
          "description": "<string>",
          "category": "Corp"
        }
      ],
      "conditionalOverrides": [
        {
          "conditions": [
            {
              "pointer": "/companyClassification/legalStructure",
              "operator": "eq",
              "value": "<string>",
              "values": [
                "<string>"
              ],
              "scope": "root"
            }
          ],
          "constraints": {
            "pattern": "^\\d{2}\\.\\d{3}\\.\\d{3}/\\d{4}-\\d{2}$",
            "example": "12.345.678/0001-95",
            "format": "safeString",
            "minLength": 0,
            "maxLength": 0,
            "min": 123,
            "max": 123,
            "minDate": "1800-01-01",
            "maxDate": "today",
            "maxDateTime": "now",
            "minAgeYears": 0,
            "maxAgeYears": 0,
            "checksum": "aba"
          },
          "allowedValues": [
            "SSN"
          ]
        }
      ]
    }
  ],
  "documents": [
    {
      "canonicalType": "BUSINESS_REGISTRATION",
      "title": "Articles of Incorporation",
      "required": true,
      "from": "<string>",
      "alternatives": [
        {
          "title": "Certificate of Incorporation",
          "from": "<string>"
        }
      ],
      "requiredArtifacts": [
        {
          "title": "Certificate of Incorporation",
          "from": "<string>"
        }
      ],
      "optionalArtifacts": [
        {
          "title": "Certificate of Incorporation",
          "from": "<string>"
        }
      ],
      "optional": true,
      "minCount": 4503599627370496,
      "groupId": "group:any-of:AUDITED_FINANCIAL_STATEMENT+BANK_STATEMENT",
      "policyFallback": true,
      "guidance": "<string>",
      "addressTarget": "registered",
      "conditions": [
        {
          "pointer": "/companyClassification/legalStructure",
          "operator": "eq",
          "value": "<string>",
          "values": [
            "<string>"
          ],
          "scope": "root"
        }
      ]
    }
  ],
  "minDocuments": 1,
  "individualRequirements": [
    {
      "role": "BENEFICIAL_OWNER",
      "minCount": 4503599627370495,
      "fields": [
        {
          "pointer": "/businessInfo/taxId",
          "label": "Tax Identification Number",
          "type": "string",
          "required": true,
          "helpText": "Issued by HMRC. 10-digit number; auto-assigned on CT registration; appears on HMRC correspondence. VAT Registration Number (GB + 9 digits; XI prefix for NI–EU trade) is supplementary — collect separately if VAT-registered.",
          "group": "<string>",
          "mustEqual": true,
          "constraints": {
            "pattern": "^\\d{2}\\.\\d{3}\\.\\d{3}/\\d{4}-\\d{2}$",
            "example": "12.345.678/0001-95",
            "format": "safeString",
            "minLength": 0,
            "maxLength": 0,
            "min": 123,
            "max": 123,
            "minDate": "1800-01-01",
            "maxDate": "today",
            "maxDateTime": "now",
            "minAgeYears": 0,
            "maxAgeYears": 0,
            "checksum": "aba"
          },
          "requiredOneOf": "accountIdentifier",
          "conditions": [
            {
              "pointer": "/companyClassification/legalStructure",
              "operator": "eq",
              "value": "<string>",
              "values": [
                "<string>"
              ],
              "scope": "root"
            }
          ],
          "allowedValues": [
            "LLC",
            "CORPORATION",
            "PARTNERSHIP"
          ],
          "options": [
            {
              "value": "Sociedad Anónima",
              "label": "Sociedad Anónima",
              "abbr": "S.A.",
              "description": "<string>",
              "category": "Corp"
            }
          ],
          "conditionalOverrides": [
            {
              "conditions": [
                {
                  "pointer": "/companyClassification/legalStructure",
                  "operator": "eq",
                  "value": "<string>",
                  "values": [
                    "<string>"
                  ],
                  "scope": "root"
                }
              ],
              "constraints": {
                "pattern": "^\\d{2}\\.\\d{3}\\.\\d{3}/\\d{4}-\\d{2}$",
                "example": "12.345.678/0001-95",
                "format": "safeString",
                "minLength": 0,
                "maxLength": 0,
                "min": 123,
                "max": 123,
                "minDate": "1800-01-01",
                "maxDate": "today",
                "maxDateTime": "now",
                "minAgeYears": 0,
                "maxAgeYears": 0,
                "checksum": "aba"
              },
              "allowedValues": [
                "SSN"
              ]
            }
          ]
        }
      ],
      "documents": [
        {
          "canonicalType": "BUSINESS_REGISTRATION",
          "title": "Government-issued photo ID",
          "optional": true
        }
      ],
      "maxCount": 0,
      "ownershipThreshold": 25,
      "conditionalOverrides": [
        {
          "conditions": [
            {
              "pointer": "/companyClassification/legalStructure",
              "operator": "eq",
              "value": "<string>",
              "values": [
                "<string>"
              ],
              "scope": "root"
            }
          ],
          "ownershipThreshold": 10
        }
      ]
    }
  ]
}

{
  "type": "INVALID_OID_FORMAT",
  "title": "Invalid Object ID Format",
  "status": 400,
  "detail": "A path or query parameter expected a valid object identifier but received a value that does not match the expected format.",
  "resolution": "Verify that all IDs in the request URL and query parameters are correctly formatted. IDs are typically prefixed strings like 'cus_...', 'app_...', or 'doc_...'.",
  "docs": "https://v2.docs.conduit.financial/errors#invalid-oid-format",
  "instance": "/v2/...",
  "correlationId": "00469ea4-52c1-4ffa-bd05-9f28b236a5fe",
  "timestamp": "2026-01-15T09:30:00.000Z"
}

{
  "type": "API_KEY_MISSING",
  "title": "API Key Missing",
  "status": 401,
  "detail": "The request did not include an API key. All API requests must be authenticated.",
  "resolution": "Include your API key in the 'x-api-key' header with every request.",
  "docs": "https://v2.docs.conduit.financial/errors#api-key-missing",
  "instance": "/v2/...",
  "correlationId": "00469ea4-52c1-4ffa-bd05-9f28b236a5fe",
  "timestamp": "2026-01-15T09:30:00.000Z"
}

{
  "type": "ORGANIZATION_ACCESS_SUSPENDED",
  "title": "Organization Access Suspended",
  "status": 403,
  "detail": "Conduit has suspended this organization's access. Requests with the organization's API keys and from its users are refused until Conduit restores access.",
  "resolution": "Contact Conduit support.",
  "docs": "https://v2.docs.conduit.financial/errors#organization-access-suspended",
  "instance": "/v2/...",
  "correlationId": "00469ea4-52c1-4ffa-bd05-9f28b236a5fe",
  "timestamp": "2026-01-15T09:30:00.000Z"
}

{
  "type": "CUSTOMER_NOT_FOUND",
  "title": "Customer Not Found",
  "status": 404,
  "detail": "No customer exists with the specified ID, or the customer belongs to a different organization.",
  "resolution": "Verify the customer ID is correct. Use the list customers endpoint to find valid customer IDs for your organization.",
  "docs": "https://v2.docs.conduit.financial/errors#customer-not-found",
  "instance": "/v2/...",
  "correlationId": "00469ea4-52c1-4ffa-bd05-9f28b236a5fe",
  "timestamp": "2026-01-15T09:30:00.000Z"
}

{
  "type": "ONBOARDING_NOT_READY",
  "title": "Onboarding Not Ready",
  "status": 422,
  "detail": "The onboarding submission cannot be completed because one or more required fields or documents are still missing, or a submitted value is not one of the accepted options for a closed-set field (e.g. a country-specific field like `companyClassification.legalStructure`). Each blocker is reported per field in `errors[]` with a `category` and, for closed-set fields, the accepted `allowedValues`.",
  "resolution": "Use the onboarding requirements endpoint to check which fields and documents are required and which values each field accepts, then submit valid values before retrying.",
  "docs": "https://v2.docs.conduit.financial/errors#onboarding-not-ready",
  "instance": "/v2/...",
  "correlationId": "00469ea4-52c1-4ffa-bd05-9f28b236a5fe",
  "timestamp": "2026-01-15T09:30:00.000Z",
  "errors": [
    {
      "pointer": "/businessInfo/taxId",
      "detail": "Tax ID is required",
      "category": "field"
    },
    {
      "pointer": "/documentIds",
      "detail": "At least one document is required",
      "category": "document"
    }
  ]
}

{
  "type": "RATE_LIMITED",
  "title": "Rate Limited",
  "status": 429,
  "detail": "Too many requests. This error is returned by three independent checks: the per-organization bucket applied to every authenticated API request; the per-IP bucket applied to unauthenticated traffic before an API key is validated; and the per-IP bucket applied when repeated invalid API keys are submitted from the same address. Honor the Retry-After header (also exposed as retryAfterSeconds in the body) before retrying. Current limits and remaining budget are visible in X-RateLimit-Limit (the bucket size), X-RateLimit-Remaining, and X-RateLimit-Reset (seconds until the bucket refills) on every response once your API key is accepted.",
  "resolution": "Sleep until Retry-After seconds have elapsed, then retry. For sustained workloads exceeding the per-organization defaults, request a rate-limit increase through your support contact.",
  "docs": "https://v2.docs.conduit.financial/errors#rate-limited",
  "instance": "/v2/...",
  "correlationId": "00469ea4-52c1-4ffa-bd05-9f28b236a5fe",
  "timestamp": "2026-01-15T09:30:00.000Z",
  "retryAfterSeconds": 3
}

{
  "type": "INTERNAL_ERROR",
  "title": "Internal Error",
  "status": 500,
  "detail": "An unexpected error occurred while processing your request.",
  "resolution": "Retry the request after a brief delay. If the error persists, contact support and include the correlationId from the error response for investigation.",
  "docs": "https://v2.docs.conduit.financial/errors#internal-error",
  "instance": "/v2/...",
  "correlationId": "00469ea4-52c1-4ffa-bd05-9f28b236a5fe",
  "timestamp": "2026-01-15T09:30:00.000Z"
}