Show sender ID verification status and verification token (POST /)

Retrieves the verification status and verification token (for domains) for the specified sender IDs (email address or domain).

The sender ID verification status can be one of the following types:
  • Pending (verifying)
  • Success (successful)
  • Failed (failed)
  • TemporaryFailure (temporary failure)
  • NotStarted (verification has not started)

Request Headers

Refer to "Common API request headers".

Request Parameters

Action

Name of the API to run.

"GetIdentityVerificationAttributes"

Data Type Cardinality
String 1..1

Version

API version.

"v1.0" (optional)

Data Type Cardinality
String 0..1

Identities.member.N

List of sender IDs (email address or domain)

Up to 255 characters.

Specify N from 1 to 100.

Data Type Cardinality
String list 1..n

Request Elements

n/a

HTTP status

Status

Returns the status of the request.

One of the following values will be returned.
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)

GetIdentityVerificationAttributesResponse

Envelope of the response.

Data Type Cardinality Parent Element Child Element(s)
- 1..1 None GetIdentityVerificationAttributesResult

ResponseMetadata

GetIdentityVerificationAttributesResult

Envelope of the result.

Data Type Cardinality Parent Element Child Element(s)
- 1..1 GetIdentityVerificationAttributesResponse VerificationAttributes

VerificationAttributes

Envelope of the verification status list

Data Type Cardinality Parent Element Child Element(s)
- 1..1 GetIdentityVerificationAttributesResult entry

entry

Envelope of the verification status

Data Type Cardinality Parent Element Child Element(s)
- 0..n VerificationAttributes key

value

key

ID (domain name or email address)

Data Type Cardinality Parent Element Child Element(s)
xsd:string 1..1 entry None

value

Envelope of the attribute information

Data Type Cardinality Parent Element Child Element(s)
- 1..1 entry VerificationStatus

VerificationToken

VerificationStatus

Verification status of the sender IDs (email address or domain)

This can be one of the following types:
  • Pending (verifying)
  • Success (successful)
  • Failed (failed)
  • TemporaryFailure (temporary failure)
  • NotStarted (verification has not started)
Data Type Cardinality Parent Element Child Element(s)
xsd:string 1..1 value None

VerificationToken

Verification token of the sender IDs (for domains)

This will be "null" if the sender ID is an email address.

Data Type Cardinality Parent Element Child Element(s)
xsd:string 0..1 value None

ResponseMetadata

Envelope of the metadata.

Data Type Cardinality Parent Element Child Element(s)
- 1..1 GetIdentityVerificationAttributesResponse 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=GetIdentityVerificationAttributes
&Identities.member.1=example.com
&Identities.member.2=user%40example.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: d96bd874-9bf2-11e1-8ee7-c98a0037a2b6

<?xml version="1.0" encoding="UTF-8"?>
<GetIdentityVerificationAttributesResponse>
  <GetIdentityVerificationAttributesResult>
    <VerificationAttributes>
      <entry>
        <key>example.com</key>
        <value>
          <VerificationStatus>Pending</VerificationStatus>
          <VerificationToken>QTKknzFg2J4ygwa+XvHAxUl1hyHoY0gVfZdfjIedHZ0=</VerificationToken>
        </value>
      </entry>
      <entry>
        <key>user@ example.com</key>
        <value>
          <VerificationStatus>Pending</VerificationStatus>
        </value>
      </entry>
    </VerificationAttributes>
  </GetIdentityVerificationAttributesResult>
  <ResponseMetadata>
    <RequestId>d96bd874-9bf2-11e1-8ee7-c98a0037a2b6</RequestId>
  </ResponseMetadata>
</GetIdentityVerificationAttributesResponse>