{"components":{"schemas":{"Brand":{"properties":{"created_at":{"format":"date-time","nullable":true,"type":"string"},"display_name":{"type":"string"},"entity_type":{"enum":["PRIVATE_PROFIT","PUBLIC_PROFIT","NON_PROFIT","GOVERNMENT","SOLE_PROPRIETOR"],"type":"string"},"otp_status":{"nullable":true,"type":"string"},"ref":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"},"status":{"nullable":true,"type":"string"},"tcr_brand_id":{"nullable":true,"type":"string"}},"required":["ref","entity_type","display_name"],"type":"object"},"BrandCreate":{"example":{"city":"Austin","country":"US","display_name":"Example Consulting","email":"alex@example.com","first_name":"Alex","last_name":"Example","mobile_phone":"+15555550123","phone":"+15555550123","postal_code":"78701","state":"TX","street":"123 Example St"},"properties":{"city":{"type":"string"},"country":{"default":"US","type":"string"},"display_name":{"type":"string"},"email":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"mobile_phone":{"description":"Mobile number receiving the request to reply YES.","example":"+15555550123","pattern":"^\\+[1-9]\\d{1,14}$","type":"string"},"phone":{"example":"+15555550123","pattern":"^\\+[1-9]\\d{1,14}$","type":"string"},"postal_code":{"type":"string"},"reference_id":{"description":"Your external reference; this is not an idempotency key.","type":"string"},"state":{"type":"string"},"street":{"type":"string"},"vertical":{"type":"string"},"website":{"type":"string"}},"required":["display_name","email","phone","first_name","last_name","mobile_phone","street","city","state","postal_code"],"type":"object"},"BrandFull":{"properties":{"brand_description":{"nullable":true,"type":"string"},"city":{"nullable":true,"type":"string"},"contact_email":{"nullable":true,"type":"string"},"contact_phone":{"nullable":true,"type":"string"},"country":{"nullable":true,"type":"string"},"created_at":{"format":"date-time","nullable":true,"type":"string"},"display_name":{"type":"string"},"ein":{"nullable":true,"type":"string"},"ein_verification_status":{"nullable":true,"type":"string"},"entity_type":{"enum":["PRIVATE_PROFIT","PUBLIC_PROFIT","NON_PROFIT","GOVERNMENT","SOLE_PROPRIETOR"],"type":"string"},"first_name":{"nullable":true,"type":"string"},"integration_provider":{"nullable":true,"type":"string"},"last_name":{"nullable":true,"type":"string"},"legal_company_name":{"nullable":true,"type":"string"},"mobile_phone":{"nullable":true,"type":"string"},"optin_proof_url":{"nullable":true,"type":"string"},"otp_status":{"nullable":true,"type":"string"},"postal_code":{"nullable":true,"type":"string"},"privacy_policy_url":{"nullable":true,"type":"string"},"ref":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"},"rejection_reason":{"nullable":true,"type":"string"},"scan_completed_at":{"format":"date-time","nullable":true,"type":"string"},"scan_version":{"nullable":true,"type":"integer"},"state":{"nullable":true,"type":"string"},"status":{"nullable":true,"type":"string"},"street":{"nullable":true,"type":"string"},"submitted_at":{"format":"date-time","nullable":true,"type":"string"},"tcr_brand_id":{"nullable":true,"type":"string"},"tcr_status":{"nullable":true,"type":"string"},"terms_conditions_url":{"nullable":true,"type":"string"},"tnid_brand_id":{"nullable":true,"type":"string"},"tnid_status":{"nullable":true,"type":"string"},"verified_at":{"format":"date-time","nullable":true,"type":"string"},"vertical":{"nullable":true,"type":"string"},"website":{"nullable":true,"type":"string"}},"required":["ref","entity_type","display_name"],"type":"object"},"BrandPatch":{"properties":{"alt_sms_contact_email":{"nullable":true,"type":"string"},"authorized_rep_email":{"nullable":true,"type":"string"},"authorized_rep_name":{"nullable":true,"type":"string"},"brand_description":{"nullable":true,"type":"string"},"business_contact_email":{"nullable":true,"type":"string"},"city":{"nullable":true,"type":"string"},"contact_email":{"nullable":true,"type":"string"},"contact_phone":{"nullable":true,"type":"string"},"country":{"nullable":true,"type":"string"},"display_name":{"nullable":true,"type":"string"},"ein":{"description":"Nine digits, optionally XX-XXXXXXX; null clears it.","nullable":true,"type":"string"},"email":{"nullable":true,"type":"string"},"entity_type":{"enum":["PRIVATE_PROFIT","PUBLIC_PROFIT","NON_PROFIT","GOVERNMENT","SOLE_PROPRIETOR"],"type":"string"},"first_name":{"nullable":true,"type":"string"},"last_name":{"nullable":true,"type":"string"},"legal_company_name":{"nullable":true,"type":"string"},"mobile_phone":{"nullable":true,"type":"string"},"optin_proof_url":{"nullable":true,"type":"string"},"phone":{"nullable":true,"type":"string"},"postal_code":{"nullable":true,"type":"string"},"privacy_policy_url":{"nullable":true,"type":"string"},"state":{"nullable":true,"type":"string"},"stock_exchange":{"nullable":true,"type":"string"},"stock_symbol":{"nullable":true,"type":"string"},"street":{"nullable":true,"type":"string"},"terms_conditions_url":{"nullable":true,"type":"string"},"terms_url":{"nullable":true,"type":"string"},"vertical":{"nullable":true,"type":"string"},"website":{"nullable":true,"type":"string"}},"type":"object"},"Campaign":{"properties":{"compliance_status":{"nullable":true,"type":"string"},"created_at":{"format":"date-time","nullable":true,"type":"string"},"expected_volume":{"nullable":true,"type":"string"},"number_pool":{"description":"TCR campaign attribute only; does not allocate or assign a downstream number pool.","type":"boolean"},"ref":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"},"status":{"nullable":true,"type":"string"},"tnid_campaign_id":{"nullable":true,"type":"string"},"use_case":{"nullable":true,"type":"string"}},"required":["ref","status"],"type":"object"},"CampaignCreate":{"example":{"campaign_description":"Appointment reminders for customers who explicitly request text updates.","expected_volume":"0-1000","message_flow":"Customers choose text reminders using an unchecked consent box on our appointment form.","sample1":"Example Consulting: Your appointment is tomorrow at 3pm. Reply STOP to opt out, HELP for help.","subscriber_optin_method":"web_form","use_case":"CUSTOMER_CARE"},"properties":{"affiliate_marketing":{"default":false,"type":"boolean"},"age_gated":{"default":false,"type":"boolean"},"campaign_description":{"minLength":40,"type":"string"},"direct_lending":{"default":false,"type":"boolean"},"embedded_link":{"default":false,"type":"boolean"},"embedded_phone":{"default":false,"type":"boolean"},"expected_volume":{"enum":["0-1000","1000-10000","10000-50000","50000-100000","100000+"],"type":"string"},"help_keywords":{"type":"string"},"help_message":{"type":"string"},"message_flow":{"type":"string"},"number_pool":{"default":false,"description":"TCR numberPool campaign attribute. Does not request, allocate, assign or confirm deployment of a provider number pool.","type":"boolean"},"optin_keywords":{"type":"string"},"optin_message":{"type":"string"},"optout_keywords":{"type":"string"},"optout_message":{"type":"string"},"privacy_policy_link":{"type":"string"},"reseller_id":{"type":"string"},"sample1":{"type":"string"},"sample2":{"type":"string"},"sample3":{"type":"string"},"sample4":{"type":"string"},"sample5":{"type":"string"},"sub_use_cases":{"description":"For mixed: provide 2\u20135 valid entries.","items":{"enum":["account_notification","marketing","customer_care","2fa","delivery_notification","fraud_alert","security_alert","public_service_announcement","polling_voting","higher_education","sweepstakes","emergency_alerts"],"type":"string"},"type":"array"},"subscriber_optin_method":{"enum":["web_form","keyword","qr_code","ivr","paper_form","verbal","point_of_sale","mobile_app","email","sweepstakes","existing_customer","third_party"],"type":"string"},"tag":{"type":"string"},"terms_conditions_link":{"type":"string"},"use_case":{"enum":["2FA","ACCOUNT_NOTIFICATION","CUSTOMER_CARE","DELIVERY_NOTIFICATION","FRAUD_ALERT","HIGHER_EDUCATION","low_vol_mixed","MARKETING","mixed","POLLING_VOTING","PUBLIC_SERVICE_ANNOUNCEMENT","SECURITY_ALERT","CHARITY","EMERGENCY","POLITICAL","AGENTS_FRANCHISES","CONVERSATIONAL","SOCIAL","SOLE_PROPRIETOR","SWEEPSTAKE","K12_EDUCATION"],"type":"string"}},"required":["campaign_description","use_case","expected_volume","sample1"],"type":"object"},"CampaignFull":{"properties":{"activated_at":{"format":"date-time","nullable":true,"type":"string"},"brand_ref":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"nullable":true,"pattern":"^[a-f0-9]{32}$","type":"string"},"campaign_description":{"nullable":true,"type":"string"},"campaign_name":{"nullable":true,"type":"string"},"compliance_passed":{"nullable":true,"type":"boolean"},"compliance_results_user":{"description":"Plain-language reviewer output from the generation workflow.","nullable":true,"type":"string"},"compliance_reviewed_at":{"format":"date-time","nullable":true,"type":"string"},"compliance_status":{"nullable":true,"type":"string"},"compliance_summary":{"description":"Saved AI compliance summary shown on the full campaign page, including legacy campaigns.","nullable":true,"type":"string"},"created_at":{"format":"date-time","nullable":true,"type":"string"},"dca_submission_route":{"nullable":true,"type":"string"},"dca_submitted_at":{"format":"date-time","nullable":true,"type":"string"},"expected_volume":{"nullable":true,"type":"string"},"generation_completed_at":{"format":"date-time","nullable":true,"type":"string"},"generation_in_progress":{"type":"boolean"},"help_message":{"nullable":true,"type":"string"},"in_review_queue":{"type":"boolean"},"message_flow":{"nullable":true,"type":"string"},"number_pool":{"description":"TCR campaign attribute only; does not allocate or assign a downstream number pool.","type":"boolean"},"optin_message":{"nullable":true,"type":"string"},"optin_proof_url":{"nullable":true,"type":"string"},"optout_message":{"nullable":true,"type":"string"},"recommendations":{"items":{"type":"string"},"type":"array"},"ref":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"},"review_decision":{"nullable":true,"type":"string"},"review_notes_summary":{"nullable":true,"type":"string"},"review_status":{"nullable":true,"type":"string"},"reviewed_at":{"format":"date-time","nullable":true,"type":"string"},"sample1":{"nullable":true,"type":"string"},"sample2":{"nullable":true,"type":"string"},"sample3":{"nullable":true,"type":"string"},"sample4":{"nullable":true,"type":"string"},"sample5":{"nullable":true,"type":"string"},"status":{"nullable":true,"type":"string"},"sub_use_cases":{"items":{"type":"string"},"type":"array"},"submitted_at":{"format":"date-time","nullable":true,"type":"string"},"subscriber_optin_method":{"nullable":true,"type":"string"},"tcr_brand_id":{"nullable":true,"type":"string"},"tcr_campaign_id":{"nullable":true,"type":"string"},"tnid_campaign_id":{"nullable":true,"type":"string"},"use_case":{"nullable":true,"type":"string"},"usecase_plain_english":{"nullable":true,"type":"string"}},"required":["ref","status"],"type":"object"},"CampaignGenerate":{"example":{"interview_responses":{"purpose":"Appointment reminders requested by customers"},"optin_method":"web_form","optin_proof_url":"https://example.com/signup","volume":"0-1000"},"properties":{"interview_responses":{"additionalProperties":{"type":"string"},"properties":{},"type":"object"},"optin_method":{"enum":["web_form","keyword","qr_code","ivr","paper_form","verbal","point_of_sale","mobile_app","email","sweepstakes","existing_customer","third_party"],"type":"string"},"optin_proof_url":{"maxLength":2048,"type":"string"},"volume":{"enum":["0-1000","1001-10000","10001-100000","100001+"],"type":"string"}},"required":["volume","optin_method"],"type":"object"},"CampaignPatch":{"properties":{"campaign_description":{"maxLength":4096,"nullable":true,"type":"string"},"campaign_name":{"maxLength":4096,"nullable":true,"type":"string"},"help_message":{"maxLength":4096,"nullable":true,"type":"string"},"keywords":{"maxLength":4096,"nullable":true,"type":"string"},"message_flow":{"maxLength":4096,"nullable":true,"type":"string"},"optin_message":{"maxLength":4096,"nullable":true,"type":"string"},"optin_proof_url":{"maxLength":4096,"nullable":true,"type":"string"},"optout_message":{"maxLength":4096,"nullable":true,"type":"string"},"sample1":{"maxLength":4096,"nullable":true,"type":"string"},"sample2":{"maxLength":4096,"nullable":true,"type":"string"},"sample3":{"maxLength":4096,"nullable":true,"type":"string"},"sample4":{"maxLength":4096,"nullable":true,"type":"string"},"sample5":{"maxLength":4096,"nullable":true,"type":"string"},"usecase_plain_english":{"maxLength":4096,"nullable":true,"type":"string"}},"type":"object"},"CampaignSummary":{"properties":{"brand_ref":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"nullable":true,"pattern":"^[a-f0-9]{32}$","type":"string"},"campaign_name":{"nullable":true,"type":"string"},"created_at":{"format":"date-time","nullable":true,"type":"string"},"number_pool":{"type":"boolean"},"ref":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"},"status":{"nullable":true,"type":"string"},"tcr_brand_id":{"nullable":true,"type":"string"},"tcr_campaign_id":{"nullable":true,"type":"string"},"tnid_campaign_id":{"nullable":true,"type":"string"},"use_case":{"nullable":true,"type":"string"}},"required":["ref","brand_ref","campaign_name","status","use_case","tcr_campaign_id","tnid_campaign_id","created_at"],"type":"object"},"Error":{"properties":{"error":{"properties":{"code":{"type":"string"},"details":{"additionalProperties":true,"properties":{},"type":"object"},"message":{"type":"string"}},"required":["code","message"],"type":"object"}},"required":["error"],"type":"object"},"IntakeAction":{"additionalProperties":false,"properties":{"expected_revision":{"minimum":1,"type":"integer"},"source_hash":{"maxLength":64,"pattern":"^[a-f0-9]{64}$","type":"string"}},"required":["expected_revision","source_hash"],"type":"object"},"IntakeCreate":{"additionalProperties":false,"properties":{"answers":{"additionalProperties":false,"properties":{"agent_name":{"maxLength":2048,"type":"string"},"brand_authorized":{"enum":["","no","yes"],"maxLength":2048,"type":"string"},"brand_color":{"maxLength":2048,"type":"string"},"brand_contact_email":{"maxLength":2048,"type":"string"},"brand_contact_name":{"maxLength":2048,"type":"string"},"business_description":{"maxLength":8000,"type":"string"},"business_family":{"enum":["","other","mary_kay"],"maxLength":2048,"type":"string"},"call_to_action":{"maxLength":8000,"type":"string"},"city":{"maxLength":2048,"type":"string"},"consent_description":{"maxLength":8000,"type":"string"},"country":{"enum":["","US","CA"],"maxLength":2048,"type":"string"},"customer_reference":{"maxLength":2048,"type":"string"},"display_name":{"maxLength":2048,"type":"string"},"ein":{"maxLength":2048,"type":"string"},"email":{"maxLength":2048,"type":"string"},"entity_type":{"enum":["","PRIVATE_PROFIT","PUBLIC_PROFIT","NON_PROFIT","GOVERNMENT","SOLE_PROPRIETOR"],"maxLength":2048,"type":"string"},"experience_description":{"maxLength":8000,"type":"string"},"first_name":{"maxLength":2048,"type":"string"},"help_description":{"maxLength":8000,"type":"string"},"hero_url":{"maxLength":2048,"type":"string"},"last_name":{"maxLength":2048,"type":"string"},"launch_carriers":{"items":{"maxLength":2000,"type":"string"},"maxItems":100,"type":"array"},"launch_country":{"enum":["","US","CA"],"maxLength":2048,"type":"string"},"lease_evidence_url":{"maxLength":2048,"type":"string"},"lease_status":{"enum":["","unknown","pending","active","expired"],"maxLength":2048,"type":"string"},"leaseholder_name":{"maxLength":2048,"type":"string"},"legal_name":{"maxLength":2048,"type":"string"},"logo_url":{"maxLength":2048,"type":"string"},"mary_kay_role":{"enum":["","consultant","director"],"maxLength":2048,"type":"string"},"messaging_provider":{"maxLength":2048,"type":"string"},"mobile_phone":{"maxLength":2048,"type":"string"},"monthly_volume":{"maxLength":2048,"type":"string"},"needs_tnid":{"enum":["","no","yes"],"maxLength":2048,"type":"string"},"notes":{"maxLength":8000,"type":"string"},"numbers":{"items":{"maxLength":2000,"type":"string"},"maxItems":100,"type":"array"},"opt_out_description":{"maxLength":8000,"type":"string"},"optin_method":{"enum":["","web_form","keyword","point_of_sale","verbal","paper_form","qr_code","existing_customer"],"maxLength":2048,"type":"string"},"optin_proof_url":{"maxLength":2048,"type":"string"},"phone":{"maxLength":2048,"type":"string"},"postal_code":{"maxLength":2048,"type":"string"},"privacy_url":{"maxLength":2048,"type":"string"},"program_name":{"maxLength":2048,"type":"string"},"promotional":{"enum":["","no","yes"],"maxLength":2048,"type":"string"},"registration_number":{"maxLength":2048,"type":"string"},"registration_path":{"enum":["","existing","new","migration"],"maxLength":2048,"type":"string"},"registration_type":{"maxLength":2048,"type":"string"},"sample_message":{"maxLength":8000,"type":"string"},"samples":{"items":{"maxLength":2000,"type":"string"},"maxItems":100,"type":"array"},"short_code":{"maxLength":2048,"type":"string"},"source_application_hash":{"maxLength":2048,"type":"string"},"source_application_ref":{"maxLength":2048,"type":"string"},"source_existing_brand_ref":{"maxLength":2048,"type":"string"},"source_help_message":{"maxLength":8000,"type":"string"},"source_industry_vertical":{"maxLength":2048,"type":"string"},"source_message_flow":{"maxLength":8000,"type":"string"},"source_optin_message":{"maxLength":8000,"type":"string"},"source_optout_message":{"maxLength":8000,"type":"string"},"source_requested_use_case":{"maxLength":8000,"type":"string"},"source_samples":{"items":{"maxLength":2000,"type":"string"},"maxItems":100,"type":"array"},"source_sub_use_cases":{"items":{"maxLength":2000,"type":"string"},"maxItems":100,"type":"array"},"source_use_case":{"maxLength":2048,"type":"string"},"state":{"maxLength":2048,"type":"string"},"street":{"maxLength":2048,"type":"string"},"subscription_topics":{"items":{"maxLength":2000,"type":"string"},"maxItems":100,"type":"array"},"support_email":{"maxLength":2048,"type":"string"},"support_phone":{"maxLength":2048,"type":"string"},"terms_url":{"maxLength":2048,"type":"string"},"tnid_profile_url":{"maxLength":2048,"type":"string"},"volume":{"enum":["","0-1000","1001-10000","10001-100000","100001+"],"maxLength":2048,"type":"string"},"website":{"maxLength":2048,"type":"string"},"what_you_send":{"maxLength":8000,"type":"string"},"who_gets_it":{"maxLength":8000,"type":"string"}},"type":"object"},"channel":{"enum":["10dlc","10dlc_sp","toll_free","short_code","rcs_agent"],"maxLength":2000,"type":"string"}},"required":["channel"],"type":"object"},"IntakePatch":{"additionalProperties":false,"properties":{"answers":{"additionalProperties":false,"properties":{"agent_name":{"maxLength":2048,"type":"string"},"brand_authorized":{"enum":["","no","yes"],"maxLength":2048,"type":"string"},"brand_color":{"maxLength":2048,"type":"string"},"brand_contact_email":{"maxLength":2048,"type":"string"},"brand_contact_name":{"maxLength":2048,"type":"string"},"business_description":{"maxLength":8000,"type":"string"},"business_family":{"enum":["","other","mary_kay"],"maxLength":2048,"type":"string"},"call_to_action":{"maxLength":8000,"type":"string"},"city":{"maxLength":2048,"type":"string"},"consent_description":{"maxLength":8000,"type":"string"},"country":{"enum":["","US","CA"],"maxLength":2048,"type":"string"},"customer_reference":{"maxLength":2048,"type":"string"},"display_name":{"maxLength":2048,"type":"string"},"ein":{"maxLength":2048,"type":"string"},"email":{"maxLength":2048,"type":"string"},"entity_type":{"enum":["","PRIVATE_PROFIT","PUBLIC_PROFIT","NON_PROFIT","GOVERNMENT","SOLE_PROPRIETOR"],"maxLength":2048,"type":"string"},"experience_description":{"maxLength":8000,"type":"string"},"first_name":{"maxLength":2048,"type":"string"},"help_description":{"maxLength":8000,"type":"string"},"hero_url":{"maxLength":2048,"type":"string"},"last_name":{"maxLength":2048,"type":"string"},"launch_carriers":{"items":{"maxLength":2000,"type":"string"},"maxItems":100,"type":"array"},"launch_country":{"enum":["","US","CA"],"maxLength":2048,"type":"string"},"lease_evidence_url":{"maxLength":2048,"type":"string"},"lease_status":{"enum":["","unknown","pending","active","expired"],"maxLength":2048,"type":"string"},"leaseholder_name":{"maxLength":2048,"type":"string"},"legal_name":{"maxLength":2048,"type":"string"},"logo_url":{"maxLength":2048,"type":"string"},"mary_kay_role":{"enum":["","consultant","director"],"maxLength":2048,"type":"string"},"messaging_provider":{"maxLength":2048,"type":"string"},"mobile_phone":{"maxLength":2048,"type":"string"},"monthly_volume":{"maxLength":2048,"type":"string"},"needs_tnid":{"enum":["","no","yes"],"maxLength":2048,"type":"string"},"notes":{"maxLength":8000,"type":"string"},"numbers":{"items":{"maxLength":2000,"type":"string"},"maxItems":100,"type":"array"},"opt_out_description":{"maxLength":8000,"type":"string"},"optin_method":{"enum":["","web_form","keyword","point_of_sale","verbal","paper_form","qr_code","existing_customer"],"maxLength":2048,"type":"string"},"optin_proof_url":{"maxLength":2048,"type":"string"},"phone":{"maxLength":2048,"type":"string"},"postal_code":{"maxLength":2048,"type":"string"},"privacy_url":{"maxLength":2048,"type":"string"},"program_name":{"maxLength":2048,"type":"string"},"promotional":{"enum":["","no","yes"],"maxLength":2048,"type":"string"},"registration_number":{"maxLength":2048,"type":"string"},"registration_path":{"enum":["","existing","new","migration"],"maxLength":2048,"type":"string"},"registration_type":{"maxLength":2048,"type":"string"},"sample_message":{"maxLength":8000,"type":"string"},"samples":{"items":{"maxLength":2000,"type":"string"},"maxItems":100,"type":"array"},"short_code":{"maxLength":2048,"type":"string"},"source_application_hash":{"maxLength":2048,"type":"string"},"source_application_ref":{"maxLength":2048,"type":"string"},"source_existing_brand_ref":{"maxLength":2048,"type":"string"},"source_help_message":{"maxLength":8000,"type":"string"},"source_industry_vertical":{"maxLength":2048,"type":"string"},"source_message_flow":{"maxLength":8000,"type":"string"},"source_optin_message":{"maxLength":8000,"type":"string"},"source_optout_message":{"maxLength":8000,"type":"string"},"source_requested_use_case":{"maxLength":8000,"type":"string"},"source_samples":{"items":{"maxLength":2000,"type":"string"},"maxItems":100,"type":"array"},"source_sub_use_cases":{"items":{"maxLength":2000,"type":"string"},"maxItems":100,"type":"array"},"source_use_case":{"maxLength":2048,"type":"string"},"state":{"maxLength":2048,"type":"string"},"street":{"maxLength":2048,"type":"string"},"subscription_topics":{"items":{"maxLength":2000,"type":"string"},"maxItems":100,"type":"array"},"support_email":{"maxLength":2048,"type":"string"},"support_phone":{"maxLength":2048,"type":"string"},"terms_url":{"maxLength":2048,"type":"string"},"tnid_profile_url":{"maxLength":2048,"type":"string"},"volume":{"enum":["","0-1000","1001-10000","10001-100000","100001+"],"maxLength":2048,"type":"string"},"website":{"maxLength":2048,"type":"string"},"what_you_send":{"maxLength":8000,"type":"string"},"who_gets_it":{"maxLength":8000,"type":"string"}},"type":"object"},"expected_revision":{"minimum":1,"type":"integer"}},"required":["expected_revision","answers"],"type":"object"},"Registration":{"additionalProperties":false,"properties":{"approved_snapshot":{"nullable":true,"type":"object"},"brand_ref":{"maxLength":32,"nullable":true,"pattern":"^[a-f0-9]{32}$","type":"string"},"created_at":{"format":"date-time","maxLength":2000,"type":"string"},"details":{"anyOf":[{"additionalProperties":false,"properties":{"business_name":{"maxLength":255,"type":"string"},"consent_evidence_url":{"maxLength":2048,"pattern":"^https://[^\\s]+$","type":"string"},"country":{"enum":["US","CA"],"maxLength":2000,"type":"string"},"numbers":{"items":{"maxLength":12,"pattern":"^\\+1(800|833|844|855|866|877|888)[0-9]{7}$","type":"string"},"maxItems":100,"type":"array","uniqueItems":true},"opt_in_description":{"maxLength":4000,"type":"string"},"purpose":{"maxLength":2000,"type":"string"},"sample_message":{"maxLength":2000,"type":"string"},"website":{"maxLength":2048,"pattern":"^https://[^\\s]+$","type":"string"}},"type":"object"},{"additionalProperties":false,"properties":{"country":{"enum":["US"],"maxLength":2000,"type":"string"},"help_description":{"maxLength":2000,"type":"string"},"lease_evidence_url":{"maxLength":2048,"pattern":"^https://[^\\s]+$","type":"string"},"lease_status":{"enum":["unknown","pending","active","expired"],"maxLength":2000,"type":"string"},"leaseholder_name":{"maxLength":255,"type":"string"},"opt_in_description":{"maxLength":4000,"type":"string"},"opt_out_description":{"maxLength":2000,"type":"string"},"program_name":{"maxLength":255,"type":"string"},"purpose":{"maxLength":2000,"type":"string"},"registration_path":{"enum":["existing","new","migration"],"maxLength":2000,"type":"string"},"sample_message":{"maxLength":2000,"type":"string"},"short_code":{"maxLength":6,"pattern":"^[0-9]{5,6}$","type":"string"}},"type":"object"},{"additionalProperties":false,"properties":{"agent_name":{"maxLength":100,"type":"string"},"brand_authorized":{"type":"boolean"},"brand_color":{"maxLength":7,"pattern":"^#[a-fA-F0-9]{6}$","type":"string"},"brand_contact_email":{"format":"email","maxLength":254,"type":"string"},"brand_contact_name":{"maxLength":255,"type":"string"},"description":{"maxLength":1000,"type":"string"},"experience_description":{"maxLength":4000,"type":"string"},"hero_url":{"maxLength":2048,"pattern":"^https://[^\\s]+$","type":"string"},"launch_targets":{"items":{"additionalProperties":false,"properties":{"carrier":{"maxLength":100,"minLength":1,"type":"string"},"country":{"maxLength":2,"pattern":"^[A-Z]{2}$","type":"string"},"provider_region_id":{"maxLength":200,"type":"string"}},"required":["country","carrier"],"type":"object"},"maxItems":100,"type":"array","uniqueItems":true},"logo_url":{"maxLength":2048,"pattern":"^https://[^\\s]+$","type":"string"},"opt_out_description":{"maxLength":2000,"type":"string"},"privacy_url":{"maxLength":2048,"pattern":"^https://[^\\s]+$","type":"string"},"terms_url":{"maxLength":2048,"pattern":"^https://[^\\s]+$","type":"string"},"website":{"maxLength":2048,"pattern":"^https://[^\\s]+$","type":"string"}},"type":"object"}]},"evidence":{"items":{"additionalProperties":false,"properties":{"description":{"maxLength":500,"type":"string"},"kind":{"enum":["consent","lease","authorization","brand_asset","other"],"maxLength":40,"type":"string"},"url":{"maxLength":2048,"pattern":"^https://[^\\s]+$","type":"string"}},"required":["kind","url"],"type":"object"},"type":"array"},"next_action":{"maxLength":2000,"type":"string"},"provider_mode":{"enum":["manual","sandbox"],"maxLength":2000,"type":"string"},"provider_ready":{"enum":[false],"type":"boolean"},"ref":{"maxLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"},"revision":{"minimum":1,"type":"integer"},"schema_version":{"maxLength":2000,"type":"string"},"status":{"enum":["draft","needs_revision","pending_review","ready_to_submit"],"maxLength":2000,"type":"string"},"type":{"enum":["toll_free","short_code","rcs_agent"],"maxLength":2000,"type":"string"},"updated_at":{"format":"date-time","maxLength":2000,"type":"string"}},"required":["ref","type","schema_version","revision","status","provider_mode","provider_ready","details","evidence"],"type":"object"},"RegistrationAction":{"additionalProperties":false,"properties":{"expected_revision":{"minimum":1,"type":"integer"}},"required":["expected_revision"],"type":"object"},"RegistrationCapabilities":{"additionalProperties":false,"properties":{"enabled":{"type":"boolean"},"live_submission_supported":{"enum":[false],"type":"boolean"},"note":{"maxLength":2000,"type":"string"},"requirements":{"type":"object"},"schema_version":{"maxLength":2000,"type":"string"},"submission_modes":{"items":{"enum":["manual","sandbox"],"maxLength":2000,"type":"string"},"type":"array"},"types":{"items":{"enum":["toll_free","short_code","rcs_agent"],"maxLength":2000,"type":"string"},"type":"array"}},"required":["enabled","schema_version","types","live_submission_supported","submission_modes","requirements","note"],"type":"object"},"RegistrationCreate":{"discriminator":{"propertyName":"type"},"oneOf":[{"additionalProperties":false,"properties":{"brand_ref":{"maxLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"},"details":{"additionalProperties":false,"properties":{"business_name":{"maxLength":255,"type":"string"},"consent_evidence_url":{"maxLength":2048,"pattern":"^https://[^\\s]+$","type":"string"},"country":{"enum":["US","CA"],"maxLength":2000,"type":"string"},"numbers":{"items":{"maxLength":12,"pattern":"^\\+1(800|833|844|855|866|877|888)[0-9]{7}$","type":"string"},"maxItems":100,"type":"array","uniqueItems":true},"opt_in_description":{"maxLength":4000,"type":"string"},"purpose":{"maxLength":2000,"type":"string"},"sample_message":{"maxLength":2000,"type":"string"},"website":{"maxLength":2048,"pattern":"^https://[^\\s]+$","type":"string"}},"type":"object"},"evidence":{"items":{"additionalProperties":false,"properties":{"description":{"maxLength":500,"type":"string"},"kind":{"enum":["consent","lease","authorization","brand_asset","other"],"maxLength":40,"type":"string"},"url":{"maxLength":2048,"pattern":"^https://[^\\s]+$","type":"string"}},"required":["kind","url"],"type":"object"},"maxItems":30,"type":"array"},"provider_mode":{"enum":["manual","sandbox"],"maxLength":2000,"type":"string"},"type":{"enum":["toll_free"],"maxLength":2000,"type":"string"}},"required":["type"],"type":"object"},{"additionalProperties":false,"properties":{"brand_ref":{"maxLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"},"details":{"additionalProperties":false,"properties":{"country":{"enum":["US"],"maxLength":2000,"type":"string"},"help_description":{"maxLength":2000,"type":"string"},"lease_evidence_url":{"maxLength":2048,"pattern":"^https://[^\\s]+$","type":"string"},"lease_status":{"enum":["unknown","pending","active","expired"],"maxLength":2000,"type":"string"},"leaseholder_name":{"maxLength":255,"type":"string"},"opt_in_description":{"maxLength":4000,"type":"string"},"opt_out_description":{"maxLength":2000,"type":"string"},"program_name":{"maxLength":255,"type":"string"},"purpose":{"maxLength":2000,"type":"string"},"registration_path":{"enum":["existing","new","migration"],"maxLength":2000,"type":"string"},"sample_message":{"maxLength":2000,"type":"string"},"short_code":{"maxLength":6,"pattern":"^[0-9]{5,6}$","type":"string"}},"type":"object"},"evidence":{"items":{"additionalProperties":false,"properties":{"description":{"maxLength":500,"type":"string"},"kind":{"enum":["consent","lease","authorization","brand_asset","other"],"maxLength":40,"type":"string"},"url":{"maxLength":2048,"pattern":"^https://[^\\s]+$","type":"string"}},"required":["kind","url"],"type":"object"},"maxItems":30,"type":"array"},"provider_mode":{"enum":["manual","sandbox"],"maxLength":2000,"type":"string"},"type":{"enum":["short_code"],"maxLength":2000,"type":"string"}},"required":["type"],"type":"object"},{"additionalProperties":false,"properties":{"brand_ref":{"maxLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"},"details":{"additionalProperties":false,"properties":{"agent_name":{"maxLength":100,"type":"string"},"brand_authorized":{"type":"boolean"},"brand_color":{"maxLength":7,"pattern":"^#[a-fA-F0-9]{6}$","type":"string"},"brand_contact_email":{"format":"email","maxLength":254,"type":"string"},"brand_contact_name":{"maxLength":255,"type":"string"},"description":{"maxLength":1000,"type":"string"},"experience_description":{"maxLength":4000,"type":"string"},"hero_url":{"maxLength":2048,"pattern":"^https://[^\\s]+$","type":"string"},"launch_targets":{"items":{"additionalProperties":false,"properties":{"carrier":{"maxLength":100,"minLength":1,"type":"string"},"country":{"maxLength":2,"pattern":"^[A-Z]{2}$","type":"string"},"provider_region_id":{"maxLength":200,"type":"string"}},"required":["country","carrier"],"type":"object"},"maxItems":100,"type":"array","uniqueItems":true},"logo_url":{"maxLength":2048,"pattern":"^https://[^\\s]+$","type":"string"},"opt_out_description":{"maxLength":2000,"type":"string"},"privacy_url":{"maxLength":2048,"pattern":"^https://[^\\s]+$","type":"string"},"terms_url":{"maxLength":2048,"pattern":"^https://[^\\s]+$","type":"string"},"website":{"maxLength":2048,"pattern":"^https://[^\\s]+$","type":"string"}},"type":"object"},"evidence":{"items":{"additionalProperties":false,"properties":{"description":{"maxLength":500,"type":"string"},"kind":{"enum":["consent","lease","authorization","brand_asset","other"],"maxLength":40,"type":"string"},"url":{"maxLength":2048,"pattern":"^https://[^\\s]+$","type":"string"}},"required":["kind","url"],"type":"object"},"maxItems":30,"type":"array"},"provider_mode":{"enum":["manual","sandbox"],"maxLength":2000,"type":"string"},"type":{"enum":["rcs_agent"],"maxLength":2000,"type":"string"}},"required":["type"],"type":"object"}]},"RegistrationEvent":{"additionalProperties":false,"properties":{"created_at":{"format":"date-time","maxLength":2000,"type":"string"},"data":{"type":"object"},"ref":{"maxLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"},"revision":{"minimum":1,"type":"integer"},"type":{"maxLength":2000,"type":"string"}},"required":["ref","type","revision","data","created_at"],"type":"object"},"RegistrationEvidence":{"additionalProperties":false,"properties":{"description":{"maxLength":500,"type":"string"},"kind":{"enum":["consent","lease","authorization","brand_asset","other"],"maxLength":40,"type":"string"},"url":{"maxLength":2048,"pattern":"^https://[^\\s]+$","type":"string"}},"required":["kind","url"],"type":"object"},"RegistrationOperation":{"additionalProperties":false,"properties":{"completed_at":{"format":"date-time","maxLength":2000,"type":"string"},"created_at":{"format":"date-time","maxLength":2000,"type":"string"},"mode":{"enum":["sandbox"],"maxLength":2000,"type":"string"},"ref":{"maxLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"},"registration_ref":{"maxLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"},"result":{"type":"object"},"status":{"enum":["completed"],"maxLength":2000,"type":"string"}},"required":["ref","registration_ref","mode","status","result"],"type":"object"},"RegistrationPatch":{"additionalProperties":false,"properties":{"details":{"anyOf":[{"additionalProperties":false,"properties":{"business_name":{"maxLength":255,"type":"string"},"consent_evidence_url":{"maxLength":2048,"pattern":"^https://[^\\s]+$","type":"string"},"country":{"enum":["US","CA"],"maxLength":2000,"type":"string"},"numbers":{"items":{"maxLength":12,"pattern":"^\\+1(800|833|844|855|866|877|888)[0-9]{7}$","type":"string"},"maxItems":100,"type":"array","uniqueItems":true},"opt_in_description":{"maxLength":4000,"type":"string"},"purpose":{"maxLength":2000,"type":"string"},"sample_message":{"maxLength":2000,"type":"string"},"website":{"maxLength":2048,"pattern":"^https://[^\\s]+$","type":"string"}},"type":"object"},{"additionalProperties":false,"properties":{"country":{"enum":["US"],"maxLength":2000,"type":"string"},"help_description":{"maxLength":2000,"type":"string"},"lease_evidence_url":{"maxLength":2048,"pattern":"^https://[^\\s]+$","type":"string"},"lease_status":{"enum":["unknown","pending","active","expired"],"maxLength":2000,"type":"string"},"leaseholder_name":{"maxLength":255,"type":"string"},"opt_in_description":{"maxLength":4000,"type":"string"},"opt_out_description":{"maxLength":2000,"type":"string"},"program_name":{"maxLength":255,"type":"string"},"purpose":{"maxLength":2000,"type":"string"},"registration_path":{"enum":["existing","new","migration"],"maxLength":2000,"type":"string"},"sample_message":{"maxLength":2000,"type":"string"},"short_code":{"maxLength":6,"pattern":"^[0-9]{5,6}$","type":"string"}},"type":"object"},{"additionalProperties":false,"properties":{"agent_name":{"maxLength":100,"type":"string"},"brand_authorized":{"type":"boolean"},"brand_color":{"maxLength":7,"pattern":"^#[a-fA-F0-9]{6}$","type":"string"},"brand_contact_email":{"format":"email","maxLength":254,"type":"string"},"brand_contact_name":{"maxLength":255,"type":"string"},"description":{"maxLength":1000,"type":"string"},"experience_description":{"maxLength":4000,"type":"string"},"hero_url":{"maxLength":2048,"pattern":"^https://[^\\s]+$","type":"string"},"launch_targets":{"items":{"additionalProperties":false,"properties":{"carrier":{"maxLength":100,"minLength":1,"type":"string"},"country":{"maxLength":2,"pattern":"^[A-Z]{2}$","type":"string"},"provider_region_id":{"maxLength":200,"type":"string"}},"required":["country","carrier"],"type":"object"},"maxItems":100,"type":"array","uniqueItems":true},"logo_url":{"maxLength":2048,"pattern":"^https://[^\\s]+$","type":"string"},"opt_out_description":{"maxLength":2000,"type":"string"},"privacy_url":{"maxLength":2048,"pattern":"^https://[^\\s]+$","type":"string"},"terms_url":{"maxLength":2048,"pattern":"^https://[^\\s]+$","type":"string"},"website":{"maxLength":2048,"pattern":"^https://[^\\s]+$","type":"string"}},"type":"object"}]},"evidence":{"items":{"additionalProperties":false,"properties":{"description":{"maxLength":500,"type":"string"},"kind":{"enum":["consent","lease","authorization","brand_asset","other"],"maxLength":40,"type":"string"},"url":{"maxLength":2048,"pattern":"^https://[^\\s]+$","type":"string"}},"required":["kind","url"],"type":"object"},"maxItems":30,"type":"array"},"expected_revision":{"minimum":1,"type":"integer"}},"required":["expected_revision"],"type":"object"},"RegistrationRevisionRequest":{"additionalProperties":false,"properties":{"expected_revision":{"minimum":1,"type":"integer"},"reason":{"maxLength":2000,"minLength":1,"type":"string"}},"required":["expected_revision","reason"],"type":"object"},"RegistrationValidation":{"additionalProperties":false,"properties":{"issues":{"items":{"additionalProperties":false,"properties":{"code":{"maxLength":2000,"type":"string"},"field":{"maxLength":2000,"type":"string"},"message":{"maxLength":2000,"type":"string"}},"required":["field","code","message"],"type":"object"},"type":"array"},"note":{"maxLength":2000,"type":"string"},"provider_ready":{"enum":[false],"type":"boolean"},"requirements_scope":{"maxLength":2000,"type":"string"},"schema_version":{"maxLength":2000,"type":"string"},"valid":{"type":"boolean"}},"required":["valid","schema_version","issues","provider_ready","requirements_scope","note"],"type":"object"}},"securitySchemes":{"apiKeyAuth":{"in":"header","name":"X-API-Key","type":"apiKey"},"bearerAuth":{"description":"Company key or scoped staff superadmin key, issued by a TSG superadmin.","scheme":"bearer","type":"http"}}},"externalDocs":{"description":"Partner integration guide","url":"https://dev.10dlc-campaigns.com/api/v1/guide"},"info":{"description":"Partner brand and campaign registration, website scanning, AI drafting, verification, review and status. Authenticate with a company-scoped API key. Partner keys cannot approve or reconcile campaigns. Admin keys remain company-scoped. Staff superadmin keys use explicit permissions and X-Company-Ref. See /api/v1/guide for workflow examples and /api/v1/mcp for MCP. Default quota: 120 requests/hour per IP per endpoint; MCP tools share the MCP endpoint quota; OTP send 10/minute and verify 20/minute. Use GET /brands and GET /campaigns to discover company records with limit/cursor pagination. Outbound partner webhooks are not available; store refs and poll with backoff. Toll-free, short code and RCS registrations are a feature-gated scaffold with no live provider adapter. SANDBOX environment: brand and campaign submissions are simulated. Nothing reaches The Campaign Registry and no carrier charges are incurred.","title":"TSG Global Messaging Registration API (Sandbox)","version":"1.5.0"},"openapi":"3.0.3","paths":{"/brands":{"get":{"description":"Read-only summaries of records stored in Campaign Manager for the authorized company. Includes all statuses. Records are ordered by opaque ref ascending. Follow data.next_cursor until null; send it unchanged with the same filter. Cursors are signed and bound to the company, list and filter. Pages are a live view, not a snapshot; restart the list to include records inserted before a previous cursor. These endpoints do not fetch or import TCR campaigns. Use each returned ref with the individual GET endpoint. Staff keys require: brands:read.","operationId":"list_brands","parameters":[{"description":"Maximum records per page. Defaults to 25; maximum 100.","in":"query","name":"limit","required":false,"schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Opaque data.next_cursor from the preceding page. Omit for the first page.","in":"query","name":"cursor","required":false,"schema":{"maxLength":1024,"minLength":1,"type":"string"}},{"description":"Required for staff superadmin keys. Select an authorized target from GET /companies. Company partner/admin keys must omit this header.","in":"header","name":"X-Company-Ref","required":false,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"brands":{"items":{"$ref":"#/components/schemas/Brand"},"type":"array"},"next_cursor":{"maxLength":1024,"nullable":true,"type":"string"}},"required":["brands","next_cursor"],"type":"object"}},"required":["data"],"type":"object"}}},"description":"List company brands"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Missing, invalid, or revoked API key"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Company or read permission is not authorized"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Resource not found in this company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Workflow state prevents this action"},"410":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Verification expired"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Validation failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Rate limit or OTP cooldown; back off before retrying"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unexpected server error"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Upstream service unavailable"}},"summary":"List company brands","tags":["Brands"],"x-access-level":"partner","x-staff-required-permissions":["brands:read"]},"post":{"description":"Forces SOLE_PROPRIETOR. No registry call until verification is requested. Idempotency-Key reuses the existing company-scoped brand; a changed request body returns 409. Keys created before payload-bound retries return legacy_idempotency_key with the existing brand_ref. Staff keys require: brands:write.","operationId":"create_brand","parameters":[{"in":"header","name":"Idempotency-Key","required":false,"schema":{"maxLength":100,"minLength":1,"type":"string"}},{"description":"Required for staff superadmin keys. Select an authorized target from GET /companies. Company partner/admin keys must omit this header.","in":"header","name":"X-Company-Ref","required":false,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrandCreate"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"brand":{"$ref":"#/components/schemas/Brand"}},"required":["brand"],"type":"object"}},"required":["data"],"type":"object"}}},"description":"Create a sole-proprietor draft brand"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Missing, invalid, or revoked API key"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Admin API key required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Resource not found in this company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Workflow state prevents this action"},"410":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Verification expired"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Validation failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Rate limit or OTP cooldown; back off before retrying"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unexpected server error"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Upstream service unavailable"}},"summary":"Create a sole-proprietor draft brand","tags":["Brands"],"x-access-level":"partner","x-staff-required-permissions":["brands:write"]}},"/brands/scan":{"post":{"description":"Supports standard entities and sole proprietors. Website must resolve publicly. Every call creates a brand; no automatic retry on ambiguous timeouts. Staff keys require: brands:write.","operationId":"brand_scan","parameters":[{"description":"Required for staff superadmin keys. Select an authorized target from GET /companies. Company partner/admin keys must omit this header.","in":"header","name":"X-Company-Ref","required":false,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"entity_type":{"default":"PRIVATE_PROFIT","enum":["PRIVATE_PROFIT","PUBLIC_PROFIT","NON_PROFIT","GOVERNMENT","SOLE_PROPRIETOR"],"type":"string"},"website_url":{"type":"string"}},"required":["website_url"],"type":"object"}}},"required":true},"responses":{"202":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"brand":{"$ref":"#/components/schemas/BrandFull"},"job_id":{"nullable":true,"type":"string"}},"required":["brand","job_id"],"type":"object"}},"required":["data"],"type":"object"}}},"description":"Create a draft brand and scan its website"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Missing, invalid, or revoked API key"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Admin API key required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Resource not found in this company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Workflow state prevents this action"},"410":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Verification expired"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Validation failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Rate limit or OTP cooldown; back off before retrying"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unexpected server error"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Upstream service unavailable"}},"summary":"Create a draft brand and scan its website","tags":["Brands"],"x-access-level":"partner","x-staff-required-permissions":["brands:write"]}},"/brands/{ref}":{"get":{"description":" Staff keys require: brands:read.","operationId":"get_brand","parameters":[{"in":"path","name":"ref","required":true,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}},{"description":"Required for staff superadmin keys. Select an authorized target from GET /companies. Company partner/admin keys must omit this header.","in":"header","name":"X-Company-Ref","required":false,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"brand":{"$ref":"#/components/schemas/BrandFull"}},"required":["brand"],"type":"object"}},"required":["data"],"type":"object"}}},"description":"Get the full brand record"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Missing, invalid, or revoked API key"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Admin API key required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Resource not found in this company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Workflow state prevents this action"},"410":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Verification expired"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Validation failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Rate limit or OTP cooldown; back off before retrying"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unexpected server error"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Upstream service unavailable"}},"summary":"Get the full brand record","tags":["Brands"],"x-access-level":"partner","x-staff-required-permissions":["brands:read"]},"patch":{"description":"Allowlisted fields only; pending verification and verified brands are locked. Staff keys require: brands:write.","operationId":"patch_brand","parameters":[{"in":"path","name":"ref","required":true,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}},{"description":"Required for staff superadmin keys. Select an authorized target from GET /companies. Company partner/admin keys must omit this header.","in":"header","name":"X-Company-Ref","required":false,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrandPatch"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"brand":{"$ref":"#/components/schemas/BrandFull"}},"required":["brand"],"type":"object"}},"required":["data"],"type":"object"}}},"description":"Update a draft brand"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Missing, invalid, or revoked API key"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Admin API key required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Resource not found in this company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Workflow state prevents this action"},"410":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Verification expired"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Validation failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Rate limit or OTP cooldown; back off before retrying"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unexpected server error"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Upstream service unavailable"}},"summary":"Update a draft brand","tags":["Brands"],"x-access-level":"partner","x-staff-required-permissions":["brands:write"]}},"/brands/{ref}/campaigns":{"post":{"description":"Creates a pending_review campaign and queues compliance review. Sole proprietors must be verified. May register with TNID when the brand is eligible. This is a submission, not an editable draft. No idempotency guarantee. Staff keys require: campaigns:write.","operationId":"create_campaign","parameters":[{"in":"path","name":"ref","required":true,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}},{"description":"Required for staff superadmin keys. Select an authorized target from GET /companies. Company partner/admin keys must omit this header.","in":"header","name":"X-Company-Ref","required":false,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignCreate"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"campaign":{"$ref":"#/components/schemas/Campaign"}},"required":["campaign"],"type":"object"},"meta":{"properties":{"tnid_warning":{"type":"string"}},"type":"object"}},"required":["data"],"type":"object"}}},"description":"Create a campaign from supplied content"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Missing, invalid, or revoked API key"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Admin API key required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Resource not found in this company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Workflow state prevents this action"},"410":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Verification expired"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Validation failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Rate limit or OTP cooldown; back off before retrying"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unexpected server error"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Upstream service unavailable"}},"summary":"Create a campaign from supplied content","tags":["Campaigns"],"x-access-level":"partner","x-staff-required-permissions":["campaigns:write"]}},"/brands/{ref}/campaigns/generate":{"post":{"description":"Poll GET /campaigns/{ref} until generation_in_progress=false. Review and edit before submitting. Draft workflow forces Low Volume Mixed with customer care, marketing and account notifications. No idempotency guarantee. Staff keys require: campaigns:write.","operationId":"generate_campaign","parameters":[{"in":"path","name":"ref","required":true,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}},{"description":"Required for staff superadmin keys. Select an authorized target from GET /companies. Company partner/admin keys must omit this header.","in":"header","name":"X-Company-Ref","required":false,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignGenerate"}}},"required":true},"responses":{"202":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"campaign":{"$ref":"#/components/schemas/CampaignFull"}},"required":["campaign"],"type":"object"}},"required":["data"],"type":"object"}}},"description":"Generate a draft campaign with AI"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Missing, invalid, or revoked API key"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Admin API key required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Resource not found in this company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Workflow state prevents this action"},"410":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Verification expired"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Validation failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Rate limit or OTP cooldown; back off before retrying"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unexpected server error"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Upstream service unavailable"}},"summary":"Generate a draft campaign with AI","tags":["Campaigns"],"x-access-level":"partner","x-staff-required-permissions":["campaigns:write"]}},"/brands/{ref}/otp":{"get":{"description":"Polls TCR and updates verification locally. Poll about every 60 seconds with backoff. Staff keys require: brands:read.","operationId":"check_otp","parameters":[{"in":"path","name":"ref","required":true,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}},{"description":"Required for staff superadmin keys. Select an authorized target from GET /companies. Company partner/admin keys must omit this header.","in":"header","name":"X-Company-Ref","required":false,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"attempts":{"type":"integer"},"otp_status":{"type":"string"},"sent_at":{"format":"date-time","nullable":true,"type":"string"},"verified_at":{"format":"date-time","nullable":true,"type":"string"}},"required":["otp_status","sent_at","verified_at","attempts"],"type":"object"}},"required":["data"],"type":"object"}}},"description":"Poll for the YES-reply verification result"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Missing, invalid, or revoked API key"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Admin API key required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Resource not found in this company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Workflow state prevents this action"},"410":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Verification expired"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Validation failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Rate limit or OTP cooldown; back off before retrying"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unexpected server error"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Upstream service unavailable"}},"summary":"Poll for the YES-reply verification result","tags":["Brands"],"x-access-level":"partner","x-staff-required-permissions":["brands:read"]},"post":{"description":"Registers the sole proprietor if needed. Recipient must reply YES; no PIN is needed. Resend cooldown is 60 seconds by default. Staff keys require: brands:submit.","operationId":"request_otp","parameters":[{"in":"path","name":"ref","required":true,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}},{"description":"Required for staff superadmin keys. Select an authorized target from GET /companies. Company partner/admin keys must omit this header.","in":"header","name":"X-Company-Ref","required":false,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"responses":{"202":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"otp_status":{"type":"string"},"reference_id":{"nullable":true,"type":"string"}},"required":["otp_status","reference_id"],"type":"object"}},"required":["data"],"type":"object"}}},"description":"Send a YES-reply verification SMS"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Missing, invalid, or revoked API key"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Admin API key required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Resource not found in this company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Workflow state prevents this action"},"410":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Verification expired"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Validation failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Rate limit or OTP cooldown; back off before retrying"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unexpected server error"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Upstream service unavailable"}},"summary":"Send a YES-reply verification SMS","tags":["Brands"],"x-access-level":"partner","x-staff-required-permissions":["brands:submit"]}},"/brands/{ref}/otp/verify":{"post":{"description":"With no code, polls TCR. Returns 409 not_yet_verified until the recipient replies YES. Staff keys require: brands:submit.","operationId":"verify_otp","parameters":[{"in":"path","name":"ref","required":true,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}},{"description":"Required for staff superadmin keys. Select an authorized target from GET /companies. Company partner/admin keys must omit this header.","in":"header","name":"X-Company-Ref","required":false,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"code":{"description":"Optional legacy PIN fallback only. Omit for the YES-reply flow.","type":"string"}},"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"otp_status":{"type":"string"},"verified":{"type":"boolean"}},"required":["verified","otp_status"],"type":"object"}},"required":["data"],"type":"object"}}},"description":"Confirm verification"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Missing, invalid, or revoked API key"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Admin API key required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Resource not found in this company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Workflow state prevents this action"},"410":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Verification expired"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Validation failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Rate limit or OTP cooldown; back off before retrying"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unexpected server error"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Upstream service unavailable"}},"summary":"Confirm verification","tags":["Brands"],"x-access-level":"partner","x-staff-required-permissions":["brands:submit"]}},"/brands/{ref}/scan":{"get":{"description":"Poll with the job_id returned for this brand. Prefer 60-second intervals with backoff. Staff keys require: brands:read.","operationId":"brand_scan_status","parameters":[{"in":"path","name":"ref","required":true,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}},{"in":"query","name":"job_id","required":false,"schema":{"type":"string"}},{"description":"Required for staff superadmin keys. Select an authorized target from GET /companies. Company partner/admin keys must omit this header.","in":"header","name":"X-Company-Ref","required":false,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"error":{"type":"string"},"pct":{"type":"integer"},"scan_version":{"nullable":true,"type":"integer"},"status":{"enum":["pending","running","complete","failed"],"type":"string"},"step":{"type":"string"}},"required":["status"],"type":"object"}},"required":["data"],"type":"object"}}},"description":"Read website scan progress"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Missing, invalid, or revoked API key"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Admin API key required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Resource not found in this company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Workflow state prevents this action"},"410":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Verification expired"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Validation failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Rate limit or OTP cooldown; back off before retrying"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unexpected server error"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Upstream service unavailable"}},"summary":"Read website scan progress","tags":["Brands"],"x-access-level":"partner","x-staff-required-permissions":["brands:read"]}},"/brands/{ref}/submit":{"post":{"description":"Registers with TNID for standard entities or TCR for sole proprietors. Standard entities require legal name, contact details and address; EIN is required when EIN verification is configured. For sole proprietors prefer POST /brands/{ref}/otp, which registers and sends the YES request. Staff keys require: brands:submit.","operationId":"submit_brand","parameters":[{"in":"path","name":"ref","required":true,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}},{"description":"Required for staff superadmin keys. Select an authorized target from GET /companies. Company partner/admin keys must omit this header.","in":"header","name":"X-Company-Ref","required":false,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"brand":{"$ref":"#/components/schemas/BrandFull"}},"required":["brand"],"type":"object"}},"required":["data"],"type":"object"}}},"description":"Submit a brand for identity verification"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Missing, invalid, or revoked API key"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Admin API key required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Resource not found in this company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Workflow state prevents this action"},"410":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Verification expired"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Validation failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Rate limit or OTP cooldown; back off before retrying"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unexpected server error"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Upstream service unavailable"}},"summary":"Submit a brand for identity verification","tags":["Brands"],"x-access-level":"partner","x-staff-required-permissions":["brands:submit"]}},"/business-applications/import":{"post":{"description":"Structured JSON only; spreadsheet extraction stays with the client. EIN business path is 10dlc, never inferred sole proprietor. Original declared program, samples, use case and factual assertions are retained. Saving does not confirm facts, register, send OTP, submit or approve. Duplicate tenant EIN requires an explicit authorized existing brand reference. Staff keys require: intakes:write.","operationId":"import_business_application","parameters":[{"description":"Same key and body replay the original response; changed body returns 409.","in":"header","name":"Idempotency-Key","required":true,"schema":{"maxLength":128,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"assertions":{"additionalProperties":false,"properties":{"controls_website":{"maxLength":2000,"type":"string"},"direct_lending_or_arrangement":{"maxLength":2000,"type":"string"},"has_ein":{"maxLength":2000,"type":"string"},"payment_completed":{"maxLength":2000,"type":"string"},"website_matches_brand":{"maxLength":2000,"type":"string"},"written_consent":{"maxLength":2000,"type":"string"}},"type":"object"},"existing_brand_ref":{"maxLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"},"identity":{"additionalProperties":false,"properties":{"city":{"maxLength":255,"type":"string"},"country":{"maxLength":255,"type":"string"},"display_name":{"maxLength":255,"type":"string"},"ein":{"maxLength":255,"type":"string"},"email":{"maxLength":255,"type":"string"},"entity_type":{"enum":["PRIVATE_PROFIT","PUBLIC_PROFIT","NON_PROFIT","GOVERNMENT","SOLE_PROPRIETOR"],"maxLength":2000,"type":"string"},"first_name":{"maxLength":255,"type":"string"},"industry_vertical":{"maxLength":255,"type":"string"},"last_name":{"maxLength":255,"type":"string"},"legal_name":{"maxLength":255,"type":"string"},"phone":{"maxLength":255,"type":"string"},"postal_code":{"maxLength":255,"type":"string"},"state":{"maxLength":255,"type":"string"},"street":{"maxLength":255,"type":"string"}},"type":"object"},"links":{"additionalProperties":false,"properties":{"optin_proof_url":{"maxLength":2048,"pattern":"^https?://[^\\s]+$","type":"string"},"privacy_url":{"maxLength":2048,"pattern":"^https?://[^\\s]+$","type":"string"},"terms_url":{"maxLength":2048,"pattern":"^https?://[^\\s]+$","type":"string"},"website":{"maxLength":2048,"pattern":"^https?://[^\\s]+$","type":"string"}},"type":"object"},"program":{"additionalProperties":false,"properties":{"business_description":{"maxLength":8000,"type":"string"},"consent_description":{"maxLength":8000,"type":"string"},"description":{"maxLength":8000,"type":"string"},"help_message":{"maxLength":1024,"type":"string"},"message_flow":{"maxLength":8000,"type":"string"},"optin_message":{"maxLength":1024,"type":"string"},"optin_method":{"enum":["web_form","keyword","point_of_sale","verbal","paper_form","qr_code","existing_customer"],"maxLength":2000,"type":"string"},"optout_message":{"maxLength":1024,"type":"string"},"recipients":{"maxLength":8000,"type":"string"},"requested_use_case":{"maxLength":8000,"type":"string"},"samples":{"items":{"maxLength":1024,"minLength":1,"type":"string"},"maxItems":5,"minItems":1,"type":"array"},"sub_use_cases":{"items":{"maxLength":100,"type":"string"},"maxItems":5,"type":"array","uniqueItems":true},"use_case":{"maxLength":100,"type":"string"},"volume":{"enum":["0-1000","1001-10000","10001-100000","100001+"],"maxLength":2000,"type":"string"}},"type":"object"},"source_ref":{"maxLength":200,"minLength":1,"type":"string"},"support_email":{"maxLength":255,"type":"string"},"support_phone":{"maxLength":100,"type":"string"}},"required":["source_ref","identity","program"],"type":"object"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Import the source facts of an EIN business application into a saved interview"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Authentication required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Permission required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Not found in target company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"revision_conflict, idempotency_conflict, invalid_state, or manual_handoff_required"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Field validation failed"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"feature_disabled"}},"summary":"Import the source facts of an EIN business application into a saved interview","tags":["Business applications"],"x-access-level":"partner","x-permission":"intakes:write","x-staff-required-permissions":["intakes:write"]}},"/business-applications/{ref}":{"get":{"description":"Structured JSON only; spreadsheet extraction stays with the client. EIN business path is 10dlc, never inferred sole proprietor. Original declared program, samples, use case and factual assertions are retained. Saving does not confirm facts, register, send OTP, submit or approve. Duplicate tenant EIN requires an explicit authorized existing brand reference. Staff keys require: intakes:read.","operationId":"get_business_application","parameters":[{"in":"path","name":"ref","required":true,"schema":{"maxLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Read a source-preserving application interview and its missing facts"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Authentication required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Permission required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Not found in target company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"revision_conflict, idempotency_conflict, invalid_state, or manual_handoff_required"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Field validation failed"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"feature_disabled"}},"summary":"Read a source-preserving application interview and its missing facts","tags":["Business applications"],"x-access-level":"partner","x-permission":"intakes:read","x-staff-required-permissions":["intakes:read"]}},"/campaigns":{"get":{"description":"Read-only summaries of records stored in Campaign Manager for the authorized company. Includes all statuses. Records are ordered by opaque ref ascending. Follow data.next_cursor until null; send it unchanged with the same filter. Cursors are signed and bound to the company, list and filter. Pages are a live view, not a snapshot; restart the list to include records inserted before a previous cursor. These endpoints do not fetch or import TCR campaigns. Use each returned ref with the individual GET endpoint. Staff keys require: campaigns:read.","operationId":"list_campaigns","parameters":[{"description":"Maximum records per page. Defaults to 25; maximum 100.","in":"query","name":"limit","required":false,"schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Opaque data.next_cursor from the preceding page. Omit for the first page.","in":"query","name":"cursor","required":false,"schema":{"maxLength":1024,"minLength":1,"type":"string"}},{"description":"Optional brand ref in the same company. An unknown or other-company brand returns 404. Keep the same brand_ref on every page. Without this filter, all company campaigns are listed.","in":"query","name":"brand_ref","required":false,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}},{"description":"Required for staff superadmin keys. Select an authorized target from GET /companies. Company partner/admin keys must omit this header.","in":"header","name":"X-Company-Ref","required":false,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"campaigns":{"items":{"$ref":"#/components/schemas/CampaignSummary"},"type":"array"},"next_cursor":{"maxLength":1024,"nullable":true,"type":"string"}},"required":["campaigns","next_cursor"],"type":"object"}},"required":["data"],"type":"object"}}},"description":"List company campaigns"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Missing, invalid, or revoked API key"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Company or read permission is not authorized"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Resource not found in this company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Workflow state prevents this action"},"410":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Verification expired"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Validation failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Rate limit or OTP cooldown; back off before retrying"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unexpected server error"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Upstream service unavailable"}},"summary":"List company campaigns","tags":["Campaigns"],"x-access-level":"partner","x-staff-required-permissions":["campaigns:read"]}},"/campaigns/{ref}":{"get":{"description":"Staff superadmin reads never modify campaign content. Company partner/admin reads retain platform-default normalization for editable drafts. Carrier status may require TSG reconciliation. Staff keys require: campaigns:read.","operationId":"get_campaign","parameters":[{"in":"path","name":"ref","required":true,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}},{"description":"Required for staff superadmin keys. Select an authorized target from GET /companies. Company partner/admin keys must omit this header.","in":"header","name":"X-Company-Ref","required":false,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"campaign":{"$ref":"#/components/schemas/CampaignFull"}},"required":["campaign"],"type":"object"}},"required":["data"],"type":"object"}}},"description":"Get campaign content, recommendations and lifecycle status"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Missing, invalid, or revoked API key"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Admin API key required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Resource not found in this company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Workflow state prevents this action"},"410":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Verification expired"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Validation failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Rate limit or OTP cooldown; back off before retrying"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unexpected server error"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Upstream service unavailable"}},"summary":"Get campaign content, recommendations and lifecycle status","tags":["Campaigns"],"x-access-level":"partner","x-staff-required-permissions":["campaigns:read"]},"patch":{"description":"Only draft, needs_revision and test states are editable; generation must have finished. Staff keys require: campaigns:write.","operationId":"patch_campaign","parameters":[{"in":"path","name":"ref","required":true,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}},{"description":"Required for staff superadmin keys. Select an authorized target from GET /companies. Company partner/admin keys must omit this header.","in":"header","name":"X-Company-Ref","required":false,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignPatch"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"campaign":{"$ref":"#/components/schemas/CampaignFull"}},"required":["campaign"],"type":"object"}},"required":["data"],"type":"object"}}},"description":"Edit draft campaign content"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Missing, invalid, or revoked API key"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Admin API key required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Resource not found in this company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Workflow state prevents this action"},"410":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Verification expired"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Validation failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Rate limit or OTP cooldown; back off before retrying"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unexpected server error"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Upstream service unavailable"}},"summary":"Edit draft campaign content","tags":["Campaigns"],"x-access-level":"partner","x-staff-required-permissions":["campaigns:write"]}},"/campaigns/{ref}/approve":{"post":{"description":"Requires a company admin key, or a staff superadmin key with the operation\u2019s explicit permissions and X-Company-Ref. Test campaigns are rejected. Verified brands can be sent to carriers; others wait for brand verification. HTTP 200 does not guarantee carrier submission: inspect submitted_to_tcr and tnid_error. Staff keys require: campaigns:review, campaigns:submit.","operationId":"approve_campaign","parameters":[{"in":"path","name":"ref","required":true,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}},{"description":"Required for staff superadmin keys. Select an authorized target from GET /companies. Company partner/admin keys must omit this header.","in":"header","name":"X-Company-Ref","required":false,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"campaign":{"$ref":"#/components/schemas/CampaignFull"},"submitted_to_tcr":{"type":"boolean"},"tnid_error":{"nullable":true,"type":"string"}},"required":["submitted_to_tcr","tnid_error","campaign"],"type":"object"}},"required":["data"],"type":"object"}}},"description":"Approve and submit through Syniverse"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Missing, invalid, or revoked API key"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Admin API key required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Resource not found in this company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Workflow state prevents this action"},"410":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Verification expired"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Validation failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Rate limit or OTP cooldown; back off before retrying"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unexpected server error"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Upstream service unavailable"}},"summary":"Approve and submit through Syniverse","tags":["Administration"],"x-access-level":"admin","x-staff-required-permissions":["campaigns:review","campaigns:submit"]}},"/campaigns/{ref}/deactivate":{"post":{"description":"Requires a company admin key, or a staff superadmin key with the operation\u2019s explicit permissions and X-Company-Ref. Only active campaigns. Attempts carrier deletion when a TNID campaign exists. Staff keys require: campaigns:deactivate.","operationId":"deactivate_campaign","parameters":[{"in":"path","name":"ref","required":true,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}},{"description":"Required for staff superadmin keys. Select an authorized target from GET /companies. Company partner/admin keys must omit this header.","in":"header","name":"X-Company-Ref","required":false,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"campaign":{"$ref":"#/components/schemas/CampaignFull"}},"required":["campaign"],"type":"object"}},"required":["data"],"type":"object"}}},"description":"Deactivate an active campaign"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Missing, invalid, or revoked API key"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Admin API key required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Resource not found in this company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Workflow state prevents this action"},"410":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Verification expired"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Validation failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Rate limit or OTP cooldown; back off before retrying"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unexpected server error"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Upstream service unavailable"}},"summary":"Deactivate an active campaign","tags":["Administration"],"x-access-level":"admin","x-staff-required-permissions":["campaigns:deactivate"]}},"/campaigns/{ref}/expedite":{"get":{"description":"Tenant scoped. Paid quotes require explicit customer consent. Provider email acceptance, registry approval and deployment remain separate. Uncertain writes/sends require reconciliation. No submission is performed by reading or approving a proposal. Staff keys require: campaigns:read.","operationId":"get_campaign_expedite","parameters":[{"in":"path","name":"ref","required":true,"schema":{"maxLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Read an expedite request"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Authentication required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Permission required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Not found in target company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"revision_conflict, idempotency_conflict, invalid_state, or manual_handoff_required"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Field validation failed"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"feature_disabled"}},"summary":"Read an expedite request","tags":["Registrations"],"x-access-level":"partner","x-permission":"campaigns:read","x-staff-required-permissions":["campaigns:read"]},"post":{"description":"Tenant scoped. Paid quotes require explicit customer consent. Provider email acceptance, registry approval and deployment remain separate. Uncertain writes/sends require reconciliation. No submission is performed by reading or approving a proposal. Staff keys require: campaigns:write.","operationId":"request_campaign_expedite","parameters":[{"in":"path","name":"ref","required":true,"schema":{"maxLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"reason":{"maxLength":3000,"minLength":1,"type":"string"},"request_key":{"maxLength":120,"minLength":1,"type":"string"},"service_level":{"enum":["paid_expedite","urgency_inquiry"],"maxLength":2000,"type":"string"}},"required":["request_key","service_level","reason"],"type":"object"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Request expedited review or ask about options"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Authentication required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Permission required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Not found in target company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"revision_conflict, idempotency_conflict, invalid_state, or manual_handoff_required"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Field validation failed"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"feature_disabled"}},"summary":"Request expedited review or ask about options","tags":["Registrations"],"x-access-level":"partner","x-permission":"campaigns:write","x-staff-required-permissions":["campaigns:write"]}},"/campaigns/{ref}/expedite/authorize":{"post":{"description":"Tenant scoped. Paid quotes require explicit customer consent. Provider email acceptance, registry approval and deployment remain separate. Uncertain writes/sends require reconciliation. No submission is performed by reading or approving a proposal. Staff keys require: campaigns:review.","operationId":"authorize_campaign_expedite","parameters":[{"in":"path","name":"ref","required":true,"schema":{"maxLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"confirm_dispatch":{"type":"boolean"},"expected_version":{"minimum":1,"type":"integer"}},"required":["expected_version","confirm_dispatch"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Staff authorize the elected campaign\u2019s expedite email"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Authentication required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Permission required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Not found in target company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"revision_conflict, idempotency_conflict, invalid_state, or manual_handoff_required"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Field validation failed"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"feature_disabled"}},"summary":"Staff authorize the elected campaign\u2019s expedite email","tags":["Registrations"],"x-access-level":"superadmin","x-permission":"campaigns:review","x-staff-required-permissions":["campaigns:review"]}},"/campaigns/{ref}/expedite/consent":{"post":{"description":"Tenant scoped. Paid quotes require explicit customer consent. Provider email acceptance, registry approval and deployment remain separate. Uncertain writes/sends require reconciliation. No submission is performed by reading or approving a proposal. Staff keys require: campaigns:write.","operationId":"consent_campaign_expedite","parameters":[{"in":"path","name":"ref","required":true,"schema":{"maxLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"confirm_paid_fee":{"type":"boolean"},"expected_version":{"minimum":1,"type":"integer"},"quote_version":{"minimum":1,"type":"integer"}},"required":["expected_version","quote_version","confirm_paid_fee"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Accept the exact current expedite quote"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Authentication required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Permission required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Not found in target company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"revision_conflict, idempotency_conflict, invalid_state, or manual_handoff_required"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Field validation failed"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"feature_disabled"}},"summary":"Accept the exact current expedite quote","tags":["Registrations"],"x-access-level":"partner","x-permission":"campaigns:write","x-staff-required-permissions":["campaigns:write"]}},"/campaigns/{ref}/expedite/quote":{"post":{"description":"Tenant scoped. Paid quotes require explicit customer consent. Provider email acceptance, registry approval and deployment remain separate. Uncertain writes/sends require reconciliation. No submission is performed by reading or approving a proposal. Staff keys require: campaigns:review.","operationId":"quote_campaign_expedite","parameters":[{"in":"path","name":"ref","required":true,"schema":{"maxLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"amount":{"maxLength":30,"type":"string"},"currency":{"maxLength":3,"pattern":"^[A-Z]{3}$","type":"string"},"expected_version":{"minimum":1,"type":"integer"},"expires_at":{"maxLength":100,"type":"string"},"reference":{"maxLength":255,"type":"string"},"terms":{"maxLength":3000,"type":"string"}},"required":["expected_version","amount","currency","terms","reference","expires_at"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Record an actual expedite quote"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Authentication required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Permission required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Not found in target company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"revision_conflict, idempotency_conflict, invalid_state, or manual_handoff_required"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Field validation failed"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"feature_disabled"}},"summary":"Record an actual expedite quote","tags":["Registrations"],"x-access-level":"superadmin","x-permission":"campaigns:review","x-staff-required-permissions":["campaigns:review"]}},"/campaigns/{ref}/messages":{"get":{"description":"Tenant scoped. Paid quotes require explicit customer consent. Provider email acceptance, registry approval and deployment remain separate. Uncertain writes/sends require reconciliation. No submission is performed by reading or approving a proposal. Staff keys require: campaigns:read.","operationId":"get_campaign_messages","parameters":[{"in":"path","name":"ref","required":true,"schema":{"maxLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Read the shared campaign conversation"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Authentication required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Permission required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Not found in target company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"revision_conflict, idempotency_conflict, invalid_state, or manual_handoff_required"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Field validation failed"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"feature_disabled"}},"summary":"Read the shared campaign conversation","tags":["Registrations"],"x-access-level":"partner","x-permission":"campaigns:read","x-staff-required-permissions":["campaigns:read"]},"post":{"description":"Tenant scoped. Paid quotes require explicit customer consent. Provider email acceptance, registry approval and deployment remain separate. Uncertain writes/sends require reconciliation. No submission is performed by reading or approving a proposal. Staff keys require: campaigns:write.","operationId":"reply_campaign_message","parameters":[{"in":"path","name":"ref","required":true,"schema":{"maxLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"note_text":{"maxLength":10000,"minLength":1,"type":"string"},"visibility":{"enum":["shared","staff_private"],"maxLength":2000,"type":"string"}},"required":["note_text"],"type":"object"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Reply in the campaign conversation"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Authentication required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Permission required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Not found in target company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"revision_conflict, idempotency_conflict, invalid_state, or manual_handoff_required"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Field validation failed"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"feature_disabled"}},"summary":"Reply in the campaign conversation","tags":["Registrations"],"x-access-level":"partner","x-permission":"campaigns:write","x-staff-required-permissions":["campaigns:write"]}},"/campaigns/{ref}/reconcile":{"post":{"description":"Requires a company admin key, or a staff superadmin key with the operation\u2019s explicit permissions and X-Company-Ref. Manual reconciliation after independent carrier confirmation; this does not query a carrier. Staff keys require: campaigns:reconcile.","operationId":"reconcile_campaign","parameters":[{"in":"path","name":"ref","required":true,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}},{"description":"Required for staff superadmin keys. Select an authorized target from GET /companies. Company partner/admin keys must omit this header.","in":"header","name":"X-Company-Ref","required":false,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"dca_submitted_at":{"format":"date-time","type":"string"},"status":{"enum":["active","submitted","deactivated"],"type":"string"},"tcr_campaign_id":{"type":"string"}},"required":["status"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"campaign":{"$ref":"#/components/schemas/CampaignFull"}},"required":["campaign"],"type":"object"}},"required":["data"],"type":"object"}}},"description":"Record a confirmed carrier status"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Missing, invalid, or revoked API key"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Admin API key required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Resource not found in this company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Workflow state prevents this action"},"410":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Verification expired"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Validation failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Rate limit or OTP cooldown; back off before retrying"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unexpected server error"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Upstream service unavailable"}},"summary":"Record a confirmed carrier status","tags":["Administration"],"x-access-level":"admin","x-staff-required-permissions":["campaigns:reconcile"]}},"/campaigns/{ref}/resubmit":{"post":{"description":"Requires a company admin key, or a staff superadmin key with the operation\u2019s explicit permissions and X-Company-Ref. After a DCA decline (MANDATORY_MESSAGE_TERMINOLOGY / CALL_TO_ACTION): appends the required opt-in path, consent, frequency, rates, HELP, STOP and privacy/terms disclosures to the message flow and program messages, pushes the edited fields to the existing TNID campaign and resubmits it. Requires a TNID-registered campaign. Staff keys require both campaigns:write and campaigns:submit because this action edits campaign content before submission. Staff keys require: campaigns:submit, campaigns:write.","operationId":"resubmit_campaign","parameters":[{"in":"path","name":"ref","required":true,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}},{"description":"Required for staff superadmin keys. Select an authorized target from GET /companies. Company partner/admin keys must omit this header.","in":"header","name":"X-Company-Ref","required":false,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"campaign":{"$ref":"#/components/schemas/CampaignFull"},"changed_fields":{"items":{"type":"string"},"type":"array"},"tnid":{"type":"object"}},"required":["changed_fields","campaign"],"type":"object"}},"required":["data"],"type":"object"}}},"description":"Fix DCA disclosures and resubmit to carriers"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Missing, invalid, or revoked API key"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Admin API key required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Resource not found in this company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Workflow state prevents this action"},"410":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Verification expired"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Validation failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Rate limit or OTP cooldown; back off before retrying"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unexpected server error"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Upstream service unavailable"}},"summary":"Fix DCA disclosures and resubmit to carriers","tags":["Administration"],"x-access-level":"admin","x-staff-required-permissions":["campaigns:submit","campaigns:write"]}},"/campaigns/{ref}/review-feedback":{"get":{"description":"Exact prepared values and one factual question. Private staff notes excluded. No provider writes. Staff keys require: campaigns:read.","operationId":"get_campaign_review_feedback","parameters":[{"in":"path","name":"ref","required":true,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}},{"description":"Required for staff superadmin keys. Select an authorized target from GET /companies. Company partner/admin keys must omit this header.","in":"header","name":"X-Company-Ref","required":false,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"review":{"additionalProperties":true,"nullable":true,"type":"object"}},"type":"object"}},"required":["data"],"type":"object"}}},"description":"Read the current prepared customer review"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Missing, invalid, or revoked API key"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Admin API key required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Resource not found in this company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Workflow state prevents this action"},"410":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Verification expired"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Validation failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Rate limit or OTP cooldown; back off before retrying"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unexpected server error"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Upstream service unavailable"}},"summary":"Read the current prepared customer review","tags":["Campaigns"],"x-access-level":"partner","x-staff-required-permissions":["campaigns:read"]},"post":{"description":"Requires the current packet ID/hash and an active authorized customer actor. TSG staff cannot impersonate customer confirmation. Confirmed exact wording returns to internal TSG review; never provider submission. Stale409; identical response replay is idempotent. Staff keys require: campaigns:write.","operationId":"respond_campaign_review_feedback","parameters":[{"in":"path","name":"ref","required":true,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}},{"description":"Required for staff superadmin keys. Select an authorized target from GET /companies. Company partner/admin keys must omit this header.","in":"header","name":"X-Company-Ref","required":false,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"action":{"enum":["confirm","request_change"],"type":"string"},"answer":{"type":"string"},"confirm_facts":{"type":"boolean"},"note":{"maxLength":2000,"type":"string"},"packet_id":{"minimum":1,"type":"integer"},"source_hash":{"type":"string"}},"required":["packet_id","source_hash","action"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"review":{"additionalProperties":true,"nullable":true,"type":"object"}},"type":"object"}},"required":["data"],"type":"object"}}},"description":"Confirm prepared wording or request a change"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Missing, invalid, or revoked API key"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Admin API key required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Resource not found in this company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Workflow state prevents this action"},"410":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Verification expired"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Validation failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Rate limit or OTP cooldown; back off before retrying"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unexpected server error"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Upstream service unavailable"}},"summary":"Confirm prepared wording or request a change","tags":["Campaigns"],"x-access-level":"partner","x-staff-required-permissions":["campaigns:write"]}},"/campaigns/{ref}/review-feedback/prepare":{"post":{"description":"Requires a company admin key, or a staff superadmin key with the operation\u2019s explicit permissions and X-Company-Ref. TSG staff only. Explicit exact replacements; no parsing reviewer prose. Does not send a notification. Staff keys require: campaigns:review.","operationId":"prepare_campaign_review_feedback","parameters":[{"in":"path","name":"ref","required":true,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}},{"description":"Required for staff superadmin keys. Select an authorized target from GET /companies. Company partner/admin keys must omit this header.","in":"header","name":"X-Company-Ref","required":false,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"changes":{"items":{"properties":{"field":{"type":"string"},"label":{"type":"string"},"proposed_value":{"type":"string"},"reason":{"type":"string"}},"required":["field","label","reason","proposed_value"],"type":"object"},"maxItems":10,"minItems":1,"type":"array"},"question":{"properties":{"apply_answer":{"type":"string"},"options":{"items":{"properties":{"label":{"type":"string"},"value":{"type":"string"}},"required":["value","label"],"type":"object"},"maxItems":5,"minItems":2,"type":"array"},"text":{"type":"string"}},"required":["text","options","apply_answer"],"type":"object"},"summary":{"type":"string"},"website_changes_requested":{"type":"boolean"}},"required":["summary","website_changes_requested","changes","question"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"review":{"additionalProperties":true,"nullable":true,"type":"object"}},"type":"object"}},"required":["data"],"type":"object"}}},"description":"Prepare a version-bound customer review"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Missing, invalid, or revoked API key"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Admin API key required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Resource not found in this company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Workflow state prevents this action"},"410":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Verification expired"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Validation failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Rate limit or OTP cooldown; back off before retrying"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unexpected server error"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Upstream service unavailable"}},"summary":"Prepare a version-bound customer review","tags":["Administration"],"x-access-level":"admin","x-staff-required-permissions":["campaigns:review"]}},"/campaigns/{ref}/review-feedback/progress":{"get":{"description":"Tenant scoped. Paid quotes require explicit customer consent. Provider email acceptance, registry approval and deployment remain separate. Uncertain writes/sends require reconciliation. No submission is performed by reading or approving a proposal. Staff keys require: campaigns:read.","operationId":"get_prepared_review_progress","parameters":[{"in":"path","name":"ref","required":true,"schema":{"maxLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Read customer confirmation and conditional submission progress"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Authentication required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Permission required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Not found in target company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"revision_conflict, idempotency_conflict, invalid_state, or manual_handoff_required"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Field validation failed"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"feature_disabled"}},"summary":"Read customer confirmation and conditional submission progress","tags":["Registrations"],"x-access-level":"partner","x-permission":"campaigns:read","x-staff-required-permissions":["campaigns:read"]}},"/campaigns/{ref}/review-feedback/release":{"post":{"description":"Tenant scoped. Paid quotes require explicit customer consent. Provider email acceptance, registry approval and deployment remain separate. Uncertain writes/sends require reconciliation. No submission is performed by reading or approving a proposal. Staff keys require: campaigns:review, campaigns:submit.","operationId":"authorize_prepared_review_release","parameters":[{"in":"path","name":"ref","required":true,"schema":{"maxLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"confirm_charges":{"type":"boolean"},"eligibility_checks":{"additionalProperties":false,"properties":{"attributes":{"type":"boolean"},"consent":{"type":"boolean"},"evidence":{"type":"boolean"},"identity":{"type":"boolean"},"privacy":{"type":"boolean"},"program":{"type":"boolean"},"samples":{"type":"boolean"},"terms":{"type":"boolean"}},"required":["identity","program","consent","privacy","terms","samples","attributes","evidence"],"type":"object"},"packet_id":{"minimum":1,"type":"integer"},"source_hash":{"maxLength":64,"type":"string"},"source_note":{"maxLength":4000,"minLength":20,"type":"string"}},"required":["packet_id","source_hash","eligibility_checks","source_note","confirm_charges"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Human review and conditional release of this exact prepared packet"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Authentication required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Permission required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Not found in target company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"revision_conflict, idempotency_conflict, invalid_state, or manual_handoff_required"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Field validation failed"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"feature_disabled"}},"summary":"Human review and conditional release of this exact prepared packet","tags":["Registrations"],"x-access-level":"superadmin","x-permission":"campaigns:review","x-staff-required-permissions":["campaigns:review","campaigns:submit"]}},"/campaigns/{ref}/revise":{"post":{"description":"Requires a company admin key, or a staff superadmin key with the operation\u2019s explicit permissions and X-Company-Ref. Stores the reviewer note and changes status to needs_revision. Staff keys require: campaigns:review.","operationId":"revise_campaign","parameters":[{"in":"path","name":"ref","required":true,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}},{"description":"Required for staff superadmin keys. Select an authorized target from GET /companies. Company partner/admin keys must omit this header.","in":"header","name":"X-Company-Ref","required":false,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"reason":{"minLength":1,"type":"string"}},"required":["reason"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"campaign":{"$ref":"#/components/schemas/CampaignFull"}},"required":["campaign"],"type":"object"}},"required":["data"],"type":"object"}}},"description":"Return a campaign for customer revision"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Missing, invalid, or revoked API key"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Admin API key required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Resource not found in this company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Workflow state prevents this action"},"410":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Verification expired"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Validation failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Rate limit or OTP cooldown; back off before retrying"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unexpected server error"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Upstream service unavailable"}},"summary":"Return a campaign for customer revision","tags":["Administration"],"x-access-level":"admin","x-staff-required-permissions":["campaigns:review"]}},"/campaigns/{ref}/source-release":{"get":{"description":"Tenant scoped. Paid quotes require explicit customer consent. Provider email acceptance, registry approval and deployment remain separate. Uncertain writes/sends require reconciliation. No submission is performed by reading or approving a proposal. Staff keys require: campaigns:read.","operationId":"get_source_application_release","parameters":[{"in":"path","name":"ref","required":true,"schema":{"maxLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Read unchanged-source submission release status"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Authentication required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Permission required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Not found in target company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"revision_conflict, idempotency_conflict, invalid_state, or manual_handoff_required"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Field validation failed"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"feature_disabled"}},"summary":"Read unchanged-source submission release status","tags":["Registrations"],"x-access-level":"partner","x-permission":"campaigns:read","x-staff-required-permissions":["campaigns:read"]},"post":{"description":"Tenant scoped. Paid quotes require explicit customer consent. Provider email acceptance, registry approval and deployment remain separate. Uncertain writes/sends require reconciliation. No submission is performed by reading or approving a proposal. Staff keys require: campaigns:review, campaigns:submit.","operationId":"authorize_source_application_release","parameters":[{"in":"path","name":"ref","required":true,"schema":{"maxLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"confirm_charges":{"type":"boolean"},"confirmed_source_hash":{"maxLength":64,"type":"string"},"eligibility_checks":{"additionalProperties":false,"properties":{"attributes":{"type":"boolean"},"consent":{"type":"boolean"},"evidence":{"type":"boolean"},"identity":{"type":"boolean"},"privacy":{"type":"boolean"},"program":{"type":"boolean"},"samples":{"type":"boolean"},"terms":{"type":"boolean"}},"required":["identity","program","consent","privacy","terms","samples","attributes","evidence"],"type":"object"},"intake_ref":{"maxLength":32,"type":"string"},"packet_id":{"minimum":1,"type":"integer"},"source_hash":{"maxLength":64,"type":"string"},"source_note":{"maxLength":4000,"minLength":20,"type":"string"}},"required":["intake_ref","confirmed_source_hash","source_hash","eligibility_checks","source_note","confirm_charges"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Human authorize the already-confirmed unchanged source application"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Authentication required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Permission required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Not found in target company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"revision_conflict, idempotency_conflict, invalid_state, or manual_handoff_required"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Field validation failed"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"feature_disabled"}},"summary":"Human authorize the already-confirmed unchanged source application","tags":["Registrations"],"x-access-level":"superadmin","x-permission":"campaigns:review","x-staff-required-permissions":["campaigns:review","campaigns:submit"]}},"/campaigns/{ref}/submit":{"post":{"description":"An HTTP 200 can mean warnings_pending: show the warnings, obtain acknowledgment, then retry with acknowledge_warnings=true. Submitted means pending_review, not carrier approval. Repeating while pending_review is safe. Staff keys require: campaigns:write.","operationId":"submit_campaign","parameters":[{"in":"path","name":"ref","required":true,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}},{"description":"Required for staff superadmin keys. Select an authorized target from GET /companies. Company partner/admin keys must omit this header.","in":"header","name":"X-Company-Ref","required":false,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"acknowledge_warnings":{"default":false,"type":"boolean"}},"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"campaign":{"$ref":"#/components/schemas/CampaignFull"},"status":{"enum":["warnings_pending","submitted"],"type":"string"},"warnings":{"items":{"type":"string"},"type":"array"}},"required":["status","campaign"],"type":"object"}},"required":["data"],"type":"object"}}},"description":"Submit a campaign for TSG review"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Missing, invalid, or revoked API key"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Admin API key required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Resource not found in this company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Workflow state prevents this action"},"410":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Verification expired"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Validation failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Rate limit or OTP cooldown; back off before retrying"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unexpected server error"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Upstream service unavailable"}},"summary":"Submit a campaign for TSG review","tags":["Campaigns"],"x-access-level":"partner","x-staff-required-permissions":["campaigns:write"]}},"/communications/{ref}":{"get":{"description":"Tenant scoped. Paid quotes require explicit customer consent. Provider email acceptance, registry approval and deployment remain separate. Uncertain writes/sends require reconciliation. No submission is performed by reading or approving a proposal. Staff keys require: campaigns:review.","operationId":"get_operational_communication","parameters":[{"in":"path","name":"ref","required":true,"schema":{"maxLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Staff read the case\u2019s received email replies"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Authentication required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Permission required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Not found in target company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"revision_conflict, idempotency_conflict, invalid_state, or manual_handoff_required"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Field validation failed"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"feature_disabled"}},"summary":"Staff read the case\u2019s received email replies","tags":["Registrations"],"x-access-level":"superadmin","x-permission":"campaigns:review","x-staff-required-permissions":["campaigns:review"]}},"/companies":{"get":{"description":"Requires a staff superadmin key with companies:read. Returns active authorized companies only. No target header is needed. Staff keys require: companies:read.","operationId":"list_companies","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"companies":{"items":{"properties":{"name":{"type":"string"},"ref":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"},"slug":{"type":"string"}},"required":["ref","name","slug"],"type":"object"},"type":"array"}},"required":["companies"],"type":"object"}},"required":["data"],"type":"object"}}},"description":"List companies available to a staff key"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Missing, invalid, or revoked API key"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Admin API key required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Resource not found in this company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Workflow state prevents this action"},"410":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Verification expired"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Validation failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Rate limit or OTP cooldown; back off before retrying"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unexpected server error"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Upstream service unavailable"}},"summary":"List companies available to a staff key","tags":["Administration"],"x-access-level":"superadmin","x-staff-required-permissions":["companies:read"]}},"/inquiries":{"get":{"description":"Prospective business inquiry only. No brand, campaign, OTP, provider registration or outbound message is created. Research drafts require staff review before publication; public-page text is not identity verification or proof of consent. Staff keys require: inquiries:read.","operationId":"list_inquiries","responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"List this account\u2019s business questions"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Authentication required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Permission required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Not found in target company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"revision_conflict, idempotency_conflict, invalid_state, or manual_handoff_required"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Field validation failed"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"feature_disabled"}},"summary":"List this account\u2019s business questions","tags":["Business questions"],"x-access-level":"partner","x-permission":"inquiries:read","x-staff-required-permissions":["inquiries:read"]},"post":{"description":"Prospective business inquiry only. No brand, campaign, OTP, provider registration or outbound message is created. Research drafts require staff review before publication; public-page text is not identity verification or proof of consent. Staff keys require: inquiries:write.","operationId":"create_inquiry","parameters":[{"description":"Same key and body replay the original response; changed body returns 409.","in":"header","name":"Idempotency-Key","required":true,"schema":{"maxLength":128,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"channel":{"enum":["10dlc","10dlc_sp","toll_free","short_code","rcs_agent","unknown"],"maxLength":2000,"type":"string"},"facts":{"additionalProperties":false,"properties":{"business_model":{"maxLength":8000,"type":"string"},"business_name":{"maxLength":8000,"type":"string"},"consent_process":{"maxLength":8000,"type":"string"},"intended_messages":{"maxLength":8000,"type":"string"},"prior_provider_feedback":{"maxLength":8000,"type":"string"},"recipients":{"maxLength":8000,"type":"string"}},"type":"object"},"public_urls":{"items":{"maxLength":2048,"pattern":"^https?://[^\\s]+$","type":"string"},"maxItems":5,"type":"array","uniqueItems":true},"question":{"maxLength":8000,"minLength":1,"type":"string"},"title":{"maxLength":200,"minLength":1,"type":"string"}},"required":["title","channel","question"],"type":"object"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Ask about a prospective business or messaging use case"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Authentication required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Permission required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Not found in target company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"revision_conflict, idempotency_conflict, invalid_state, or manual_handoff_required"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Field validation failed"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"feature_disabled"}},"summary":"Ask about a prospective business or messaging use case","tags":["Business questions"],"x-access-level":"partner","x-permission":"inquiries:write","x-staff-required-permissions":["inquiries:write"]}},"/inquiries/{ref}":{"get":{"description":"Prospective business inquiry only. No brand, campaign, OTP, provider registration or outbound message is created. Research drafts require staff review before publication; public-page text is not identity verification or proof of consent. Staff keys require: inquiries:read.","operationId":"get_inquiry","parameters":[{"in":"path","name":"ref","required":true,"schema":{"maxLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Read a business question and conversation"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Authentication required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Permission required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Not found in target company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"revision_conflict, idempotency_conflict, invalid_state, or manual_handoff_required"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Field validation failed"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"feature_disabled"}},"summary":"Read a business question and conversation","tags":["Business questions"],"x-access-level":"partner","x-permission":"inquiries:read","x-staff-required-permissions":["inquiries:read"]}},"/inquiries/{ref}/messages":{"post":{"description":"Prospective business inquiry only. No brand, campaign, OTP, provider registration or outbound message is created. Research drafts require staff review before publication; public-page text is not identity verification or proof of consent. Staff keys require: inquiries:write.","operationId":"respond_inquiry","parameters":[{"in":"path","name":"ref","required":true,"schema":{"maxLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"expected_revision":{"minimum":1,"type":"integer"},"facts":{"additionalProperties":false,"properties":{"business_model":{"maxLength":8000,"type":"string"},"business_name":{"maxLength":8000,"type":"string"},"consent_process":{"maxLength":8000,"type":"string"},"intended_messages":{"maxLength":8000,"type":"string"},"prior_provider_feedback":{"maxLength":8000,"type":"string"},"recipients":{"maxLength":8000,"type":"string"}},"type":"object"},"public_urls":{"items":{"maxLength":2048,"pattern":"^https?://[^\\s]+$","type":"string"},"maxItems":5,"type":"array","uniqueItems":true},"source_hash":{"maxLength":64,"pattern":"^[a-f0-9]{64}$","type":"string"},"text":{"maxLength":8000,"minLength":1,"type":"string"},"visibility":{"enum":["shared","staff_private"],"maxLength":2000,"type":"string"}},"required":["expected_revision","source_hash","text"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Reply or clarify the proposed business facts"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Authentication required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Permission required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Not found in target company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"revision_conflict, idempotency_conflict, invalid_state, or manual_handoff_required"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Field validation failed"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"feature_disabled"}},"summary":"Reply or clarify the proposed business facts","tags":["Business questions"],"x-access-level":"partner","x-permission":"inquiries:write","x-staff-required-permissions":["inquiries:write"]}},"/inquiries/{ref}/research":{"post":{"description":"Prospective business inquiry only. No brand, campaign, OTP, provider registration or outbound message is created. Research drafts require staff review before publication; public-page text is not identity verification or proof of consent. Staff keys require: inquiries:write.","operationId":"request_inquiry_research","parameters":[{"in":"path","name":"ref","required":true,"schema":{"maxLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"expected_revision":{"minimum":1,"type":"integer"},"source_hash":{"maxLength":64,"pattern":"^[a-f0-9]{64}$","type":"string"}},"required":["expected_revision","source_hash"],"type":"object"}}},"required":true},"responses":{"202":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Research supplied pages, linked first-party disclosures and current facts"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Authentication required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Permission required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Not found in target company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"revision_conflict, idempotency_conflict, invalid_state, or manual_handoff_required"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Field validation failed"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"feature_disabled"}},"summary":"Research supplied pages, linked first-party disclosures and current facts","tags":["Business questions"],"x-access-level":"partner","x-permission":"inquiries:write","x-staff-required-permissions":["inquiries:write"]}},"/inquiries/{ref}/staff-review":{"post":{"description":"Prospective business inquiry only. No brand, campaign, OTP, provider registration or outbound message is created. Research drafts require staff review before publication; public-page text is not identity verification or proof of consent. Staff keys require: inquiries:review.","operationId":"review_inquiry","parameters":[{"in":"path","name":"ref","required":true,"schema":{"maxLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"answer":{"maxLength":12000,"minLength":1,"type":"string"},"basis":{"maxLength":4000,"minLength":1,"type":"string"},"expected_revision":{"minimum":1,"type":"integer"},"questions":{"items":{"maxLength":1000,"minLength":1,"type":"string"},"maxItems":8,"type":"array"},"source_hash":{"maxLength":64,"pattern":"^[a-f0-9]{64}$","type":"string"}},"required":["expected_revision","source_hash","answer","questions","basis"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Publish a staff-reviewed answer or clarification questions"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Authentication required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Permission required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Not found in target company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"revision_conflict, idempotency_conflict, invalid_state, or manual_handoff_required"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Field validation failed"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"feature_disabled"}},"summary":"Publish a staff-reviewed answer or clarification questions","tags":["Business questions"],"x-access-level":"superadmin","x-permission":"inquiries:review","x-staff-required-permissions":["inquiries:review"]}},"/intake-capabilities":{"get":{"description":"Tenant-scoped saved interview. Confirmation is factual, not compliance approval. Provider submission, OTP and billing remain separate. Staff keys require: intakes:read.","operationId":"get_intake_capabilities","parameters":[{"description":"Required for staff superadmin keys. Select an authorized target from GET /companies. Company partner/admin keys must omit this header.","in":"header","name":"X-Company-Ref","required":false,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Get guided interview paths"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Authentication required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Permission required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Not found in target company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"revision_conflict, idempotency_conflict, invalid_state, or manual_handoff_required"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Field validation failed"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"feature_disabled"}},"summary":"Get guided interview paths","tags":["Guided intake"],"x-access-level":"partner","x-permission":"intakes:read","x-staff-required-permissions":["intakes:read"]}},"/intakes":{"get":{"description":"Tenant-scoped saved interview. Confirmation is factual, not compliance approval. Provider submission, OTP and billing remain separate. Staff keys require: intakes:read.","operationId":"list_intakes","parameters":[{"description":"Required for staff superadmin keys. Select an authorized target from GET /companies. Company partner/admin keys must omit this header.","in":"header","name":"X-Company-Ref","required":false,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"List saved interviews"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Authentication required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Permission required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Not found in target company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"revision_conflict, idempotency_conflict, invalid_state, or manual_handoff_required"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Field validation failed"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"feature_disabled"}},"summary":"List saved interviews","tags":["Guided intake"],"x-access-level":"partner","x-permission":"intakes:read","x-staff-required-permissions":["intakes:read"]},"post":{"description":"Tenant-scoped saved interview. Confirmation is factual, not compliance approval. Provider submission, OTP and billing remain separate. Staff keys require: intakes:write.","operationId":"create_intake","parameters":[{"description":"Same key and body replay the original response; changed body returns 409.","in":"header","name":"Idempotency-Key","required":true,"schema":{"maxLength":128,"minLength":1,"type":"string"}},{"description":"Required for staff superadmin keys. Select an authorized target from GET /companies. Company partner/admin keys must omit this header.","in":"header","name":"X-Company-Ref","required":false,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"answers":{"additionalProperties":false,"properties":{"agent_name":{"maxLength":2048,"type":"string"},"brand_authorized":{"enum":["","no","yes"],"maxLength":2048,"type":"string"},"brand_color":{"maxLength":2048,"type":"string"},"brand_contact_email":{"maxLength":2048,"type":"string"},"brand_contact_name":{"maxLength":2048,"type":"string"},"business_description":{"maxLength":8000,"type":"string"},"business_family":{"enum":["","other","mary_kay"],"maxLength":2048,"type":"string"},"call_to_action":{"maxLength":8000,"type":"string"},"city":{"maxLength":2048,"type":"string"},"consent_description":{"maxLength":8000,"type":"string"},"country":{"enum":["","US","CA"],"maxLength":2048,"type":"string"},"customer_reference":{"maxLength":2048,"type":"string"},"display_name":{"maxLength":2048,"type":"string"},"ein":{"maxLength":2048,"type":"string"},"email":{"maxLength":2048,"type":"string"},"entity_type":{"enum":["","PRIVATE_PROFIT","PUBLIC_PROFIT","NON_PROFIT","GOVERNMENT","SOLE_PROPRIETOR"],"maxLength":2048,"type":"string"},"experience_description":{"maxLength":8000,"type":"string"},"first_name":{"maxLength":2048,"type":"string"},"help_description":{"maxLength":8000,"type":"string"},"hero_url":{"maxLength":2048,"type":"string"},"last_name":{"maxLength":2048,"type":"string"},"launch_carriers":{"items":{"maxLength":2000,"type":"string"},"maxItems":100,"type":"array"},"launch_country":{"enum":["","US","CA"],"maxLength":2048,"type":"string"},"lease_evidence_url":{"maxLength":2048,"type":"string"},"lease_status":{"enum":["","unknown","pending","active","expired"],"maxLength":2048,"type":"string"},"leaseholder_name":{"maxLength":2048,"type":"string"},"legal_name":{"maxLength":2048,"type":"string"},"logo_url":{"maxLength":2048,"type":"string"},"mary_kay_role":{"enum":["","consultant","director"],"maxLength":2048,"type":"string"},"messaging_provider":{"maxLength":2048,"type":"string"},"mobile_phone":{"maxLength":2048,"type":"string"},"monthly_volume":{"maxLength":2048,"type":"string"},"needs_tnid":{"enum":["","no","yes"],"maxLength":2048,"type":"string"},"notes":{"maxLength":8000,"type":"string"},"numbers":{"items":{"maxLength":2000,"type":"string"},"maxItems":100,"type":"array"},"opt_out_description":{"maxLength":8000,"type":"string"},"optin_method":{"enum":["","web_form","keyword","point_of_sale","verbal","paper_form","qr_code","existing_customer"],"maxLength":2048,"type":"string"},"optin_proof_url":{"maxLength":2048,"type":"string"},"phone":{"maxLength":2048,"type":"string"},"postal_code":{"maxLength":2048,"type":"string"},"privacy_url":{"maxLength":2048,"type":"string"},"program_name":{"maxLength":2048,"type":"string"},"promotional":{"enum":["","no","yes"],"maxLength":2048,"type":"string"},"registration_number":{"maxLength":2048,"type":"string"},"registration_path":{"enum":["","existing","new","migration"],"maxLength":2048,"type":"string"},"registration_type":{"maxLength":2048,"type":"string"},"sample_message":{"maxLength":8000,"type":"string"},"samples":{"items":{"maxLength":2000,"type":"string"},"maxItems":100,"type":"array"},"short_code":{"maxLength":2048,"type":"string"},"source_application_hash":{"maxLength":2048,"type":"string"},"source_application_ref":{"maxLength":2048,"type":"string"},"source_existing_brand_ref":{"maxLength":2048,"type":"string"},"source_help_message":{"maxLength":8000,"type":"string"},"source_industry_vertical":{"maxLength":2048,"type":"string"},"source_message_flow":{"maxLength":8000,"type":"string"},"source_optin_message":{"maxLength":8000,"type":"string"},"source_optout_message":{"maxLength":8000,"type":"string"},"source_requested_use_case":{"maxLength":8000,"type":"string"},"source_samples":{"items":{"maxLength":2000,"type":"string"},"maxItems":100,"type":"array"},"source_sub_use_cases":{"items":{"maxLength":2000,"type":"string"},"maxItems":100,"type":"array"},"source_use_case":{"maxLength":2048,"type":"string"},"state":{"maxLength":2048,"type":"string"},"street":{"maxLength":2048,"type":"string"},"subscription_topics":{"items":{"maxLength":2000,"type":"string"},"maxItems":100,"type":"array"},"support_email":{"maxLength":2048,"type":"string"},"support_phone":{"maxLength":2048,"type":"string"},"terms_url":{"maxLength":2048,"type":"string"},"tnid_profile_url":{"maxLength":2048,"type":"string"},"volume":{"enum":["","0-1000","1001-10000","10001-100000","100001+"],"maxLength":2048,"type":"string"},"website":{"maxLength":2048,"type":"string"},"what_you_send":{"maxLength":8000,"type":"string"},"who_gets_it":{"maxLength":8000,"type":"string"}},"type":"object"},"channel":{"enum":["10dlc","10dlc_sp","toll_free","short_code","rcs_agent"],"maxLength":2000,"type":"string"}},"required":["channel"],"type":"object"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Start a guided interview"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Authentication required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Permission required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Not found in target company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"revision_conflict, idempotency_conflict, invalid_state, or manual_handoff_required"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Field validation failed"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"feature_disabled"}},"summary":"Start a guided interview","tags":["Guided intake"],"x-access-level":"partner","x-permission":"intakes:write","x-staff-required-permissions":["intakes:write"]}},"/intakes/{ref}":{"get":{"description":"Tenant-scoped saved interview. Confirmation is factual, not compliance approval. Provider submission, OTP and billing remain separate. Staff keys require: intakes:read.","operationId":"get_intake","parameters":[{"in":"path","name":"ref","required":true,"schema":{"maxLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}},{"description":"Required for staff superadmin keys. Select an authorized target from GET /companies. Company partner/admin keys must omit this header.","in":"header","name":"X-Company-Ref","required":false,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Get a saved interview"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Authentication required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Permission required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Not found in target company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"revision_conflict, idempotency_conflict, invalid_state, or manual_handoff_required"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Field validation failed"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"feature_disabled"}},"summary":"Get a saved interview","tags":["Guided intake"],"x-access-level":"partner","x-permission":"intakes:read","x-staff-required-permissions":["intakes:read"]},"patch":{"description":"Tenant-scoped saved interview. Confirmation is factual, not compliance approval. Provider submission, OTP and billing remain separate. Staff keys require: intakes:write.","operationId":"patch_intake","parameters":[{"in":"path","name":"ref","required":true,"schema":{"maxLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}},{"description":"Required for staff superadmin keys. Select an authorized target from GET /companies. Company partner/admin keys must omit this header.","in":"header","name":"X-Company-Ref","required":false,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"answers":{"additionalProperties":false,"properties":{"agent_name":{"maxLength":2048,"type":"string"},"brand_authorized":{"enum":["","no","yes"],"maxLength":2048,"type":"string"},"brand_color":{"maxLength":2048,"type":"string"},"brand_contact_email":{"maxLength":2048,"type":"string"},"brand_contact_name":{"maxLength":2048,"type":"string"},"business_description":{"maxLength":8000,"type":"string"},"business_family":{"enum":["","other","mary_kay"],"maxLength":2048,"type":"string"},"call_to_action":{"maxLength":8000,"type":"string"},"city":{"maxLength":2048,"type":"string"},"consent_description":{"maxLength":8000,"type":"string"},"country":{"enum":["","US","CA"],"maxLength":2048,"type":"string"},"customer_reference":{"maxLength":2048,"type":"string"},"display_name":{"maxLength":2048,"type":"string"},"ein":{"maxLength":2048,"type":"string"},"email":{"maxLength":2048,"type":"string"},"entity_type":{"enum":["","PRIVATE_PROFIT","PUBLIC_PROFIT","NON_PROFIT","GOVERNMENT","SOLE_PROPRIETOR"],"maxLength":2048,"type":"string"},"experience_description":{"maxLength":8000,"type":"string"},"first_name":{"maxLength":2048,"type":"string"},"help_description":{"maxLength":8000,"type":"string"},"hero_url":{"maxLength":2048,"type":"string"},"last_name":{"maxLength":2048,"type":"string"},"launch_carriers":{"items":{"maxLength":2000,"type":"string"},"maxItems":100,"type":"array"},"launch_country":{"enum":["","US","CA"],"maxLength":2048,"type":"string"},"lease_evidence_url":{"maxLength":2048,"type":"string"},"lease_status":{"enum":["","unknown","pending","active","expired"],"maxLength":2048,"type":"string"},"leaseholder_name":{"maxLength":2048,"type":"string"},"legal_name":{"maxLength":2048,"type":"string"},"logo_url":{"maxLength":2048,"type":"string"},"mary_kay_role":{"enum":["","consultant","director"],"maxLength":2048,"type":"string"},"messaging_provider":{"maxLength":2048,"type":"string"},"mobile_phone":{"maxLength":2048,"type":"string"},"monthly_volume":{"maxLength":2048,"type":"string"},"needs_tnid":{"enum":["","no","yes"],"maxLength":2048,"type":"string"},"notes":{"maxLength":8000,"type":"string"},"numbers":{"items":{"maxLength":2000,"type":"string"},"maxItems":100,"type":"array"},"opt_out_description":{"maxLength":8000,"type":"string"},"optin_method":{"enum":["","web_form","keyword","point_of_sale","verbal","paper_form","qr_code","existing_customer"],"maxLength":2048,"type":"string"},"optin_proof_url":{"maxLength":2048,"type":"string"},"phone":{"maxLength":2048,"type":"string"},"postal_code":{"maxLength":2048,"type":"string"},"privacy_url":{"maxLength":2048,"type":"string"},"program_name":{"maxLength":2048,"type":"string"},"promotional":{"enum":["","no","yes"],"maxLength":2048,"type":"string"},"registration_number":{"maxLength":2048,"type":"string"},"registration_path":{"enum":["","existing","new","migration"],"maxLength":2048,"type":"string"},"registration_type":{"maxLength":2048,"type":"string"},"sample_message":{"maxLength":8000,"type":"string"},"samples":{"items":{"maxLength":2000,"type":"string"},"maxItems":100,"type":"array"},"short_code":{"maxLength":2048,"type":"string"},"source_application_hash":{"maxLength":2048,"type":"string"},"source_application_ref":{"maxLength":2048,"type":"string"},"source_existing_brand_ref":{"maxLength":2048,"type":"string"},"source_help_message":{"maxLength":8000,"type":"string"},"source_industry_vertical":{"maxLength":2048,"type":"string"},"source_message_flow":{"maxLength":8000,"type":"string"},"source_optin_message":{"maxLength":8000,"type":"string"},"source_optout_message":{"maxLength":8000,"type":"string"},"source_requested_use_case":{"maxLength":8000,"type":"string"},"source_samples":{"items":{"maxLength":2000,"type":"string"},"maxItems":100,"type":"array"},"source_sub_use_cases":{"items":{"maxLength":2000,"type":"string"},"maxItems":100,"type":"array"},"source_use_case":{"maxLength":2048,"type":"string"},"state":{"maxLength":2048,"type":"string"},"street":{"maxLength":2048,"type":"string"},"subscription_topics":{"items":{"maxLength":2000,"type":"string"},"maxItems":100,"type":"array"},"support_email":{"maxLength":2048,"type":"string"},"support_phone":{"maxLength":2048,"type":"string"},"terms_url":{"maxLength":2048,"type":"string"},"tnid_profile_url":{"maxLength":2048,"type":"string"},"volume":{"enum":["","0-1000","1001-10000","10001-100000","100001+"],"maxLength":2048,"type":"string"},"website":{"maxLength":2048,"type":"string"},"what_you_send":{"maxLength":8000,"type":"string"},"who_gets_it":{"maxLength":8000,"type":"string"}},"type":"object"},"expected_revision":{"minimum":1,"type":"integer"}},"required":["expected_revision","answers"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Save interview answers"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Authentication required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Permission required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Not found in target company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"revision_conflict, idempotency_conflict, invalid_state, or manual_handoff_required"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Field validation failed"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"feature_disabled"}},"summary":"Save interview answers","tags":["Guided intake"],"x-access-level":"partner","x-permission":"intakes:write","x-staff-required-permissions":["intakes:write"]}},"/intakes/{ref}/confirm":{"post":{"description":"Tenant-scoped saved interview. Confirmation is factual, not compliance approval. Provider submission, OTP and billing remain separate. Staff keys require: intakes:write.","operationId":"confirm_intake","parameters":[{"in":"path","name":"ref","required":true,"schema":{"maxLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}},{"description":"Required for staff superadmin keys. Select an authorized target from GET /companies. Company partner/admin keys must omit this header.","in":"header","name":"X-Company-Ref","required":false,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"expected_revision":{"minimum":1,"type":"integer"},"source_hash":{"maxLength":64,"pattern":"^[a-f0-9]{64}$","type":"string"}},"required":["expected_revision","source_hash"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Confirm this version of the facts"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Authentication required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Permission required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Not found in target company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"revision_conflict, idempotency_conflict, invalid_state, or manual_handoff_required"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Field validation failed"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"feature_disabled"}},"summary":"Confirm this version of the facts","tags":["Guided intake"],"x-access-level":"partner","x-permission":"intakes:write","x-staff-required-permissions":["intakes:write"]}},"/intakes/{ref}/prepare":{"post":{"description":"Tenant-scoped saved interview. Confirmation is factual, not compliance approval. Provider submission, OTP and billing remain separate. Staff keys require: intakes:write.","operationId":"prepare_intake","parameters":[{"in":"path","name":"ref","required":true,"schema":{"maxLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}},{"description":"Required for staff superadmin keys. Select an authorized target from GET /companies. Company partner/admin keys must omit this header.","in":"header","name":"X-Company-Ref","required":false,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"expected_revision":{"minimum":1,"type":"integer"},"source_hash":{"maxLength":64,"pattern":"^[a-f0-9]{64}$","type":"string"}},"required":["expected_revision","source_hash"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Prepare a local submission draft"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Authentication required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Permission required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Not found in target company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"revision_conflict, idempotency_conflict, invalid_state, or manual_handoff_required"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Field validation failed"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"feature_disabled"}},"summary":"Prepare a local submission draft","tags":["Guided intake"],"x-access-level":"partner","x-permission":"intakes:write","x-staff-required-permissions":["intakes:write"]}},"/intakes/{ref}/sole-proprietor":{"get":{"description":"Tenant-scoped saved interview. Confirmation is factual, not compliance approval. Provider submission, OTP and billing remain separate. Staff keys require: intakes:read.","operationId":"get_sole_proprietor_plan","parameters":[{"in":"path","name":"ref","required":true,"schema":{"maxLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}},{"description":"Required for staff superadmin keys. Select an authorized target from GET /companies. Company partner/admin keys must omit this header.","in":"header","name":"X-Company-Ref","required":false,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Get sole proprietor preparation and progress"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Authentication required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Permission required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Not found in target company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"revision_conflict, idempotency_conflict, invalid_state, or manual_handoff_required"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Field validation failed"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"feature_disabled"}},"summary":"Get sole proprietor preparation and progress","tags":["Guided intake"],"x-access-level":"partner","x-permission":"intakes:read","x-staff-required-permissions":["intakes:read"]}},"/intakes/{ref}/sole-proprietor/brand":{"post":{"description":"Tenant-scoped saved interview. Confirmation is factual, not compliance approval. Provider submission, OTP and billing remain separate. Staff keys require: intakes:write.","operationId":"prepare_sole_proprietor_brand","parameters":[{"in":"path","name":"ref","required":true,"schema":{"maxLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}},{"description":"Required for staff superadmin keys. Select an authorized target from GET /companies. Company partner/admin keys must omit this header.","in":"header","name":"X-Company-Ref","required":false,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"expected_revision":{"minimum":1,"type":"integer"},"source_hash":{"maxLength":64,"pattern":"^[a-f0-9]{64}$","type":"string"}},"required":["expected_revision","source_hash"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Prepare the confirmed sole proprietor brand locally"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Authentication required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Permission required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Not found in target company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"revision_conflict, idempotency_conflict, invalid_state, or manual_handoff_required"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Field validation failed"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"feature_disabled"}},"summary":"Prepare the confirmed sole proprietor brand locally","tags":["Guided intake"],"x-access-level":"partner","x-permission":"intakes:write","x-staff-required-permissions":["intakes:write"]}},"/intakes/{ref}/sole-proprietor/campaign":{"post":{"description":"Tenant-scoped saved interview. Confirmation is factual, not compliance approval. Provider submission, OTP and billing remain separate. Staff keys require: intakes:write.","operationId":"prepare_sole_proprietor_campaign","parameters":[{"in":"path","name":"ref","required":true,"schema":{"maxLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}},{"description":"Required for staff superadmin keys. Select an authorized target from GET /companies. Company partner/admin keys must omit this header.","in":"header","name":"X-Company-Ref","required":false,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"expected_revision":{"minimum":1,"type":"integer"},"source_hash":{"maxLength":64,"pattern":"^[a-f0-9]{64}$","type":"string"}},"required":["expected_revision","source_hash"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Prepare the verified representative campaign for staff review"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Authentication required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Permission required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Not found in target company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"revision_conflict, idempotency_conflict, invalid_state, or manual_handoff_required"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Field validation failed"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"feature_disabled"}},"summary":"Prepare the verified representative campaign for staff review","tags":["Guided intake"],"x-access-level":"partner","x-permission":"intakes:write","x-staff-required-permissions":["intakes:write"]}},"/intakes/{ref}/sole-proprietor/evidence":{"post":{"description":"Tenant-scoped saved interview. Confirmation is factual, not compliance approval. Provider submission, OTP and billing remain separate. Staff keys require: intakes:write.","operationId":"verify_sole_proprietor_evidence","parameters":[{"in":"path","name":"ref","required":true,"schema":{"maxLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}},{"description":"Required for staff superadmin keys. Select an authorized target from GET /companies. Company partner/admin keys must omit this header.","in":"header","name":"X-Company-Ref","required":false,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"criteria":{"items":{"maxLength":100,"type":"string"},"maxItems":10,"type":"array","uniqueItems":true},"document_ref":{"maxLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"},"expected_revision":{"minimum":1,"type":"integer"},"source_hash":{"maxLength":64,"pattern":"^[a-f0-9]{64}$","type":"string"},"source_note":{"maxLength":2000,"type":"string"}},"required":["expected_revision","source_hash","document_ref","criteria","source_note"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Staff verify current sender evidence and profile access"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Authentication required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Permission required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Not found in target company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"revision_conflict, idempotency_conflict, invalid_state, or manual_handoff_required"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Field validation failed"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"feature_disabled"}},"summary":"Staff verify current sender evidence and profile access","tags":["Guided intake"],"x-access-level":"partner","x-permission":"intakes:write","x-staff-required-permissions":["intakes:write"]}},"/intakes/{ref}/sole-proprietor/mobile":{"post":{"description":"Tenant-scoped saved interview. Confirmation is factual, not compliance approval. Provider submission, OTP and billing remain separate. Staff keys require: intakes:write.","operationId":"request_sole_proprietor_mobile","parameters":[{"in":"path","name":"ref","required":true,"schema":{"maxLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}},{"description":"Required for staff superadmin keys. Select an authorized target from GET /companies. Company partner/admin keys must omit this header.","in":"header","name":"X-Company-Ref","required":false,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"expected_revision":{"minimum":1,"type":"integer"},"source_hash":{"maxLength":64,"pattern":"^[a-f0-9]{64}$","type":"string"}},"required":["expected_revision","source_hash"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Register the brand and request representative SMS verification"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Authentication required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Permission required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Not found in target company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"revision_conflict, idempotency_conflict, invalid_state, or manual_handoff_required"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Field validation failed"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"feature_disabled"}},"summary":"Register the brand and request representative SMS verification","tags":["Guided intake"],"x-access-level":"partner","x-permission":"intakes:write","x-staff-required-permissions":["intakes:write"]}},"/intakes/{ref}/sole-proprietor/mobile/check":{"post":{"description":"Tenant-scoped saved interview. Confirmation is factual, not compliance approval. Provider submission, OTP and billing remain separate. Staff keys require: intakes:write.","operationId":"check_sole_proprietor_mobile","parameters":[{"in":"path","name":"ref","required":true,"schema":{"maxLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}},{"description":"Required for staff superadmin keys. Select an authorized target from GET /companies. Company partner/admin keys must omit this header.","in":"header","name":"X-Company-Ref","required":false,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"expected_revision":{"minimum":1,"type":"integer"},"source_hash":{"maxLength":64,"pattern":"^[a-f0-9]{64}$","type":"string"}},"required":["expected_revision","source_hash"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Check the representative YES reply"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Authentication required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Permission required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Not found in target company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"revision_conflict, idempotency_conflict, invalid_state, or manual_handoff_required"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Field validation failed"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"feature_disabled"}},"summary":"Check the representative YES reply","tags":["Guided intake"],"x-access-level":"partner","x-permission":"intakes:write","x-staff-required-permissions":["intakes:write"]}},"/intakes/{ref}/sole-proprietor/profile":{"post":{"description":"Tenant-scoped saved interview. Confirmation is factual, not compliance approval. Provider submission, OTP and billing remain separate. Staff keys require: intakes:write.","operationId":"link_sole_proprietor_profile","parameters":[{"in":"path","name":"ref","required":true,"schema":{"maxLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}},{"description":"Required for staff superadmin keys. Select an authorized target from GET /companies. Company partner/admin keys must omit this header.","in":"header","name":"X-Company-Ref","required":false,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"expected_revision":{"minimum":1,"type":"integer"},"scope_ref":{"maxLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"},"source_hash":{"maxLength":64,"pattern":"^[a-f0-9]{64}$","type":"string"}},"required":["expected_revision","source_hash","scope_ref"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Staff connect the existing authorized representative profile"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Authentication required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Permission required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Not found in target company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"revision_conflict, idempotency_conflict, invalid_state, or manual_handoff_required"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Field validation failed"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"feature_disabled"}},"summary":"Staff connect the existing authorized representative profile","tags":["Guided intake"],"x-access-level":"partner","x-permission":"intakes:write","x-staff-required-permissions":["intakes:write"]}},"/intakes/{ref}/sole-proprietor/submit":{"post":{"description":"Tenant-scoped saved interview. Confirmation is factual, not compliance approval. Provider submission, OTP and billing remain separate. Staff keys require: intakes:write.","operationId":"submit_sole_proprietor_campaign","parameters":[{"in":"path","name":"ref","required":true,"schema":{"maxLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}},{"description":"Required for staff superadmin keys. Select an authorized target from GET /companies. Company partner/admin keys must omit this header.","in":"header","name":"X-Company-Ref","required":false,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"confirm_charges":{"type":"boolean"},"expected_revision":{"minimum":1,"type":"integer"},"source_hash":{"maxLength":64,"pattern":"^[a-f0-9]{64}$","type":"string"}},"required":["expected_revision","source_hash","confirm_charges"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Staff register the approved campaign, attach evidence and elect DCA1; may incur charges"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Authentication required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Permission required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Not found in target company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"revision_conflict, idempotency_conflict, invalid_state, or manual_handoff_required"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Field validation failed"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"feature_disabled"}},"summary":"Staff register the approved campaign, attach evidence and elect DCA1; may incur charges","tags":["Guided intake"],"x-access-level":"partner","x-permission":"intakes:write","x-staff-required-permissions":["intakes:write"]}},"/intakes/{ref}/tnid":{"get":{"description":"Customer-scoped TNID module. No provider submission, election, OTP, email or approval. Extracted answers require explicit confirmation. TNID form publication does not establish SMS consent or a verified public signup URL. Staff keys require: intakes:read.","operationId":"get_tnid_workspace","parameters":[{"in":"path","name":"ref","required":true,"schema":{"maxLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}},{"description":"Required for staff superadmin keys. Select an authorized target from GET /companies. Company partner/admin keys must omit this header.","in":"header","name":"X-Company-Ref","required":false,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Get TNID evidence, suggestions and form status"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Authentication required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Permission required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Not found in target company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"revision_conflict, idempotency_conflict, invalid_state, or manual_handoff_required"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Field validation failed"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"feature_disabled"}},"summary":"Get TNID evidence, suggestions and form status","tags":["Guided intake"],"x-access-level":"partner","x-permission":"intakes:read","x-staff-required-permissions":["intakes:read"]}},"/intakes/{ref}/tnid-profile":{"post":{"description":"Tenant-scoped saved interview. Confirmation is factual, not compliance approval. Provider submission, OTP and billing remain separate. Staff keys require: intakes:write.","operationId":"create_intake_profile","parameters":[{"in":"path","name":"ref","required":true,"schema":{"maxLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}},{"description":"Required for staff superadmin keys. Select an authorized target from GET /companies. Company partner/admin keys must omit this header.","in":"header","name":"X-Company-Ref","required":false,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"expected_revision":{"minimum":1,"type":"integer"},"source_hash":{"maxLength":64,"pattern":"^[a-f0-9]{64}$","type":"string"}},"required":["expected_revision","source_hash"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Create the confirmed TNID profile"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Authentication required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Permission required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Not found in target company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"revision_conflict, idempotency_conflict, invalid_state, or manual_handoff_required"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Field validation failed"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"feature_disabled"}},"summary":"Create the confirmed TNID profile","tags":["Guided intake"],"x-access-level":"partner","x-permission":"intakes:write","x-staff-required-permissions":["intakes:write"]}},"/intakes/{ref}/tnid/documents":{"post":{"description":"Tenant-scoped saved interview. Confirmation is factual, not compliance approval. Provider submission, OTP and billing remain separate. Staff keys require: intakes:write.","operationId":"upload_tnid_document","parameters":[{"in":"path","name":"ref","required":true,"schema":{"maxLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}},{"description":"Required for staff superadmin keys. Select an authorized target from GET /companies. Company partner/admin keys must omit this header.","in":"header","name":"X-Company-Ref","required":false,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"additionalProperties":false,"properties":{"document":{"format":"binary","type":"string"},"kind":{"enum":["irs_letter","vsf","screenshot","supporting_document"],"maxLength":2000,"type":"string"}},"required":["document","kind"],"type":"object"}}},"required":true},"responses":{"202":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Attach private interview evidence"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Authentication required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Permission required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Not found in target company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"revision_conflict, idempotency_conflict, invalid_state, or manual_handoff_required"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Field validation failed"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"feature_disabled"}},"summary":"Attach private interview evidence","tags":["Guided intake"],"x-access-level":"partner","x-mcp-tool":false,"x-permission":"intakes:write","x-staff-required-permissions":["intakes:write"]}},"/intakes/{ref}/tnid/forms":{"post":{"description":"Customer-scoped TNID module. No provider submission, election, OTP, email or approval. Extracted answers require explicit confirmation. TNID form publication does not establish SMS consent or a verified public signup URL. Staff keys require: intakes:write.","operationId":"propose_tnid_form","parameters":[{"in":"path","name":"ref","required":true,"schema":{"maxLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}},{"description":"Required for staff superadmin keys. Select an authorized target from GET /companies. Company partner/admin keys must omit this header.","in":"header","name":"X-Company-Ref","required":false,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"frequency":{"maxLength":200,"minLength":1,"type":"string"},"help_contact":{"maxLength":255,"minLength":1,"type":"string"}},"required":["frequency","help_contact"],"type":"object"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Prepare sender signup copy for confirmation"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Authentication required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Permission required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Not found in target company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"revision_conflict, idempotency_conflict, invalid_state, or manual_handoff_required"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Field validation failed"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"feature_disabled"}},"summary":"Prepare sender signup copy for confirmation","tags":["Guided intake"],"x-access-level":"partner","x-permission":"intakes:write","x-staff-required-permissions":["intakes:write"]}},"/intakes/{ref}/tnid/refresh":{"post":{"description":"Customer-scoped TNID module. No provider submission, election, OTP, email or approval. Extracted answers require explicit confirmation. TNID form publication does not establish SMS consent or a verified public signup URL. Staff keys require: intakes:write.","operationId":"refresh_tnid_workspace","parameters":[{"in":"path","name":"ref","required":true,"schema":{"maxLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}},{"description":"Required for staff superadmin keys. Select an authorized target from GET /companies. Company partner/admin keys must omit this header.","in":"header","name":"X-Company-Ref","required":false,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"responses":{"202":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Refresh this interview\u2019s TNID records"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Authentication required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Permission required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Not found in target company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"revision_conflict, idempotency_conflict, invalid_state, or manual_handoff_required"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Field validation failed"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"feature_disabled"}},"summary":"Refresh this interview\u2019s TNID records","tags":["Guided intake"],"x-access-level":"partner","x-permission":"intakes:write","x-staff-required-permissions":["intakes:write"]}},"/registration-capabilities":{"get":{"description":"Feature-gated local foundation. No live upstream registration is available. Internal approval and sandbox simulation never establish carrier readiness. Staff keys require: registrations:read.","operationId":"get_registration_capabilities","parameters":[{"description":"Required for staff superadmin keys. Select an authorized target from GET /companies. Company partner/admin keys must omit this header.","in":"header","name":"X-Company-Ref","required":false,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/RegistrationCapabilities"}},"required":["data"],"type":"object"}}},"description":"Get registration capabilities and requirements"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Authentication required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Permission required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Not found in target company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"revision_conflict, idempotency_conflict, invalid_state, or manual_handoff_required"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Field validation failed"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"feature_disabled"}},"summary":"Get registration capabilities and requirements","tags":["Registrations"],"x-access-level":"partner","x-permission":"registrations:read","x-staff-required-permissions":["registrations:read"]}},"/registration-operations/{ref}":{"get":{"description":"Feature-gated local foundation. No live upstream registration is available. Internal approval and sandbox simulation never establish carrier readiness. Staff keys require: registrations:read.","operationId":"get_registration_operation","parameters":[{"in":"path","name":"ref","required":true,"schema":{"maxLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}},{"description":"Required for staff superadmin keys. Select an authorized target from GET /companies. Company partner/admin keys must omit this header.","in":"header","name":"X-Company-Ref","required":false,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"data":{"additionalProperties":false,"properties":{"operation":{"$ref":"#/components/schemas/RegistrationOperation"}},"required":["operation"],"type":"object"}},"required":["data"],"type":"object"}}},"description":"Read a sandbox operation"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Authentication required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Permission required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Not found in target company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"revision_conflict, idempotency_conflict, invalid_state, or manual_handoff_required"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Field validation failed"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"feature_disabled"}},"summary":"Read a sandbox operation","tags":["Registrations"],"x-access-level":"partner","x-permission":"registrations:read","x-staff-required-permissions":["registrations:read"]}},"/registrations":{"get":{"description":"Feature-gated local foundation. No live upstream registration is available. Internal approval and sandbox simulation never establish carrier readiness. Staff keys require: registrations:read.","operationId":"list_registrations","parameters":[{"in":"query","name":"cursor","schema":{"maxLength":1000,"type":"string"}},{"in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"in":"query","name":"registration_type","schema":{"enum":["toll_free","short_code","rcs_agent"],"maxLength":2000,"type":"string"}},{"description":"Required for staff superadmin keys. Select an authorized target from GET /companies. Company partner/admin keys must omit this header.","in":"header","name":"X-Company-Ref","required":false,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"data":{"additionalProperties":false,"properties":{"next_cursor":{"nullable":true,"type":"string"},"registrations":{"items":{"$ref":"#/components/schemas/Registration"},"type":"array"}},"required":["registrations","next_cursor"],"type":"object"}},"required":["data"],"type":"object"}}},"description":"List company registrations"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Authentication required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Permission required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Not found in target company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"revision_conflict, idempotency_conflict, invalid_state, or manual_handoff_required"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Field validation failed"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"feature_disabled"}},"summary":"List company registrations","tags":["Registrations"],"x-access-level":"partner","x-permission":"registrations:read","x-staff-required-permissions":["registrations:read"]},"post":{"description":"Feature-gated local foundation. No live upstream registration is available. Internal approval and sandbox simulation never establish carrier readiness. Staff keys require: registrations:write.","operationId":"create_registration","parameters":[{"description":"Same key and body replay the original response; changed body returns 409.","in":"header","name":"Idempotency-Key","required":true,"schema":{"maxLength":128,"minLength":1,"type":"string"}},{"description":"Required for staff superadmin keys. Select an authorized target from GET /companies. Company partner/admin keys must omit this header.","in":"header","name":"X-Company-Ref","required":false,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"rcs_agent":{"summary":"Save an RCS profile before details are complete","value":{"details":{"agent_name":"Example Company","description":"Order updates"},"provider_mode":"manual","type":"rcs_agent"}},"short_code":{"summary":"Start a short-code program draft","value":{"details":{"country":"US","lease_status":"unknown","opt_in_description":"Web signup","program_name":"Example alerts","purpose":"Customer alerts","registration_path":"new"},"provider_mode":"manual","type":"short_code"}},"toll_free":{"summary":"Start a toll-free verification draft","value":{"details":{"business_name":"Example Company","consent_evidence_url":"https://example.com/consent","country":"US","numbers":["+18005550123"],"opt_in_description":"Customers choose SMS on the booking form.","purpose":"Appointment reminders"},"provider_mode":"manual","type":"toll_free"}}},"schema":{"$ref":"#/components/schemas/RegistrationCreate"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"data":{"additionalProperties":false,"properties":{"registration":{"$ref":"#/components/schemas/Registration"}},"required":["registration"],"type":"object"}},"required":["data"],"type":"object"}}},"description":"Create a typed registration draft"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Authentication required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Permission required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Not found in target company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"revision_conflict, idempotency_conflict, invalid_state, or manual_handoff_required"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Field validation failed"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"feature_disabled"}},"summary":"Create a typed registration draft","tags":["Registrations"],"x-access-level":"partner","x-permission":"registrations:write","x-staff-required-permissions":["registrations:write"]}},"/registrations/{ref}":{"get":{"description":"Feature-gated local foundation. No live upstream registration is available. Internal approval and sandbox simulation never establish carrier readiness. Staff keys require: registrations:read.","operationId":"get_registration","parameters":[{"in":"path","name":"ref","required":true,"schema":{"maxLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}},{"description":"Required for staff superadmin keys. Select an authorized target from GET /companies. Company partner/admin keys must omit this header.","in":"header","name":"X-Company-Ref","required":false,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"data":{"additionalProperties":false,"properties":{"registration":{"$ref":"#/components/schemas/Registration"}},"required":["registration"],"type":"object"}},"required":["data"],"type":"object"}}},"description":"Get a registration"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Authentication required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Permission required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Not found in target company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"revision_conflict, idempotency_conflict, invalid_state, or manual_handoff_required"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Field validation failed"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"feature_disabled"}},"summary":"Get a registration","tags":["Registrations"],"x-access-level":"partner","x-permission":"registrations:read","x-staff-required-permissions":["registrations:read"]},"patch":{"description":"Feature-gated local foundation. No live upstream registration is available. Internal approval and sandbox simulation never establish carrier readiness. Details are merged; evidence replaces the list. expected_revision is mandatory and stale revisions return 409 revision_conflict. Staff keys require: registrations:write.","operationId":"patch_registration","parameters":[{"in":"path","name":"ref","required":true,"schema":{"maxLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}},{"description":"Required for staff superadmin keys. Select an authorized target from GET /companies. Company partner/admin keys must omit this header.","in":"header","name":"X-Company-Ref","required":false,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegistrationPatch"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"data":{"additionalProperties":false,"properties":{"registration":{"$ref":"#/components/schemas/Registration"}},"required":["registration"],"type":"object"}},"required":["data"],"type":"object"}}},"description":"Update a registration draft"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Authentication required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Permission required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Not found in target company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"revision_conflict, idempotency_conflict, invalid_state, or manual_handoff_required"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Field validation failed"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"feature_disabled"}},"summary":"Update a registration draft","tags":["Registrations"],"x-access-level":"partner","x-permission":"registrations:write","x-staff-required-permissions":["registrations:write"]}},"/registrations/{ref}/approve":{"post":{"description":"Feature-gated local foundation. No live upstream registration is available. Internal approval and sandbox simulation never establish carrier readiness. Staff keys require: registrations:review.","operationId":"approve_registration","parameters":[{"in":"path","name":"ref","required":true,"schema":{"maxLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}},{"description":"Required for staff superadmin keys. Select an authorized target from GET /companies. Company partner/admin keys must omit this header.","in":"header","name":"X-Company-Ref","required":false,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegistrationAction"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"data":{"additionalProperties":false,"properties":{"registration":{"$ref":"#/components/schemas/Registration"}},"required":["registration"],"type":"object"}},"required":["data"],"type":"object"}}},"description":"Approve an immutable internal snapshot"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Authentication required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Permission required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Not found in target company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"revision_conflict, idempotency_conflict, invalid_state, or manual_handoff_required"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Field validation failed"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"feature_disabled"}},"summary":"Approve an immutable internal snapshot","tags":["Registrations"],"x-access-level":"admin","x-permission":"registrations:review","x-staff-required-permissions":["registrations:review"]}},"/registrations/{ref}/events":{"get":{"description":"Feature-gated local foundation. No live upstream registration is available. Internal approval and sandbox simulation never establish carrier readiness. Staff keys require: registrations:read.","operationId":"registration_events","parameters":[{"in":"path","name":"ref","required":true,"schema":{"maxLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}},{"description":"Required for staff superadmin keys. Select an authorized target from GET /companies. Company partner/admin keys must omit this header.","in":"header","name":"X-Company-Ref","required":false,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"data":{"additionalProperties":false,"properties":{"events":{"items":{"$ref":"#/components/schemas/RegistrationEvent"},"type":"array"},"truncated":{"type":"boolean"}},"required":["events","truncated"],"type":"object"}},"required":["data"],"type":"object"}}},"description":"Read registration history"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Authentication required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Permission required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Not found in target company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"revision_conflict, idempotency_conflict, invalid_state, or manual_handoff_required"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Field validation failed"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"feature_disabled"}},"summary":"Read registration history","tags":["Registrations"],"x-access-level":"partner","x-permission":"registrations:read","x-staff-required-permissions":["registrations:read"]}},"/registrations/{ref}/request-review":{"post":{"description":"Feature-gated local foundation. No live upstream registration is available. Internal approval and sandbox simulation never establish carrier readiness. Staff keys require: registrations:write.","operationId":"request_registration_review","parameters":[{"in":"path","name":"ref","required":true,"schema":{"maxLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}},{"description":"Required for staff superadmin keys. Select an authorized target from GET /companies. Company partner/admin keys must omit this header.","in":"header","name":"X-Company-Ref","required":false,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegistrationAction"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"data":{"additionalProperties":false,"properties":{"registration":{"$ref":"#/components/schemas/Registration"}},"required":["registration"],"type":"object"}},"required":["data"],"type":"object"}}},"description":"Request internal review"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Authentication required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Permission required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Not found in target company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"revision_conflict, idempotency_conflict, invalid_state, or manual_handoff_required"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Field validation failed"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"feature_disabled"}},"summary":"Request internal review","tags":["Registrations"],"x-access-level":"partner","x-permission":"registrations:write","x-staff-required-permissions":["registrations:write"]}},"/registrations/{ref}/request-revision":{"post":{"description":"Feature-gated local foundation. No live upstream registration is available. Internal approval and sandbox simulation never establish carrier readiness. A nonblank reason is mandatory. This revokes the current internal approval while preserving its snapshot in event history. Staff keys require: registrations:review.","operationId":"request_registration_revision","parameters":[{"in":"path","name":"ref","required":true,"schema":{"maxLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}},{"description":"Required for staff superadmin keys. Select an authorized target from GET /companies. Company partner/admin keys must omit this header.","in":"header","name":"X-Company-Ref","required":false,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegistrationRevisionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"data":{"additionalProperties":false,"properties":{"registration":{"$ref":"#/components/schemas/Registration"}},"required":["registration"],"type":"object"}},"required":["data"],"type":"object"}}},"description":"Return a registration for revision"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Authentication required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Permission required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Not found in target company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"revision_conflict, idempotency_conflict, invalid_state, or manual_handoff_required"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Field validation failed"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"feature_disabled"}},"summary":"Return a registration for revision","tags":["Registrations"],"x-access-level":"admin","x-permission":"registrations:review","x-staff-required-permissions":["registrations:review"]}},"/registrations/{ref}/submit":{"post":{"description":"Feature-gated local foundation. No live upstream registration is available. Internal approval and sandbox simulation never establish carrier readiness. Manual mode returns 409 manual_handoff_required. Sandbox mode immediately completes a deterministic simulation and returns an inspectable operation with 202; it never grants provider approval. A successful simulation advances the registration revision and preserves its input snapshot in the operation result; reload before the next action. Staff keys require: registrations:submit.","operationId":"submit_registration","parameters":[{"in":"path","name":"ref","required":true,"schema":{"maxLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}},{"description":"Same key and body replay the original response; changed body returns 409.","in":"header","name":"Idempotency-Key","required":true,"schema":{"maxLength":128,"minLength":1,"type":"string"}},{"description":"Required for staff superadmin keys. Select an authorized target from GET /companies. Company partner/admin keys must omit this header.","in":"header","name":"X-Company-Ref","required":false,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegistrationAction"}}},"required":true},"responses":{"202":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"data":{"additionalProperties":false,"properties":{"operation":{"$ref":"#/components/schemas/RegistrationOperation"}},"required":["operation"],"type":"object"},"links":{"additionalProperties":false,"properties":{"operation":{"maxLength":2000,"type":"string"}},"required":["operation"],"type":"object"}},"required":["data"],"type":"object"}}},"description":"Simulate submission or report manual handoff required"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Authentication required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Permission required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Not found in target company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"revision_conflict, idempotency_conflict, invalid_state, or manual_handoff_required"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Field validation failed"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"feature_disabled"}},"summary":"Simulate submission or report manual handoff required","tags":["Registrations"],"x-access-level":"admin","x-permission":"registrations:submit","x-staff-required-permissions":["registrations:submit"]}},"/registrations/{ref}/validate":{"post":{"description":"Feature-gated local foundation. No live upstream registration is available. Internal approval and sandbox simulation never establish carrier readiness. Staff keys require: registrations:read.","operationId":"validate_registration","parameters":[{"in":"path","name":"ref","required":true,"schema":{"maxLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}},{"description":"Required for staff superadmin keys. Select an authorized target from GET /companies. Company partner/admin keys must omit this header.","in":"header","name":"X-Company-Ref","required":false,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/RegistrationValidation"}},"required":["data"],"type":"object"}}},"description":"Validate foundation requirements"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Authentication required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Permission required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Not found in target company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"revision_conflict, idempotency_conflict, invalid_state, or manual_handoff_required"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Field validation failed"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"feature_disabled"}},"summary":"Validate foundation requirements","tags":["Registrations"],"x-access-level":"partner","x-permission":"registrations:read","x-staff-required-permissions":["registrations:read"]}},"/tnid-documents/{ref}/download":{"get":{"description":"Tenant-scoped saved interview. Confirmation is factual, not compliance approval. Provider submission, OTP and billing remain separate. Staff keys require: intakes:read.","operationId":"download_tnid_document","parameters":[{"in":"path","name":"ref","required":true,"schema":{"maxLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}},{"description":"Required for staff superadmin keys. Select an authorized target from GET /companies. Company partner/admin keys must omit this header.","in":"header","name":"X-Company-Ref","required":false,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"responses":{"200":{"content":{"application/octet-stream":{"schema":{"format":"binary","type":"string"}}},"description":"Download the private source document"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Authentication required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Permission required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Not found in target company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"revision_conflict, idempotency_conflict, invalid_state, or manual_handoff_required"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Field validation failed"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"feature_disabled"}},"summary":"Download the private source document","tags":["Guided intake"],"x-access-level":"partner","x-mcp-tool":false,"x-permission":"intakes:read","x-staff-required-permissions":["intakes:read"]}},"/tnid-documents/{ref}/extract":{"post":{"description":"Customer-scoped TNID module. No provider submission, election, OTP, email or approval. Extracted answers require explicit confirmation. TNID form publication does not establish SMS consent or a verified public signup URL. Staff keys require: intakes:write.","operationId":"extract_tnid_document","parameters":[{"in":"path","name":"ref","required":true,"schema":{"maxLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}},{"description":"Required for staff superadmin keys. Select an authorized target from GET /companies. Company partner/admin keys must omit this header.","in":"header","name":"X-Company-Ref","required":false,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"responses":{"202":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Extract candidate interview answers from one stored document"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Authentication required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Permission required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Not found in target company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"revision_conflict, idempotency_conflict, invalid_state, or manual_handoff_required"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Field validation failed"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"feature_disabled"}},"summary":"Extract candidate interview answers from one stored document","tags":["Guided intake"],"x-access-level":"partner","x-permission":"intakes:write","x-staff-required-permissions":["intakes:write"]}},"/tnid-documents/{ref}/transfer":{"post":{"description":"Customer-scoped TNID module. No provider submission, election, OTP, email or approval. Extracted answers require explicit confirmation. TNID form publication does not establish SMS consent or a verified public signup URL. Staff keys require: intakes:write.","operationId":"transfer_tnid_document","parameters":[{"in":"path","name":"ref","required":true,"schema":{"maxLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}},{"description":"Required for staff superadmin keys. Select an authorized target from GET /companies. Company partner/admin keys must omit this header.","in":"header","name":"X-Company-Ref","required":false,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"responses":{"202":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Transfer the privately retained document after connecting TNID"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Authentication required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Permission required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Not found in target company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"revision_conflict, idempotency_conflict, invalid_state, or manual_handoff_required"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Field validation failed"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"feature_disabled"}},"summary":"Transfer the privately retained document after connecting TNID","tags":["Guided intake"],"x-access-level":"partner","x-permission":"intakes:write","x-staff-required-permissions":["intakes:write"]}},"/tnid-extractions/{ref}/apply":{"post":{"description":"Customer-scoped TNID module. No provider submission, election, OTP, email or approval. Extracted answers require explicit confirmation. TNID form publication does not establish SMS consent or a verified public signup URL. Staff keys require: intakes:write.","operationId":"apply_tnid_candidates","parameters":[{"in":"path","name":"ref","required":true,"schema":{"maxLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}},{"description":"Required for staff superadmin keys. Select an authorized target from GET /companies. Company partner/admin keys must omit this header.","in":"header","name":"X-Company-Ref","required":false,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"confirm_accuracy":{"enum":[true],"type":"boolean"},"expected_revision":{"minimum":1,"type":"integer"},"selected":{"items":{"maxLength":100,"type":"string"},"maxItems":50,"minItems":1,"type":"array","uniqueItems":true},"source_hash":{"maxLength":64,"pattern":"^[a-f0-9]{64}$","type":"string"}},"required":["expected_revision","source_hash","selected","confirm_accuracy"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Apply explicitly confirmed candidate answers"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Authentication required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Permission required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Not found in target company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"revision_conflict, idempotency_conflict, invalid_state, or manual_handoff_required"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Field validation failed"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"feature_disabled"}},"summary":"Apply explicitly confirmed candidate answers","tags":["Guided intake"],"x-access-level":"partner","x-permission":"intakes:write","x-staff-required-permissions":["intakes:write"]}},"/tnid-forms/{ref}/publish":{"post":{"description":"Customer-scoped TNID module. No provider submission, election, OTP, email or approval. Extracted answers require explicit confirmation. TNID form publication does not establish SMS consent or a verified public signup URL. Staff keys require: intakes:write.","operationId":"publish_tnid_form","parameters":[{"in":"path","name":"ref","required":true,"schema":{"maxLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}},{"description":"Required for staff superadmin keys. Select an authorized target from GET /companies. Company partner/admin keys must omit this header.","in":"header","name":"X-Company-Ref","required":false,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"confirm_accuracy":{"enum":[true],"type":"boolean"},"source_hash":{"maxLength":64,"pattern":"^[a-f0-9]{64}$","type":"string"}},"required":["source_hash","confirm_accuracy"],"type":"object"}}},"required":true},"responses":{"202":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Publish the confirmed TNID form version"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Authentication required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Permission required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Not found in target company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"revision_conflict, idempotency_conflict, invalid_state, or manual_handoff_required"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Field validation failed"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"feature_disabled"}},"summary":"Publish the confirmed TNID form version","tags":["Guided intake"],"x-access-level":"partner","x-permission":"intakes:write","x-staff-required-permissions":["intakes:write"]}},"/tnid-forms/{ref}/unpublish":{"post":{"description":"Customer-scoped TNID module. No provider submission, election, OTP, email or approval. Extracted answers require explicit confirmation. TNID form publication does not establish SMS consent or a verified public signup URL. Staff keys require: intakes:write.","operationId":"unpublish_tnid_form","parameters":[{"in":"path","name":"ref","required":true,"schema":{"maxLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}},{"description":"Required for staff superadmin keys. Select an authorized target from GET /companies. Company partner/admin keys must omit this header.","in":"header","name":"X-Company-Ref","required":false,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Withdraw a TNID form version"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Authentication required"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Permission required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Not found in target company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"revision_conflict, idempotency_conflict, invalid_state, or manual_handoff_required"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Field validation failed"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"feature_disabled"}},"summary":"Withdraw a TNID form version","tags":["Guided intake"],"x-access-level":"partner","x-permission":"intakes:write","x-staff-required-permissions":["intakes:write"]}},"/tnid/connection":{"get":{"description":"Tokens and codes are never returned. Complete authorization interactively at /tnid/connect. Staff keys require: intakes:read.","operationId":"get_tnid_connection","parameters":[{"description":"Required for staff superadmin keys. Select an authorized target from GET /companies. Company partner/admin keys must omit this header.","in":"header","name":"X-Company-Ref","required":false,"schema":{"description":"Opaque reference returned by this API. Store it; integer IDs are not accepted.","maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"connection":{"properties":{"connect_url":{"type":"string"},"connected":{"type":"boolean"},"connected_at":{"nullable":true,"type":"string"},"connected_by":{"nullable":true,"type":"string"},"credentials_exposed":{"type":"boolean"},"status":{"type":"string"}},"required":["connected","status","credentials_exposed"],"type":"object"}},"required":["connection"],"type":"object"}},"required":["data"],"type":"object"}}},"description":"Read TNID user connection status without credentials"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Missing, invalid, or revoked API key"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Admin API key required"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Resource not found in this company"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Workflow state prevents this action"},"410":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Verification expired"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Validation failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Rate limit or OTP cooldown; back off before retrying"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unexpected server error"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Upstream service unavailable"}},"summary":"Read TNID user connection status without credentials","tags":["Campaigns"],"x-access-level":"partner","x-staff-required-permissions":["intakes:read"]}}},"security":[{"bearerAuth":[]},{"apiKeyAuth":[]}],"servers":[{"url":"https://dev.10dlc-campaigns.com/api/v1"}],"tags":[{"name":"Brands"},{"name":"Campaigns"},{"name":"Administration"},{"name":"Registrations"}],"x-live-registration-adapters":[],"x-registration-scaffold-enabled":true}
