business-profiles-v2

Dry-run: validate business-profile fields and report field-level errors without

saving. readyForVerification is true when the profile is valid and carries every field KYB submission needs.

post/v2/business-profiles/validate

Request

  • Base URL: https://api.tracklysms.com/api
  • URL: https://api.tracklysms.com/api/v2/business-profiles/validate
  • Auth: API key in header X-Api-Key

Request body

addressCitystring

City

addressCountrystring

ISO 3166-1 country (alpha-2, alpha-3, or name)

addressPostalCodestring

Postal code

addressStatestring

State/region (coerced to a 2-letter code where applicable)

addressStreetstring

Street

brandNamestring

Brand name

businessContactFirstNamestring

Authorized contact first name

businessContactLastNamestring

Authorized contact last name

businessRelationship'account_business' | 'client_business'
companyLegalNamestring

Registered legal entity name (as on IRS/registry records)

confirmedboolean

Explicit confirmation when establishing an existing business relationship.

contactEmailstring

Business contact email

expectedIdentityRevisioninteger

Required for canonical-name confirmation and existing-business confirmation.

identifierTypestring

Type of value in taxId (e.g. ein, cbn, neq, provincial_number, registration_number). Auto-defaulted for countries with exactly one legal value; CA requires an explicit choice.

industrystring

Industry / vertical

namestring required

Profile label (required on create). Max 100 chars.

taxIdstring

EIN/TIN — validated against the address country

websiteUrlstring

Business website URL

Example request

{
  "businessRelationship": "account_business"
}

Response

Success

Changes

No recorded changes to this operation across all 1 revision of this API.