Get sender details

Request

Parameter	In	Type	Required	Description
`Format`	path	string	true	The supported file format for getting a response. Possible values: `json`and `xml`.
`Email`	query	string	true	The email address of the sender that contains the details you are requesting.
`apikey`	query	string	true	The API key of your account.

Parameter

Type

Required

Description

Format

path

string

true

The supported file format for getting a response.

Possible values: jsonand xml.

Email

query

string

true

The email address of the sender that contains the details you are requesting.

apikey

query

string

true

The API key of your account.

RequestResponse

GET https://{hostname}/v3/senders/find_one.{Format}?Email=&apikey=

Response

Status	Description	Headers	Schema
`200 OK`	The request is successful.	`Content-Type:application/json` `Accept:application/json`	N/A

Status

Description

Headers

Schema

200 OK

The request is successful.

Content-Type:application/json

Accept:application/json

N/A

RequestResponse

{
  "Code": 0,
  "Error": null,
  "Context": {
    "ID": "01234567-89ab-cdef-0123-456789abcdef",
    "Name": "Your Name",
    "Email": "[email protected]",
    "CreatedOn": "/Date(1323857838000+0200)/",
    "IsEnabled": true,
    "SpfVerified": false,
    "DkimVerified": false,
    "DkimPublic": "Some DkimPublic"
  }
}

Code - the response code. This is 0 if successful.
Error - the response error message. This is null if successful.
Context - an object that contains all the information about the sender:
- ID - the ID of the sender.
- Name - the name of the sender.
- Email - the email address of the sender.
- CreatedOn - the date that the sender was created.
- IsEnabled - this is true if the sender is enabled and false if it is not.
- SpfVerified - this is true if the SPF record for the sender is enabled and false if it is not.
- DkimVerified - this is true if the DKIM record for the sender is enabled and false if it is not.
- DkimPublic - specifies the sender's email public DKIM.
- DmarcVerified - this is true if the Dmarc record for the sender is enabled and false if it is not.
- IsVerified - this is true when the sender has both statuses Enabled AND Accepted.

Do you have some feedback for us?

If you have suggestions for improving this article,