Get brand identity
Read your brand and your custom email server settings. The brand is what your client organizations see: your brand name on their emails, and spoken in their verification calls. Your own emails do not change.
Reseller accounts only. Request access.
curl -X GET 'https://backend.omnidim.io/api/v1/reseller/identity' \ -H 'Authorization: Bearer YOUR_API_KEY'
{ "success": true, "can_use_brand_identity": true, "can_use_custom_smtp": true, "has_identity": true, "identity": { "platform_name": "Acme Voice", "company_name": "Acme Ltd", "logo_url": "https://acme.example/logo.png", "primary_color": "#1976d2", "real_email": "hello@acme.example" }, "smtp": { "configured": true, "active": true, "host": "smtp.acme.example", "port": 587, "username": "mailer@acme.example", "encryption": "starttls", "from_email": "hello@acme.example" } }
BearerAuthAuthorizationBearer <token>Bearer token authentication. Obtain your API key from the OmniDimension dashboard.
Response body
application/jsonThe current brand and email server state.
application/jsonYour brand and custom email server state. The SMTP password is never returned.
success?booleancan_use_brand_identity?booleanWhether this account may hold a brand. When false, every write returns 403.
can_use_custom_smtp?booleanWhether this account may send clients' emails through its own email server.
has_identity?booleanfalse until the first save.
identity?The saved brand. Empty until the first save. Other branding keys can appear.
smtp?Submit a KYC verification step
Run one step of a client's identity verification. One endpoint handles every step: the step path parameter names the step, and the body carries user_id, region, carrier, and whatever that step needs. The example below is the register step on carrier-1.
Save brand identity
Set the brand your client organizations see: your brand name and company name on their emails, and your brand name spoken in their verification calls. The first save creates the brand. Later saves change only the fields you send. Your own emails do not change.
