Quikaid Lead Submission API Documentation

Introduction

Welcome to Quikaid’s Lead Submission API. This API allows clients to submit lead information in a flexible format. It accepts multiple field names (aliases) for the same data point to accommodate different client systems.

Endpoint

Authentication

An API key is required to authenticate requests. This key is unique to each client and must be included in the request body as the ApiKey field.

Note: Keep your API key secure and do not expose it publicly.

HTTP Method

POST

Content-Type

Request Parameters

Required

ApiKey (string): Your unique API key.

Optional

The following fields are optional. The API supports aliases for flexibility across client systems.

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, this field will be parsed.
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 (MM-DD-YYYY preferred).
Aliases: Date_Of_Birth, DOB, Birth_Date, BirthDate

DateOfLead (string): Date the lead was created. Defaults to current date/time if not provided.

Numeric Values

Age (integer): Age of the lead. May be calculated from DateOfBirth if not provided.

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 disability benefits.
Aliases: CurrentlyOnSocialSecurityDisability, Benefits

DoYouExpectToBeOutOfWorkForAtLeast12Months (boolean): Expected duration of unemployment.
Aliases: ExpectOutOfWork12MonthsOrMore, OutOfWork

IsAHealthConditionAndOrDisabilityPreventingYoufromFullTimeWork (boolean): Indicates if a condition prevents full-time work.
Aliases: PreventingFullTimeWork, HealthCondition

WereYouTreatedByADoctor (boolean): Indicates if the lead has received medical treatment.
Aliases: ReceivedMedicalTreatment, Treatment

HaveYouAlreadyBeenApprovedForSocialSecurityDisabilityBenefits (boolean): Indicates prior approval for disability benefits.
Aliases: AlreadyApprovedForBenefits, ApprovedForDisability

HeyFlow-Specific Fields

WhatIsTheNatureOfYourDisablingMedicalConditions (string): Indicates the type of disabling medical condition.
Accepted values: Physical, Mental, PhysicalAndMental, None
Aliases: MedicalConditions, ConditionType

AreYouCurrentlyEmployed (string): Indicates current employment status.
Accepted values: FullTime, PartTime, NotEmployed
Aliases: CurrentlyEmployed, EmploymentStatus

WhatIsYourAge (string): Represents the lead’s age range.
Accepted values: UnderEighteen, EighteenToFortyEight, FortyNineToFiftyFour, FiftyFiveToSixtyOne, SixtyTwoToSixtyFive, SixtySixAndOlder
Aliases: AgeRange

Data Types and Formats

Strings: UTF-8 encoded text.

Booleans: Accepts true/false, "Yes"/"No" (case-insensitive), and values with trailing numeric suffixes (e.g., "True1", "No2").

Dates: Accepts MM-DD-YYYY and other common formats (e.g., YYYY-MM-DD).

GUID: ApiKey must be a valid GUID string.

Example Request

Field Aliases and Mapping

Notes on Field Parsing

Name Parsing: FullName may be split into first, middle, and last names if needed.

Date Parsing: Multiple formats are accepted; MM-DD-YYYY is preferred.

Boolean Parsing: Accepts true/false, "Yes"/"No", and values with trailing numeric suffixes.

Enum Parsing: Accepts case-insensitive enum names. Trailing numeric suffixes (e.g., "FullTime1") are ignored.

Best Practices

• Include as much relevant data as possible
• Prefer standard field names over aliases
• Validate data before submission

Support

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

Conclusion

This API is designed to be flexible and easy to integrate. If you need assistance, contact our support team.

Share via: