Retrieve a domain claim

Request parameters

Request example

Set OPENSEND_BASE_URL=https://api.example.com and OPENSEND_API_KEY=os_replace_me on your server.

curl -X GET "$OPENSEND_BASE_URL/domains/YOUR_id/claim" \
  -H "Authorization: Bearer $OPENSEND_API_KEY"

Response

200 · application/json. Example IDs stand for IDs returned by your installation.

{
  "object": "domain_claim",
  "id": "d91cd9bd-1176-453e-8fc1-35364d380206",
  "name": "example.com",
  "status": "pending",
  "domain_id": "a1b2c3d4-1176-453e-8fc1-35364d380206",
  "region": "us-east-1",
  "record": {
    "type": "TXT",
    "name": "example.com",
    "value": "opensend-domain-verification=abc123",
    "ttl": "Auto"
  },
  "blocked_reason": null,
  "failure_reason": null,
  "created_at": "2023-04-26 20:21:26.347412+00",
  "expires_at": "2023-05-03 20:21:26.347412+00"
}

Behavior and errors

id is the placeholder domain’s ID (domain_id in the claim response), not the claim ID. The response is the latest claim for that placeholder.

status is pending until ownership is proven, verified while the domain is released from the previous team and provisioned for yours, and completed once your provisioning succeeds. blocked means verification found the TXT record but the transfer cannot start yet: pending_scheduled_emails when the current owner has queued or scheduled mail, or recent_owner_activity during an active removal, provisioning, refresh, competing transfer, or while the domain is an imported SES identity the owner has not released. Verify again after the condition clears. expired claims can be started again; canceled and superseded are terminal. failed and a non-null failure_reason explain what to fix before verifying again.

Timestamps use the same format as other domain responses. region and domain_id are null only for claims without a placeholder.

Use a full-access credential. Unknown or foreign resources return 404. See authentication, errors, rate limits, and pagination.