Authentication Methods

There are two authentication options available to you. (We recommend UserKey Authentication.)

  • Basic Authentication
  • UserKey Authentication

Authenticating via Basic Authentication

Basic Authentication requires a UsernamePassword, and an APIKey encoded in base64.

While the Username and Password should not need an introduction, you might not know exactly what our APIKey represents. Simply put, the ApiKey is a unique identifier assigned to a partner and allows access to the API.  Every APIKey is unique and has its own data associated with it. (see sample record below)

APIKey Record



<Name>Redtail Technology</Name>




How do I supply the credentials?

Below, you can see that the credentials are supplied in the request header as a string, with each credential separated by a single colon. The credentials are secured via SSL.



When supplying the credentials, you will want to use base64 encoding to alleviate any woes related to incompatible characters, as well as specify the Basic authentication type. See bolded string in request header example below.(C#)


HttpWebRequest req = (HttpWebRequest)HttpWebRequest.Create("");

req.Headers[System.Net.HttpRequestHeader.Authorization] = "Basic " + Convert.ToBase64String(System.Text.Encoding.Default.GetBytes("G5555F31-56Z2-62X7-9PSG-553E0MCD8ATG2:CoolGuy65:L@zypass"));

req.Method = "GET";

req.ContentType = "text/xml";

Your Credentials

Please reach out to to obtain your credentials, if you have not done so already.

Authenticating via UserKey

UserKey Authentication requires an APIKey and a UserKey and does NOT expire. The UserKey is a unique Identifier for an individual user and remains constant regardless if a User decides to change his or her password. As such, authenticating through the UserKey is ideal once you've obtained the user's UserKey.

Supplying the credentials is similar for all of our authentication method types. As seen in the Basic Authentication method, the credentials are colon delimited.



And just as before, when supplying the credentials you will want to use base64 encoding to alleviate any woes related to incompatible characters. However, this time around, you will want to specfiy the authentication type in the request header as "UserkeyAuth " Please see example below.(C#)



HttpWebRequest req = (HttpWebRequest)HttpWebRequest.Create("");

req.Headers[System.Net.HttpRequestHeader.Authorization] = "Userkeyauth " + Convert.ToBase64String(System.Text.Encoding.Default.GetBytes("6C135EDF-C37C-4039-AEF3-5DFC079F9E6A:B7B4BCDD-67C8-449C-B1D4-C1AAFE49703D"));
req.Method = "GET";

req.ContentType = "text/xml";  


Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request


Powered by Zendesk