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 identity — email when it contains @, otherwise domain.

One of: email, domain

ownership string enum required

Who this identity belongs to, where one AWS account may be shared by more than one SendOps organization. - claimed — this org has adopted the identity. Prefer these when choosing a default from-address. - discovered — the identity exists in the shared AWS account and this org can send from it, but has not adopted it. - conflict — two organizations claim it and neither wins. Its event stream is paused pending resolution; do not send from it. detached is the fourth value in SendOps' vocabulary but cannot appear here: this endpoint returns live identities only.

One of: claimed, discovered, conflict

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 A query parameter, path value or body field failed validation. The body is a validation_failed Problem. When the refusal is about a reference — a segment key, template slug, topic or attribute name the organization does not have — it additionally carries validation_code, field, line/column, missing, candidates and next_step, so a client can correct the call without a second round of guessing. See ValidationProblem. 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