Skip to main content
GET
/
onboarding
/
requirements
Discover onboarding requirements for a country
curl --request GET \
  --url https://api.conduit.financial/v2/onboarding/requirements \
  --header 'x-api-key: <api-key>'
{
  "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",
        "minAgeYears": 0
      },
      "conditions": [
        {
          "pointer": "/companyClassification/legalStructure",
          "operator": "eq",
          "value": "<string>",
          "values": [
            "<string>"
          ]
        }
      ],
      "allowedValues": [
        "LLC",
        "CORPORATION",
        "PARTNERSHIP"
      ],
      "options": [
        {
          "value": "Sociedad Anónima",
          "label": "Sociedad Anónima",
          "abbr": "S.A.",
          "description": "<string>"
        }
      ]
    }
  ],
  "documents": [
    {
      "title": "Articles of Incorporation",
      "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>"
    }
  ],
  "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",
            "minAgeYears": 0
          },
          "conditions": [
            {
              "pointer": "/companyClassification/legalStructure",
              "operator": "eq",
              "value": "<string>",
              "values": [
                "<string>"
              ]
            }
          ],
          "allowedValues": [
            "LLC",
            "CORPORATION",
            "PARTNERSHIP"
          ],
          "options": [
            {
              "value": "Sociedad Anónima",
              "label": "Sociedad Anónima",
              "abbr": "S.A.",
              "description": "<string>"
            }
          ]
        }
      ],
      "documents": [
        {
          "title": "Government-issued photo ID",
          "optional": true
        }
      ],
      "maxCount": 0,
      "ownershipThreshold": 25
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
country
string
required

ISO 3166-1 alpha-2 or alpha-3 country code for the customer's primary jurisdiction.

Response

​
schemaVersion
enum<string>
required

Discovery response schema version. Bumps on any breaking discovery-response change (field renamed, removed, type changed, conditional semantics changed). Distinct from the webhook envelope's apiVersion which tracks the API major. Clients pin the literal and fail loudly on mismatch; servers do not negotiate.

Available options:
3
​
context
enum<string>
required

The discovery context that produced this requirements set.

Available options:
onboarding,
feature,
order
Example:

"onboarding"

​
country
string
required

ISO 3166-1 alpha-3 country code the requirements were resolved for. Always three uppercase letters.

Pattern: ^[A-Z]{3}$
Example:

"USA"

​
fields
object[]
required

Scalar fields the integrator must collect, with format hints and allowedValues for enum fields.

​
documents
object[]
required

Customer-level documents to collect. Each row is keyed by canonicalType; upload every requiredArtifacts[] entry and any one alternatives[] entry when present, otherwise upload the row itself via POST /v2/documents.

​
individualRequirements
object[]
required

Per-role count and person-level field + document requirements for ownership.persons[].