Verify domain (POST /)
Registers a domain as a sender ID and verifies ownership of the domain.
Specifying the VerificationToken value of the response to a TXT record on the DNS server completes the verification procedure.
Once domain ownership is confirmed, emails can be sent from all the email addresses that belong to the domain without verifying individual email addresses.
Request Headers
Refer to "Common API request headers".
Request Parameters
Action
Name of the API to run.
"VerifyDomainIdentity"
| Data Type | Cardinality |
|---|---|
| String | 1..1 |
Version
API version.
"v1.0" (optional)
| Data Type | Cardinality |
|---|---|
| String | 0..1 |
Domain
Domain to be verified.
Up to 255 characters.
| Data Type | Cardinality |
|---|---|
| String | 1..1 |
Request Elements
n/a
HTTP status
Status
Returns the status of the request.
- 200:
- Normal completion
- 400:
- Request parameter error
- 401:
- Authentication error
- 403:
- Access denied
- 500:
- Internal error
| Data Type | Cardinality |
|---|---|
| Int | 1..1 |
Response elements (normal completion)
VerifyDomainIdentityResponse
Envelope of the response.
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| - | 1..1 | None | VerifyDomainIdentityResult ResponseMetadata |
VerifyDomainIdentityResult
Envelope of the result.
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| - | 1..1 | VerifyDomainIdentityResponse | VerificationToken |
VerificationToken
Verification token.
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| xsd:string | 1..1 | VerifyDomainIdentityResult | None |
ResponseMetadata
Envelope of the metadata.
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| - | 1..1 | VerifyDomainIdentityResponse | RequestId |
RequestId
ID that uniquely identifies the request.
This is required when contacting support staff to troubleshoot an issue.
UUID format (example: 647cd254-e0d1-44a9-af61-1d6d86ea6b77)
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| xsd:string | 1..1 | ResponseMetadata | None |
Example of request
POST / HTTP/1.1
Date: Fri, 06 Jun 2014 11:00:37 AM GMT
Content-Length: ...
Host: mail.jp-east-1.tps5.fujitsu.com
Content-Type: application/x-www-form-urlencoded; charset=utf-8
X-Auth-Token: MIIFvgY...
Action=VerifyDomainIdentity
&Domain=example.com
Example of Response
HTTP/1.1 200 OK
Date: Fri, 06 Jun 2014 11:00:38 GMT
Content-Length: ...
Content-Type: application/xml
x-fj-request-id: 0610909f-2598-4354-838b-67223520e3ea
<?xml version="1.0" encoding="UTF-8"?>
<VerifyDomainIdentityResponse>
<VerifyDomainIdentityResult>
<VerificationToken>95f2f6b80985...</VerificationToken>
</VerifyDomainIdentityResult>
<ResponseMetadata>
<RequestId>0610909f-2598-4354-838b-67223520e3ea</RequestId>
</ResponseMetadata>
</VerifyDomainIdentityResponse>