Validate Business Profile

{
  "valid": false,
  "errors": [
    { "field": "taxId", "code": "compliance_tax_id_format", "message": "taxId format is invalid for US" }
  ],
  "readyForVerification": false
}

{
  "valid": true,
  "errors": [],
  "readyForVerification": true
}

POST

business-profiles

validate

{
  "valid": false,
  "errors": [
    { "field": "taxId", "code": "compliance_tax_id_format", "message": "taxId format is invalid for US" }
  ],
  "readyForVerification": false
}

{
  "valid": true,
  "errors": [],
  "readyForVerification": true
}

Validates business-profile fields and returns field-level errors without creating or changing anything. Use it to drive an inline correction UI before you create or update a profile. Works with any key (including sandbox). Checks performed: country allowlist, tax-id format for the country, state-code coercion, and the US TIN-match legal-name length cap.

Body Parameters

Accepts the same fields as create; all are optional here — only the fields you send are validated.

Response Fields

boolean

true when no field errors were found.

array

Field-level errors. Each has field (the offending camelCase field), code, and a human message.

boolean

true when the payload is valid and carries every field KYB needs (name, companyLegalName, taxId, addressCountry, businessContactFirstName, businessContactLastName).

Examples

cURL

curl -X POST "https://api.tracklysms.com/api/v2/business-profiles/validate" \
  -H "X-Api-Key: trk_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{ "name": "Acme", "addressCountry": "US", "taxId": "not-an-ein" }'

Python

import requests

resp = requests.post(
    "https://api.tracklysms.com/api/v2/business-profiles/validate",
    headers={"X-Api-Key": "trk_your_api_key_here"},
    json={"name": "Acme", "addressCountry": "US", "taxId": "not-an-ein"},
)
print(resp.json()["errors"])

{
  "valid": false,
  "errors": [
    { "field": "taxId", "code": "compliance_tax_id_format", "message": "taxId format is invalid for US" }
  ],
  "readyForVerification": false
}

{
  "valid": true,
  "errors": [],
  "readyForVerification": true
}

Error Codes

Field errors are returned inline in errors (HTTP 200), not as HTTP error statuses. Common code values:

Code	Field	Meaning
`address_country_invalid`	`addressCountry`	Not a recognized / supported country.
`compliance_tax_id_format`	`taxId`	Tax-id format is wrong for the country.
`address_state_invalid`	`addressState`	Not a valid state/region for the country.
`compliance_legal_name_too_long`	`companyLegalName`	Exceeds the 40-char US TIN-match cap.

API Reference

V2 API Reference

Partner Accounts (v2)

Messages (v2)

Contacts (v2)

Lists (v2)

Number Requests (v2)

Business Profiles (v2)

Creatives (v2)

Audiences (v2)

Offers (v2)

Schedules (v2)

Revenue (v2)

Usage & Billing (v2)

Data Import (v2)

Links (v2)

Clicks (v2)

Webhooks (v2)

Phone Validation (v1)

API Reference (v1 - Deprecated)

Validate Business Profile

Body Parameters

Response Fields

Examples

Error Codes

Next Steps

Create the profile

Lifecycle overview

​Body Parameters

​Response Fields

​Examples

​Error Codes

​Next Steps

Create the profile

Lifecycle overview

Body Parameters

Response Fields

Examples

Error Codes

Next Steps