- 22 May 2024
- 1 Minute to read
- Print
- DarkLight
Authentication API
- Updated on 22 May 2024
- 1 Minute to read
- Print
- DarkLight
Introduction
This article provides the API specifications for the Authentication API.
Example Request Structure (GET method)
https://api.leadid.com/Authenticate?lac={ACCOUNTCODE}&id={LEADIDTOKEN}
Parameter Definitions
Name | Value | Required | Description |
URL | https://api.leadid.com/Authenticate | Yes | The URL to be used for the query. |
Method | GET | Yes | The HTTPS method to be used. |
lac | xxxxxxxx-xxxx-xxxx-xxxx | Yes | Your Jornaya Account Code. |
id | 36 Character LeadiD token | Yes | The LeadiD token, which must be included in every query. |
Security for Usage
The usage of HTTPS/TLS is highly recommended when implementing the Jornaya TCPA Guardian (3rd Party) API. This ensures data transmitted between your networks and Jornaya’s systems are securely encrypted and protected. Jornaya supports the usage and configuration of TLS 1.2, and the following TLS cipher suites:
ECDHE-ECDSA-AES128-GCM-SHA256 | ECDHE-RSA-AES256-SHA384 |
ECDHE-RSA-AES128-GCM-SHA256 | ECDHE-RSA-AES256-SHA |
ECDHE-ECDSA-AES128-SHA256 | ECDHE-ECDSA-AES256-SHA |
ECDHE-RSA-AES128-SHA256 | AES128-GCM-SHA256 |
ECDHE-ECDSA-AES128-SHA | AES128-SHA256 |
ECDHE-RSA-AES128-SHA | AES128-SHA |
ECDHE-ECDSA-AES256-GCM-SHA384 | AES256-GCM-SHA384 |
ECDHE-RSA-AES256-GCM-SHA384 | AES256-SHA256 |
ECDHE-ECDSA-AES256-SHA384 |
At any future time, Jornaya may revise the list of supported TLS protocols and cipher suites as required by industry security best practices. You will be notified in advance of such changes to ensure continued successful operations of your integrations with Jornaya’s services.
Example Response Structure
JSON | XML |
---|---|
{ | <authenticate> |
"authenticate": { | <authentic>1</authentic> |
"authentic": 1, | <token>{LeadiD}</token> |
"token": "{LeadiD" | </authenticate> |
} | |
} |
Data Responses
The following sections list the responses (and associated values) received when utilizing the Authentication API.
Audit | ||
---|---|---|
Data Point | Value | Description |
token | {LeadiD token} | The LeadiD token being returned |
Authentic | ||
---|---|---|
Data Point | Value | Description |
authentic | 0 | One or more of the conditions have been met below and no additional data will be returned for this LeadiD token:
|
1 | Authentic LeadiD |