Quikaid Lead Submission API Documentation

Quikaid Lead Submission API Documentation

Introduction

Welcome to Quikaid’s Lead Submission API documentation. This API allows clients to submit lead information in a flexible format. The API is designed to accept various field names for the same data to accommodate different client systems. This document provides all the necessary information to integrate with the API successfully.

Base URL

https://flight.quikaid.com/api/leads/create

Authentication

An API Key is required to authenticate requests. This key is unique to each client and ensures secure communication. You must include your API key in the request body as the ApiKey field.

Note: The API key will be generated and provided by us. Ensure you keep your API key secure and do not share it publicly.

HTTP Method

All requests should be made using the POST HTTP method.

Content-Type

Set the Content-Type header to:

application/json

Request Parameters

Required

• ApiKey (string, required): Your unique API key provided by us.

Optional

The API accepts various field names (aliases) for the same data point to accommodate different client data structures. Below is a list of accepted parameters and their aliases.

Personal Information

• FirstName (string): First name of the lead.
• Aliases: First
• MiddleName (string): Middle name of the lead.
• Aliases: Middle
• LastName (string): Last name of the lead.
• Aliases: Last
• FullName (string): Full name of the lead. If FirstName and LastName are not provided, the API will attempt to parse this field.
• Aliases: Name
• Nickname (string): Nickname of the lead.

Contact Information

• Phone (string): Phone number of the lead.
• Aliases: PhoneNumber
• Email (string): Email address of the lead.
• Aliases: EmailAddress
• Address1 (string): Primary address line.
• Aliases: Address
• Address2 (string): Secondary address line (e.g., apartment, suite, unit).
• City (string): City of residence.
• State (string): State or province.
• Zip (string): ZIP or postal code.
• Aliases: Zip5, Zip_Code, ZipCode

Identification

• Ssn (string): Social Security Number.
• Aliases: SocialSecurityNumber, Social

Additional Information

• CaseDescription (string): Description of the case or additional notes.
• Aliases: Notes, AdditionalNotes, ConditionDescription
• RequestId (string): Unique identifier for the lead in your system.
• Aliases: LeadId

Dates

• DateOfBirth (string): Date of birth in MM-DD-YYYY format.
• Aliases: Date_Of_Birth, DOB, Birth_Date, BirthDate
• DateOfLead (string): Date when the lead was created. If not provided, defaults to the current date and time.

Numeric Values

• Age (integer): Age of the lead. If not provided, the API may calculate it from DateOfBirth.

Boolean Flags

• HasTextConsent (boolean): Indicates if the lead has consented to receive text messages.
• Aliases: TextConsent
• HaveYouWorked5OfTheLast10Years (boolean): Employment status over the past 10 years.
• Aliases: EmployedIn5OfPast10Years, HasWorked5OutOf10Years, HasWorked
• DoYouCurrentlyHaveAnAttorneyHelpingYouWithYourCase (boolean): Indicates if the lead currently has legal representation.
• Aliases: CurrentlyRepresentedByAttorney, Attorney
• AreYouCurrentlyReceivingSocialSecurityDisabilityBenefits (boolean): Indicates if the lead is receiving social security disability benefits.
• Aliases: CurrentlyOnSocialSecurityDisability, Benefits
• DoYouExpectToBeOutOfWorkForAtLeast12Months (boolean): Expected duration of unemployment.
• Aliases: ExpectOutOfWork12MonthsOrMore, OutOfWork
• IsAHealthConditionAndOrDisabilityPreventingYoufromFullTimeWork (boolean): Health status affecting work.
• Aliases: PreventingFullTimeWork, HealthCondition
• WereYouTreatedByADoctor (boolean): Indicates if the lead has received medical treatment.
• Aliases: ReceivedMedicalTreatment, Treatment

Data Types and Formats

• Strings: All string fields should be UTF-8 encoded.
• Booleans: Boolean fields should be true or false (case-insensitive). Strings like "Yes" or "No" are also accepted.
• Dates: Date fields should be in MM-DD-YYYY format. Other common formats like YYYY-MM-DD are also accepted.
• GUID: The ApiKey should be a valid GUID string.

Example Request

{

  "ApiKey": "your-api-key-here",

  "FullName": "John Jacob Doe",

  "Nickname": "Johnny",

  "DateOfBirth": "03-22-1962",

  "PhoneNumber": "1234567890",

  "HasTextConsent": true,

  "EmailAddress": "[email protected]",

  "ZipCode": "55555",

  "Address": "555 Test Center Dr",

  "Address2": "Ste 200",

  "Ssn": "590-11-9376",

  "EmployedIn5OfPast10Years": false,

  "DoYouCurrentlyHaveAnAttorneyHelpingYouWithYourCase": true,

  "AreYouCurrentlyReceivingSocialSecurityDisabilityBenefits": false,

  "DoYouExpectToBeOutOfWorkForAtLeast12Months": true,

  "IsAHealthConditionAndOrDisabilityPreventingYoufromFullTimeWork": true,

  "WereYouTreatedByADoctor": true,

  "Notes": "This is a test lead, do not contact this person."

}

Field Aliases and Mapping

To accommodate different client systems, the API accepts various aliases for the same data field. Below is a mapping of these aliases:

Notes on Field Parsing

• Name Parsing: If FirstName and LastName are not provided, the API will attempt to parse FullName into first, middle, and last names.
• Date Parsing: The API accepts dates in multiple common formats, but MM-DD-YYYY is preferred.
• Boolean Parsing: The API accepts true/false, 1/0, and "Yes"/"No" (case-insensitive) for boolean fields.

Best Practices

• Include All Relevant Data: While many fields are optional, including as much information as possible ensures accurate processing.
• Consistent Field Names: Use the standard field names, if possible, to avoid confusion.
• Data Validation: Validate data on your end before submission to reduce errors.

Support and Contact Information

If you encounter any issues or have questions, please reach out to our support team:

• Email: [email protected]
• Hours: Monday to Friday, 9 AM to 5 PM EST

Conclusion

Thank you for choosing our services. We are committed to providing a robust and flexible API to meet your lead submission needs. Should you have any questions or require assistance, please do not hesitate to contact our support team.

Share via: