Get one identity

Search Documentation

Search across all developer documentation

entities

Get one identity

GET /v1/identities/{identity}
Auth required api.identities.view

Returns one identity by its full address. Match is case-insensitive. Percent-encode @ as %40 (e.g. user%40example.com). Returns 404 not_found when the identity is not managed by this org.

Path parameters

identity string required

Email address or domain. Percent-encode @ as %40. Case-insensitive.

Responses

Errors follow the RFC 7807 problem format — see the error reference.

200 Identity detail application/json
identity string required

Full identity — an email address (e.g. support@example.com) or a bare domain (e.g. example.com).

type string enum required

Derived from identityemail when it contains @, otherwise domain.

One of: email, domain

verification_status string enum required

One of: pending, success, failed

dkim_status string enum required

Today this is always the same value as verification_status. The fields are exposed separately so they can diverge in a future revision without breaking clients.

One of: pending, success, failed

mail_from_domain string | null required

The identity's custom MAIL FROM (Return-Path) domain as Amazon SES reports it, or null when the identity uses the SES default (amazonses.com). Reflected, not owned: SendOps mirrors what is configured in your AWS account and never sets it. The value refreshes whenever the identity is synced or its status refreshed, so a change made in the AWS console appears here after the next sync.

created_at string<date-time> required
401 Missing, malformed, or unknown API key application/problem+json
403 Key lacks the required scope or plan limit violated application/problem+json
404 Resource not found application/problem+json
422 Query parameter or path value failed validation application/problem+json
429 Per-org rate limit exceeded application/problem+json
500 Unexpected server-side failure. The code is internal_error. The request_id field can be quoted to SendOps support to investigate. application/problem+json