diff --git a/specs/email-sending.openapi.yml b/specs/email-sending.openapi.yml index db3ff35..a9d7c7d 100644 --- a/specs/email-sending.openapi.yml +++ b/specs/email-sending.openapi.yml @@ -1514,16 +1514,34 @@ components: type: boolean compliance_status: type: string + description: | + Indicates the compliance verification status of the sending domain. + The domain must reach `compliant` status before you can send emails + in production. + + - `demo` - A demo domain provided by Mailtrap. Can only send emails to the account owner. + - `exhausted` - A demo domain that has used up its sending allowance. Cannot send emails. + - `unverified_dns` - Domain DNS records have not been verified yet. Open your domain on the [Sending Domains](https://mailtrap.io/sending/domains) page and follow the [Sending Domain Setup](https://docs.mailtrap.io/email-api-smtp/setup/sending-domain) guide. + - `missing_company_info` - Account is missing required company information. Go to [Company Information](https://mailtrap.io/account-management?current_tab=company_information) and fill in the required details. + - `initial` - Domain is verified and undergoing automatic compliance review. No action needed — typically completes within 2 minutes. + - `pending` - Automatic review required additional information. Open your domain on the [Sending Domains](https://mailtrap.io/sending/domains) page and fill in the compliance questionnaire. + - `pending_cc` - Compliance questionnaire was submitted but credit card identity verification is still needed. Open your domain on the [Sending Domains](https://mailtrap.io/sending/domains) page and enter card details. The charged amount is refunded immediately and the card is not stored. + - `under_review` - Compliance questionnaire submitted and manual review is in progress. No action needed — this can take up to one business day. + - `non_compliant` - Domain did not pass compliance checks. Sending is not allowed. Contact [Mailtrap Support](mailto:support@mailtrap.io) for details and next steps. + - `compliant` - Domain has passed all compliance checks and is ready to send emails. + - `suspended` - Domain sending has been suspended. Contact [Mailtrap Support](mailto:support@mailtrap.io) to resolve the issue. enum: - initial - unverified_dns - demo - missing_company_info - pending + - pending_cc - under_review + - compliant - non_compliant - suspended - - compliant + - exhausted dns_verified: type: boolean dns_verified_at: