Scan the business website
Start with its primary public website. The scan creates a draft and returns data.brand.ref and data.job_id.
HTTP request
POST /brands/scan
{
"website_url": "https://your-business.example",
"entity_type": "PRIVATE_PROFIT"
}Supported entity types: PRIVATE_PROFIT, PUBLIC_PROFIT, NON_PROFIT, GOVERNMENT and SOLE_PROPRIETOR. The default is PRIVATE_PROFIT. Private-network URLs and some hosted platform subdomains are rejected.
Review and verify the business
- Poll
GET /brands/{ref}/scan?job_id={job_id}with that brand's returned job ID. Status is pending, running, complete or failed. - Read
GET /brands/{ref}. Show the scanned information to the customer and correct it withPATCH /brands/{ref}. - Submit with
POST /brands/{ref}/submit. Standard businesses need a legal company name, contact email/phone and address; EIN is required when EIN verification is configured. Any missing fields are returned inerror.details.missing. - Poll the brand record for
tcr_statusand anyrejection_reason. Submission starts verification; it does not mean verification succeeded. Pending-verification and verified brands are locked against edits.
HTTP request
PATCH /brands/<brand-ref> { "legal_company_name": "Example Business LLC", "display_name": "Example Business", "ein": "12-3456789", "street": "123 Main St", "city": "Austin", "state": "TX", "postal_code": "78701", "contact_email": "support@example.com", "contact_phone": "+15555550123" }